org.gvsig.fmap.mapcontext.rendering.legend

Interface ILegend

All Superinterfaces:

Cloneable, Persistent

All Known Subinterfaces:

IBarsChartLegend, IChartLegend, IClassifiedLegend, IClassifiedRasterLegend, IClassifiedVectorLegend, ILinkedChartLegend, IPieChartLegend, IRasterLegend, ISingleSymbolLegend, IVectorialIntervalLegend, IVectorialUniqueValueLegend, IVectorLegend, VectorComplexLegend

All Known Implementing Classes:

AbstractClassifiedVectorLegend, AbstractIntervalLegend, AbstractLegend, AbstractVectorialLegend, BarsChartLegend, ColorTableLegend, DefaultVectorComplexLegend, ImageLegend, LegendControl, LinkedChartLegend, PieChartLegend, SingleSymbolLegend, VectorialIntervalLegend, VectorialUniqueValueLegend

public interface ILegend
extends Persistent, Cloneable

Information about the legend to be represented in the interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLegendListener(LegendContentsChangedListener listener) Adds a new listener to the legend.
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.
LegendContentsChangedListener[]	getListeners() Obtains the listeners of a legend.
void	removeLegendListener(LegendContentsChangedListener listener) Removes a listener from the legend.

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

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

clone

Method Detail

getDefaultSymbol

ISymbol getDefaultSymbol()

Obtains the default symbol of the legend.

Returns:

default symbol.

cloneLegend

ILegend cloneLegend()

Clones the legend.

Returns:

Cloned legend.

Throws:

XMLException

addLegendListener

void addLegendListener(LegendContentsChangedListener listener)

Adds a new listener to the legend.

Parameters:

listener - to be added

removeLegendListener

void removeLegendListener(LegendContentsChangedListener listener)

Removes a listener from the legend.

Parameters:

listener - to be removed

fireDefaultSymbolChangedEvent

void fireDefaultSymbolChangedEvent(SymbolLegendEvent event)

Executed when the default symbol of a legend is changed.

Parameters:

event -

getListeners

LegendContentsChangedListener[] getListeners()

Obtains the listeners of a legend.

Returns:

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