Package io.guise.framework.component.layout

Enum Corner

java.lang.Object
java.lang.Enum<Corner>
io.guise.framework.component.layout.Corner
All Implemented Interfaces:
Serializable, Comparable<Corner>
public enum Corner extends Enum<Corner>
The four logical flow corners.
Author:
Garret Wilson
See Also:

  • Enum Constant Details

    • LINE_NEAR_PAGE_NEAR

      public static final Corner LINE_NEAR_PAGE_NEAR
      The upper-left corner in left-to-right top-to-bottom orientation.

    • LINE_FAR_PAGE_NEAR

      public static final Corner LINE_FAR_PAGE_NEAR
      The upper-right corner in left-to-right top-to-bottom orientation.

    • LINE_NEAR_PAGE_FAR

      public static final Corner LINE_NEAR_PAGE_FAR
      The bottom-left corner in left-to-right top-to-bottom orientation.

    • LINE_FAR_PAGE_FAR

      public static final Corner LINE_FAR_PAGE_FAR
      The bottom-right corner in left-to-right top-to-bottom orientation.

  • Method Details

    • values

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

    • getBorder

      public Border getBorder(Flow flow)
      Determines the border for the given flow.
      Parameters:
      flow - The flow for which the border should be returned.
      Returns:
      The corner border for the given flow.
      Throws:
      NullPointerException - if the given flow is null.

    • getCorner

      public static Corner getCorner(Flow.End lineEnd, Flow.End pageEnd)
      Determines the corner from the given line and page ends.
      Parameters:
      lineEnd - The line end.
      pageEnd - The page end.
      Returns:
      The corner value for the specified line and page ends.
      Throws:
      NullPointerException - if the given line end and/or page end is null.