org.jowidgets.tools.command

Class CommandAction

java.lang.Object

org.jowidgets.tools.command.CommandAction

All Implemented Interfaces:

IAction, ICommandAction

public class CommandAction
extends java.lang.Object
implements ICommandAction

Constructor Summary

Constructors

Constructor and Description
CommandAction()
CommandAction(IActionBuilder builder)
CommandAction(java.lang.String text)
CommandAction(java.lang.String text, IImageConstant icon)
CommandAction(java.lang.String text, java.lang.String toolTipText)
CommandAction(java.lang.String text, java.lang.String toolTipText, IImageConstant icon)

Method Summary

Methods

Modifier and Type	Method and Description
static IActionBuilder	builder()
static IActionBuilder	builder(java.lang.String text)
static IActionBuilder	builder(java.lang.String text, IImageConstant icon)
static IActionBuilder	builder(java.lang.String text, java.lang.String toolTipText)
static IActionBuilder	builder(java.lang.String text, java.lang.String toolTipText, IImageConstant icon)
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.
ICommand	getCommand() Gets the command
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.
void	setActionExceptionHandler(IExceptionHandler exceptionHandler) Set's the ExceptionHandler of the action.
void	setCommand(ICommand command) Sets the actions command
void	setCommand(ICommandExecutor command) Sets the actions command defined by a command executor The command that will be set has no enabled checker and no exception handler
void	setCommand(ICommandExecutor command, IEnabledChecker enabledChecker) Sets the actions command defined by a command executor and enabled checker The command that will be set has no exception handler
void	setCommand(ICommandExecutor command, IEnabledChecker enabledChecker, IExceptionHandler exceptionHandler) Sets the actions command defined by a command executor, enabled checker and exception handler
void	setCommand(ICommandExecutor command, IExceptionHandler exceptionHandler) Sets the actions command defined by a command executor and exception handler The command that will be set has no enabled checker
void	setEnabled(boolean enabled) Sets the enabled state of the action
void	setIcon(IImageConstant icon) Sets the actions icon
void	setText(java.lang.String text) Sets the actions label text
void	setToolTipText(java.lang.String toolTipText) Sets the actions tooltip text

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandAction

public CommandAction()

CommandAction

public CommandAction(java.lang.String text)

CommandAction

public CommandAction(java.lang.String text,
             IImageConstant icon)

CommandAction

public CommandAction(java.lang.String text,
             java.lang.String toolTipText)

CommandAction

public CommandAction(java.lang.String text,
             java.lang.String toolTipText,
             IImageConstant icon)

CommandAction

public CommandAction(IActionBuilder builder)

Method Detail

setText

public final void setText(java.lang.String text)

Description copied from interface: ICommandAction

Sets the actions label text

Specified by:

setText in interface ICommandAction

Parameters:

text - The text to set

getText

public final 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

setToolTipText

public final void setToolTipText(java.lang.String toolTipText)

Description copied from interface: ICommandAction

Sets the actions tooltip text

Specified by:

setToolTipText in interface ICommandAction

Parameters:

toolTipText - The text to set

getToolTipText

public final 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 final IImageConstant getIcon()

Description copied from interface: IAction

Gets the action icon

Specified by:

getIcon in interface IAction

Returns:

The actions icon, may be null

setIcon

public final void setIcon(IImageConstant icon)

Description copied from interface: ICommandAction

Sets the actions icon

Specified by:

setIcon in interface ICommandAction

Parameters:

icon - The icon to set

getMnemonic

public final 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

setEnabled

public final void setEnabled(boolean enabled)

Description copied from interface: ICommandAction

Sets the enabled state of the action

Specified by:

setEnabled in interface ICommandAction

Parameters:

enabled - The enabled state to set

getAccelerator

public final Accelerator getAccelerator()

Description copied from interface: IAction

Gets the actions accelerator

Specified by:

getAccelerator in interface IAction

Returns:

The accelerator, may be null

setCommand

public final void setCommand(ICommand command)

Description copied from interface: ICommandAction

Sets the actions command

Specified by:

setCommand in interface ICommandAction

Parameters:

command - The command to set, may be null if the action should not have a command

getCommand

public ICommand getCommand()

Description copied from interface: ICommandAction

Gets the command

Specified by:

getCommand in interface ICommandAction

Returns:

The command, may be null if no command is set

isEnabled

public final 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 final 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

setCommand

public final void setCommand(ICommandExecutor command)

Description copied from interface: ICommandAction

Sets the actions command defined by a command executor The command that will be set has no enabled checker and no exception handler

Specified by:

setCommand in interface ICommandAction

setCommand

public final void setCommand(ICommandExecutor command,
              IEnabledChecker enabledChecker)

Description copied from interface: ICommandAction

Sets the actions command defined by a command executor and enabled checker The command that will be set has no exception handler

Specified by:

setCommand in interface ICommandAction

enabledChecker - The enabled checker of the command to set

getExceptionHandler

public final 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

setCommand

public final void setCommand(ICommandExecutor command,
              IExceptionHandler exceptionHandler)

Description copied from interface: ICommandAction

Sets the actions command defined by a command executor and exception handler The command that will be set has no enabled checker

Specified by:

setCommand in interface ICommandAction

exceptionHandler - The exception handler of the command to set

setCommand

public final void setCommand(ICommandExecutor command,
              IEnabledChecker enabledChecker,
              IExceptionHandler exceptionHandler)

Description copied from interface: ICommandAction

Sets the actions command defined by a command executor, enabled checker and exception handler

Specified by:

setCommand in interface ICommandAction

enabledChecker - The enabled checker of the command to set

exceptionHandler - The exception handler of the command to set

setActionExceptionHandler

public final void setActionExceptionHandler(IExceptionHandler exceptionHandler)

Description copied from interface: ICommandAction

Set's the ExceptionHandler of the action. The actions ExceptionHandler handles exceptions that are not handled by the command's exception handler. The actions ExceptionHandler should be implemented independently of the current command. If exception handling is command specific, the commands exception handler should be used for that. If no exception handler is set, a default handler will be used for the action.

Specified by:

setActionExceptionHandler in interface ICommandAction

Parameters:

exceptionHandler - The ExceptionHandler to set

getActionChangeObservable

public final 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

builder

public static IActionBuilder builder()

builder

public static IActionBuilder builder(java.lang.String text)

builder

public static IActionBuilder builder(java.lang.String text,
                     IImageConstant icon)

builder

public static IActionBuilder builder(java.lang.String text,
                     java.lang.String toolTipText)

builder

public static IActionBuilder builder(java.lang.String text,
                     java.lang.String toolTipText,
                     IImageConstant icon)