org.eclipse.emfforms.spi.swt.table.action

Class ActionConfigurationBuilder

java.lang.Object

org.eclipse.emfforms.spi.swt.table.action.ActionConfigurationBuilder

public final class ActionConfigurationBuilder
extends Object

The action configuration builder.

Author:

Mat Hansen

Method Summary

Modifier and Type	Method and Description
ActionConfigurationBuilder	addAction(Action action) Add a new action to this builder.
<Creator extends ActionControlCreator<? extends org.eclipse.swt.widgets.Control>> ActionConfigurationBuilder	addControlFor(Action action, Creator controlCreator) Add a new control creator to an action.
ActionConfigurationBuilder	addKeySequenceFor(Action action, String... sequences) Add a key sequence for a registered action.
ActionConfiguration	build() Return an action configuration based on the current builder state.
static ActionConfigurationBuilder	usingConfiguration(ActionConfiguration configuration) Initialize a new ActionConfigurationBuilder using a an existing ActionConfiguration.
static ActionConfigurationBuilder	usingDefaults() Create an empty builder instance.

Methods inherited from class java.lang.Object

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

Method Detail

usingDefaults

public static ActionConfigurationBuilder usingDefaults()

Create an empty builder instance.

Returns:

an empty ActionConfigurationBuilder

usingConfiguration

public static ActionConfigurationBuilder usingConfiguration(ActionConfiguration configuration)

Initialize a new ActionConfigurationBuilder using a an existing ActionConfiguration.

Parameters:

configuration - the configuration to re-use.

Returns:

a new ActionConfigurationBuilder

addAction

public ActionConfigurationBuilder addAction(Action action)

Add a new action to this builder.

Parameters:

action - the action to add

Returns:

self

addKeySequenceFor

public ActionConfigurationBuilder addKeySequenceFor(Action action,
                                                    String... sequences)

Add a key sequence for a registered action.

Parameters:

action - the action to register a key sequence for

sequences - the key sequences to use

Returns:

self

addControlFor

public <Creator extends ActionControlCreator<? extends org.eclipse.swt.widgets.Control>> ActionConfigurationBuilder addControlFor(Action action,
                                                                                                                                  Creator controlCreator)

Add a new control creator to an action.

Type Parameters:

Creator - a creator

Parameters:

action - the action to register a control creator for.

controlCreator - the creator

Returns:

self

build

public ActionConfiguration build()

Return an action configuration based on the current builder state.

Returns:

an action configuration