Enum Class BreakType

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

public enum BreakType extends Enum<BreakType>
Specifies the possible types of break characters in a WordprocessingML document. The break type determines the next location where text shall be placed after this manual break is applied to the text contents
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 current break shall restart itself on the next column available on the current page when the document is displayed in page view.
    Specifies that the current break shall restart itself on the next page of the document when the document is displayed in page view.
    Specifies that the current break shall restart itself on the next line in the document when the document is displayed in page view.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
    static BreakType
    valueOf(int type)
    Returns the enum constant of this class with the specified name.
    static BreakType
    Returns the enum constant of this class with the specified name.
    static BreakType[]
    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

    • PAGE

      public static final BreakType PAGE
      Specifies that the current break shall restart itself on the next page of the document when the document is displayed in page view.
    • COLUMN

      public static final BreakType COLUMN
      Specifies that the current break shall restart itself on the next column available on the current page when the document is displayed in page view.

      If the current section is not divided into columns, or the column break occurs in the last column on the current page when displayed, then the restart location for text shall be the next page in the document.

    • TEXT_WRAPPING

      public static final BreakType TEXT_WRAPPING
      Specifies that the current break shall restart itself on the next line in the document when the document is displayed in page view. The determine of the next line shall be done subject to the value of the clear attribute on the specified break character.
  • Method Details

    • values

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