Package com.vuzix.ultralite

Enum Class TextWrapMode

java.lang.Object

java.lang.Enum<TextWrapMode>

com.vuzix.ultralite.TextWrapMode

All Implemented Interfaces:

Serializable, Comparable<TextWrapMode>, Constable

public enum TextWrapMode
extends Enum<TextWrapMode>

Available wrap modes for text 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
CLIP	Simply clip the parts of the text outside the label.
SCROLL	If the text is wider than the label, scroll it horizontally back and forth.
SCROLL_CIRCULAR	If the text is wider than the label, scroll it horizontally continuously.
TRUNCATE	If the text is wider than the label, replaces the last 3 characters from bottom right corner of the label with dots (.)
WRAP	Wrap too long lines into additional rows of text.

Method Summary

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

WRAP

public static final TextWrapMode WRAP

Wrap too long lines into additional rows of text. If the label height is insufficient the text will be clipped. (Default)

Since:

1.0.0

TRUNCATE

public static final TextWrapMode TRUNCATE

If the text is wider than the label, replaces the last 3 characters from bottom right corner of the label with dots (.)

Since:

1.0.0

SCROLL

public static final TextWrapMode SCROLL

If the text is wider than the label, scroll it horizontally back and forth. If it's higher, scroll vertically. Only one direction is scrolled and horizontal scrolling has higher precedence.

Since:

1.0.0

SCROLL_CIRCULAR

public static final TextWrapMode SCROLL_CIRCULAR

If the text is wider than the label, scroll it horizontally continuously. If it's higher, scroll vertically. Only one direction is scrolled and horizontal scrolling has higher precedence.

Since:

1.0.0

CLIP

public static final TextWrapMode CLIP

Simply clip the parts of the text outside the label.

Since:

1.0.0

Method Details

values

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