Package com.luciad.lucy.gui

Class ALcyActiveSettable

java.lang.Object

com.luciad.lucy.gui.ALcyActiveSettable

All Implemented Interfaces:

ILcyActiveSettable, ILcdPropertyChangeSource, Serializable

Direct Known Subclasses:

TLcyFullScreenActiveSettable, TLcyGXYSetControllerActiveSettable, TLcyLspProjectionActiveSettable, TLcyLspSetControllerActiveSettable, TLcyMain

public abstract class ALcyActiveSettable
extends Object
implements ILcyActiveSettable

Default implementation of ILcyActiveSettable for convenience.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.luciad.lucy.gui.ILcyActiveSettable

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

Constructor Summary

Constructors

Constructor	Description
ALcyActiveSettable()	Creates a new ALcyActiveSettable.
ALcyActiveSettable(String aName)	Creates a new ALcyActiveSettable with the given name.
ALcyActiveSettable(String aName, ILcdIcon aIcon)	Creates a new ALcyActiveSettable with the given name and the given icon.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)	Registers the given PropertyChangeListener to be notified when this object's properties change.
void	firePropertyChange(String aPropertyName, Object aOldValue, Object aNewValue)
String	getDisplayName()	Deprecated. use getName() instead, which is already a display name.
ILcdIcon	getIcon()	Returns the icon of this active settable.
String	getLongDescription()	Returns the long description of this active settable.
String	getName()	Returns the name of this active settable.
String	getShortDescription()	Returns the short description of this active settable.
Object	getValue(String aKey)	Gets a value given its key.
boolean	isEnabled()	Returns true if this object is enabled, false otherwise.
void	putValue(String aKey, Object aValue)	Associates a given value with a given key.
void	removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)	De-registers the given PropertyChangeListener from receiving property change events for this object.
void	setDisplayName(String aDisplayName)	Deprecated. use setName(java.lang.String) instead, which is already a display name.
void	setEnabled(boolean aEnabled)	Sets the enabled state of this active settable.
void	setIcon(ILcdIcon aIcon)	Sets the icon of this active settable.
void	setLongDescription(String aLongDescription)	Sets the long description of this active settable.
void	setName(String aName)	Sets the name of this active settable.
void	setShortDescription(String aShortDescription)	Sets the short description of this active settable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.lucy.gui.ILcyActiveSettable

isActive, setActive

Constructor Details

ALcyActiveSettable

public ALcyActiveSettable()

Creates a new ALcyActiveSettable.

ALcyActiveSettable

public ALcyActiveSettable(String aName)

Creates a new ALcyActiveSettable with the given name.

Parameters:

aName - The name of this active settable.

ALcyActiveSettable

public ALcyActiveSettable(String aName,
 ILcdIcon aIcon)

Creates a new ALcyActiveSettable with the given name and the given icon.

Parameters:

aName - The name of this active settable.

aIcon - The icon of this active settable.

Method Details

getDisplayName

@Deprecated
public String getDisplayName()

Deprecated.

use getName() instead, which is already a display name.

Returns the display name of this active settable.

Returns:

the display name of this active settable.

See Also:

• setDisplayName(java.lang.String)

setDisplayName

@Deprecated
public void setDisplayName(String aDisplayName)

Deprecated.

use setName(java.lang.String) instead, which is already a display name.

Sets the display name of this active settable.

Parameters:

aDisplayName - The display name.

See Also:

• getDisplayName()

getName

public String getName()

Returns the name of this active settable.

Returns:

the name of this active settable.

See Also:

• setName(java.lang.String)

setName

public void setName(String aName)

Sets the name of this active settable.

Parameters:

aName - The name.

See Also:

• getName()

getIcon

public ILcdIcon getIcon()

Returns the icon of this active settable.

Returns:

the icon of this active settable.

See Also:

• setIcon(com.luciad.gui.ILcdIcon)

setIcon

public void setIcon(ILcdIcon aIcon)

Sets the icon of this active settable.

Parameters:

aIcon - The icon.

See Also:

• getIcon()

getShortDescription

public String getShortDescription()

Returns the short description of this active settable.

Returns:

the short description of this active settable.

See Also:

• setShortDescription(java.lang.String)

setShortDescription

public void setShortDescription(String aShortDescription)

Sets the short description of this active settable.

Parameters:

aShortDescription - The short description.

See Also:

• getShortDescription()

getLongDescription

public String getLongDescription()

Returns the long description of this active settable.

Returns:

the long description of this active settable.

See Also:

• setLongDescription(java.lang.String)

setLongDescription

public void setLongDescription(String aLongDescription)

Sets the long description of this active settable.

Parameters:

aLongDescription - The long description.

See Also:

• getLongDescription()

getValue

public Object getValue(String aKey)

Description copied from interface: ILcyActiveSettable

Gets a value given its key.

Specified by:

getValue in interface ILcyActiveSettable

Parameters:

aKey - The key to retrieve the value for.

Returns:

The value associated with the given key, or null if they key is unknown.

See Also:

• ILcyActiveSettable.putValue(java.lang.String, java.lang.Object)

putValue

public void putValue(String aKey,
 Object aValue)

Description copied from interface: ILcyActiveSettable

Associates a given value with a given key.

Specified by:

putValue in interface ILcyActiveSettable

Parameters:

aKey - The key.

aValue - The value to associate to the key.

See Also:

• ILcyActiveSettable.getValue(java.lang.String)

setEnabled

public void setEnabled(boolean aEnabled)

Description copied from interface: ILcyActiveSettable

Sets the enabled state of this active settable.

Specified by:

setEnabled in interface ILcyActiveSettable

Parameters:

aEnabled - True if the new state of this object is enabled, false otherwise.

See Also:

• ILcyActiveSettable.isEnabled()

isEnabled

public boolean isEnabled()

Description copied from interface: ILcyActiveSettable

Returns true if this object is enabled, false otherwise.

Specified by:

isEnabled in interface ILcyActiveSettable

Returns:

true if this object is enabled, false otherwise.

See Also:

• ILcyActiveSettable.setEnabled(boolean)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

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:

aPropertyChangeListener - The listener to be notified

See Also:

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

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

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:

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

See Also:

• ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

firePropertyChange

public void firePropertyChange(String aPropertyName,
 Object aOldValue,
 Object aNewValue)