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

Class SimpleMarkerSymbol

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class SimpleMarkerSymbol
extends AbstractMarkerSymbol
implements ISimpleMarkerSymbol

SimpleMarkerSymbol is the most basic symbol for the representation of point objects which can define its size and color apart from the rotation and the offset from a point in the map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleMarkerSymbol.RegisterPersistence
static class	SimpleMarkerSymbol.RegisterSymbol

Field Summary

Fields

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

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

MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

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

SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol

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

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
SimpleMarkerSymbol()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, Feature feature, Cancellable cancel) Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.
java.awt.Color	getOutlineColor() Returns the outline color for the symple marker symbol
double	getOutlineSize() Gets the size of the outline for the simple marker symbol
ISymbol	getSelectionSymbol()
int	getStyle() Obtains the style for the simple marker symbol
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
boolean	hasOutline() Returns true or false depending if the simple marker symbol has an outline or not.
boolean	isOutlined() Returns if the marker symbol should be drawn outlined.
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	setOutlineColor(java.awt.Color outlineColor) Sets the outline color for the simple marker symbol
void	setOutlined(boolean outlined) Establishes the outline for the simple marker symbol.
void	setOutlineSize(double outlineSize) Establishes the size for the outline of the simple marker symbol
void	setSelectionSymbol(ISymbol selectionSymbol)
void	setStyle(int style) Sets the style for the simple marker symbol

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

drawInsideRectangle, getCartographicSize, getColor, getMask, getOffset, getOnePointRgb, getPixExtentPlus, getRotation, getSize, getSymbolType, isSuitableFor, print, setAlpha, setCartographicSize, setColor, setMask, setOffset, setRotation, setSize, toCartographicSize

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

cloneForSelection, equals, getDescription, getID, getReferenceSystem, getUnit, isOneDotOrPixel, isShapeVisible, setDescription, setID, setIsShapeVisible, setReferenceSystem, setUnit

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.marker.IMarkerSymbol

getColor, getMask, getOffset, getRotation, getSize, setAlpha, setColor, setMask, setOffset, setRotation, setSize

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

drawInsideRectangle, getDescription, getOnePointRgb, getPixExtentPlus, getSymbolType, isOneDotOrPixel, isShapeVisible, isSuitableFor, setDescription

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

print

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

getCartographicSize, getReferenceSystem, getUnit, setCartographicSize, setReferenceSystem, setUnit, toCartographicSize

Field Detail

SIMPLE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SIMPLE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

SimpleMarkerSymbol

public SimpleMarkerSymbol()

Method Detail

getSymbolForSelection

public ISymbol getSymbolForSelection()

Description copied from interface: ISymbol

Returns the derived version of the symbol that will be used to draw the feature when it is selected.

Specified by:

getSymbolForSelection in interface ISymbol

Returns:

ISymbol applied to a feature when it has been selected.

draw

public void draw(java.awt.Graphics2D g,
        java.awt.geom.AffineTransform affineTransform,
        Geometry geom,
        Feature feature,
        Cancellable cancel)

Description copied from interface: ISymbol

Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.

Specified by:

draw in interface ISymbol

cancel - TODO

hasOutline

public boolean hasOutline()

Returns true or false depending if the simple marker symbol has an outline or not.

Specified by:

hasOutline in interface ISimpleMarkerSymbol

Returns:

Returns the outline.

setOutlined

public void setOutlined(boolean outlined)

Establishes the outline for the simple marker symbol.

Specified by:

setOutlined in interface ISimpleMarkerSymbol

Parameters:

outline - The outline to set.

getOutlineColor

public java.awt.Color getOutlineColor()

Returns the outline color for the symple marker symbol

Specified by:

getOutlineColor in interface ISimpleMarkerSymbol

Returns:

Color,outlineColor.

setOutlineColor

public void setOutlineColor(java.awt.Color outlineColor)

Sets the outline color for the simple marker symbol

Specified by:

setOutlineColor in interface ISimpleMarkerSymbol

Parameters:

outlineColor, - Color

getOutlineSize

public double getOutlineSize()

Gets the size of the outline for the simple marker symbol

Specified by:

getOutlineSize in interface ISimpleMarkerSymbol

Returns:

Returns the outlineSize.

setOutlineSize

public void setOutlineSize(double outlineSize)

Establishes the size for the outline of the simple marker symbol

Specified by:

setOutlineSize in interface ISimpleMarkerSymbol

Parameters:

outlineSize - The outlineSize to set.

getSelectionSymbol

public ISymbol getSelectionSymbol()

Specified by:

getSelectionSymbol in interface ISimpleMarkerSymbol

Returns:

Returns the selectionSymbol.

setSelectionSymbol

public void setSelectionSymbol(ISymbol selectionSymbol)

Specified by:

setSelectionSymbol in interface ISimpleMarkerSymbol

Parameters:

selectionSymbol - The selectionSymbol to set.

setStyle

public void setStyle(int style)

Sets the style for the simple marker symbol

Specified by:

setStyle in interface ISimpleMarkerSymbol

Parameters:

style -

getStyle

public int getStyle()

Obtains the style for the simple marker symbol

Specified by:

getStyle in interface ISimpleMarkerSymbol

Returns:

markerStyle,int

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 AbstractMarkerSymbol

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()}.

isOutlined

public boolean isOutlined()

Returns if the marker symbol should be drawn outlined.

Specified by:

isOutlined in interface ISimpleMarkerSymbol

Returns:

if it is outlined

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 AbstractMarkerSymbol

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 AbstractMarkerSymbol

Throws:

PersistenceException