Module org.controlsfx.controls

Package org.controlsfx.control.action

Class ActionUtils

java.lang.Object

org.controlsfx.control.action.ActionUtils

public class ActionUtils
extends Object

Convenience class for users of the Action API. Primarily this class is used to conveniently create UI controls from a given Action (this is necessary for now as there is no built-in support for Action in JavaFX UI controls at present).

Some of the methods in this class take a Collection of actions. In these cases, it is likely they are designed to work with action groups. For examples on how to work with these methods, refer to the ActionGroup class documentation.

See Also:

Action, ActionGroup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionUtils.ActionTextBehavior	Action text behavior.

Field Summary

Fields

Modifier and Type	Field	Description
static Action	ACTION_SEPARATOR	Action representation of the generic separator.
static Action	ACTION_SPAN

Method Summary

Modifier and Type	Method	Description
static ButtonBase	configureButton(Action action, ButtonBase button)	Takes the provided Action and binds the relevant properties to the supplied Button.
static ButtonBase	configureButton(Action action, ButtonBase button, ActionUtils.ActionTextBehavior textBehavior)	Takes the provided Action and binds the relevant properties to the supplied Button.
static MenuItem	configureMenuItem(Action action, MenuItem menuItem)
static Button	createButton(Action action)	Takes the provided Action and returns a Button instance with all relevant properties bound to the properties of the Action.
static Button	createButton(Action action, ActionUtils.ActionTextBehavior textBehavior)	Takes the provided Action and returns a Button instance with all relevant properties bound to the properties of the Action.
static ButtonBar	createButtonBar(Collection<? extends Action> actions)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a ButtonBar populated with appropriate nodes bound to the provided actions.
static CheckBox	createCheckBox(Action action)	Takes the provided Action and returns a CheckBox instance with all relevant properties bound to the properties of the Action.
static CheckMenuItem	createCheckMenuItem(Action action)	Takes the provided Action and returns a CheckMenuItem instance with all relevant properties bound to the properties of the Action.
static ContextMenu	createContextMenu(Collection<? extends Action> actions)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a ContextMenu populated with appropriate nodes bound to the provided actions.
static Hyperlink	createHyperlink(Action action)	Takes the provided Action and returns a Hyperlink instance with all relevant properties bound to the properties of the Action.
static Menu	createMenu(Action action)	Takes the provided Action and returns a Menu instance with all relevant properties bound to the properties of the Action.
static MenuBar	createMenuBar(Collection<? extends Action> actions)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a MenuBar populated with appropriate nodes bound to the provided actions.
static MenuButton	createMenuButton(Action action)	Takes the provided Action and returns a MenuButton instance with all relevant properties bound to the properties of the Action.
static MenuButton	createMenuButton(Action action, ActionUtils.ActionTextBehavior textBehavior)	Takes the provided Action and returns a MenuButton instance with all relevant properties bound to the properties of the Action.
static MenuItem	createMenuItem(Action action)	Takes the provided Action and returns a MenuItem instance with all relevant properties bound to the properties of the Action.
static RadioButton	createRadioButton(Action action)	Takes the provided Action and returns a RadioButton instance with all relevant properties bound to the properties of the Action.
static RadioMenuItem	createRadioMenuItem(Action action)	Takes the provided Action and returns a RadioMenuItem instance with all relevant properties bound to the properties of the Action.
static SegmentedButton	createSegmentedButton(Collection<? extends Action> actions)	Takes the provided Collection of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.
static SegmentedButton	createSegmentedButton(Action... actions)	Takes the provided varargs array of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.
static SegmentedButton	createSegmentedButton(ActionUtils.ActionTextBehavior textBehavior, Collection<? extends Action> actions)	Takes the provided Collection of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.
static SegmentedButton	createSegmentedButton(ActionUtils.ActionTextBehavior textBehavior, Action... actions)	Takes the provided varargs array of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.
static ToggleButton	createToggleButton(Action action)	Takes the provided Action and returns a ToggleButton instance with all relevant properties bound to the properties of the Action.
static ToggleButton	createToggleButton(Action action, ActionUtils.ActionTextBehavior textBehavior)	Takes the provided Action and returns a ToggleButton instance with all relevant properties bound to the properties of the Action.
static ToolBar	createToolBar(Collection<? extends Action> actions, ActionUtils.ActionTextBehavior textBehavior)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a ToolBar populated with appropriate nodes bound to the provided actions.
static void	unconfigureButton(ButtonBase button)	Removes all bindings and listeners which were added when the supplied ButtonBase was bound to an Action via one of the methods of this class.
static void	unconfigureMenuItem(MenuItem menuItem)	Removes all bindings and listeners which were added when the supplied MenuItem was bound to an Action via one of the methods of this class.
static ButtonBar	updateButtonBar(ButtonBar buttonBar, Collection<? extends Action> actions)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and updates a ButtonBar populated with appropriate nodes bound to the provided actions.
static ContextMenu	updateContextMenu(ContextMenu menu, Collection<? extends Action> actions)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and updates a ContextMenu populated with appropriate nodes bound to the provided actions.
static MenuBar	updateMenuBar(MenuBar menuBar, Collection<? extends Action> actions)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and updates a MenuBar populated with appropriate nodes bound to the provided actions.
static ToolBar	updateToolBar(ToolBar toolbar, Collection<? extends Action> actions, ActionUtils.ActionTextBehavior textBehavior)	Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns provided ToolBar populated with appropriate nodes bound to the provided actions.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_SEPARATOR

public static Action ACTION_SEPARATOR

Action representation of the generic separator. Adding this action anywhere in the action tree serves as indication that separator has be created in its place. See ActionGroup for example of action tree creation

ACTION_SPAN

public static Action ACTION_SPAN

Method Detail

createButton

public static Button createButton(Action action,
                                  ActionUtils.ActionTextBehavior textBehavior)

Takes the provided Action and returns a Button instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the Button should bind to.

textBehavior - Defines ActionUtils.ActionTextBehavior

Returns:

A Button that is bound to the state of the provided Action

createButton

public static Button createButton(Action action)

Takes the provided Action and returns a Button instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the Button should bind to.

Returns:

A Button that is bound to the state of the provided Action

configureButton

public static ButtonBase configureButton(Action action,
                                         ButtonBase button,
                                         ActionUtils.ActionTextBehavior textBehavior)

Takes the provided Action and binds the relevant properties to the supplied Button. This allows for the use of Actions within custom Button subclasses.

Parameters:

action - The Action that the Button should bind to.

button - The ButtonBase that the Action should be bound to.

textBehavior - Defines ActionUtils.ActionTextBehavior

Returns:

The ButtonBase that was bound to the Action.

configureButton

public static ButtonBase configureButton(Action action,
                                         ButtonBase button)

Takes the provided Action and binds the relevant properties to the supplied Button. This allows for the use of Actions within custom Button subclasses.

Parameters:

action - The Action that the Button should bind to.

button - The ButtonBase that the Action should be bound to.

Returns:

The ButtonBase that was bound to the Action.

unconfigureButton

public static void unconfigureButton(ButtonBase button)

Removes all bindings and listeners which were added when the supplied ButtonBase was bound to an Action via one of the methods of this class.

Parameters:

button - a ButtonBase that was bound to an Action

createMenuButton

public static MenuButton createMenuButton(Action action,
                                          ActionUtils.ActionTextBehavior textBehavior)

Takes the provided Action and returns a MenuButton instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the MenuButton should bind to.

textBehavior - Defines ActionUtils.ActionTextBehavior

Returns:

A MenuButton that is bound to the state of the provided Action

createMenuButton

public static MenuButton createMenuButton(Action action)

Takes the provided Action and returns a MenuButton instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the MenuButton should bind to.

Returns:

A MenuButton that is bound to the state of the provided Action

createHyperlink

public static Hyperlink createHyperlink(Action action)

Takes the provided Action and returns a Hyperlink instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the Hyperlink should bind to.

Returns:

A Hyperlink that is bound to the state of the provided Action

createToggleButton

public static ToggleButton createToggleButton(Action action,
                                              ActionUtils.ActionTextBehavior textBehavior)

Takes the provided Action and returns a ToggleButton instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the ToggleButton should bind to.

textBehavior - Defines ActionUtils.ActionTextBehavior

Returns:

A ToggleButton that is bound to the state of the provided Action

createToggleButton

public static ToggleButton createToggleButton(Action action)

Takes the provided Action and returns a ToggleButton instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the ToggleButton should bind to.

Returns:

A ToggleButton that is bound to the state of the provided Action

createSegmentedButton

public static SegmentedButton createSegmentedButton(ActionUtils.ActionTextBehavior textBehavior,
                                                    Collection<? extends Action> actions)

Takes the provided Collection of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.

Parameters:

actions - The Collection of Action that the SegmentedButton should bind to.

textBehavior - Defines ActionUtils.ActionTextBehavior

Returns:

A SegmentedButton that is bound to the state of the provided Actions

createSegmentedButton

public static SegmentedButton createSegmentedButton(Collection<? extends Action> actions)

Takes the provided Collection of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.

Parameters:

actions - The Collection of Action that the SegmentedButton should bind to.

Returns:

A SegmentedButton that is bound to the state of the provided Actions

createSegmentedButton

public static SegmentedButton createSegmentedButton(ActionUtils.ActionTextBehavior textBehavior,
                                                    Action... actions)

Takes the provided varargs array of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.

Parameters:

actions - A varargs array of Action that the SegmentedButton should bind to.

textBehavior - Defines ActionUtils.ActionTextBehavior

Returns:

A SegmentedButton that is bound to the state of the provided Actions

createSegmentedButton

public static SegmentedButton createSegmentedButton(Action... actions)

Takes the provided varargs array of Action and returns a SegmentedButton instance with all relevant properties bound to the properties of the actions.

Parameters:

actions - A varargs array of Action that the SegmentedButton should bind to.

Returns:

A SegmentedButton that is bound to the state of the provided Actions

createCheckBox

public static CheckBox createCheckBox(Action action)

Takes the provided Action and returns a CheckBox instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the CheckBox should bind to.

Returns:

A CheckBox that is bound to the state of the provided Action

createRadioButton

public static RadioButton createRadioButton(Action action)

Takes the provided Action and returns a RadioButton instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the RadioButton should bind to.

Returns:

A RadioButton that is bound to the state of the provided Action

createMenuItem

public static MenuItem createMenuItem(Action action)

Takes the provided Action and returns a MenuItem instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the MenuItem should bind to.

Returns:

A MenuItem that is bound to the state of the provided Action

configureMenuItem

public static MenuItem configureMenuItem(Action action,
                                         MenuItem menuItem)

unconfigureMenuItem

public static void unconfigureMenuItem(MenuItem menuItem)

Removes all bindings and listeners which were added when the supplied MenuItem was bound to an Action via one of the methods of this class.

Parameters:

menuItem - a MenuItem that was bound to an Action

createMenu

public static Menu createMenu(Action action)

Takes the provided Action and returns a Menu instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the Menu should bind to.

Returns:

A Menu that is bound to the state of the provided Action

createCheckMenuItem

public static CheckMenuItem createCheckMenuItem(Action action)

Takes the provided Action and returns a CheckMenuItem instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the CheckMenuItem should bind to.

Returns:

A CheckMenuItem that is bound to the state of the provided Action

createRadioMenuItem

public static RadioMenuItem createRadioMenuItem(Action action)

Takes the provided Action and returns a RadioMenuItem instance with all relevant properties bound to the properties of the Action.

Parameters:

action - The Action that the RadioMenuItem should bind to.

Returns:

A RadioMenuItem that is bound to the state of the provided Action

createToolBar

public static ToolBar createToolBar(Collection<? extends Action> actions,
                                    ActionUtils.ActionTextBehavior textBehavior)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a ToolBar populated with appropriate nodes bound to the provided actions.

Parameters:

actions - The actions to place on the ToolBar.

textBehavior - defines ActionUtils.ActionTextBehavior

Returns:

A ToolBar that contains nodes which are bound to the state of the provided Action

updateToolBar

public static ToolBar updateToolBar(ToolBar toolbar,
                                    Collection<? extends Action> actions,
                                    ActionUtils.ActionTextBehavior textBehavior)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns provided ToolBar populated with appropriate nodes bound to the provided actions. Previous toolbar content is removed

Parameters:

toolbar - The toolbar to update

actions - The actions to place on the ToolBar.

textBehavior - defines ActionUtils.ActionTextBehavior

Returns:

A ToolBar that contains nodes which are bound to the state of the provided Action

createMenuBar

public static MenuBar createMenuBar(Collection<? extends Action> actions)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a MenuBar populated with appropriate nodes bound to the provided actions.

Parameters:

actions - The actions to place on the MenuBar.

Returns:

A MenuBar that contains nodes which are bound to the state of the provided Action

updateMenuBar

public static MenuBar updateMenuBar(MenuBar menuBar,
                                    Collection<? extends Action> actions)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and updates a MenuBar populated with appropriate nodes bound to the provided actions. Previous MenuBar content is removed.

Parameters:

menuBar - The menuBar to update

actions - The actions to place on the MenuBar.

Returns:

A MenuBar that contains nodes which are bound to the state of the provided Action

createButtonBar

public static ButtonBar createButtonBar(Collection<? extends Action> actions)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a ButtonBar populated with appropriate nodes bound to the provided actions.

Parameters:

actions - The actions to place on the ButtonBar.

Returns:

A ButtonBar that contains nodes which are bound to the state of the provided Action

updateButtonBar

public static ButtonBar updateButtonBar(ButtonBar buttonBar,
                                        Collection<? extends Action> actions)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and updates a ButtonBar populated with appropriate nodes bound to the provided actions. Previous content of button bar is removed

Parameters:

buttonBar - The buttonBar to update

actions - The actions to place on the ButtonBar.

Returns:

A ButtonBar that contains nodes which are bound to the state of the provided Action

createContextMenu

public static ContextMenu createContextMenu(Collection<? extends Action> actions)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and returns a ContextMenu populated with appropriate nodes bound to the provided actions.

Parameters:

actions - The actions to place on the ContextMenu.

Returns:

A ContextMenu that contains nodes which are bound to the state of the provided Action

updateContextMenu

public static ContextMenu updateContextMenu(ContextMenu menu,
                                            Collection<? extends Action> actions)

Takes the provided Collection of Action (or subclasses, such as ActionGroup) instances and updates a ContextMenu populated with appropriate nodes bound to the provided actions. Previous content of context menu is removed

Parameters:

menu - The menu to update

actions - The actions to place on the ContextMenu.

Returns:

A ContextMenu that contains nodes which are bound to the state of the provided Action