com.ibm.portal.content
Class Orientation

java.lang.Object
  extended by com.ibm.portal.content.Orientation
All Implemented Interfaces:
java.io.Serializable

public final class Orientation
extends java.lang.Object
implements java.io.Serializable

The Orientation class is a finite enumeration of the possible orientations that a container can operate at. Possible orientations are "horizontal" and "vertical". An orientation might be returned from LayoutMetrics.

Since:
5.1.0.1
See Also:
Serialized Form

Field Summary
static Orientation HORIZONTAL
          The horizontal orientation
static Orientation VERTICAL
          The vertical orientation
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 int hashCode()
           
 Orientation opposite()
          Returns the opposite of this orientation.
 java.lang.String toString()
          Returns a textual representation of the orientation.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

HORIZONTAL

public static final Orientation HORIZONTAL
The horizontal orientation


VERTICAL

public static final Orientation VERTICAL
The vertical orientation

Method Detail

opposite

public Orientation opposite()
Returns the opposite of this orientation. This means it returns HORIZONTAL for a VERTICAL orientation and vice versa.

Returns:
the opposite orientation

toString

public java.lang.String toString()
Returns a textual representation of the orientation.

Overrides:
toString in class java.lang.Object
Returns:
a string "Horizontal" or "Vertical", depending on orientation

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object