Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2023 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style;

import java.awt.Stroke;

import org.gvsig.fmap.mapcontext.rendering.symbols.styles.IStyle;

/**

 * Interface that controls the properties that define the style of a line.This

 * properties are the width, stroke, offset and arrow decorator style( for

 * example if the line includes markers as an arrow to specify an orientation).

 *

 * @author jaume dominguez faus - jaume.dominguez@iver.es

 */

public interface ILineStyle extends IStyle {

    /**

     * Returns the width of the line

     *

     * @return

     */

    public abstract float getLineWidth();

    /**

     * Establishes the width of the line

     *

     * @param width of the line

     */

    public abstract void setLineWidth(float width);

    /**

     * Returns the stroke of the line

     *

     * @return Stroke of the line

     */

    public abstract Stroke getStroke();

    /**

     * Sets the stroke of the line

     *

     * @param stroke,stroke to be established

     */

    public abstract void setStroke(Stroke stroke);

    /**

     * Gets the arrow decorator style that has the line

     *

     * @return ArrowDecoratorStyle

     */

    public abstract IArrowDecoratorStyle getArrowDecorator();

    /**

     * Sets the arrow decorator style of the line

     *

     * @param arrowDecoratorStyle, ArrowDecoratorStyle

     */

    public abstract void setArrowDecorator(IArrowDecoratorStyle arrowDecoratorStyle);

    /**

     * Returns the offset of the line

     *

     * @return

     */

    public abstract double getOffset();

    /**

     * Establishes the offset of the line

     *

     * @param offset

     */

    public abstract void setOffset(double offset);

    public Stroke getCartographicStroke();

    public double getCartographicOffset();

}