org.jowidgets.tools.command

Class ActionWrapper

java.lang.Object

org.jowidgets.tools.command.ActionWrapper

All Implemented Interfaces:

IAction, IWrapper<IAction>

public class ActionWrapper
extends java.lang.Object
implements IAction, IWrapper<IAction>

Constructor Summary

Constructors

Constructor and Description
ActionWrapper(IAction action)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(IExecutionContext actionEvent) Executes the action
Accelerator	getAccelerator() Gets the actions accelerator
IActionChangeObservable	getActionChangeObservable() For mutable actions, an observable can be implemented to recognize changes on this action.
IExceptionHandler	getExceptionHandler() Gets the ExceptionHandler of this action.
IImageConstant	getIcon() Gets the action icon
java.lang.Character	getMnemonic() Gets the action mnemonic
java.lang.String	getText() Gets the action label text
java.lang.String	getToolTipText() Gets the actions tooltip text
boolean	isEnabled() Gets the enabled state of the action.
IAction	unwrap()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionWrapper

public ActionWrapper(IAction action)

Method Detail

getText

public java.lang.String getText()

Description copied from interface: IAction

Gets the action label text

Specified by:

getText in interface IAction

Returns:

The actions label text, may be null or empty

getToolTipText

public java.lang.String getToolTipText()

Description copied from interface: IAction

Gets the actions tooltip text

Specified by:

getToolTipText in interface IAction

Returns:

The actions tooltip text, may be null or empty

getIcon

public IImageConstant getIcon()

Description copied from interface: IAction

Gets the action icon

Specified by:

getIcon in interface IAction

Returns:

The actions icon, may be null

getMnemonic

public java.lang.Character getMnemonic()

Description copied from interface: IAction

Gets the action mnemonic

Specified by:

getMnemonic in interface IAction

Returns:

The mnemonic key, may be null

getAccelerator

public Accelerator getAccelerator()

Description copied from interface: IAction

Gets the actions accelerator

Specified by:

getAccelerator in interface IAction

Returns:

The accelerator, may be null

isEnabled

public boolean isEnabled()

Description copied from interface: IAction

Gets the enabled state of the action. A action that is not enabled can not be executed

Specified by:

isEnabled in interface IAction

Returns:

True if the action is enabled, false otherwise

execute

public void execute(IExecutionContext actionEvent)
             throws java.lang.Exception

Description copied from interface: IAction

Executes the action

Specified by:

execute in interface IAction

Parameters:

actionEvent - The execution context

Throws:

java.lang.Exception

getExceptionHandler

public IExceptionHandler getExceptionHandler()

Description copied from interface: IAction

Gets the ExceptionHandler of this action. If no ExceptionHandler is defined, a default exception handler will be used.

Specified by:

getExceptionHandler in interface IAction

Returns:

exceptionHandler The exception handler or null, if no handler is defined

getActionChangeObservable

public IActionChangeObservable getActionChangeObservable()

Description copied from interface: IAction

For mutable actions, an observable can be implemented to recognize changes on this action. The following properties can be mutable: text, toolTipText, icon, enabled

Specified by:

getActionChangeObservable in interface IAction

Returns:

The observable if the action is mutable or null if the action is immutable

unwrap

public IAction unwrap()

Specified by:

unwrap in interface IWrapper<IAction>

Returns:

The unwrapped (original) instance