Module org.snapfx

Package org.snapfx.dnd

Enum Class DockDropVisualizationMode

java.lang.Object

java.lang.Enum<DockDropVisualizationMode>

org.snapfx.dnd.DockDropVisualizationMode

All Implemented Interfaces:

Serializable, Comparable<DockDropVisualizationMode>, Constable

public enum DockDropVisualizationMode
extends Enum<DockDropVisualizationMode>

Controls how drop zones are visualized during drag.

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
ACTIVE_ONLY	Show only the active indicator, without background zones.
ALL_ZONES	Show all valid drop zones in the current layout tree.
DEFAULT	Show only zones related to the currently active target.
OFF	Hide all drop-zone visuals while dragging.
SUBTREE	Show valid drop zones within the active target subtree.

Method Summary

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

OFF

public static final DockDropVisualizationMode OFF

Hide all drop-zone visuals while dragging.

DEFAULT

public static final DockDropVisualizationMode DEFAULT

Show only zones related to the currently active target.

ALL_ZONES

public static final DockDropVisualizationMode ALL_ZONES

Show all valid drop zones in the current layout tree.

SUBTREE

public static final DockDropVisualizationMode SUBTREE

Show valid drop zones within the active target subtree.

ACTIVE_ONLY

public static final DockDropVisualizationMode ACTIVE_ONLY

Show only the active indicator, without background zones.

Method Details

values

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