com.google.gwt.gadgets.client
Enum LanguageDirection

java.lang.Object
  extended by java.lang.Enum<LanguageDirection>
      extended by com.google.gwt.gadgets.client.LanguageDirection
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<LanguageDirection>

public enum LanguageDirection
extends java.lang.Enum<LanguageDirection>

Enum used in the Gadget.GadgetLocale annotation to specify the language direction to use for a locale. For more informatoin, see Creating Bi-Directional Gadgets


Enum Constant Summary
LTR
          Left to Right language support.
RTL
          Right to Left language support.
UNSPECIFIED
          Not specified (use the default.)
 
Method Summary
static LanguageDirection getDir()
          Returns the value of the substitution variable __BIDI_DIR__
static java.lang.String getEndEdge()
          Returns the value of the substitution variable __BIDI_END_EDGE__
static LanguageDirection getReverseDir()
          Returns the value of the substitution variable __BIDI_REVERSE_DIR__.
static java.lang.String getStartEdge()
          Returns the value of the substitution variable __BIDI_START_EDGE__
 java.lang.String getValue()
           
static LanguageDirection valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static LanguageDirection[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

LTR

public static final LanguageDirection LTR
Left to Right language support.


RTL

public static final LanguageDirection RTL
Right to Left language support.


UNSPECIFIED

public static final LanguageDirection UNSPECIFIED
Not specified (use the default.)

Method Detail

values

public static final LanguageDirection[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(LanguageDirection c : LanguageDirection.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static LanguageDirection 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

getDir

public static LanguageDirection getDir()
Returns the value of the substitution variable __BIDI_DIR__

Returns:
LTR when the gadget is in LTR-mode and RTL when the gadget is in RTL-mode.

getEndEdge

public static java.lang.String getEndEdge()
Returns the value of the substitution variable __BIDI_END_EDGE__

Returns:
"right" when the gadget is in LTR-mode and "left" when the gadget is in RTL-mode.

getReverseDir

public static LanguageDirection getReverseDir()
Returns the value of the substitution variable __BIDI_REVERSE_DIR__.

Returns:
RTL when the gadget is in LTR-mode and LTR when the gadget is in RTL-mode.

getStartEdge

public static java.lang.String getStartEdge()
Returns the value of the substitution variable __BIDI_START_EDGE__

Returns:
"left" when the gadget is in LTR-mode and "right" when the gadget is in RTL-mode.

getValue

public java.lang.String getValue()