com.guiseframework.component.layout
Enum Flow

java.lang.Object
  extended by java.lang.Enum<Flow>
      extended by com.guiseframework.component.layout.Flow
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Flow>

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

Indicates a logical flow axis.

Author:
Garret Wilson
See Also:
Axis

Nested Class Summary
static class Flow.Direction
          The flow direction for a line or page, relative to the origin in the top, left-hand corner of the area.
static class Flow.End
          Indicates an end of a flow, relative to a direction.
 
Enum Constant Summary
LINE
          Flow along a line; the X axis in left-to-right, top-to-bottom orientation.
PAGE
          Flow along a page; the Y axis in left-to-right, top-to-bottom orientation.
 
Method Summary
static Flow valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Flow[] 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

LINE

public static final Flow LINE
Flow along a line; the X axis in left-to-right, top-to-bottom orientation.


PAGE

public static final Flow PAGE
Flow along a page; the Y axis in left-to-right, top-to-bottom orientation.

Method Detail

values

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

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

valueOf

public static Flow 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
java.lang.NullPointerException - if the argument is null


Copyright © 2005-2010 GlobalMentor, Inc. All Rights Reserved.