Package com.hp.lft.sdk.uiapro

Enum Class TextUnit

java.lang.Object

java.lang.Enum<TextUnit>

com.hp.lft.sdk.uiapro.TextUnit

All Implemented Interfaces:

com.hp.lft.sdk.internal.EnumValueProvider<Integer>, Serializable, Comparable<TextUnit>, java.lang.constant.Constable

public enum TextUnit
extends Enum<TextUnit>
implements com.hp.lft.sdk.internal.EnumValueProvider<Integer>

The possible unit lengths to use when navigating within a document.

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
Line	Specifies that the text unit is one line in length.
Page	Specifies that the text unit is one document-specific page in length.

Method Summary

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

Line

public static final TextUnit Line

Specifies that the text unit is one line in length.

Page

public static final TextUnit Page

Specifies that the text unit is one document-specific page in length.

Method Details

values

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

getValue

public Integer getValue()

Returns the integer value representing the TextUnit value.

Specified by:

getValue in interface com.hp.lft.sdk.internal.EnumValueProvider<Integer>

Returns:

the integer value representing the TextUnit value.