Package jme3utilities.ui

Enum Class LocationPolicy

java.lang.Object

java.lang.Enum<LocationPolicy>

jme3utilities.ui.LocationPolicy

All Implemented Interfaces:

Serializable, Comparable<LocationPolicy>, Constable

public enum LocationPolicy
extends Enum<LocationPolicy>

Enumerate policies for locating overlays within viewports.

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
Center	centered in the ViewPort, ignoring margins
CenterLeft	set in by the horizontal margin from the left edge of the ViewPort
LowerLeft	set in by margins from the lower-left corner of the ViewPort
UpperLeft	set in by margins from the upper-left corner of the ViewPort

Method Summary

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

Center

public static final LocationPolicy Center

centered in the ViewPort, ignoring margins

CenterLeft

public static final LocationPolicy CenterLeft

set in by the horizontal margin from the left edge of the ViewPort

LowerLeft

public static final LocationPolicy LowerLeft

set in by margins from the lower-left corner of the ViewPort

UpperLeft

public static final LocationPolicy UpperLeft

set in by margins from the upper-left corner of the ViewPort

Method Details

values

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