SourceForge.net Logo
aXSL API 0.2

org.axsl.common.value
Enum AbsoluteDirection

java.lang.Object
  extended by java.lang.Enum<AbsoluteDirection>
      extended by org.axsl.common.value.AbsoluteDirection
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AbsoluteDirection>

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

An enumeration of absolute directions or vectors, that is, directions of movement.


Enum Constant Summary
BOTTOM_TO_TOP
          Constant indicating the "bottom-to-top" direction.
LEFT_TO_RIGHT
          Constant indicating the "left-to-right" direction.
RIGHT_TO_LEFT
          Constant indicating the "right-to-left" direction.
TOP_TO_BOTTOM
          Constant indicating the "top-to-bottom" direction.
 
Method Summary
 boolean isHorizontal()
          Indicates whether this direction is on the horizontal axis.
 boolean isVertical()
          Indicates whether this direction is on the horizontal axis.
static AbsoluteDirection valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AbsoluteDirection[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, 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 AbsoluteDirection LEFT_TO_RIGHT
Constant indicating the "left-to-right" direction.


RIGHT_TO_LEFT

public static final AbsoluteDirection RIGHT_TO_LEFT
Constant indicating the "right-to-left" direction.


TOP_TO_BOTTOM

public static final AbsoluteDirection TOP_TO_BOTTOM
Constant indicating the "top-to-bottom" direction.


BOTTOM_TO_TOP

public static final AbsoluteDirection BOTTOM_TO_TOP
Constant indicating the "bottom-to-top" direction.

Method Detail

values

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

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

valueOf

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

isHorizontal

public boolean isHorizontal()
Indicates whether this direction is on the horizontal axis.

Returns:
True iff this direction is on the horizontal axis.

isVertical

public boolean isVertical()
Indicates whether this direction is on the horizontal axis.

Returns:
True iff this direction is on the horizontal axis.

SourceForge.net Logo
aXSL API 0.2

This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.