com.luciad.gui

LuciadLightspeedClass ALcdActionWrapper

java.lang.Object

com.luciad.gui.ALcdActionWrapper

All Implemented Interfaces:

ILcdAction, ILcdPropertyChangeSource, ActionListener, Serializable, EventListener

public abstract class ALcdActionWrapper
extends Object
implements ILcdAction

Abstract decorator class for an ILcdAction.

A typical use-case of this class if you want to add some extra behavior to an existing action. This can be achieved by using this decorator and override the actionPerformed method to include the extra behavior.

Since:

2012.1

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.luciad.gui.ILcdAction

DEFAULT, LONG_DESCRIPTION, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SHOW_ACTION_NAME, SMALL_ICON, VISIBLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ALcdActionWrapper(ILcdAction aDelegateAction)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	addPropertyChangeListener(PropertyChangeListener listener) Registers the given PropertyChangeListener to be notified when this object's properties change.
Object	getValue(String key) Returns one of this object's properties using the associated key.
boolean	isEnabled()
void	putValue(String key, Object value) Sets one of this objects properties.
void	removePropertyChangeListener(PropertyChangeListener listener) De-registers the given PropertyChangeListener from receiving property change events for this object.
void	setEnabled(boolean b) Sets/tests the enabled state of the ILcdAction.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcdActionWrapper

protected ALcdActionWrapper(ILcdAction aDelegateAction)

Method Detail

getValue

public Object getValue(String key)

Description copied from interface: ILcdAction

Returns one of this object's properties using the associated key. If the value has changed, a PropertyChangeEvent will be sent to listeners.

Specified by:

getValue in interface ILcdAction

putValue

public void putValue(String key,
                     Object value)

Description copied from interface: ILcdAction

Sets one of this objects properties.

Specified by:

putValue in interface ILcdAction

Parameters:

key - one of NAME, SHORT_DESCRIPTION, LONG_DESCRIPTION, SMALL_ICON.

value - the value to be used for this action to display it textually using the name, short description or long description or to display it graphically using the icon. Values for NAME, SHORT_DESCRIPTION and LONG_DESCRIPTION should be String objects, values for SMALL_ICON should be ILcdIcon implementations.

setEnabled

public void setEnabled(boolean b)

Description copied from interface: ILcdAction

Sets/tests the enabled state of the ILcdAction. When enabled, any component associated with this object is active and able to fire this object's actionPerformed method.

Specified by:

setEnabled in interface ILcdAction

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface ILcdAction

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

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:

listener - The listener to be notified

See Also:

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

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

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:

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

See Also:

ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener