org.gvsig.raster.fmap.legend

Class ImageLegend

java.lang.Object

org.gvsig.raster.fmap.legend.ImageLegend

All Implemented Interfaces:

Cloneable, IHasImageLegend, ILegend, IRasterLegend, Legend, Persistent

public class ImageLegend
extends Object
implements IRasterLegend, IHasImageLegend

This object is for rasters which returns its legend as a image

Constructor Summary

Constructors

Constructor and Description
ImageLegend(Image image)

Method Summary

Modifier and Type	Method and Description
void	addLegendListener(LegendContentsChangedListener listener) Adds a new listener to the legend.
Object	clone() Creates a copy of the object.
ILegend	cloneLegend() Clones the legend.
void	fireDefaultSymbolChangedEvent(SymbolLegendEvent event) Executed when the default symbol of a legend is changed.
ISymbol	getDefaultSymbol() Obtains the default symbol of the legend.
Image	getImageLegend()
LegendContentsChangedListener[]	getListeners() Obtains the listeners of a legend.
String	getPathImage()
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
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

Constructor Detail

ImageLegend

public ImageLegend(Image image)

Method Detail

getImageLegend

public Image getImageLegend()

Specified by:

getImageLegend in interface IHasImageLegend

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class Object

Returns:

a copy of the object

Throws:

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

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

cloneLegend

public ILegend cloneLegend()

Description copied from interface: ILegend

Clones the legend.

Specified by:

cloneLegend in interface ILegend

Returns:

Cloned legend.

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

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.

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

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

getPathImage

public String getPathImage()

Specified by:

getPathImage in interface IHasImageLegend