Enum Class BreakClear

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

public enum BreakClear extends Enum<BreakClear>
Specifies the set of possible restart locations which may be used as to determine the next available line when a break's type attribute has a value of textWrapping.
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 text wrapping break shall advance the text to the next line in the WordprocessingML document which spans the full width of the line.
    Specifies that the text wrapping break shall behave as follows: If this line is broken into multiple regions (a floating object in the center of the page has text wrapping on both sides: If this is the leftmost region of text flow on this line, advance the text to the next position on the line Otherwise, treat this as a text wrapping break of type all.
    Specifies that the text wrapping break shall advance the text to the next line in the WordprocessingML document, regardless of its position left to right or the presence of any floating objects which intersect with the line,
    Specifies that the text wrapping break shall behave as follows: If this line is broken into multiple regions (a floating object in the center of the page has text wrapping on both sides: If this is the rightmost region of text flow on this line, advance the text to the next position on the next line Otherwise, treat this as a text wrapping break of type all.
  • Method Summary

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

    • NONE

      public static final BreakClear NONE
      Specifies that the text wrapping break shall advance the text to the next line in the WordprocessingML document, regardless of its position left to right or the presence of any floating objects which intersect with the line,

      This is the setting for a typical line break in a document.

    • LEFT

      public static final BreakClear LEFT
      Specifies that the text wrapping break shall behave as follows:
      • If this line is broken into multiple regions (a floating object in the center of the page has text wrapping on both sides:
        • If this is the leftmost region of text flow on this line, advance the text to the next position on the line
        • Otherwise, treat this as a text wrapping break of type all.
      • If this line is not broken into multiple regions, then treat this break as a text wrapping break of type none.
    • If the parent paragraph is right to left, then these behaviors are also reversed.
    • ALL

      public static final BreakClear ALL
      Specifies that the text wrapping break shall advance the text to the next line in the WordprocessingML document which spans the full width of the line.
  • Method Details

    • values

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