Action (ControlsFX Project 8.40.18)

java.lang.Object
- org.controlsfx.control.action.Action

All Implemented Interfaces:

java.util.EventListener, javafx.event.EventHandler<javafx.event.ActionEvent>

Direct Known Subclasses:

ActionGroup, AnnotatedAction, ColumnFixAction, ListActionView.ListAction, ListSelectionView.ListSelectionAction, RowFixAction
```
public class Action
extends java.lang.Object
implements javafx.event.EventHandler<javafx.event.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.

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ObjectProperty<javafx.scene.input.KeyCombination>`	`accelerator` The accelerator `KeyCombination` that should be used for this action, if it is used in an applicable UI control (most notably `MenuItem`).
`javafx.beans.property.BooleanProperty`	`disabled` This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`graphic` The graphic that should be shown to the user in relation to this action.
`javafx.beans.property.StringProperty`	`longText` The longer form of the text to show to the user (e.g.
`javafx.beans.property.BooleanProperty`	`selected` Represents action's selected state.
`javafx.beans.property.StringProperty`	`style` A string representation of the CSS style associated with this Action instance and passed to related UI controls.
`javafx.beans.property.StringProperty`	`text` The text to show to the user.

Constructor Summary

Constructors
Constructor and Description
`Action(java.util.function.Consumer<javafx.event.ActionEvent> eventHandler)`
`Action(java.lang.String text)` Constructors
`Action(java.lang.String text, java.util.function.Consumer<javafx.event.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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javafx.beans.property.ObjectProperty<javafx.scene.input.KeyCombination>`	`acceleratorProperty()` The accelerator `KeyCombination` that should be used for this action, if it is used in an applicable UI control (most notably `MenuItem`).
`javafx.beans.property.BooleanProperty`	`disabledProperty()` This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
`javafx.scene.input.KeyCombination`	`getAccelerator()`
`protected java.util.function.Consumer<javafx.event.ActionEvent>`	`getEventHandler()`
`javafx.scene.Node`	`getGraphic()`
`java.lang.String`	`getLongText()`
`javafx.collections.ObservableMap<java.lang.Object,java.lang.Object>`	`getProperties()` Returns an observable map of properties on this Action for use primarily by application developers.
`java.lang.String`	`getStyle()` Gets the value of the property style.
`javafx.collections.ObservableList<java.lang.String>`	`getStyleClass()` A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
`java.lang.String`	`getText()`
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`graphicProperty()` The graphic that should be shown to the user in relation to this action.
`void`	`handle(javafx.event.ActionEvent event)` Defers to the `Consumer<ActionEvent>` passed in to the Action constructor.
`boolean`	`isDisabled()`
`boolean`	`isSelected()` Selected state of the Action.
`protected void`	`lock()`
`javafx.beans.property.StringProperty`	`longTextProperty()` The longer form of the text to show to the user (e.g.
`javafx.beans.property.BooleanProperty`	`selectedProperty()` Represents action's selected state.
`void`	`setAccelerator(javafx.scene.input.KeyCombination value)` Sets the accelerator `KeyCombination` that should be used for this action, if it is used in an applicable UI control
`void`	`setDisabled(boolean value)` Sets whether the action should be available to the end user, or whether it should appeared 'grayed out'.
`protected void`	`setEventHandler(java.util.function.Consumer<javafx.event.ActionEvent> eventHandler)`
`void`	`setGraphic(javafx.scene.Node value)` Sets the graphic that should be shown to the user in relation to this action.
`void`	`setLongText(java.lang.String value)` Sets the longer form of the text to show to the user
`void`	`setSelected(boolean selected)` Sets selected state of the Action
`void`	`setStyle(java.lang.String value)` Sets the value of the property style.
`void`	`setText(java.lang.String value)` Sets the text of the Action.
`javafx.beans.property.StringProperty`	`styleProperty()` A string representation of the CSS style associated with this Action instance and passed to related UI controls.
`javafx.beans.property.StringProperty`	`textProperty()` The text to show to the user.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - style
```
public final javafx.beans.property.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)
  - selected
```
public final javafx.beans.property.BooleanProperty selectedProperty
```
    Represents action's selected state. Usually bound to selected state of components such as Toggle Buttons, CheckBOxes etc
    
    See Also:
    
    isSelected(), setSelected(boolean)
  - text
```
public final javafx.beans.property.StringProperty textProperty
```
    The text to show to the user.
    
    See Also:
    
    getText(), setText(String)
  - disabled
```
public final javafx.beans.property.BooleanProperty disabledProperty
```
    This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
    
    See Also:
    
    isDisabled(), setDisabled(boolean)
  - longText
```
public final javafx.beans.property.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)
  - graphic
```
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty
```
    The graphic that should be shown to the user in relation to this action.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - accelerator
```
public final javafx.beans.property.ObjectProperty<javafx.scene.input.KeyCombination> acceleratorProperty
```
    The accelerator KeyCombination that should be used for this action, if it is used in an applicable UI control (most notably MenuItem).
    
    See Also:
    
    getAccelerator(), setAccelerator(KeyCombination)
- Constructor Detail
  - Action
```
public Action(java.lang.String text)
```
    Constructors
  - Action
```
public Action(java.util.function.Consumer<javafx.event.ActionEvent> eventHandler)
```
  - Action
```
public Action(java.lang.String text,
              java.util.function.Consumer<javafx.event.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(java.lang.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 java.lang.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 javafx.beans.property.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 javafx.collections.ObservableList<java.lang.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
  - selectedProperty
```
public final javafx.beans.property.BooleanProperty selectedProperty()
```
    Represents action's selected state. Usually bound to selected state of components such as Toggle Buttons, CheckBOxes etc
    
    See Also:
    
    isSelected(), setSelected(boolean)
  - 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 -
  - textProperty
```
public final javafx.beans.property.StringProperty textProperty()
```
    The text to show to the user.
    
    See Also:
    
    getText(), setText(String)
  - getText
```
public final java.lang.String getText()
```
    Returns:
    
    the text of the Action.
  - setText
```
public final void setText(java.lang.String value)
```
    Sets the text of the Action.
    
    Parameters:
    
    value -
  - disabledProperty
```
public final javafx.beans.property.BooleanProperty disabledProperty()
```
    This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
    
    See Also:
    
    isDisabled(), setDisabled(boolean)
  - 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 javafx.beans.property.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 java.lang.String getLongText()
```
    Returns:
    
    The longer form of the text to show to the user
    
    See Also:
    
    longTextProperty()
  - setLongText
```
public final void setLongText(java.lang.String value)
```
    Sets the longer form of the text to show to the user
    
    Parameters:
    
    value -
    
    See Also:
    
    longTextProperty()
  - graphicProperty
```
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty()
```
    The graphic that should be shown to the user in relation to this action.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - getGraphic
```
public final javafx.scene.Node getGraphic()
```
    Returns:
    
    The graphic that should be shown to the user in relation to this action.
  - setGraphic
```
public final void setGraphic(javafx.scene.Node value)
```
    Sets the graphic that should be shown to the user in relation to this action.
    
    Parameters:
    
    value -
  - acceleratorProperty
```
public final javafx.beans.property.ObjectProperty<javafx.scene.input.KeyCombination> acceleratorProperty()
```
    The accelerator KeyCombination that should be used for this action, if it is used in an applicable UI control (most notably MenuItem).
    
    See Also:
    
    getAccelerator(), setAccelerator(KeyCombination)
  - getAccelerator
```
public final javafx.scene.input.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(javafx.scene.input.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 javafx.collections.ObservableMap<java.lang.Object,java.lang.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
  - getEventHandler
```
protected java.util.function.Consumer<javafx.event.ActionEvent> getEventHandler()
```
  - setEventHandler
```
protected void setEventHandler(java.util.function.Consumer<javafx.event.ActionEvent> eventHandler)
```
  - handle
```
public final void handle(javafx.event.ActionEvent event)
```
    Defers to the Consumer<ActionEvent> passed in to the Action constructor.
    
    Specified by:
    
    handle in interface javafx.event.EventHandler<javafx.event.ActionEvent>

Class Action

What is an Action?

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

style

selected

text

disabled

longText

graphic

accelerator

Constructor Detail

Action

Action

Action

Method Detail

lock

setStyle

getStyle

styleProperty

getStyleClass

selectedProperty

isSelected

setSelected

textProperty

getText

setText

disabledProperty

isDisabled

setDisabled

longTextProperty

getLongText

setLongText

graphicProperty

getGraphic

setGraphic

acceleratorProperty

getAccelerator

setAccelerator

getProperties

getEventHandler

setEventHandler

handle