org.gvsig.raster.fmap.legend

Class ColorTableLegend

java.lang.Object

org.gvsig.raster.fmap.legend.ColorTableLegend

All Implemented Interfaces:

java.lang.Cloneable, IClassifiedLegend, ILegend, Legend, Persistent

public class ColorTableLegend
extends java.lang.Object
implements IClassifiedLegend, ILegend

Leyenda para tablas de color aplicadas a un raster.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ColorTableLegend() Empty constructor used only for persistence purposes.
ColorTableLegend(ISymbol[] s, java.lang.String[] d) Leyenda para tablas de color raster.

Method Summary

Modifier and Type	Method and Description
void	addLegendListener(LegendContentsChangedListener listener) Adds a new listener to the legend.
java.lang.Object	clone() Creates a copy of the object.
ILegend	cloneLegend() Clones the legend.
static ColorTableLegend	createLegend(ColorTable colorTable) Crea una leyenda de tipo ColorTableLegend a partir de un objeto ColorTable
void	fireDefaultSymbolChangedEvent(SymbolLegendEvent event) Executed when the default symbol of a legend is changed.
java.lang.String	getClassName()
ISymbol	getDefaultSymbol() Obtains the default symbol of the legend.
java.lang.String[]	getDescriptions() Obtains the descriptions of the classes that are in the classification
LegendContentsChangedListener[]	getListeners() Obtains the listeners of a legend.
java.lang.String	getSLDString(java.lang.String layerName)
ISymbol[]	getSymbols() Obtains the symbols of each class of the classification for the user.
java.lang.Object[]	getValues() Obtains the values in relation with each class of the classification
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	registerPersistence()
void	removeLegendListener(LegendContentsChangedListener listener) Removes a listener from the legend.
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.

Methods inherited from class java.lang.Object

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

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

cloneQuietly, cloneQuietly

Field Detail

COLOR_TABLE_LEGEND_DYNCLASS_NAME

public static final java.lang.String COLOR_TABLE_LEGEND_DYNCLASS_NAME

See Also:

Constant Field Values

Constructor Detail

ColorTableLegend

public ColorTableLegend(ISymbol[] s,
                        java.lang.String[] d)

Leyenda para tablas de color raster.

Parameters:

s - Lista de simbolos

d - Lista de descripciones de simbolos

ColorTableLegend

public ColorTableLegend()

Empty constructor used only for persistence purposes.

Method Detail

createLegend

public static ColorTableLegend createLegend(ColorTable colorTable)

Crea una leyenda de tipo ColorTableLegend a partir de un objeto ColorTable

Parameters:

colorTable -

Returns:

ColorTableLegend

getDescriptions

public java.lang.String[] getDescriptions()

Description copied from interface: IClassifiedLegend

Obtains the descriptions of the classes that are in the classification

Specified by:

getDescriptions in interface IClassifiedLegend

Returns:

DOCUMENT ME!

getSymbols

public ISymbol[] getSymbols()

Description copied from interface: IClassifiedLegend

Obtains the symbols of each class of the classification for the user.

Specified by:

getSymbols in interface IClassifiedLegend

Returns:

DOCUMENT ME!

getValues

public java.lang.Object[] getValues()

Description copied from interface: IClassifiedLegend

Obtains the values in relation with each class of the classification

Specified by:

getValues in interface IClassifiedLegend

Returns:

DOCUMENT ME!

cloneLegend

public ILegend cloneLegend()

Description copied from interface: ILegend

Clones the legend.

Specified by:

cloneLegend in interface ILegend

Returns:

Cloned legend.

getDefaultSymbol

public ISymbol getDefaultSymbol()

Description copied from interface: ILegend

Obtains the default symbol of the legend.

Specified by:

getDefaultSymbol in interface ILegend

Returns:

default symbol.

getSLDString

public java.lang.String getSLDString(java.lang.String layerName)

getClassName

public java.lang.String getClassName()

addLegendListener

public void addLegendListener(LegendContentsChangedListener listener)

Description copied from interface: ILegend

Adds a new listener to the legend.

Specified by:

addLegendListener in interface ILegend

Parameters:

listener - to be added

fireDefaultSymbolChangedEvent

public void fireDefaultSymbolChangedEvent(SymbolLegendEvent event)

Description copied from interface: ILegend

Executed when the default symbol of a legend is changed.

Specified by:

fireDefaultSymbolChangedEvent in interface ILegend

getListeners

public LegendContentsChangedListener[] getListeners()

Description copied from interface: ILegend

Obtains the listeners of a legend.

Specified by:

getListeners in interface ILegend

Returns:

LegendListener[] array composed by the listeners of a legend.

removeLegendListener

public void removeLegendListener(LegendContentsChangedListener listener)

Description copied from interface: ILegend

Removes a listener from the legend.

Specified by:

removeLegendListener in interface ILegend

Parameters:

listener - to be removed

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

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

registerPersistence

public static void registerPersistence()