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

Class AbstractSymbol

java.lang.Object

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

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, DefaultDynamicSymbol, MultiShapeSymbol, SimpleTextSymbol, SmartTextSymbol

public abstract class AbstractSymbol
extends AbstractCartographicSupport
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

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

CartographicSupport.CartographicContext

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER
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

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
protected ISymbol	cloneForSelection()
protected ISymbol	cloneForSelection(java.awt.Color selectionColor)
void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, Feature f, 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.
void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, java.awt.Rectangle r) Useful to render the symbol inside the TOC, or inside little rectangles.
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.
Feature	getFeature()
java.lang.String	getID() Get the id ob the symbol (the basename of file).This attribute is not persistent.
java.lang.String[]	getRequiredFeatureAttributeNames(FeatureStore featureStore)
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
ISymbol	getSymbolForSelection(java.awt.Color selectionColor)
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	print(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, PrintAttributes properties)
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	setFeature(Feature feature)
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

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.ISymbol

draw, getColor, getSymbolType, isSuitableFor, setColor

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

Field Detail

LOGGER

protected static final Logger LOGGER

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

getFeature

public Feature getFeature()

Specified by:

getFeature in interface ISymbol

setFeature

public void setFeature(Feature feature)

Specified by:

setFeature in interface ISymbol

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)

Description copied from interface: ISymbol

Set the id ob the symbol (the basename of file). This attribute is not persistent.

Specified by:

setID in interface ISymbol

getID

public final java.lang.String getID()

Description copied from interface: ISymbol

Get the id ob the symbol (the basename of file).This attribute is not persistent.

Specified by:

getID in interface ISymbol

Returns:

isShapeVisible

public 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:

true if Shape must be drawn. Useful if you are labelling

setIsShapeVisible

public final void setIsShapeVisible(boolean isShapeVisible)

Sets this symbol to visible

Parameters:

isShapeVisible -

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

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

cloneForSelection

protected ISymbol cloneForSelection(java.awt.Color selectionColor)

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

getRequiredFeatureAttributeNames

public java.lang.String[] getRequiredFeatureAttributeNames(FeatureStore featureStore)
                                                    throws DataException

Throws:

DataException

draw

public void draw(java.awt.Graphics2D g,
                 java.awt.geom.AffineTransform affineTransform,
                 Geometry geom,
                 Feature f,
                 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

drawInsideRectangle

public void drawInsideRectangle(java.awt.Graphics2D g,
                                java.awt.geom.AffineTransform affineTransform,
                                java.awt.Rectangle r)
                         throws SymbolDrawingException

Description copied from interface: ISymbol

Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course, you can also to choose to render a prepared image, etc.

Specified by:

drawInsideRectangle in interface ISymbol

Throws:

SymbolDrawingException - TODO

print

public void print(java.awt.Graphics2D g,
                  java.awt.geom.AffineTransform affineTransform,
                  Geometry geom,
                  PrintAttributes properties)

Specified by:

print in interface IPrintable

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.

getSymbolForSelection

public ISymbol getSymbolForSelection(java.awt.Color selectionColor)

Specified by:

getSymbolForSelection in interface ISymbol