Package io.guise.framework.component.layout

Enum FlowOrientation

java.lang.Object
java.lang.Enum<FlowOrientation>
io.guise.framework.component.layout.FlowOrientation
All Implemented Interfaces:
Serializable, Comparable<FlowOrientation>
public enum FlowOrientation extends Enum<FlowOrientation>
The orientation of a particular flow; its axis and direction.
Author:
Garret Wilson

  • Enum Constant Details

  • Method Details

    • values

      public static FlowOrientation[] 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 FlowOrientation 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

    • getGlyph

      public URI getGlyph()
      Returns:
      The resource reference for the glyph, using the session's default orientation.

    • getAxis

      public Axis getAxis()
      Returns:
      The axis of the flow.

    • getDirection

      public Flow.Direction getDirection()
      Returns:
      The direction of the flow on the axis.

    • getCompassPoint

      public CompassPoint getCompassPoint(Flow.End end)
      Retrieves a cardinal compass point indicating the absolute direction based upon the given flow end.
      Parameters:
      end - The end of the flow.
      Returns:
      The cardinal compass point indicating the absolute direction of the given end.
      Throws:
      NullPointerException - if the given end is null.
      See Also: