Enum InfoCenterViewPos

java.lang.Object

java.lang.Enum<InfoCenterViewPos>

com.dlsc.gemsfx.infocenter.InfoCenterViewPos

All Implemented Interfaces:

Serializable, Comparable<InfoCenterViewPos>

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.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM_LEFT	Places the info center at the bottom-left edge of the pane.
BOTTOM_RIGHT	Places the info center at the bottom-right edge of the pane.
CENTER_LEFT	Places the info center centered on the left edge of the pane.
CENTER_RIGHT	Places the info center centered on the right edge of the pane.
TOP_LEFT	Places the info center at the top-left edge of the pane.
TOP_RIGHT	Places the info center at the top-right edge of the pane.

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 type with the specified name.
static InfoCenterViewPos[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, 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

Places the info center at the top-left edge of the pane.

TOP_RIGHT

public static final InfoCenterViewPos TOP_RIGHT

Places the info center at the top-right edge of the pane.

CENTER_LEFT

public static final InfoCenterViewPos CENTER_LEFT

Places the info center centered on the left edge of the pane.

CENTER_RIGHT

public static final InfoCenterViewPos CENTER_RIGHT

Places the info center centered on the right edge of the pane.

BOTTOM_LEFT

public static final InfoCenterViewPos BOTTOM_LEFT

Places the info center at the bottom-left edge of the pane.

BOTTOM_RIGHT

public static final InfoCenterViewPos BOTTOM_RIGHT

Places the info center at the bottom-right edge of the pane.

Method Details

values

public static InfoCenterViewPos[] values()

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

Returns:

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

valueOf

public static InfoCenterViewPos valueOf(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:

IllegalArgumentException - if this enum type 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