com.luciad.lucy.gui

LuciadLightspeedInterface ILcyActiveSettable

All Superinterfaces:

ILcdPropertyChangeSource, Serializable

All Known Subinterfaces:

ILcyCustomizableRepresentationActiveSettable

All Known Implementing Classes:

ALcyActiveSettable, ALcyGXYNewControllerActiveSettable, TLcyFullScreenActiveSettable, TLcyGXYNewControllerActiveSettable, TLcyGXYSetControllerActiveSettable, TLcyGXYTouchNewControllerActiveSettable, TLcyLspCreateControllerActiveSettable, TLcyLspProjectionActiveSettable, TLcyLspSetControllerActiveSettable, TLcyMain

public interface ILcyActiveSettable
extends Serializable, ILcdPropertyChangeSource

Interface that specifies an object that has a state 'active'. As an example of an item that could have an active state, think of a toggle button. Changing the active state will cause a certain action to be performed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT
static String	LONG_DESCRIPTION
static String	NAME
static String	SHORT_DESCRIPTION
static String	SHOW_ACTION_NAME See ILcdAction.SHOW_ACTION_NAME.
static String	SMALL_ICON
static String	SMALL_SELECTED_ICON Constant key for SmallSelectedIcon property.
static String	VISIBLE

Method Summary

Modifier and Type	Method and Description
Object	getValue(String aKey) Gets a value given its key.
boolean	isActive() Returns true if the state of this object is active, false if the state is inactive.
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	setActive(boolean aActive) Sets the active state of this object.
void	setEnabled(boolean aEnabled) Sets the enabled state of this active settable.

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

Field Detail

DEFAULT

static final String DEFAULT

See Also:

ILcdAction, Constant Field Values

NAME

static final String NAME

See Also:

ILcdAction, Constant Field Values

SHORT_DESCRIPTION

static final String SHORT_DESCRIPTION

See Also:

ILcdAction, Constant Field Values

LONG_DESCRIPTION

static final String LONG_DESCRIPTION

See Also:

ILcdAction, Constant Field Values

SMALL_ICON

static final String SMALL_ICON

See Also:

ILcdAction, Constant Field Values

VISIBLE

static final String VISIBLE

See Also:

ILcdAction, Constant Field Values

SMALL_SELECTED_ICON

static final String SMALL_SELECTED_ICON

Constant key for SmallSelectedIcon property. Its associated value should be of type ILcdIcon.

See Also:

Constant Field Values

SHOW_ACTION_NAME

static final String SHOW_ACTION_NAME

See ILcdAction.SHOW_ACTION_NAME.

See Also:

Constant Field Values

Method Detail

isActive

boolean isActive()

Returns true if the state of this object is active, false if the state is inactive. As for every property: whenever the return value of this method changes, a property change event must be fired (see setActive(boolean)).

Returns:

true if the state of this object is active, false if the state is inactive.

See Also:

setActive(boolean)

setActive

void setActive(boolean aActive)

Sets the active state of this object. When the new state is different from the previous state, a certain action will need to be performed. Also a property change event will be fired in such a case. If no property change event is fired, synchronization between this ILcyActiveSettable and the GUI widget representing it will probably fail (e.g. the checkbox will not change state).

Note: refer to Implementing Bound Property Support Within a Bean for an example about firing a property change.

Parameters:

aActive - True if the new state is active, false if the new state is inactive.

See Also:

isActive()

getValue

Object getValue(String aKey)

Gets a value given its key.

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:

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

putValue

void putValue(String aKey,
              Object aValue)

Associates a given value with a given key.

Parameters:

aKey - The key.

aValue - The value to associate to the key.

See Also:

getValue(java.lang.String)

setEnabled

void setEnabled(boolean aEnabled)

Sets the enabled state of this active settable.

Parameters:

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

See Also:

isEnabled()

isEnabled

boolean isEnabled()

Returns true if this object is enabled, false otherwise.

Returns:

true if this object is enabled, false otherwise.

See Also:

setEnabled(boolean)