Module org.snapfx

Package org.snapfx.view

Enum Class DockCloseButtonMode

java.lang.Object

java.lang.Enum<DockCloseButtonMode>

org.snapfx.view.DockCloseButtonMode

All Implemented Interfaces:

Serializable, Comparable<DockCloseButtonMode>, Constable

public enum DockCloseButtonMode
extends Enum<DockCloseButtonMode>

Controls which close buttons are visible for docked nodes.

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
BOTH	Show close controls on both tab headers and title bars.
TAB_ONLY	Show close controls only on tab headers.
TITLE_ONLY	Show close controls only on dock-node title bars.

Method Summary

Modifier and Type	Method	Description
boolean	showTabClose()	Returns whether tab close controls should be visible.
boolean	showTitleClose()	Returns whether title-bar close controls should be visible.
static DockCloseButtonMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DockCloseButtonMode[]	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

TAB_ONLY

public static final DockCloseButtonMode TAB_ONLY

Show close controls only on tab headers.

TITLE_ONLY

public static final DockCloseButtonMode TITLE_ONLY

Show close controls only on dock-node title bars.

BOTH

public static final DockCloseButtonMode BOTH

Show close controls on both tab headers and title bars.

Method Details

values

public static DockCloseButtonMode[] 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 DockCloseButtonMode 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

showTabClose

public boolean showTabClose()

Returns whether tab close controls should be visible.

Returns:

true when tab close controls are enabled

showTitleClose

public boolean showTitleClose()

Returns whether title-bar close controls should be visible.

Returns:

true when title-bar close controls are enabled