Module org.controlsfx.controls
Package org.controlsfx.control.action

Class Action

  • All Implemented Interfaces:
    EventListener, EventHandler<ActionEvent>
    Direct Known Subclasses:
    ActionGroup, AnnotatedAction, ListActionView.ListAction, ListSelectionView.ListSelectionAction
    public class Action
extends Object
implements EventHandler<ActionEvent>
    A base class for Action API.

    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.

    • Constructor Detail

      • Action

        public Action​(String text)
        Constructors

      • Action

        public Action​(String text,
              Consumer<ActionEvent> eventHandler)
        Creates a new AbstractAction instance with the given String set as the text value, as well as the Consumer<ActionEvent> set to be called when the action event is fired.
        Parameters:
        text - The string to display in the text property of controls such as Button.
        eventHandler - This will be called when the ActionEvent is fired.

    • Method Detail

      • lock

        protected void lock()

      • setStyle

        public final void setStyle​(String value)
        Sets the value of the property style.
        Property description:
        A string representation of the CSS style associated with this Action instance and passed to related UI controls. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.

        Parsing this style might not be supported on some limited platforms. It is recommended to use a standalone CSS file instead.

      • getStyle

        public final String getStyle()
        Gets the value of the property style.
        Property description:
        A string representation of the CSS style associated with this Action instance and passed to related UI controls. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.

        Parsing this style might not be supported on some limited platforms. It is recommended to use a standalone CSS file instead.

      • styleProperty

        public final StringProperty styleProperty()
        A string representation of the CSS style associated with this Action instance and passed to related UI controls. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.

        Parsing this style might not be supported on some limited platforms. It is recommended to use a standalone CSS file instead.

        See Also:
        getStyle(), setStyle(String)

      • getStyleClass

        public ObservableList<String> getStyleClass()
        A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine. This variable is analogous to the "class" attribute on an HTML element and, as such, each element of the list is a style class to which this Node belongs.
        See Also:
        CSS3 class selectors

      • isSelected

        public final boolean isSelected()
        Selected state of the Action.
        Returns:
        The selected state of this action.

      • setSelected

        public final void setSelected​(boolean selected)
        Sets selected state of the Action
        Parameters:
        selected -

      • getText

        public final String getText()
        Returns:
        the text of the Action.

      • setText

        public final void setText​(String value)
        Sets the text of the Action.
        Parameters:
        value -

      • isDisabled

        public final boolean isDisabled()
        Returns:
        whether the action is available to the end user, or whether it should appeared 'grayed out'.

      • setDisabled

        public final void setDisabled​(boolean value)
        Sets whether the action should be available to the end user, or whether it should appeared 'grayed out'.
        Parameters:
        value -

      • longTextProperty

        public final 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).
        See Also:
        getLongText(), setLongText(String)

      • getLongText

        public final String getLongText()
        Returns:
        The longer form of the text to show to the user
        See Also:
        longTextProperty()

      • setLongText

        public final void setLongText​(String value)
        Sets the longer form of the text to show to the user
        Parameters:
        value -
        See Also:
        longTextProperty()

      • getGraphic

        public final Node getGraphic()
        Returns:
        The graphic that should be shown to the user in relation to this action.

      • setGraphic

        public final void setGraphic​(Node value)
        Sets the graphic that should be shown to the user in relation to this action.
        Parameters:
        value -

      • getAccelerator

        public final KeyCombination getAccelerator()
        Returns:
        The accelerator KeyCombination that should be used for this action, if it is used in an applicable UI control

      • setAccelerator

        public final void setAccelerator​(KeyCombination value)
        Sets the accelerator KeyCombination that should be used for this action, if it is used in an applicable UI control
        Parameters:
        value -

      • getProperties

        public final 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