de.cau.cs.kieler.kiml.layout.options
Enum LayoutDirection

java.lang.Object
  extended by java.lang.Enum<LayoutDirection>
      extended by de.cau.cs.kieler.kiml.layout.options.LayoutDirection
All Implemented Interfaces:
Serializable, Comparable<LayoutDirection>

public enum LayoutDirection
extends Enum<LayoutDirection>

Definition of layout directions.

Rating proposed yellow
(2009-12-11) msp

Enum Constant Summary
DOWN
          downward vertical layout.
LEFT
          leftward horizontal layout.
RIGHT
          rightward horizontal layout.
UNDEFINED
          undefined layout direction.
UP
          upward vertical layout.
 
Method Summary
static LayoutDirection valueOf(int i)
          Returns the enumeration value related to the given ordinal.
static LayoutDirection valueOf(String name)
          Returns the enum constant of this type with the specified name.
static LayoutDirection[] 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

UNDEFINED

public static final LayoutDirection UNDEFINED
undefined layout direction.


RIGHT

public static final LayoutDirection RIGHT
rightward horizontal layout.


LEFT

public static final LayoutDirection LEFT
leftward horizontal layout.


DOWN

public static final LayoutDirection DOWN
downward vertical layout.


UP

public static final LayoutDirection UP
upward vertical layout.

Method Detail

values

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

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

valueOf

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

valueOf

public static LayoutDirection valueOf(int i)
Returns the enumeration value related to the given ordinal.

Parameters:
i - ordinal value
Returns:
the related enumeration value