org.jowidgets.tools.command

Class ActionBuilder

java.lang.Object

org.jowidgets.tools.command.ActionBuilder

All Implemented Interfaces:

IActionBuilder

public class ActionBuilder
extends java.lang.Object
implements IActionBuilder

Constructor Summary

Constructors

Constructor and Description
ActionBuilder()
ActionBuilder(IActionBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
ICommandAction	build() Creates a new command action defined by the builder setup
static IActionBuilder	builder()
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

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionBuilder

public ActionBuilder()

ActionBuilder

public ActionBuilder(IActionBuilder builder)

Method Detail

setText

public IActionBuilder setText(java.lang.String text)

Description copied from interface: IActionBuilder

Sets the actions label text

Specified by:

setText in interface IActionBuilder

Parameters:

text - The text to set

Returns:

This builder

setToolTipText

public IActionBuilder setToolTipText(java.lang.String toolTipText)

Description copied from interface: IActionBuilder

Sets the actions tooltip text

Specified by:

setToolTipText in interface IActionBuilder

Parameters:

toolTipText - The text to set

Returns:

This builder

setIcon

public IActionBuilder setIcon(IImageConstant icon)

Description copied from interface: IActionBuilder

Sets the actions icon

Specified by:

setIcon in interface IActionBuilder

Parameters:

icon - The icon to set

Returns:

This builder

setMnemonic

public IActionBuilder setMnemonic(java.lang.Character mnemonic)

Description copied from interface: IActionBuilder

Sets the actions mnemonic

Specified by:

setMnemonic in interface IActionBuilder

Parameters:

mnemonic - The mnemonic to set, may be null

Returns:

This builder

setMnemonic

public IActionBuilder setMnemonic(char mnemonic)

Description copied from interface: IActionBuilder

Sets the actions mnemonic

Specified by:

setMnemonic in interface IActionBuilder

Parameters:

mnemonic - The mnemonic to set

Returns:

This builder

setAccelerator

public IActionBuilder setAccelerator(Accelerator accelerator)

Description copied from interface: IActionBuilder

Sets the actions accelerator

Specified by:

setAccelerator in interface IActionBuilder

Returns:

This builder

setAccelerator

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

Description copied from interface: IActionBuilder

Sets the actions accelerator

Specified by:

setAccelerator in interface IActionBuilder

Parameters:

key - The accelerator key

modifier - The accelerator modifier

Returns:

This builder

setAccelerator

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

Description copied from interface: IActionBuilder

Sets the actions accelerator

Specified by:

setAccelerator in interface IActionBuilder

Parameters:

virtualKey - The accelerator key

modifier - The accelerator modifier

Returns:

This builder

setEnabled

public IActionBuilder setEnabled(boolean enabled)

Description copied from interface: IActionBuilder

Sets the enabled state of the action

Specified by:

setEnabled in interface IActionBuilder

Parameters:

enabled - The enabled state to set

Returns:

This builder

setCommand

public IActionBuilder setCommand(ICommand command)

Description copied from interface: IActionBuilder

Sets the actions command

Specified by:

setCommand in interface IActionBuilder

Parameters:

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

Returns:

This builder

setCommand

public IActionBuilder setCommand(ICommandExecutor command)

Description copied from interface: IActionBuilder

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 IActionBuilder

Parameters:

command - The executor of the command to set

Returns:

This builder

setCommand

public IActionBuilder setCommand(ICommandExecutor command,
                        IEnabledChecker executableStateChecker)

Description copied from interface: IActionBuilder

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 IActionBuilder

Parameters:

command - The executor of the command to set

Returns:

This builder

setCommand

public IActionBuilder setCommand(ICommandExecutor command,
                        IExceptionHandler exceptionHandler)

Description copied from interface: IActionBuilder

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 IActionBuilder

Parameters:

command - The executor of the command to set

exceptionHandler - The exception handler of the command to set

Returns:

This builder

setCommand

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

Description copied from interface: IActionBuilder

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

Specified by:

setCommand in interface IActionBuilder

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

public IActionBuilder setActionExceptionHandler(IExceptionHandler exceptionHandler)

Description copied from interface: IActionBuilder

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 IActionBuilder

Parameters:

exceptionHandler - The ExceptionHandler to set

Returns:

This builder

build

public ICommandAction build()

Description copied from interface: IActionBuilder

Creates a new command action defined by the builder setup

Specified by:

build in interface IActionBuilder

Returns:

A new command action, never null

builder

public static IActionBuilder builder()