Enum Class TextAlignment

java.lang.Object
java.lang.Enum<TextAlignment>
org.apache.poi.xwpf.usermodel.TextAlignment
All Implemented Interfaces:
Serializable, Comparable<TextAlignment>, Constable

public enum TextAlignment extends Enum<TextAlignment>
Specifies all types of vertical alignment which are available to be applied to of all text on each line displayed within a paragraph.
Author:
Gisella Bronzetti
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Specifies that all text in the parent object shall be aligned automatically when displayed.
    Specifies that all text in the parent object shall be aligned to the baseline of each character when displayed.
    Specifies that all text in the parent object shall be aligned to the bottom of each character when displayed.
    Specifies that all text in the parent object shall be aligned to the center of each character when displayed.
    Specifies that all text in the parent object shall be aligned to the top of each character when displayed
  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
    valueOf(int type)
    Returns the enum constant of this class with the specified name.
    Returns the enum constant of this class with the specified name.
    static TextAlignment[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • TOP

      public static final TextAlignment TOP
      Specifies that all text in the parent object shall be aligned to the top of each character when displayed
    • CENTER

      public static final TextAlignment CENTER
      Specifies that all text in the parent object shall be aligned to the center of each character when displayed.
    • BASELINE

      public static final TextAlignment BASELINE
      Specifies that all text in the parent object shall be aligned to the baseline of each character when displayed.
    • BOTTOM

      public static final TextAlignment BOTTOM
      Specifies that all text in the parent object shall be aligned to the bottom of each character when displayed.
    • AUTO

      public static final TextAlignment AUTO
      Specifies that all text in the parent object shall be aligned automatically when displayed.
  • Method Details

    • values

      public static TextAlignment[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static TextAlignment valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • valueOf

      public static TextAlignment valueOf(int type)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      type - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getValue

      public int getValue()