com.luciad.lucy.map.action.lightspeed

LuciadLightspeedClass TLcyLspSetControllerActiveSettable

java.lang.Object

com.luciad.lucy.gui.ALcyActiveSettable

com.luciad.lucy.map.action.lightspeed.TLcyLspSetControllerActiveSettable

All Implemented Interfaces:

ILcyActiveSettable, ILcdPropertyChangeSource, Serializable

Direct Known Subclasses:

TLcyLspCreateControllerActiveSettable

public class TLcyLspSetControllerActiveSettable
extends ALcyActiveSettable

An active settable implementation which allows to activate a controller on a Lightspeed view. When calling setActive(true), the active settable will install the controller on the Lightspeed view. The active settable will de-activate itself when another controller is placed on the view.

Note: this active settable does nothing when calling setActive(false). To de-activate it, you need to install another controller on the view. This means that typically you use multiple instances of this class, allowing the user of your application to switch between different controllers.
To ensure that this is reflected in the UI, you need to indicate that de-activation of this active settable is not possible when inserting it into the UI. For example by passing false as last argument in TLcyActionBarUtil#insertInConfiguredActionBars, or ILcyActionBar#insertActiveSettable.

Since:

2012.1

See Also:

TLspSetControllerAction, 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 and Description
TLcyLspSetControllerActiveSettable(ILspController aController, ILspView aView, ILcyLucyEnv aLucyEnv) Creates a new active settable that, when active, sets the given controller on the given view.

Method Summary

Modifier and Type	Method and Description
ILspController	getController() Returns the controller of this active settable.
ILcyLucyEnv	getLucyEnv() Returns the current Lucy environment.
Object	getValue(String aKey) Gets a value given its key.
ILspView	getView() Returns the view to set the controller on.
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	setController(ILspController aController) Sets the controller of this active settable.
void	setEnabled(boolean aEnabled) Sets the enabled state of this active settable.
void	setView(ILspView aView) Sets the view to set the controller on.

Methods inherited from class com.luciad.lucy.gui.ALcyActiveSettable

addPropertyChangeListener, firePropertyChange, getDisplayName, getIcon, getLongDescription, getName, getShortDescription, removePropertyChangeListener, setDisplayName, setIcon, setLongDescription, setName, setShortDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyLspSetControllerActiveSettable

public TLcyLspSetControllerActiveSettable(ILspController aController,
                                          ILspView aView,
                                          ILcyLucyEnv aLucyEnv)

Creates a new active settable that, when active, sets the given controller on the given view. The active settable's icon, name and short description will be initialized with those of the controller.

Parameters:

aController - the controller that will be activated on the view. If null is provided, a controller must be set before using this active settable

aView - the view to activate the controller for. If null is provided, a view must be set before using this active settable

aLucyEnv - the Lucy back-end. Must not be null.

Method Detail

getValue

public Object getValue(String aKey)

Description copied from interface: ILcyActiveSettable

Gets a value given its key.

Specified by:

getValue in interface ILcyActiveSettable

Overrides:

getValue in class ALcyActiveSettable

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

Overrides:

putValue in class ALcyActiveSettable

Parameters:

aKey - The key.

aValue - The value to associate to the key.

See Also:

ILcyActiveSettable.getValue(java.lang.String)

isActive

public boolean isActive()

Description copied from interface: ILcyActiveSettable

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 ILcyActiveSettable.setActive(boolean)).

Returns:

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

See Also:

ILcyActiveSettable.setActive(boolean)

setActive

public void setActive(boolean aActive)

Description copied from interface: ILcyActiveSettable

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:

ILcyActiveSettable.isActive()

getController

public ILspController getController()

Returns the controller of this active settable.

Returns:

the controller of this active settable.

setController

public void setController(ILspController aController)

Sets the controller of this active settable.

Parameters:

aController - The controller to work on.

getLucyEnv

public ILcyLucyEnv getLucyEnv()

Returns the current Lucy environment.

Returns:

the current Lucy environment

getView

public ILspView getView()

Returns the view to set the controller on.

Returns:

the view to set the controller on.

setView

public void setView(ILspView aView)

Sets the view to set the controller on.

Parameters:

aView - the view to set the controller on.

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

Overrides:

setEnabled in class ALcyActiveSettable

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

Overrides:

isEnabled in class ALcyActiveSettable

Returns:

true if this object is enabled, false otherwise.

See Also:

ILcyActiveSettable.setEnabled(boolean)