Package io.guise.framework.component.layout

Enum Border

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Border>
    public enum Border
extends java.lang.Enum<Border>
    The points at which the four logical flows end.
    Author:
    Garret Wilson
    See Also:
    Side

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LINE_FAR
      The right side in left-to-right top-to-bottom orientation.
      LINE_NEAR
      The left side in left-to-right top-to-bottom orientation.
      PAGE_FAR
      The bottom side in left-to-right top-to-bottom orientation.
      PAGE_NEAR
      The top side in left-to-right top-to-bottom orientation.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Border getBorder​(Flow flow, Flow.End end)
      Determines the border from the flow and end.
      Flow.End getEnd()  
      Flow getFlow()  
      static Border valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Border[] 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

        public static final Border LINE_NEAR
        The left side in left-to-right top-to-bottom orientation.

      • LINE_FAR

        public static final Border LINE_FAR
        The right side in left-to-right top-to-bottom orientation.

      • PAGE_NEAR

        public static final Border PAGE_NEAR
        The top side in left-to-right top-to-bottom orientation.

      • PAGE_FAR

        public static final Border PAGE_FAR
        The bottom side in left-to-right top-to-bottom orientation.

    • Method Detail

      • values

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

      • valueOf

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

      • getFlow

        public Flow getFlow()
        Returns:
        The flow.

      • getEnd

        public Flow.End getEnd()
        Returns:
        The end.

      • getBorder

        public static Border getBorder​(Flow flow,
                               Flow.End end)
        Determines the border from the flow and end.
        Parameters:
        flow - The flow
        end - The end.
        Returns:
        The border for the specified flow and page end.
        Throws:
        java.lang.NullPointerException - if the given flow and/or end is null.