org.controlsfx.control.action

Interface Action

All Known Implementing Classes:

AbstractAction, ActionGroup, Dialog.Actions, Dialogs.CommandLink

public interface Action

Common interface for dialog actions, where Actions are converted into buttons in the dialogs button bar. It is highly recommended that rather than implement this interface that developers instead use AbstractAction.

What is an Action?

An action in JavaFX can be used to separate functionality and state from a control. For example, if you have two or more controls that perform the same function (e.g. one in a Menu and another on a toolbar), consider using an Action object to implement the function. An Action object provides centralized handling of the state of action-event-firing components such as buttons, menu items, etc. The state that an action can handle includes text, graphic, long text (i.e. tooltip text), and disabled.

See Also:

AbstractAction

Property Summary

Type	Property and Description
BooleanProperty	disabled This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
ObjectProperty<Node>	graphic This graphic that should be shown to the user in relation to this action.
StringProperty	longText The longer form of the text to show to the user (e.g.
StringProperty	text The text to show to the user.

Method Summary

Modifier and Type	Method and Description
BooleanProperty	disabledProperty() This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
void	execute(ActionEvent ae) This method is called when the user selects this action.
ObservableMap<Object,Object>	getProperties() Returns an observable map of properties on this Action for use primarily by application developers.
ObjectProperty<Node>	graphicProperty() This graphic that should be shown to the user in relation to this action.
StringProperty	longTextProperty() The longer form of the text to show to the user (e.g.
StringProperty	textProperty() The text to show to the user.

Property Detail

text

StringProperty textProperty

The text to show to the user.

disabled

BooleanProperty disabledProperty

This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.

longText

StringProperty longTextProperty

The longer form of the text to show to the user (e.g. on a Button, it is usually a tooltip that should be shown to the user if their mouse hovers over this action).

graphic

ObjectProperty<Node> graphicProperty

This graphic that should be shown to the user in relation to this action.

Method Detail

textProperty

StringProperty textProperty()

The text to show to the user.

disabledProperty

BooleanProperty disabledProperty()

This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.

longTextProperty

StringProperty longTextProperty()

The longer form of the text to show to the user (e.g. on a Button, it is usually a tooltip that should be shown to the user if their mouse hovers over this action).

graphicProperty

ObjectProperty<Node> graphicProperty()

This graphic that should be shown to the user in relation to this action.

getProperties

ObservableMap<Object,Object> getProperties()

Returns an observable map of properties on this Action for use primarily by application developers.

Returns:

An observable map of properties on this Action for use primarily by application developers

execute

void execute(ActionEvent ae)

This method is called when the user selects this action.

Parameters:

ae - The action context.