com.ibm.portal.model
Enum LocalizedContextHome.BASE_TEXT_DIRECTION

java.lang.Object
  java.lang.Enum<LocalizedContextHome.BASE_TEXT_DIRECTION>
      com.ibm.portal.model.LocalizedContextHome.BASE_TEXT_DIRECTION

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LocalizedContextHome.BASE_TEXT_DIRECTION>

Enclosing interface:

LocalizedContextHome

public static enum LocalizedContextHome.BASE_TEXT_DIRECTION
extends java.lang.Enum<LocalizedContextHome.BASE_TEXT_DIRECTION>

Enumerations of the base text direction for a given locale

Enum Constant Summary

LTR
Left to right encoding

RTL
right to left encoding

UNDEFINED

Method Summary

abstract java.lang.String	getFSI() Returns the character used to introduce a BDI sequence for the text direction.
abstract java.lang.String	getPDI() Returns the character used to end a BDI sequence for the text direction.
static LocalizedContextHome.BASE_TEXT_DIRECTION	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LocalizedContextHome.BASE_TEXT_DIRECTION[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LTR

public static final LocalizedContextHome.BASE_TEXT_DIRECTION LTR

Left to right encoding

RTL

public static final LocalizedContextHome.BASE_TEXT_DIRECTION RTL

right to left encoding

UNDEFINED

public static final LocalizedContextHome.BASE_TEXT_DIRECTION UNDEFINED

Method Detail

values

public static LocalizedContextHome.BASE_TEXT_DIRECTION[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LocalizedContextHome.BASE_TEXT_DIRECTION c : LocalizedContextHome.BASE_TEXT_DIRECTION.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LocalizedContextHome.BASE_TEXT_DIRECTION valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getFSI

public abstract java.lang.String getFSI()

Returns the character used to introduce a BDI sequence for the text direction. For LTR this is "RLM" for RTL it is "LRM".

Returns:

the character to start the sequence

Since:

8.5

getPDI

public abstract java.lang.String getPDI()

Returns the character used to end a BDI sequence for the text direction. For LTR this is "LRM" for RTL it is "RLM".

Returns:

the character to end the sequence

Since:

8.5