Package docking.widgets.shapes

Enum Location

java.lang.Object

java.lang.Enum<Location>

docking.widgets.shapes.Location

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Location>

public enum Location
extends java.lang.Enum<Location>

Specifies location and metrics for PopupWindowPlacer.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM
CENTER
LEFT
RIGHT
TOP

Method Summary

Modifier and Type	Method	Description
Location	clockwise()
Location	counterClockwise()
boolean	isCenter()
boolean	isGreater()
boolean	isHorizontal()
boolean	isLesser()
boolean	isVertical()
Location	match()
boolean	validMinor(Location minor)	Assumes "this" is a major axis, and tells whether the minor axis argument is valid for the major value.
static Location	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Location[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

public static final Location LEFT

RIGHT

public static final Location RIGHT

TOP

public static final Location TOP

BOTTOM

public static final Location BOTTOM

CENTER

public static final Location CENTER

Method Detail

values

public static Location[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Location c : Location.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Location valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isGreater

public boolean isGreater()

isLesser

public boolean isLesser()

isCenter

public boolean isCenter()

match

public Location match()

clockwise

public Location clockwise()

counterClockwise

public Location counterClockwise()

validMinor

public boolean validMinor(Location minor)

Assumes "this" is a major axis, and tells whether the minor axis argument is valid for the major value. Cannot have both major and minor be the same horizontal/vertical bearing. Note that CENTER can be horizontal or vertical, so this method should not count this value as a bad minor value, as it also represents a good value.

Parameters:

minor - the minor value to check

Returns:

true if valid.

isHorizontal

public boolean isHorizontal()

isVertical

public boolean isVertical()