Module org.snapfx

Package org.snapfx.floating

Enum Class DockFloatingPinButtonMode

java.lang.Object

java.lang.Enum<DockFloatingPinButtonMode>

org.snapfx.floating.DockFloatingPinButtonMode

All Implemented Interfaces:

Serializable, Comparable<DockFloatingPinButtonMode>, Constable

public enum DockFloatingPinButtonMode
extends Enum<DockFloatingPinButtonMode>

Controls when the pin button is shown in floating window title bars.

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	Always show the pin button when pin toggling is enabled.
AUTO	Show the pin button automatically based on floating window interaction state.
NEVER	Never show the pin button.

Method Summary

Modifier and Type	Method	Description
static DockFloatingPinButtonMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DockFloatingPinButtonMode[]	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

ALWAYS

public static final DockFloatingPinButtonMode ALWAYS

Always show the pin button when pin toggling is enabled.

NEVER

public static final DockFloatingPinButtonMode NEVER

Never show the pin button.

AUTO

public static final DockFloatingPinButtonMode AUTO

Show the pin button automatically based on floating window interaction state.

Method Details

values

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