Package io.guise.framework.component.layout

Enum Corner

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LINE_FAR_PAGE_FAR
      The bottom-right corner in left-to-right top-to-bottom orientation.
      LINE_FAR_PAGE_NEAR
      The upper-right corner in left-to-right top-to-bottom orientation.
      LINE_NEAR_PAGE_FAR
      The bottom-left corner in left-to-right top-to-bottom orientation.
      LINE_NEAR_PAGE_NEAR
      The upper-left corner in left-to-right top-to-bottom orientation.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Border getBorder​(Flow flow)
      Determines the border for the given flow.
      static Corner getCorner​(Flow.End lineEnd, Flow.End pageEnd)
      Determines the corner from the given line and page ends.
      static Corner valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Corner[] 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_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 Detail

      • values

        public static Corner[] 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 (Corner c : Corner.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • 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:
        java.lang.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:
        java.lang.NullPointerException - if the given line end and/or page end is null.