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

Class SingleSymbolLegend

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.SingleSymbolLegend

All Implemented Interfaces:

java.lang.Cloneable, DrawingObservable, ILegend, ISingleSymbolLegend, IVectorLegend, Legend, Persistent

public class SingleSymbolLegend
extends AbstractVectorialLegend
implements ISingleSymbolLegend

Implements a legend composed by single symbols.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleSymbolLegend.RegisterLegend
static class	SingleSymbolLegend.RegisterPersistence

Field Summary

Fields

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

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

LOG, VECTORIAL_LEGEND_PERSISTENCE_DEFINITION_NAME, zSort

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.ISingleSymbolLegend

LEGEND_NAME

Constructor Summary

Constructors

Constructor and Description
SingleSymbolLegend() Constructor method, needed by persistence.
SingleSymbolLegend(ISymbol style) Convenience fast constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
java.lang.String	getClassName()
ISymbol	getDefaultSymbol() Obtains the default symbol of the legend.
protected java.lang.String[]	getRequiredFeatureAttributeNames(FeatureStore featureStore) Returns the names of the Feature attributes required for the ILegend to operate.
int	getShapeType() Returns the type of the shape.
ISymbol	getSymbol(int recordIndex)
ISymbol	getSymbolByFeature(Feature feat) Returns a symbol starting from an IFeature.
boolean	isSuitableForShapeType(int shapeType)
boolean	isUseDefaultSymbol() Returns true or false depending on if the rest of values are used.
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	setDefaultSymbol(ISymbol s) Establishes the default symbol of a legend.
void	setFeatureStore(FeatureStore fs)
void	setShapeType(int shapeType) Defines the type of the shape.
void	useDefaultSymbol(boolean b)

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

draw, draw, draw, drawFeatures, getZSort, internalDraw, isDrawSymbolInEeachPrimitive, print, print, setDrawSymbolInEeachPrimitive, setZSort

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

addDrawingObserver, addLegendListener, addObserver, beginComplexNotification, cloneLegend, countObservers, deleteDrawingObserver, deleteDrawingObservers, deleteObserver, disableNotifications, enableNotifications, endComplexNotification, fireDefaultSymbolChangedEvent, getListeners, getManager, getSymbolManager, inComplex, isEnabledNotifications, notifyObservers, notifyObservers, removeLegendListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.ISingleSymbolLegend

getZSort, setZSort

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend

draw, draw, print, print

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.ILegend

addLegendListener, cloneLegend, fireDefaultSymbolChangedEvent, getListeners, removeLegendListener

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

cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.DrawingObservable

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

Field Detail

SINGLE_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SINGLE_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

SingleSymbolLegend

public SingleSymbolLegend()

Constructor method, needed by persistence.

SingleSymbolLegend

public SingleSymbolLegend(ISymbol style)

Convenience fast constructor.

Parameters:

style - Symbol.

Method Detail

setDefaultSymbol

public void setDefaultSymbol(ISymbol s)

Description copied from interface: IVectorLegend

Establishes the default symbol of a legend. In a SingleSymbolLegend the symbol is established by calling this method.

Specified by:

setDefaultSymbol in interface IVectorLegend

Parameters:

s - default symbol.

getSymbol

public ISymbol getSymbol(int recordIndex)

getDefaultSymbol

public ISymbol getDefaultSymbol()

Description copied from interface: IVectorLegend

Obtains the default symbol of the legend.

Specified by:

getDefaultSymbol in interface ILegend

Specified by:

getDefaultSymbol in interface IVectorLegend

Returns:

default symbol.

getShapeType

public int getShapeType()

Description copied from interface: IVectorLegend

Returns the type of the shape.

Specified by:

getShapeType in interface IVectorLegend

Returns:

Returns the type of the shapes that the legend is ready to use.

setShapeType

public void setShapeType(int shapeType)

Description copied from interface: IVectorLegend

Defines the type of the shape.

Specified by:

setShapeType in interface IVectorLegend

Parameters:

shapeType - type of the shape.

getSymbolByFeature

public ISymbol getSymbolByFeature(Feature feat)

Description copied from interface: IVectorLegend

Returns a symbol starting from an IFeature.

Specified by:

getSymbolByFeature in interface IVectorLegend

Parameters:

feat - IFeature.

Returns:

Símbolo.

useDefaultSymbol

public void useDefaultSymbol(boolean b)

Specified by:

useDefaultSymbol in interface IVectorLegend

isUseDefaultSymbol

public boolean isUseDefaultSymbol()

Description copied from interface: IVectorLegend

Returns true or false depending on if the rest of values are used.

Specified by:

isUseDefaultSymbol in interface IVectorLegend

Returns:

True if the rest of values are used.

getClassName

public java.lang.String getClassName()

isSuitableForShapeType

public boolean isSuitableForShapeType(int shapeType)

Specified by:

isSuitableForShapeType in interface IVectorLegend

setFeatureStore

public void setFeatureStore(FeatureStore fs)
                     throws DataException

Throws:

DataException

getRequiredFeatureAttributeNames

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

Description copied from class: AbstractVectorialLegend

Returns the names of the Feature attributes required for the ILegend to operate.

Specified by:

getRequiredFeatureAttributeNames in class AbstractVectorialLegend

Parameters:

featureStore - the store where the Features belong to

Returns:

the names of required Feature attribute names

Throws:

DataException - if there is an error getting the attribute names

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 AbstractVectorialLegend

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 AbstractVectorialLegend

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 AbstractVectorialLegend

Throws:

PersistenceException