Package io.guise.framework.component.layout

Enum Flow

java.lang.Object
java.lang.Enum<Flow>
io.guise.framework.component.layout.Flow
All Implemented Interfaces:
Serializable, Comparable<Flow>
public enum Flow extends Enum<Flow>
Indicates a logical flow axis.
Author:
Garret Wilson
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Flow.Direction
    The flow direction for a line or page, relative to the origin in the top, left-hand corner of the area.
    static enum 
    Flow.End
    Indicates an end of a flow, relative to a direction.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    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

    Modifier and Type
    Method
    Description
    static Flow
    valueOf(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 Details

    • 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 Details

    • values

      public static Flow[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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