Package com.vuzix.ultralite

Enum Class Anchor

java.lang.Object

java.lang.Enum<Anchor>

com.vuzix.ultralite.Anchor

All Implemented Interfaces:

Serializable, Comparable<Anchor>, Constable

public enum Anchor
extends Enum<Anchor>

Possible anchor points for images and text blocks on a canvas.

Since:

1.0.0

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
BOTTOM_CENTER	Anchor position: bottom - centered left/right
BOTTOM_LEFT	Anchor position: bottom - left
BOTTOM_RIGHT	Anchor position: bottom - right
CENTER	Anchor position: middle up/down - centered left/right
DEFAULT	Not used for most circumstances, use other Anchor values instead
MIDDLE_LEFT	Anchor position: middle up/down - left
MIDDLE_RIGHT	Anchor position: middle up/down - right
TOP_CENTER	Anchor position: top - centered left/right
TOP_LEFT	Anchor position: top - left
TOP_RIGHT	Anchor position: top - right

Method Summary

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

DEFAULT

public static final Anchor DEFAULT

Not used for most circumstances, use other Anchor values instead

Since:

1.0.0

TOP_LEFT

public static final Anchor TOP_LEFT

Anchor position: top - left

Since:

1.0.0

TOP_CENTER

public static final Anchor TOP_CENTER

Anchor position: top - centered left/right

Since:

1.0.0

TOP_RIGHT

public static final Anchor TOP_RIGHT

Anchor position: top - right

Since:

1.0.0

BOTTOM_LEFT

public static final Anchor BOTTOM_LEFT

Anchor position: bottom - left

Since:

1.0.0

BOTTOM_CENTER

public static final Anchor BOTTOM_CENTER

Anchor position: bottom - centered left/right

Since:

1.0.0

BOTTOM_RIGHT

public static final Anchor BOTTOM_RIGHT

Anchor position: bottom - right

Since:

1.0.0

MIDDLE_LEFT

public static final Anchor MIDDLE_LEFT

Anchor position: middle up/down - left

Since:

1.0.0

MIDDLE_RIGHT

public static final Anchor MIDDLE_RIGHT

Anchor position: middle up/down - right

Since:

1.0.0

CENTER

public static final Anchor CENTER

Anchor position: middle up/down - centered left/right

Since:

1.0.0

Method Details

values

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