org.gvsig.symbology.fmap.mapcontext.rendering.symbol.line.impl

Class AbstractLineSymbol

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractCartographicSupport

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.line.impl.AbstractLineSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, ILineSymbol, Persistent

Direct Known Subclasses:

MultiLayerLineSymbol, PictureLineSymbol, SimpleLineSymbol

public abstract class AbstractLineSymbol
extends AbstractSymbol
implements ILineSymbol

AbstractLineSymbol is the class that implements the interface for line symbols. It is considered as the father of all the XXXLineSymbols and will implement all the methods that these classes had not developed (and correspond with one of the methods of AbstractLineSymbol class).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractLineSymbol.RegisterPersistence

Nested classes/interfaces inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

CartographicSupport.CartographicContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

LOGGER, SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.line.ILineSymbol

SYMBOL_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

SELECTION_COLOR

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
AbstractLineSymbol()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
int	getAlpha() Obtains the transparency of the line symbol
java.awt.Color	getColor() Returns the color of the line symbol
ILineStyle	getLineStyle() Obtains the style of the line symbol.
protected Geometry	getSampleGeometry(java.awt.Rectangle r)
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static Geometry	offsetFShape(Geometry shp, double offset)
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAlpha(int outlineAlpha) Defines the transparency of a line symbol.
void	setColor(java.awt.Color color) Sets the Color to use to render the symbol.
void	setLineColor(java.awt.Color color) Sets the color for a line symbol
void	setLineStyle(ILineStyle lineStyle) Defines the style of the line symbol to be used.
void	setReferenceSystem(int system) Sets the Reference System that defines how this units have to be handled.
void	setUnit(int unitIndex) Defines the unit used to express measures.

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

cloneForSelection, cloneForSelection, draw, drawInsideRectangle, equals, getDescription, getFeature, getID, getRequiredFeatureAttributeNames, getSymbolForSelection, getSymbolForSelection, isShapeVisible, print, setDescription, setFeature, setID, setIsShapeVisible

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractCartographicSupport

copyCartographicContext, getCartographicContext, getReferenceSystem, getUnit, isInPixels, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, toCartographicUnits

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.line.ILineSymbol

getLineWidth, setLineWidth

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

draw, draw, drawInsideRectangle, getDescription, getFeature, getID, getSymbolForSelection, getSymbolForSelection, isShapeVisible, setDescription, setFeature, setID

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.IPrintable

print

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

copyCartographicContext, copyCartographicContext, getCartographicContext, getReferenceSystem, getUnit, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, toCartographicUnits

Field Detail

LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractLineSymbol

public AbstractLineSymbol()

Method Detail

getColor

public java.awt.Color getColor()

Description copied from interface: ILineSymbol

Returns the color of the line symbol

Specified by:

getColor in interface ISymbol

Specified by:

getColor in interface ILineSymbol

Returns:

Color

setLineColor

public void setLineColor(java.awt.Color color)

Description copied from interface: ILineSymbol

Sets the color for a line symbol

Specified by:

setLineColor in interface ILineSymbol

setColor

public void setColor(java.awt.Color color)

Description copied from interface: ISymbol

Sets the Color to use to render the symbol.

Specified by:

setColor in interface ISymbol

Parameters:

color - to render the symbol

getSymbolType

public final int getSymbolType()

Description copied from interface: ISymbol

The use of this method -and its mechanism- is being valorated. It probably will be deprecated.

Specified by:

getSymbolType in interface ISymbol

Returns:

FSymbol constants. I think it is better to use isSuitableFor

isSuitableFor

public boolean isSuitableFor(Geometry geom)

Description copied from interface: ISymbol

True if this symbol is ok for the geometry. For example, a FillSymbol will be suitable for a Polygon.

Specified by:

isSuitableFor in interface ISymbol

Returns:

getLineStyle

public ILineStyle getLineStyle()

Description copied from interface: ILineSymbol

Obtains the style of the line symbol.

Specified by:

getLineStyle in interface ILineSymbol

Returns:

ILineStyle, the style of the line symbol

setLineStyle

public void setLineStyle(ILineStyle lineStyle)

Description copied from interface: ILineSymbol

Defines the style of the line symbol to be used.

Specified by:

setLineStyle in interface ILineSymbol

setUnit

public void setUnit(int unitIndex)

Description copied from interface: CartographicSupport

Defines the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

Specified by:

setUnit in interface CartographicSupport

Overrides:

setUnit in class AbstractCartographicSupport

setReferenceSystem

public void setReferenceSystem(int system)

Description copied from interface: CartographicSupport

Sets the Reference System that defines how this units have to be handled. Possible values are:

1. CartographySupport.WORLD: Defines that the unit values refer to distances in the world. So, the size of the element displayed depends directly on the scale and CRS used by the map. The size of the elements defined to use CartographicSupport.WORLD will match exactly to their actual size in the real world.
2. CartographySupport.PAPER: Defines that the unit values refer to the length that the element will have regardless where it appears. If ReferenceSystem is CartographySupport.PAPER, and the length is (e.g.) millimeters the element will be displayed with the same amount of millimeters of length whether in the screen or the printer (screen DPI and printer DPI must be correctly configured).

Specified by:

setReferenceSystem in interface CartographicSupport

Overrides:

setReferenceSystem in class AbstractCartographicSupport

getAlpha

public int getAlpha()

Description copied from interface: ILineSymbol

Obtains the transparency of the line symbol

Specified by:

getAlpha in interface ILineSymbol

Returns:

setAlpha

public void setAlpha(int outlineAlpha)

Description copied from interface: ILineSymbol

Defines the transparency of a line symbol.

Specified by:

setAlpha in interface ILineSymbol

getSampleGeometry

protected Geometry getSampleGeometry(java.awt.Rectangle r)

offsetFShape

public static Geometry offsetFShape(Geometry shp,
                                    double offset)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractSymbol

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractSymbol

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractSymbol

Throws:

PersistenceException