Enum Class InfoCenterViewPos

java.lang.Object

java.lang.Enum<InfoCenterViewPos>

com.dlsc.gemsfx.infocenter.InfoCenterViewPos

All Implemented Interfaces:

Serializable, Comparable<InfoCenterViewPos>, Constable

public enum InfoCenterViewPos
extends Enum<InfoCenterViewPos>

Defines the position of the InfoCenterView within the InfoCenterPane. The horizontal component (LEFT or RIGHT) determines which edge the info center slides in from, and the vertical component (TOP, CENTER, or BOTTOM) determines where it is placed along that edge.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM_LEFT
BOTTOM_RIGHT
CENTER_LEFT
CENTER_RIGHT
TOP_LEFT
TOP_RIGHT

Method Summary

Modifier and Type	Method	Description
boolean	isLeft()	Returns true if this position is on the left side.
boolean	isRight()	Returns true if this position is on the right side.
static InfoCenterViewPos	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InfoCenterViewPos[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOP_LEFT

public static final InfoCenterViewPos TOP_LEFT

TOP_RIGHT

public static final InfoCenterViewPos TOP_RIGHT

CENTER_LEFT

public static final InfoCenterViewPos CENTER_LEFT

CENTER_RIGHT

public static final InfoCenterViewPos CENTER_RIGHT

BOTTOM_LEFT

public static final InfoCenterViewPos BOTTOM_LEFT

BOTTOM_RIGHT

public static final InfoCenterViewPos BOTTOM_RIGHT

Method Details

values

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

isLeft

public boolean isLeft()

Returns true if this position is on the left side.

Returns:

true if the position is on the left side

isRight

public boolean isRight()

Returns true if this position is on the right side.

Returns:

true if the position is on the right side