org.jowidgets.api.command

Interface IAction

All Known Subinterfaces:

ICommandAction, ITreeExpansionAction

All Known Implementing Classes:

ActionWrapper, CommandAction

public interface IAction

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(IExecutionContext executionContext) 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.

Method Detail

getText

java.lang.String getText()

Gets the action label text

Returns:

The actions label text, may be null or empty

getToolTipText

java.lang.String getToolTipText()

Gets the actions tooltip text

Returns:

The actions tooltip text, may be null or empty

getIcon

IImageConstant getIcon()

Gets the action icon

Returns:

The actions icon, may be null

getMnemonic

java.lang.Character getMnemonic()

Gets the action mnemonic

Returns:

The mnemonic key, may be null

getAccelerator

Accelerator getAccelerator()

Gets the actions accelerator

Returns:

The accelerator, may be null

isEnabled

boolean isEnabled()

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

Returns:

True if the action is enabled, false otherwise

execute

void execute(IExecutionContext executionContext)
             throws java.lang.Exception

Executes the action

Parameters:

executionContext - The execution context

Throws:

java.lang.Exception

getExceptionHandler

IExceptionHandler getExceptionHandler()

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

Returns:

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

getActionChangeObservable

IActionChangeObservable getActionChangeObservable()

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

Returns:

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