Module org.tentackle.fx

Package org.tentackle.fx

Enum Class NotificationBuilder.CloseButtonMode

java.lang.Object

java.lang.Enum<NotificationBuilder.CloseButtonMode>

org.tentackle.fx.NotificationBuilder.CloseButtonMode

All Implemented Interfaces:

Serializable, Comparable<NotificationBuilder.CloseButtonMode>, Constable

Enclosing interface:

NotificationBuilder

public static enum NotificationBuilder.CloseButtonMode
extends Enum<NotificationBuilder.CloseButtonMode>

Controls when and how the close button is displayed.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	A close button will always be displayed, if the hide action is set.
ALWAYS_DEFAULT	Same as ALWAYS, but the close button will be shown as the default button, i.e.
AUTO	This is the default. If there are no buttons defined and the hide action is set, a close button will be shown.
AUTO_DEFAULT	Same as AUTO, but the close button will be shown as the default button, i.e.
NEVER	No close button will ever be displayed.

Method Summary

Modifier and Type	Method	Description
boolean	isAlwaysShown()	Returns whether the close button is always shown.
boolean	isDefaultButton()	Returns whether this is the default button.
static NotificationBuilder.CloseButtonMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NotificationBuilder.CloseButtonMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final NotificationBuilder.CloseButtonMode AUTO

This is the default.
If there are no buttons defined and the hide action is set, a close button will be shown.

AUTO_DEFAULT

public static final NotificationBuilder.CloseButtonMode AUTO_DEFAULT

Same as AUTO, but the close button will be shown as the default button, i.e. ENTER closes the dialog.

NEVER

public static final NotificationBuilder.CloseButtonMode NEVER

No close button will ever be displayed.

ALWAYS

public static final NotificationBuilder.CloseButtonMode ALWAYS

A close button will always be displayed, if the hide action is set.

ALWAYS_DEFAULT

public static final NotificationBuilder.CloseButtonMode ALWAYS_DEFAULT

Same as ALWAYS, but the close button will be shown as the default button, i.e. ENTER closes the dialog.

Method Details

values

public static NotificationBuilder.CloseButtonMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static NotificationBuilder.CloseButtonMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isDefaultButton

public boolean isDefaultButton()

Returns whether this is the default button.

Returns:

true if default button

isAlwaysShown

public boolean isAlwaysShown()

Returns whether the close button is always shown.

Returns:

shown even if there are other buttons defined