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

Class AbstractSymbol

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFillSymbol, AbstractLineSymbol, AbstractMarkerSymbol, ChartSymbol, SimpleTextSymbol

public abstract class AbstractSymbol
extends java.lang.Object
implements ISymbol_v2, CartographicSupport

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSymbol.RegisterPersistence

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SYMBOL_PERSISTENCE_DEFINITION_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
AbstractSymbol()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
protected ISymbol	cloneForSelection()
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() The description is a human-readable text used to label it when show in a symbol menu or something like that.
java.lang.String	getID() Get the id ob the symbol (the basename of file)
int	getReferenceSystem() Returns the Reference System used to draw the elements of the image.
int	getUnit() Returns the unit used to express measures.
boolean	isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi) Informs that the geometry will be represented with that symbol in just one pixel or dot
boolean	isShapeVisible() Tells whether the shape of the symbol will be drawn or not.
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	setDescription(java.lang.String desc) Sets the description of this symbol
void	setID(java.lang.String id) Set the id ob the symbol (the basename of file)
void	setIsShapeVisible(boolean isShapeVisible) Sets this symbol to visible
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 java.lang.Object

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

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

draw, drawInsideRectangle, getColor, getOnePointRgb, getPixExtentPlus, getSymbolForSelection, getSymbolType, isSuitableFor, setColor

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

print

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

getCartographicSize, setCartographicSize, toCartographicSize

Field Detail

SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractSymbol

public AbstractSymbol()

Method Detail

setDescription

public final void setDescription(java.lang.String desc)

Description copied from interface: ISymbol

Sets the description of this symbol

Specified by:

setDescription in interface ISymbol

See Also:

ISymbol.getDescription();

getDescription

public final java.lang.String getDescription()

Description copied from interface: ISymbol

The description is a human-readable text used to label it when show in a symbol menu or something like that.

Specified by:

getDescription in interface ISymbol

Returns:

description of this symbol.

setID

public final void setID(java.lang.String id)

Set the id ob the symbol (the basename of file)

Specified by:

setID in interface ISymbol_v2

Parameters:

id -

getID

public final java.lang.String getID()

Get the id ob the symbol (the basename of file)

Specified by:

getID in interface ISymbol_v2

Parameters:

id -

isShapeVisible

public final boolean isShapeVisible()

Description copied from interface: ISymbol

Tells whether the shape of the symbol will be drawn or not.

Specified by:

isShapeVisible in interface ISymbol

Returns:

setIsShapeVisible

public final void setIsShapeVisible(boolean isShapeVisible)

Sets this symbol to visible

Parameters:

isShapeVisible -

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

getUnit

public int getUnit()

Description copied from interface: CartographicSupport

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

Specified by:

getUnit in interface CartographicSupport

getReferenceSystem

public int getReferenceSystem()

Description copied from interface: CartographicSupport

Returns the Reference System used to draw the elements of the image.

The elements have to be scaled to pixel when the image is bein drawn in order to compose the map. The elements of the map may define its size in other units than pixel.

CartographicSupport enables the elements to define the size in measure units but these units may refer to different reference system. Two kinds of Reference Systems are allowed in this context: CartographicSupport.WORLD, and CartographicSupport.PAPER.

Depending on which Reference System is used the unit used by this element refers to distances in the real world (then they are map's CRS-dependant) or screen or printer output (then they are output DPI-dependant)

In case the unit used is pixel then the reference system does not have any effect since the source unit is the same than the target unit.

Specified by:

getReferenceSystem in interface CartographicSupport

Returns:

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isOneDotOrPixel

public boolean isOneDotOrPixel(Geometry geom,
                      double[] positionOfDotOrPixel,
                      ViewPort viewPort,
                      int dpi)

Description copied from interface: ISymbol

Informs that the geometry will be represented with that symbol in just one pixel or dot

Specified by:

isOneDotOrPixel in interface ISymbol

positionOfDotOrPixel - (out) filled with pixel or dot location

Returns:

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 java.lang.Object

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

cloneForSelection

protected ISymbol cloneForSelection()

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

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

Throws:

PersistenceException