Enum HorizontalAlignment

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CENTER
      Indicates that text should be aligned along their centers.
      LEFT
      Indicates that items should be aligned along their left edges.
      RIGHT
      Indicates that text should be aligned along right edges.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void format​(java.lang.StringBuilder buffer, java.lang.String text, int width)
      Appends the provided string to the given buffer, aligned properly within the specified width.
      static HorizontalAlignment forName​(java.lang.String name)
      Retrieves the horizontal alignment value with the specified name.
      static HorizontalAlignment valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HorizontalAlignment[] 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
    • Method Detail

      • values

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

        public static HorizontalAlignment 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
      • format

        public void format​(@NotNull
                           java.lang.StringBuilder buffer,
                           @NotNull
                           java.lang.String text,
                           int width)
        Appends the provided string to the given buffer, aligned properly within the specified width. Spaces will be inserted before and/or after the text as necessary to achieve the desired alignment. This method will always append exactly width characters (including spaces added to achieve the desired alignment) to the provided buffer. If the given text is longer than width, then only the first width characters of the provided text will be appended.
        Parameters:
        buffer - The buffer to which the formatted text should be appended. It must not be null.
        text - The text to be added to the provided buffer, with additional spaces as necessary to achieve the desired width. It must not be null.
        width - The number of characters to append to the provided buffer. It must be greater than or equal to 1.
      • forName

        @Nullable
        public static HorizontalAlignment forName​(@NotNull
                                                  java.lang.String name)
        Retrieves the horizontal alignment value with the specified name.
        Parameters:
        name - The name of the horizontal alignment value to retrieve. It must not be null.
        Returns:
        The requested horizontal alignment value, or null if no such value is defined.