com.force.i18n

Enum TextDirection

java.lang.Object

java.lang.Enum<TextDirection>

com.force.i18n.TextDirection

All Implemented Interfaces:

Serializable, Comparable<TextDirection>

public enum TextDirection
extends Enum<TextDirection>

Represents the text direction for a language or set of characters. Similar to ComponentOrientation, or Bidi, but an enum, which is always better.

Author:

stamm

Enum Constant Summary

Enum Constants

Enum Constant and Description
LTR
RTL

Method Summary

Modifier and Type	Method and Description
String	addEmbeddingMarks(String string) Surround the string with the appropriate LTR or RTL mark
char	getBaseDirectionChar() Append this marker next to "weak" characters (numbers and punctuation chars) to provide direction to that and all other neighboring "weak" characters See Sec 7.3, http://www.w3.org/TR/i18n-html-tech-bidi/#ri20030218.135304584
String	getCapLeft()
String	getCapRight()
static TextDirection	getDirection(Locale locale) Get the text direction for the given locale.
static TextDirection	getDirection(String lang) Get the text direction for the given language iso code (2 characters please)
String	getLeft()
static boolean	getNormalTextDirection()
String	getRight()
String	getToken(String token)
static TextDirection	invertIfNotNormalDirection(TextDirection direction) To aid debugging RTL issues, setNormalTextDirection(false) which allows a page to be shown with its text direction inverted.
String	makeStringLeftToRight(String string) Make the string display as left to right, if necessary, based on whether this direction needs it (i.e.
static void	setNormalTextDirection(boolean normal) Set to false to allow LTR languages to be shown as RTL, or RTL as LTR.
static TextDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static TextDirection[]	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 TextDirection LTR

RTL

public static final TextDirection RTL

Method Detail

values

public static TextDirection[] 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 (TextDirection c : TextDirection.values())
    System.out.println(c);

Returns:

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

valueOf

public static TextDirection valueOf(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:

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

NullPointerException - if the argument is null

getToken

public String getToken(String token)

getLeft

public String getLeft()

Returns:

the value for css for "canonical" left. So that in a right to left language, it would be "right"

getCapLeft

public String getCapLeft()

getRight

public String getRight()

Returns:

the value for css for "canonical" right. So that in a right to left language, it would be "left"

getCapRight

public String getCapRight()

addEmbeddingMarks

public String addEmbeddingMarks(String string)

Surround the string with the appropriate LTR or RTL mark

Parameters:

string - the string to surround

Returns:

the given string surrounded by the unicode embedding char marks

makeStringLeftToRight

public String makeStringLeftToRight(String string)

Make the string display as left to right, if necessary, based on whether this direction needs it (i.e. the code is right to left.)

Parameters:

string - the string to embed as left to right

Returns:

the string with the appropriate embedding marks added.

getDirection

public static TextDirection getDirection(Locale locale)

Get the text direction for the given locale.

Parameters:

locale - the locale to test

Returns:

the text direction for that locale's language

getDirection

public static TextDirection getDirection(String lang)

Get the text direction for the given language iso code (2 characters please)

Parameters:

lang - the language to test

Returns:

the text direction for that locale's language

getBaseDirectionChar

public char getBaseDirectionChar()

Append this marker next to "weak" characters (numbers and punctuation chars) to provide direction to that and all other neighboring "weak" characters See Sec 7.3, http://www.w3.org/TR/i18n-html-tech-bidi/#ri20030218.135304584

Returns:

the Right-to-Left Marker (RLM) or Left-To-Right Marker (LRM) character

invertIfNotNormalDirection

public static TextDirection invertIfNotNormalDirection(TextDirection direction)

To aid debugging RTL issues, setNormalTextDirection(false) which allows a page to be shown with its text direction inverted.

Parameters:

direction - the direction to invert

Returns:

the reversed direction if setNormalTextDirection has been called with false

setNormalTextDirection

public static void setNormalTextDirection(boolean normal)

Set to false to allow LTR languages to be shown as RTL, or RTL as LTR. Especially helpful for debugging RTL styling issues and staying sane while doing so. Don't even try to call this on a production configuration.

Parameters:

normal - what the normal text direction should be

getNormalTextDirection

public static boolean getNormalTextDirection()

Returns:

true if the text direction is normal