org.controlsfx.dialog

Enum Dialog.Actions

java.lang.Object

java.lang.Enum<Dialog.Actions>

org.controlsfx.dialog.Dialog.Actions

All Implemented Interfaces:

Serializable, Comparable<Dialog.Actions>, Action

Enclosing class:

Dialog

public static enum Dialog.Actions
extends Enum<Dialog.Actions>
implements Action

An enumeration of common dialog actions, ideal for use in dialogs if the common behavior of presenting options to a user and listening to their response is all that is necessary. Refer to the Dialog class documentation for examples on how to use this enumeration.

See Also:

Dialog, Action

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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCEL An action that, by default, will show 'Cancel'.
CLOSE An action that, by default, will show 'Close'.
NO An action that, by default, will show 'No'.
OK An action that, by default, will show 'OK'.
YES An action that, by default, will show 'Yes'.

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.
static Dialog.Actions	valueOf(String name) Returns the enum constant of this type with the specified name.
static Dialog.Actions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANCEL

public static final Dialog.Actions CANCEL

An action that, by default, will show 'Cancel'.

CLOSE

public static final Dialog.Actions CLOSE

An action that, by default, will show 'Close'.

NO

public static final Dialog.Actions NO

An action that, by default, will show 'No'.

OK

public static final Dialog.Actions OK

An action that, by default, will show 'OK'.

YES

public static final Dialog.Actions YES

An action that, by default, will show 'Yes'.

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.

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.

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.

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.

Method Detail

values

public static Dialog.Actions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Dialog.Actions c : Dialog.Actions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Dialog.Actions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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.

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.

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.

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.

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 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.