bibliothek.gui.dock.station.stack.tab.layouting
Enum Side

java.lang.Object
  extended by java.lang.Enum<Side>
      extended by bibliothek.gui.dock.station.stack.tab.layouting.Side
All Implemented Interfaces:
Serializable, Comparable<Side>

public enum Side
extends Enum<Side>

Some side of a rectangle.

Author:
Benjamin Sigg

Enum Constant Summary
BOTTOM
          bottom side, horizontal
LEFT
          to the left, vertical
RIGHT
          to the right, vertical
TOP
          top side, horizontal
 
Method Summary
 boolean isHorizontal()
          Tells whether this side is a horizontal side.
 boolean isVertical()
          Tells whether this side is a vertical side.
static Side valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Side[] 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

TOP

public static final Side TOP
top side, horizontal


BOTTOM

public static final Side BOTTOM
bottom side, horizontal


LEFT

public static final Side LEFT
to the left, vertical


RIGHT

public static final Side RIGHT
to the right, vertical

Method Detail

values

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

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

valueOf

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

isHorizontal

public boolean isHorizontal()
Tells whether this side is a horizontal side.

Returns:
true if TOP or BOTTOM

isVertical

public boolean isVertical()
Tells whether this side is a vertical side.

Returns:
true if LEFT or RIGHT