|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Object java.lang.Enum<BreakType> org.apache.poi.xwpf.usermodel.BreakType
public 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
Enum Constant Summary | |
---|---|
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. |
|
PAGE
Specifies that the current break shall restart itself on the next page of the document when the document is displayed in page view. |
|
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. |
Method Summary | |
---|---|
int |
getValue()
|
static BreakType |
valueOf(int type)
|
static BreakType |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static BreakType[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final BreakType PAGE
public static final BreakType COLUMN
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.
public static final BreakType TEXT_WRAPPING
Method Detail |
---|
public static BreakType[] values()
for (BreakType c : BreakType.values()) System.out.println(c);
public static BreakType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic int getValue()
public static BreakType valueOf(int type)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |