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

Class AbstractLegend

java.lang.Object

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

All Implemented Interfaces:

java.lang.Cloneable, ILegend, Legend, Persistent

Direct Known Subclasses:

AbstractVectorialLegend

public abstract class AbstractLegend
extends java.lang.Object
implements ILegend

Abstract class that implements the interface for legends.It is considered as the father of all XXXLegends and will implement all the methods that these classes had not developed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractLegend.RegisterPersistence

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractLegend()

Method Summary

Modifier and Type	Method and Description
void	addDrawingObserver(Observer observer)
void	addLegendListener(LegendContentsChangedListener listener) Adds a new listener to the legend.
void	addObserver(java.lang.ref.Reference<Observer> ref)
void	beginComplexNotification()
java.lang.Object	clone() Creates a copy of the object.
ILegend	cloneLegend() Clones the legend.
int	countObservers()
void	deleteDrawingObserver(Observer observer)
void	deleteDrawingObservers()
void	deleteObserver(java.lang.ref.Reference<Observer> ref)
void	disableNotifications()
void	enableNotifications()
void	endComplexNotification()
void	fireDefaultSymbolChangedEvent(SymbolLegendEvent event) Executed when the default symbol of a legend is changed.
LegendContentsChangedListener[]	getListeners() Obtains the listeners of a legend.
MapContextManager	getManager()
SymbolManager	getSymbolManager()
boolean	inComplex()
boolean	isEnabledNotifications()
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	notifyObservers()
void	notifyObservers(java.lang.Object arg)
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.fmap.mapcontext.rendering.legend.ILegend

getDefaultSymbol

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

cloneQuietly, cloneQuietly

Field Detail

LEGEND_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractLegend

public AbstractLegend()

Method Detail

getManager

public MapContextManager getManager()

getSymbolManager

public SymbolManager getSymbolManager()

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

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

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.

addDrawingObserver

public void addDrawingObserver(Observer observer)

deleteDrawingObserver

public void deleteDrawingObserver(Observer observer)

deleteDrawingObservers

public void deleteDrawingObservers()

addObserver

public void addObserver(java.lang.ref.Reference<Observer> ref)

beginComplexNotification

public void beginComplexNotification()

countObservers

public int countObservers()

deleteObserver

public void deleteObserver(java.lang.ref.Reference<Observer> ref)

disableNotifications

public void disableNotifications()

enableNotifications

public void enableNotifications()

endComplexNotification

public void endComplexNotification()

inComplex

public boolean inComplex()

isEnabledNotifications

public boolean isEnabledNotifications()

notifyObservers

public void notifyObservers()

notifyObservers

public void notifyObservers(java.lang.Object arg)

cloneLegend

public ILegend cloneLegend()

Description copied from interface: ILegend

Clones the legend.

Specified by:

cloneLegend in interface ILegend

Returns:

Cloned legend.

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