Enum Class LineSpacingRule

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

public enum LineSpacingRule extends Enum<LineSpacingRule>
Specifies the logic which shall be used to calculate the line spacing of the parent object when it is displayed in the document.
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 the height of the line shall be at least the value specified, but may be expanded to fit its content as needed.
    Specifies that the line spacing of the parent object shall be automatically determined by the size of its contents, with no predetermined minimum or maximum size.
    Specifies that the height of the line shall be exactly the value specified, regardless of the size of the contents If the contents are too large for the specified height, then they shall be clipped as necessary.
  • 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.
    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

    • AUTO

      public static final LineSpacingRule AUTO
      Specifies that the line spacing of the parent object shall be automatically determined by the size of its contents, with no predetermined minimum or maximum size.
    • EXACT

      public static final LineSpacingRule EXACT
      Specifies that the height of the line shall be exactly the value specified, regardless of the size of the contents If the contents are too large for the specified height, then they shall be clipped as necessary.
    • AT_LEAST

      public static final LineSpacingRule AT_LEAST
      Specifies that the height of the line shall be at least the value specified, but may be expanded to fit its content as needed.
  • Method Details

    • values

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