net.sf.mmm.client.ui.api.common

Enum ScriptOrientation

java.lang.Object

java.lang.Enum<ScriptOrientation>

net.sf.mmm.client.ui.api.common.ScriptOrientation

All Implemented Interfaces:

Serializable, Comparable<ScriptOrientation>

public enum ScriptOrientation
extends Enum<ScriptOrientation>

This enumeration represents the orientation of a script-system. It is rather used to determine the orientation of the layout for widgets but better to understand as the orientation of the script.
When you read this javadoc you will be used to the fact that many scripts are written horizontally in the direction from left to right. However various other scripts on the world work different. Some scripts are written from the right to the left others vertically from the top to the bottom while the vertical rows may be ordered again from the left to the right. The user expects the orientation of widgets ordered according to its script-system.
Please note that there are also scripts that go bidirectional (bidi) so e.g. normal text is going right-to-left while numbers are written left-to-right. However the ScriptOrientation only specifies the main direction for the layout.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT_TO_RIGHT Script and layout goes horizontal from the left to the right.
RIGHT_TO_LEFT Script and layout goes horizontal from the right to the left.
RIGHT_TO_LEFT_VERTICAL Script and layout goes vertical from the top to the bottom, horizontal order goes from the right to the left.
VERTICAL_LEFT_TO_RIGHT Script and layout goes vertical from the top to the bottom, horizontal order goes from the left to the right.

Method Summary

Modifier and Type	Method and Description
abstract boolean	isHorizontal() This method determines if the primary ordering of script and layout goes horizontally.
abstract boolean	isLeftToRight() This method determines if the horizontal ordering of script and layout goes from the left to the right or vice versa.
static ScriptOrientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScriptOrientation[]	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

LEFT_TO_RIGHT

public static final ScriptOrientation LEFT_TO_RIGHT

Script and layout goes horizontal from the left to the right.

RIGHT_TO_LEFT

public static final ScriptOrientation RIGHT_TO_LEFT

Script and layout goes horizontal from the right to the left.

VERTICAL_LEFT_TO_RIGHT

public static final ScriptOrientation VERTICAL_LEFT_TO_RIGHT

Script and layout goes vertical from the top to the bottom, horizontal order goes from the left to the right.

RIGHT_TO_LEFT_VERTICAL

public static final ScriptOrientation RIGHT_TO_LEFT_VERTICAL

Script and layout goes vertical from the top to the bottom, horizontal order goes from the right to the left.

Method Detail

values

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

Returns:

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

valueOf

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

isLeftToRight

public abstract boolean isLeftToRight()

This method determines if the horizontal ordering of script and layout goes from the left to the right or vice versa.

Returns:

true if horizontal ordering is left-to-right, false for right-to-left.

isHorizontal

public abstract boolean isHorizontal()

This method determines if the primary ordering of script and layout goes horizontally. Vertical ordering always goes from the top to the bottom.

Returns:

true if the primary ordering is horizontal, false for vertical.