com.luciad.view.gxy

LuciadLightspeedClass TLcdGXYSetControllerAction

java.lang.Object

com.luciad.gui.ALcdAction

com.luciad.view.gxy.TLcdGXYSetControllerAction

All Implemented Interfaces:

ILcdAction, ILcdPropertyChangeSource, ActionListener, Serializable, EventListener

public class TLcdGXYSetControllerAction
extends ALcdAction
implements ILcdAction

When triggered (actionPerformed), this ILcdAction sets a given ILcdGXYController on a given ILcdGXYView.

The action automatically updates the ILcdAction.SELECTED_KEY value based on whether the controller is active or not.

See Also:

ILcdGXYController, ILcdGXYView.setGXYController(com.luciad.view.gxy.ILcdGXYController), setGXYController(ILcdGXYController), Serialized Form

Field Summary

Fields inherited from class com.luciad.gui.ALcdAction

changeSupport

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

Constructor and Description
TLcdGXYSetControllerAction() Creates a new controller set action with a default name.
TLcdGXYSetControllerAction(boolean aRegisterInstance) Deprecated. use the constructor without parameters.
TLcdGXYSetControllerAction(ILcdGXYController aGXYController) Creates a new controller set action with the given controller.
TLcdGXYSetControllerAction(ILcdGXYController aGXYController, boolean aRegisterInstance) Deprecated. use TLcdGXYSetControllerAction(ILcdGXYController aGXYController) instead.
TLcdGXYSetControllerAction(ILcdGXYController aGXYController, String aName, ILcdIcon aIcon) Creates a new controller set action with the given controller, name, and icon.
TLcdGXYSetControllerAction(ILcdGXYView aGXYView, ILcdGXYController aGXYController) Creates a new controller set action with the given controller and view.
TLcdGXYSetControllerAction(ILcdGXYView aGXYView, ILcdGXYController aGXYController, boolean aRegisterInstance) Deprecated. use TLcdGXYSetControllerAction(ILcdGXYView aGXYView, ILcdGXYController aGXYController) instead.
TLcdGXYSetControllerAction(ILcdGXYView aGXYView, ILcdGXYController aGXYController, String aName, ILcdIcon aIcon) Creates a new controller set action with the given controller, view, name, and icon.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
ILcdGXYController	getGXYController() Returns the controller configured for this action.
ILcdGXYView	getGXYView() Returns the view on which to activate the configured controller.
boolean	isTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setGXYController(ILcdGXYController aGXYController) Sets the controller that this action should activate on the view.
void	setGXYView(ILcdGXYView aGXYView) Sets the view on which to activate the configured controller.
void	setTraceOn(boolean aTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Methods inherited from class com.luciad.gui.ALcdAction

addPropertyChangeListener, firePropertyChange, getDisplayName, getIcon, getLongDescription, getName, getShortDescription, getValue, isEnabled, putValue, registerInstance, removePropertyChangeListener, setClassTraceOn, setDisplayName, setEnabled, setIcon, setLongDescription, setName, setShortDescription

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.gui.ILcdAction

getValue, isEnabled, putValue, setEnabled

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction()

Creates a new controller set action with a default name. After construction, a view and controller need to be set for this action to work.

See Also:

setGXYController(ILcdGXYController), setGXYView(ILcdGXYView)

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction(ILcdGXYController aGXYController)

Creates a new controller set action with the given controller. After construction, a view needs to be set for this action to work.

Parameters:

aGXYController - the controller to activate. Determines the name, short description and icon of this action.

See Also:

setGXYView(ILcdGXYView)

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction(ILcdGXYView aGXYView,
                                  ILcdGXYController aGXYController)

Creates a new controller set action with the given controller and view.

Parameters:

aGXYController - the controller to activate. Determines the name, short description and icon of this action.

aGXYView - the view for which to activate the controller

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction(ILcdGXYController aGXYController,
                                  String aName,
                                  ILcdIcon aIcon)

Creates a new controller set action with the given controller, name, and icon. After construction, a view needs to be set for this action to work.

Parameters:

aGXYController - the controller to activate. Determines the short description of this action. of this action.

aName - the name of this action

aIcon - the icon of this action

See Also:

setGXYView(ILcdGXYView)

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction(ILcdGXYView aGXYView,
                                  ILcdGXYController aGXYController,
                                  String aName,
                                  ILcdIcon aIcon)

Creates a new controller set action with the given controller, view, name, and icon.

Parameters:

aGXYView - the view to activate the controller on.

aGXYController - the controller to activate. Determines the short description of this action.

aName - the name of this action

aIcon - the icon of this action

See Also:

setGXYView(ILcdGXYView)

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction(boolean aRegisterInstance)

Deprecated. use the constructor without parameters.

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction(ILcdGXYView aGXYView,
                                  ILcdGXYController aGXYController,
                                  boolean aRegisterInstance)

Deprecated. use TLcdGXYSetControllerAction(ILcdGXYView aGXYView, ILcdGXYController aGXYController) instead.

TLcdGXYSetControllerAction

public TLcdGXYSetControllerAction(ILcdGXYController aGXYController,
                                  boolean aRegisterInstance)

Deprecated. use TLcdGXYSetControllerAction(ILcdGXYController aGXYController) instead.

Method Detail

setTraceOn

public void setTraceOn(boolean aTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.

Overrides:

setTraceOn in class ALcdAction

Parameters:

aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

isTraceOn

public boolean isTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Overrides:

isTraceOn in class ALcdAction

Returns:

true if tracing is enabled for this class, false otherwise.

getGXYView

public ILcdGXYView getGXYView()

Returns the view on which to activate the configured controller.

Returns:

the view on which to activate the configured controller

setGXYView

public void setGXYView(ILcdGXYView aGXYView)

Sets the view on which to activate the configured controller.

Parameters:

aGXYView - the view on which to activate the configured controller

setGXYController

public void setGXYController(ILcdGXYController aGXYController)

Sets the controller that this action should activate on the view. This action will take over the controller's name, icon and short description.

Parameters:

aGXYController - the controller that this action should activate on the view.

See Also:

getGXYController()

getGXYController

public ILcdGXYController getGXYController()

Returns the controller configured for this action.

Returns:

the controller configured for this action

See Also:

setGXYController(ILcdGXYController)

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener