Package org.apache.poi.xwpf.usermodel
Enum Class BreakClear
- All Implemented Interfaces:
Serializable
,Comparable<BreakClear>
,Constable
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 ConstantsEnum ConstantDescriptionSpecifies 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 TypeMethodDescriptionint
getValue()
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[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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
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.
- If this line is broken into multiple regions (a floating object in
the center of the page has text wrapping on both sides:
-
RIGHT
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.
- 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 beha viors are also reversed.
- If this line is broken into multiple regions (a floating object in
the center of the page has text wrapping on both sides:
-
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
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
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 nameNullPointerException
- if the argument is null
-
valueOf
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 nameNullPointerException
- if the argument is null
-
getValue
public int getValue()
-