Package com.vuzix.ultralite

Enum Class Layout

java.lang.Object

java.lang.Enum<Layout>

com.vuzix.ultralite.Layout

All Implemented Interfaces:

Serializable, Comparable<Layout>, Constable

public enum Layout
extends Enum<Layout>

Supported layout types.

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
CANVAS	Canvas can be drawn to directly.
DEFAULT	Default layout.
NAVIGATION	Text will appear with a navigation layout.
SCROLL	A layout with user-defined image slices that may be scrolled like a teleprompter.
TEXT_BOTTOM_CENTER_ALIGN	Text will appear at the bottom of the display, center aligned.
TEXT_BOTTOM_LEFT_ALIGN	Text will appear at the bottom of the display, left aligned.

Method Summary

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

Default layout. Used to signal glasses can go back to notification only mode.

Since:

1.0.0

TEXT_BOTTOM_LEFT_ALIGN

public static final Layout TEXT_BOTTOM_LEFT_ALIGN

Text will appear at the bottom of the display, left aligned.

Since:

1.0.0

TEXT_BOTTOM_CENTER_ALIGN

public static final Layout TEXT_BOTTOM_CENTER_ALIGN

Text will appear at the bottom of the display, center aligned.

Since:

1.0.0

NAVIGATION

public static final Layout NAVIGATION

Text will appear with a navigation layout.

Since:

1.0.0

CANVAS

public static final Layout CANVAS

Canvas can be drawn to directly. Use getCanvas() to obtain an instance of the canvas.

Since:

1.0.0

SCROLL

public static final Layout SCROLL

A layout with user-defined image slices that may be scrolled like a teleprompter.

Since:

1.3.0

Method Details

values

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