Package com.oorian.i18n

Enum Class TextDirection

java.lang.Object

java.lang.Enum<TextDirection>

com.oorian.i18n.TextDirection

All Implemented Interfaces:

Serializable, Comparable<TextDirection>, Constable

public enum TextDirection
extends Enum<TextDirection>

Text directionality for HTML content.

Maps directly to the HTML dir attribute values. Used by the framework to set the document direction based on the resolved locale.

Since:

2.1

Version:

1.0

Author:

Marvin P. Warble Jr.

See Also:

• DirectionResolver

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
AUTO	Automatic direction determined by the browser based on content.
LTR	Left-to-right direction (English, French, German, etc.).
RTL	Right-to-left direction (Arabic, Hebrew, Persian, etc.).

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the HTML dir attribute value.
boolean	isRtl()	Returns whether this direction is right-to-left.
static TextDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TextDirection[]	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

LTR

public static final TextDirection LTR

Left-to-right direction (English, French, German, etc.).

RTL

public static final TextDirection RTL

Right-to-left direction (Arabic, Hebrew, Persian, etc.).

AUTO

public static final TextDirection AUTO

Automatic direction determined by the browser based on content.

Method Details

values

public static TextDirection[] 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 TextDirection 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 String getValue()

Returns the HTML dir attribute value.

Returns:

the direction value ("ltr", "rtl", or "auto")

isRtl

public boolean isRtl()

Returns whether this direction is right-to-left.

Returns:

true if this is RTL