AbstractAction (ControlsFX Project 8.0.5)

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

All Implemented Interfaces:

Action

Direct Known Subclasses:

AbstractDialogAction, ActionGroup
```
public abstract class AbstractAction
extends Object
implements Action
```
A convenience class that implements the Action interface and provides a simpler API. It is highly recommended to use this class rather than implement the Action interface directly.
To better understand how to use actions, and where they fit within the JavaFX ecosystem, refer to the Action class documentation.

See Also:

Action

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`ObjectProperty<KeyCombination>`	`accelerator` The accelerator `KeyCombination` that should be used for this action, if it is used in an applicable UI control (most notably `MenuItem`.
`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.

Constructor Summary

Constructors
Constructor and Description

AbstractAction(String text)
Creates a new AbstractAction instance with the given String set as the text value.

Constructors
Constructor and Description
`AbstractAction(String text)` Creates a new AbstractAction instance with the given String set as the `text` value.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectProperty<KeyCombination>`	`acceleratorProperty()` The accelerator `KeyCombination` that should be used for this action, if it is used in an applicable UI control (most notably `MenuItem`.
`BooleanProperty`	`disabledProperty()` This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
`abstract void`	`execute(ActionEvent ae)` This method is called when the user selects this action.
`KeyCombination`	`getAccelerator()` Gets the value of the property accelerator.
`Node`	`getGraphic()` Gets the value of the property graphic.
`String`	`getLongText()` Gets the value of the property longText.
`ObservableMap<Object,Object>`	`getProperties()` Returns an observable map of properties on this Action for use primarily by application developers.
`String`	`getText()` Gets the value of the property text.
`ObjectProperty<Node>`	`graphicProperty()` This graphic that should be shown to the user in relation to this action.
`boolean`	`isDisabled()` Gets the value of the property disabled.
`StringProperty`	`longTextProperty()` The longer form of the text to show to the user (e.g.
`void`	`setAccelerator(KeyCombination value)` Sets the value of the property accelerator.
`void`	`setDisabled(boolean value)` Sets the value of the property disabled.
`void`	`setGraphic(Node value)` Sets the value of the property graphic.
`void`	`setLongText(String value)` Sets the value of the property longText.
`void`	`setText(String value)` Sets the value of the property text.
`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
  - text
```
public StringProperty textProperty
```
    The text to show to the user.
    
    Specified by:
    
    textProperty in interface Action
    
    Returns:
    
    An observable StringProperty that represents the current text for this property, and which can be observed for changes.
    
    See Also:
    
    getText(), setText(String)
  - disabled
```
public BooleanProperty disabledProperty
```
    This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
    
    Specified by:
    
    disabledProperty in interface Action
    
    Returns:
    
    An observable BooleanProperty that represents the current disabled state for this property, and which can be observed for changes.
    
    See Also:
    
    isDisabled(), setDisabled(boolean)
  - longText
```
public 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).
    
    Specified by:
    
    longTextProperty in interface Action
    
    Returns:
    
    An observable StringProperty that represents the current long text for this property, and which can be observed for changes.
    
    See Also:
    
    getLongText(), setLongText(String)
  - graphic
```
public ObjectProperty<Node> graphicProperty
```
    This graphic that should be shown to the user in relation to this action.
    
    Specified by:
    
    graphicProperty in interface Action
    
    Returns:
    
    An observable ObjectProperty that represents the current graphic for this property, and which can be observed for changes.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - accelerator
```
public ObjectProperty<KeyCombination> acceleratorProperty
```
    The accelerator KeyCombination that should be used for this action, if it is used in an applicable UI control (most notably MenuItem.
    
    Specified by:
    
    acceleratorProperty in interface Action
    
    Returns:
    
    An observable ObjectProperty that represents the current accelerator for this property, and which can be observed for changes.
    
    See Also:
    
    getAccelerator(), setAccelerator(KeyCombination)
- Constructor Detail
  - AbstractAction
```
public AbstractAction(String text)
```
    Creates a new AbstractAction instance with the given String set as the text value.
    
    Parameters:
    
    text - The string to display in the text property of controls such as Button.
- Method Detail
  - textProperty
```
public StringProperty textProperty()
```
    The text to show to the user.
    
    Specified by:
    
    textProperty in interface Action
    
    Returns:
    
    An observable StringProperty that represents the current text for this property, and which can be observed for changes.
    
    See Also:
    
    getText(), setText(String)
  - getText
```
public final String getText()
```
    Gets the value of the property text.
  - setText
```
public final void setText(String value)
```
    Sets the value of the property text.
  - disabledProperty
```
public BooleanProperty disabledProperty()
```
    This represents whether the action should be available to the end user, or whether it should appeared 'grayed out'.
    
    Specified by:
    
    disabledProperty in interface Action
    
    Returns:
    
    An observable BooleanProperty that represents the current disabled state for this property, and which can be observed for changes.
    
    See Also:
    
    isDisabled(), setDisabled(boolean)
  - isDisabled
```
public final boolean isDisabled()
```
    Gets the value of the property disabled.
  - setDisabled
```
public final void setDisabled(boolean value)
```
    Sets the value of the property disabled.
  - longTextProperty
```
public 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).
    
    Specified by:
    
    longTextProperty in interface Action
    
    Returns:
    
    An observable StringProperty that represents the current long text for this property, and which can be observed for changes.
    
    See Also:
    
    getLongText(), setLongText(String)
  - getLongText
```
public final String getLongText()
```
    Gets the value of the property longText.
  - setLongText
```
public final void setLongText(String value)
```
    Sets the value of the property longText.
  - graphicProperty
```
public ObjectProperty<Node> graphicProperty()
```
    This graphic that should be shown to the user in relation to this action.
    
    Specified by:
    
    graphicProperty in interface Action
    
    Returns:
    
    An observable ObjectProperty that represents the current graphic for this property, and which can be observed for changes.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - getGraphic
```
public final Node getGraphic()
```
    Gets the value of the property graphic.
  - setGraphic
```
public final void setGraphic(Node value)
```
    Sets the value of the property graphic.
  - acceleratorProperty
```
public ObjectProperty<KeyCombination> acceleratorProperty()
```
    The accelerator KeyCombination that should be used for this action, if it is used in an applicable UI control (most notably MenuItem.
    
    Specified by:
    
    acceleratorProperty in interface Action
    
    Returns:
    
    An observable ObjectProperty that represents the current accelerator for this property, and which can be observed for changes.
    
    See Also:
    
    getAccelerator(), setAccelerator(KeyCombination)
  - getAccelerator
```
public final KeyCombination getAccelerator()
```
    Gets the value of the property accelerator.
  - setAccelerator
```
public final void setAccelerator(KeyCombination value)
```
    Sets the value of the property accelerator.
  - getProperties
```
public ObservableMap<Object,Object> getProperties()
```
    Returns an observable map of properties on this Action for use primarily by application developers.
    
    Specified by:
    
    getProperties in interface Action
    
    Returns:
    
    An observable map of properties on this Action for use primarily by application developers
  - execute
```
public abstract void execute(ActionEvent ae)
```
    This method is called when the user selects this action.
    
    Specified by:
    
    execute in interface Action
    
    Parameters:
    
    ae - The action context.

Class AbstractAction

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

text

disabled

longText

graphic

accelerator

Constructor Detail

AbstractAction

Method Detail

textProperty

getText

setText

disabledProperty

isDisabled

setDisabled

longTextProperty

getLongText

setLongText

graphicProperty

getGraphic

setGraphic

acceleratorProperty

getAccelerator

setAccelerator

getProperties

execute