org.jowidgets.api.command

Interface IActionBuilder

All Known Implementing Classes:

ActionBuilder

public interface IActionBuilder

Method Summary

Methods

Modifier and Type	Method and Description
ICommandAction	build() Creates a new command action defined by the builder setup
IActionBuilder	setAccelerator(Accelerator accelerator) Sets the actions accelerator
IActionBuilder	setAccelerator(char key, Modifier... modifier) Sets the actions accelerator
IActionBuilder	setAccelerator(VirtualKey virtualKey, Modifier... modifier) Sets the actions accelerator
IActionBuilder	setActionExceptionHandler(IExceptionHandler exceptionHandler) Set's the ExceptionHandler of the action.
IActionBuilder	setCommand(ICommand command) Sets the actions command
IActionBuilder	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
IActionBuilder	setCommand(ICommandExecutor command, IEnabledChecker executableStateChecker) Sets the actions command defined by a command executor and enabled checker The command that will be set has no exception handler
IActionBuilder	setCommand(ICommandExecutor command, IEnabledChecker enabledChecker, IExceptionHandler exceptionHandler) Sets the actions command defined by a command executor, enabled checker and exception handler
IActionBuilder	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
IActionBuilder	setEnabled(boolean enabled) Sets the enabled state of the action
IActionBuilder	setIcon(IImageConstant icon) Sets the actions icon
IActionBuilder	setMnemonic(char mnemonic) Sets the actions mnemonic
IActionBuilder	setMnemonic(java.lang.Character mnemonic) Sets the actions mnemonic
IActionBuilder	setText(java.lang.String text) Sets the actions label text
IActionBuilder	setToolTipText(java.lang.String toolTipText) Sets the actions tooltip text

Method Detail

setText

IActionBuilder setText(java.lang.String text)

Sets the actions label text

Parameters:

text - The text to set

Returns:

This builder

setToolTipText

IActionBuilder setToolTipText(java.lang.String toolTipText)

Sets the actions tooltip text

Parameters:

toolTipText - The text to set

Returns:

This builder

setIcon

IActionBuilder setIcon(IImageConstant icon)

Sets the actions icon

Parameters:

icon - The icon to set

Returns:

This builder

setMnemonic

IActionBuilder setMnemonic(java.lang.Character mnemonic)

Sets the actions mnemonic

Parameters:

mnemonic - The mnemonic to set, may be null

Returns:

This builder

setMnemonic

IActionBuilder setMnemonic(char mnemonic)

Sets the actions mnemonic

Parameters:

mnemonic - The mnemonic to set

Returns:

This builder

setAccelerator

IActionBuilder setAccelerator(Accelerator accelerator)

Sets the actions accelerator

Parameters:

mnemonic - The accelerator to set

Returns:

This builder

setAccelerator

IActionBuilder setAccelerator(char key,
                            Modifier... modifier)

Sets the actions accelerator

Parameters:

key - The accelerator key

modifier - The accelerator modifier

Returns:

This builder

setAccelerator

IActionBuilder setAccelerator(VirtualKey virtualKey,
                            Modifier... modifier)

Sets the actions accelerator

Parameters:

virtualKey - The accelerator key

modifier - The accelerator modifier

Returns:

This builder

setEnabled

IActionBuilder setEnabled(boolean enabled)

Sets the enabled state of the action

Parameters:

enabled - The enabled state to set

Returns:

This builder

setCommand

IActionBuilder setCommand(ICommand command)

Sets the actions command

Parameters:

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

Returns:

This builder

setCommand

IActionBuilder 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

Parameters:

command - The executor of the command to set

Returns:

This builder

setCommand

IActionBuilder setCommand(ICommandExecutor command,
                        IEnabledChecker executableStateChecker)

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

Parameters:

command - The executor of the command to set

enabledChecker - The enabled checker of the command to set

Returns:

This builder

setCommand

IActionBuilder 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

Parameters:

command - The executor of the command to set

exceptionHandler - The exception handler of the command to set

Returns:

This builder

setCommand

IActionBuilder setCommand(ICommandExecutor command,
                        IEnabledChecker enabledChecker,
                        IExceptionHandler exceptionHandler)

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

Parameters:

command - The executor of the command to set

enabledChecker - The enabled checker of the command to set

exceptionHandler - The exception handler of the command to set

Returns:

This builder

setActionExceptionHandler

IActionBuilder setActionExceptionHandler(IExceptionHandler exceptionHandler)

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.

Parameters:

exceptionHandler - The ExceptionHandler to set

Returns:

This builder

build

ICommandAction build()

Creates a new command action defined by the builder setup

Returns:

A new command action, never null