com.luciad.lucy.addons.drawing.format

LuciadLightspeedClass ALcyDrawingSettings<S extends ILcdView & ILcdTreeLayered,T extends ILcdLayer>

java.lang.Object

com.luciad.lucy.addons.drawing.format.ALcyDrawingSettings<S,T>

All Implemented Interfaces:

ILcdPropertyChangeSource

Direct Known Subclasses:

TLcyDrawingSettings, TLcyLspDrawingSettings

public abstract class ALcyDrawingSettings<S extends ILcdView & ILcdTreeLayered,T extends ILcdLayer>
extends Object
implements ILcdPropertyChangeSource

This class provides access to the drawing settings of a drawing layer.

PropertyChangeListener instances can be registered to this class which will be notified when the current drawing layer changes.

Typically an instance of this class is retrieved by using the corresponding getter on the drawing add-on (see TLcyDrawingAddOn#getDrawingSettingsForMap and TLcyLspDrawingAddOn#getDrawingSettingsForMap).

Since:

2012.1

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ALcyDrawingSettings(ILcyLucyEnv aLucyEnv) Creates drawing settings based on the lucy environment.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener aListener) Registers the given PropertyChangeListener to be notified when this object's properties change.
void	addPropertyChangeListener(String aProperty, PropertyChangeListener aListener) Adds the given listener to the list of listeners, so that it will receive notifications about changes in aProperty.
protected void	firePropertyChange(String aProperty, Object aOldValue, Object aNewValue) Fires the given event to the associated listeners.
T	getDrawingLayer() Returns the current active drawing layer.
ILcyLucyEnv	getLucyEnv() Returns the Lucy environment
void	removePropertyChangeListener(PropertyChangeListener aListener) De-registers the given PropertyChangeListener from receiving property change events for this object.
void	removePropertyChangeListener(String aProperty, PropertyChangeListener aListener) Removes the given listener for the given property, so that it no longer receives those change events.
void	setDrawingLayer(T aDrawingLayer) Sets the active drawing layer

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcyDrawingSettings

protected ALcyDrawingSettings(ILcyLucyEnv aLucyEnv)

Creates drawing settings based on the lucy environment.

Note: typically you should not create any instances of this class yourself. Retrieve them from the drawing add-ons instead.

Parameters:

aLucyEnv - the Lucy environment

See Also:

TLcyDrawingAddOn.getDrawingSettingsForMap(com.luciad.view.ILcdView), TLcyLspDrawingAddOn.getDrawingSettingsForMap(com.luciad.view.ILcdView)

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener aListener)

Description copied from interface: ILcdPropertyChangeSource

Registers the given PropertyChangeListener to be notified when this object's properties change.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakPropertyChangeListener instance as property change listener.

Specified by:

addPropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aListener - The listener to be notified

See Also:

ALcdWeakPropertyChangeListener, ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(String aProperty,
                                      PropertyChangeListener aListener)

Adds the given listener to the list of listeners, so that it will receive notifications about changes in aProperty.

Parameters:

aProperty - The property to watch for changes.

aListener - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener aListener)

Description copied from interface: ILcdPropertyChangeSource

De-registers the given PropertyChangeListener from receiving property change events for this object.

If the listener was added more than once, it will be notified one less time after being removed. If the listener is null, or was never added, no exception is thrown and no action is taken.

Specified by:

removePropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aListener - the listener that should no longer be notified of changes of this object's properties

See Also:

ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(String aProperty,
                                         PropertyChangeListener aListener)

Removes the given listener for the given property, so that it no longer receives those change events.

Parameters:

aProperty - The property to stop listening to.

aListener - The listener to remove.

firePropertyChange

protected void firePropertyChange(String aProperty,
                                  Object aOldValue,
                                  Object aNewValue)

Fires the given event to the associated listeners.

Parameters:

aProperty - The property that was changed.

aOldValue - The old value.

aNewValue - The new value.

getLucyEnv

public ILcyLucyEnv getLucyEnv()

Returns the Lucy environment

Returns:

the Lucy environment

getDrawingLayer

public T getDrawingLayer()

Returns the current active drawing layer.

Returns:

the current active drawing layer. Can be null when for example no drawing layers are available.

setDrawingLayer

public void setDrawingLayer(T aDrawingLayer)

Sets the active drawing layer

Parameters:

aDrawingLayer - the new active drawing layer. May be null when no drawing layer is active.