Module org.snapfx

Package org.snapfx.floating

Enum Class DockFloatingSnapTarget

java.lang.Object

java.lang.Enum<DockFloatingSnapTarget>

org.snapfx.floating.DockFloatingSnapTarget

All Implemented Interfaces:

Serializable, Comparable<DockFloatingSnapTarget>, Constable

public enum DockFloatingSnapTarget
extends Enum<DockFloatingSnapTarget>

Defines which surfaces are considered while snapping floating windows during title-bar drag operations.

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
FLOATING_WINDOWS	Snap against other floating window edges.
MAIN_WINDOW	Snap against the primary/main application window edges.
SCREEN	Snap against current screen work-area edges.

Method Summary

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

SCREEN

public static final DockFloatingSnapTarget SCREEN

Snap against current screen work-area edges.

MAIN_WINDOW

public static final DockFloatingSnapTarget MAIN_WINDOW

Snap against the primary/main application window edges.

FLOATING_WINDOWS

public static final DockFloatingSnapTarget FLOATING_WINDOWS

Snap against other floating window edges.

Method Details

values

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