Package docking.action.builder

Class MultiActionBuilder NEW

java.lang.Object

docking.action.builder.AbstractActionBuilder<MultiActionDockingAction,ActionContext,MultiActionBuilder>

docking.action.builder.MultiActionBuilder

public class MultiActionBuilder
extends AbstractActionBuilder<MultiActionDockingAction,ActionContext,MultiActionBuilder>

Builder for MultiActionDockingAction

Field Summary

Fields inherited from class docking.action.builder.AbstractActionBuilder

actionCallback, actionContextClass, keyBindingType, name, owner

Constructor Summary

Constructors

Change	Constructor	Description
MultiActionBuilder(java.lang.String name, java.lang.String owner)	Builder constructor

Method Summary

Change	Modifier and Type	Method	Description
	MultiActionDockingAction	build()	Builds the action.
	MultiActionBuilder	performActionOnButtonClick(boolean b)	Configure whether to perform actions on a button click.
	protected MultiActionBuilder	self()	Returns this (typed for subclass) for chaining
	protected void	validate()
	MultiActionBuilder	withActions(java.util.List<DockingActionIf> list)	Configure a List of DockingActionIf to provide to the MultiActionDockingAction

Methods inherited from class docking.action.builder.AbstractActionBuilder

buildAndInstall, buildAndInstallLocal, decorateAction, description, enabled, enabledWhen, helpLocation, isKeyBindingAction, isMenuAction, isPopupAction, isToolbarAction, keyBinding, keyBinding, menuGroup, menuGroup, menuIcon, menuMnemonic, menuPath, onAction, popupMenuGroup, popupMenuGroup, popupMenuIcon, popupMenuPath, popupWhen, sharedKeyBinding, supportsDefaultToolContext, toolBarGroup, toolBarGroup, toolBarIcon, toolBarIcon, validContextWhen, withContext

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiActionBuilder

public MultiActionBuilder(java.lang.String name,
                          java.lang.String owner)

Builder constructor

Parameters:

name - the name of the action to be built

owner - the owner of the action to be build

Method Detail

self

protected MultiActionBuilder self()

Description copied from class: AbstractActionBuilder

Returns this (typed for subclass) for chaining

Specified by:

self in class AbstractActionBuilder<MultiActionDockingAction,ActionContext,MultiActionBuilder>

Returns:

this for chaining

build

public MultiActionDockingAction build()

Description copied from class: AbstractActionBuilder

Builds the action. To build and install the action in one step, use AbstractActionBuilder.buildAndInstall(Tool) or AbstractActionBuilder.buildAndInstallLocal(ComponentProvider).

Specified by:

build in class AbstractActionBuilder<MultiActionDockingAction,ActionContext,MultiActionBuilder>

Returns:

the newly build action

withActions

public MultiActionBuilder withActions(java.util.List<DockingActionIf> list)

Configure a List of DockingActionIf to provide to the MultiActionDockingAction

Parameters:

list - a List of DockingActionIf to provide to the MultiActionDockingAction

Returns:

this MultiActionDockingActionBuilder (for chaining)

performActionOnButtonClick

public MultiActionBuilder performActionOnButtonClick(boolean b)

Configure whether to perform actions on a button click. See MultiActionDockingAction.setPerformActionOnButtonClick(boolean)

Parameters:

b - true if the main action is invokable

Returns:

this MultiActionDockingActionBuilder (for chaining)

validate

protected void validate()

Overrides:

validate in class AbstractActionBuilder<MultiActionDockingAction,ActionContext,MultiActionBuilder>