Enum Class VerticalAlign

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

public enum VerticalAlign extends Enum<VerticalAlign>
Specifies possible values for the alignment of the contents of this run in relation to the default appearance of the run's text. This allows the text to be repositioned as subscript or superscript without altering the font size of the run properties.
Author:
Gisella Bronzetti
  • Enum Constant Details

    • BASELINE

      public static final VerticalAlign BASELINE
      Specifies that the text in the parent run shall be located at the baseline and presented in the same size as surrounding text.
    • SUPERSCRIPT

      public static final VerticalAlign SUPERSCRIPT
      Specifies that this text should be subscript. This setting shall lower the text in this run below the baseline and change it to a smaller size, if a smaller size is available.
    • SUBSCRIPT

      public static final VerticalAlign SUBSCRIPT
      Specifies that this text should be superscript. This setting shall raise the text in this run above the baseline and change it to a smaller size, if a smaller size is available.
  • Method Details

    • values

      public static VerticalAlign[] 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 VerticalAlign 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 VerticalAlign 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()