Module org.controlsfx.controls

Package impl.org.controlsfx.tools.rectangle

Enum Class CoordinatePosition

java.lang.Object

java.lang.Enum<CoordinatePosition>

impl.org.controlsfx.tools.rectangle.CoordinatePosition

All Implemented Interfaces:

Serializable, Comparable<CoordinatePosition>, Constable

public enum CoordinatePosition
extends Enum<CoordinatePosition>

Enumerates all possible positions coordinates can have relative to a rectangle.

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
EAST_EDGE	The coordinates are close to the eastern edge of the rectangle.
IN_RECTANGLE	The coordinates are inside the rectangle.
NORTH_EDGE	The coordinates are close to the northern edge of the rectangle.
NORTHEAST_EDGE	The coordinates are close to the northern and the eastern edge of the rectangle.
NORTHWEST_EDGE	The coordinates are close to the northern and the western edge of the rectangle.
OUT_OF_RECTANGLE	The coordinates are outside of the rectangle.
SOUTH_EDGE	The coordinates are close to the southern edge of the rectangle.
SOUTHEAST_EDGE	The coordinates are close to the southern and eastern edge of the rectangle.
SOUTHWEST_EDGE	The coordinates are close to the southern and western edge of the rectangle.
WEST_EDGE	The coordinates are close to the western edge of the rectangle.

Method Summary

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

IN_RECTANGLE

public static final CoordinatePosition IN_RECTANGLE

The coordinates are inside the rectangle.

OUT_OF_RECTANGLE

public static final CoordinatePosition OUT_OF_RECTANGLE

The coordinates are outside of the rectangle.

NORTH_EDGE

public static final CoordinatePosition NORTH_EDGE

The coordinates are close to the northern edge of the rectangle.

NORTHEAST_EDGE

public static final CoordinatePosition NORTHEAST_EDGE

The coordinates are close to the northern and the eastern edge of the rectangle.

EAST_EDGE

public static final CoordinatePosition EAST_EDGE

The coordinates are close to the eastern edge of the rectangle.

SOUTHEAST_EDGE

public static final CoordinatePosition SOUTHEAST_EDGE

The coordinates are close to the southern and eastern edge of the rectangle.

SOUTH_EDGE

public static final CoordinatePosition SOUTH_EDGE

The coordinates are close to the southern edge of the rectangle.

SOUTHWEST_EDGE

public static final CoordinatePosition SOUTHWEST_EDGE

The coordinates are close to the southern and western edge of the rectangle.

WEST_EDGE

public static final CoordinatePosition WEST_EDGE

The coordinates are close to the western edge of the rectangle.

NORTHWEST_EDGE

public static final CoordinatePosition NORTHWEST_EDGE

The coordinates are close to the northern and the western edge of the rectangle.

Method Details

values

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