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

Class AbstractMarkerSymbol

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.marker.impl.AbstractMarkerSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, IMarkerSymbol, IMarkerSymbol_v2, Persistent

Direct Known Subclasses:

ArrowMarkerSymbol, CharacterMarkerSymbol, MultiLayerMarkerSymbol, PictureMarkerSymbol, SimpleMarkerSymbol

public abstract class AbstractMarkerSymbol
extends AbstractSymbol
implements IMarkerSymbol_v2

Abstract class that any MARKER SYMBOL should extend.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMarkerSymbol.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	MARKER_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.marker.IMarkerSymbol

CIRCLE_STYLE, CROSS_STYLE, DIAMOND_STYLE, HORIZONTAL_LINE_STYLE, SQUARE_STYLE, STAR_STYLE, SYMBOL_NAME, TRIANGLE_STYLE, VERTICAL_LINE_STYLE, X_STYLE

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

PAPER, WORLD

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

SELECTION_COLOR

Constructor Summary

Constructors

Constructor and Description
AbstractMarkerSymbol()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
protected double	getAdjustedSize(java.awt.Rectangle r, double size)
protected double	getCartographicSize()
java.awt.Color	getColor() Returns the color of the marker symbol.
java.awt.Color	getEfectiveLineToOffsetColor(Feature f)
java.awt.geom.Point2D	getEfectiveOffset(Feature f)
double	getEfectiveRotationInDegres(Feature f)
double	getEfectiveRotationInRadians(Feature f)
double	getEfectiveSize(Feature f)
java.awt.Color	getLineToOffsetColor()
java.lang.String	getLineToOffsetColorExpression()
IMask	getMask()
java.awt.geom.Point2D	getOffset() Gets the offset for a marker symbol
java.lang.String	getOffsetXExpression()
java.lang.String	getOffsetYExpression()
protected Point	getPoint(double x, double y)
double	getRotation() Returns the rotation (in radians, counter-clockwise) of the marker symbol
java.lang.String	getRotationExpression()
double	getRotationInDegrees()
double	getRotationInRadians()
protected Geometry	getSampleGeometry(java.awt.Rectangle r)
double	getSize() Obtains the size of a marker symbol
java.lang.String	getSizeExpression()
protected SymbolTable	getSymbolTable(Feature f)
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
boolean	isDrawLineToOffset()
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.
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) Establishes a color for the marker symbol
void	setDrawLineToOffset(boolean drawLineToOffset)
void	setLineToOffsetColor(java.awt.Color color)
void	setLineToOffsetColorExpression(java.lang.String lineToOffsetColorExpression)
void	setMask(IMask mask) Defines a mask for the symbol
void	setOffset(java.awt.geom.Point2D offset) Establishes the offset currently set for the marker symbol.
void	setOffsetXExpression(java.lang.String offsetXExpression)
void	setOffsetYExpression(java.lang.String offsetYExpression)
void	setRotation(double r) Sets the rotation of the marker symbol
void	setRotationExpression(java.lang.String rotationExpression)
void	setRotationInDegrees(double r)
void	setRotationInRadians(double r)
void	setSize(double size) Sets the size of marker symbol
void	setSizeExpression(java.lang.String sizeExpression)

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, setReferenceSystem, setUnit, toCartographicUnits

Methods inherited from class java.lang.Object

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

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

copyCartographicContext, copyCartographicContext, getCartographicContext, getReferenceSystem, getUnit, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setReferenceSystem, setUnit, toCartographicUnits

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

Field Detail

MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractMarkerSymbol

public AbstractMarkerSymbol()

Method Detail

getPoint

protected Point getPoint(double x,
                         double y)

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

getRotation

public double getRotation()

Description copied from interface: IMarkerSymbol

Returns the rotation (in radians, counter-clockwise) of the marker symbol

Specified by:

getRotation in interface IMarkerSymbol

Returns:

double (rotation)

setRotation

public void setRotation(double r)

Description copied from interface: IMarkerSymbol

Sets the rotation of the marker symbol

Specified by:

setRotation in interface IMarkerSymbol

getRotationInDegrees

public double getRotationInDegrees()

setRotationInDegrees

public void setRotationInDegrees(double r)

getRotationInRadians

public double getRotationInRadians()

setRotationInRadians

public void setRotationInRadians(double r)

getOffset

public java.awt.geom.Point2D getOffset()

Description copied from interface: IMarkerSymbol

Gets the offset for a marker symbol

Specified by:

getOffset in interface IMarkerSymbol

Returns:

Point2D

setOffset

public void setOffset(java.awt.geom.Point2D offset)

Description copied from interface: IMarkerSymbol

Establishes the offset currently set for the marker symbol.

Specified by:

setOffset in interface IMarkerSymbol

getSymbolTable

protected SymbolTable getSymbolTable(Feature f)

getLineToOffsetColor

public java.awt.Color getLineToOffsetColor()

Specified by:

getLineToOffsetColor in interface IMarkerSymbol_v2

setLineToOffsetColor

public void setLineToOffsetColor(java.awt.Color color)

Specified by:

setLineToOffsetColor in interface IMarkerSymbol_v2

isDrawLineToOffset

public boolean isDrawLineToOffset()

Specified by:

isDrawLineToOffset in interface IMarkerSymbol_v2

setDrawLineToOffset

public void setDrawLineToOffset(boolean drawLineToOffset)

Specified by:

setDrawLineToOffset in interface IMarkerSymbol_v2

getOffsetXExpression

public java.lang.String getOffsetXExpression()

Specified by:

getOffsetXExpression in interface IMarkerSymbol_v2

setOffsetXExpression

public void setOffsetXExpression(java.lang.String offsetXExpression)

Specified by:

setOffsetXExpression in interface IMarkerSymbol_v2

getOffsetYExpression

public java.lang.String getOffsetYExpression()

Specified by:

getOffsetYExpression in interface IMarkerSymbol_v2

setOffsetYExpression

public void setOffsetYExpression(java.lang.String offsetYExpression)

Specified by:

setOffsetYExpression in interface IMarkerSymbol_v2

getRotationExpression

public java.lang.String getRotationExpression()

Specified by:

getRotationExpression in interface IMarkerSymbol_v2

setRotationExpression

public void setRotationExpression(java.lang.String rotationExpression)

Specified by:

setRotationExpression in interface IMarkerSymbol_v2

getSizeExpression

public java.lang.String getSizeExpression()

Specified by:

getSizeExpression in interface IMarkerSymbol_v2

setSizeExpression

public void setSizeExpression(java.lang.String sizeExpression)

Specified by:

setSizeExpression in interface IMarkerSymbol_v2

getLineToOffsetColorExpression

public java.lang.String getLineToOffsetColorExpression()

Specified by:

getLineToOffsetColorExpression in interface IMarkerSymbol_v2

setLineToOffsetColorExpression

public void setLineToOffsetColorExpression(java.lang.String lineToOffsetColorExpression)

Specified by:

setLineToOffsetColorExpression in interface IMarkerSymbol_v2

getEfectiveOffset

public java.awt.geom.Point2D getEfectiveOffset(Feature f)

Specified by:

getEfectiveOffset in interface IMarkerSymbol_v2

getEfectiveRotationInDegres

public double getEfectiveRotationInDegres(Feature f)

Specified by:

getEfectiveRotationInDegres in interface IMarkerSymbol_v2

getEfectiveRotationInRadians

public double getEfectiveRotationInRadians(Feature f)

Specified by:

getEfectiveRotationInRadians in interface IMarkerSymbol_v2

getEfectiveLineToOffsetColor

public java.awt.Color getEfectiveLineToOffsetColor(Feature f)

Specified by:

getEfectiveLineToOffsetColor in interface IMarkerSymbol_v2

getEfectiveSize

public double getEfectiveSize(Feature f)

Specified by:

getEfectiveSize in interface IMarkerSymbol_v2

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:

getSize

public double getSize()

Description copied from interface: IMarkerSymbol

Obtains the size of a marker symbol

Specified by:

getSize in interface IMarkerSymbol

Returns:

setSize

public void setSize(double size)

Description copied from interface: IMarkerSymbol

Sets the size of marker symbol

Specified by:

setSize in interface IMarkerSymbol

getColor

public java.awt.Color getColor()

Description copied from interface: IMarkerSymbol

Returns the color of the marker symbol.

Specified by:

getColor in interface ISymbol

Specified by:

getColor in interface IMarkerSymbol

Returns:

Color

setColor

public void setColor(java.awt.Color color)

Description copied from interface: IMarkerSymbol

Establishes a color for the marker symbol

Specified by:

setColor in interface ISymbol

Specified by:

setColor in interface IMarkerSymbol

Parameters:

color - to render the symbol

setAlpha

public void setAlpha(int outlineAlpha)

Description copied from interface: IMarkerSymbol

Defines the transparency of a line symbol.

Specified by:

setAlpha in interface IMarkerSymbol

getMask

public final IMask getMask()

Specified by:

getMask in interface IMarkerSymbol

Returns:

the mask of the symbol

setMask

public final void setMask(IMask mask)

Description copied from interface: IMarkerSymbol

Defines a mask for the symbol

Specified by:

setMask in interface IMarkerSymbol

getCartographicSize

protected double getCartographicSize()

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

getAdjustedSize

protected double getAdjustedSize(java.awt.Rectangle r,
                                 double size)

getSampleGeometry

protected Geometry getSampleGeometry(java.awt.Rectangle r)