Module org.snapfx

Package org.snapfx

Enum Class DockShortcutAction

java.lang.Object

java.lang.Enum<DockShortcutAction>

org.snapfx.DockShortcutAction

All Implemented Interfaces:

Serializable, Comparable<DockShortcutAction>, Constable

public enum DockShortcutAction
extends Enum<DockShortcutAction>

Built-in shortcut actions supported by SnapFX.

Applications can remap these actions to custom key combinations via SnapFX.setShortcut(DockShortcutAction, javafx.scene.input.KeyCombination).

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
CANCEL_DRAG	Cancel an active drag operation.
CLOSE_ACTIVE_NODE	Close the currently active dock node.
NEXT_TAB	Select the next tab in the active tab pane.
PREVIOUS_TAB	Select the previous tab in the active tab pane.
TOGGLE_ACTIVE_FLOATING_ALWAYS_ON_TOP	Toggle always-on-top for the active floating window.

Method Summary

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

CLOSE_ACTIVE_NODE

public static final DockShortcutAction CLOSE_ACTIVE_NODE

Close the currently active dock node.

NEXT_TAB

public static final DockShortcutAction NEXT_TAB

Select the next tab in the active tab pane.

PREVIOUS_TAB

public static final DockShortcutAction PREVIOUS_TAB

Select the previous tab in the active tab pane.

CANCEL_DRAG

public static final DockShortcutAction CANCEL_DRAG

Cancel an active drag operation.

TOGGLE_ACTIVE_FLOATING_ALWAYS_ON_TOP

public static final DockShortcutAction TOGGLE_ACTIVE_FLOATING_ALWAYS_ON_TOP

Toggle always-on-top for the active floating window.

Method Details

values

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