Package org.apache.poi.hwpf.model
Enum SubdocumentType
- java.lang.Object
-
- java.lang.Enum<SubdocumentType>
-
- org.apache.poi.hwpf.model.SubdocumentType
-
- All Implemented Interfaces:
Serializable
,Comparable<SubdocumentType>
@Internal public enum SubdocumentType extends Enum<SubdocumentType>
Document text parts that can have text pieces (CPs)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ANNOTATION
ENDNOTE
FOOTNOTE
HEADER
HEADER_TEXTBOX
MACRO
Deprecated.MAIN
TEXTBOX
-
Field Summary
Fields Modifier and Type Field Description static SubdocumentType[]
ORDERED
Array ofSubdocumentType
s ordered by document position and FIB field order
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SubdocumentType
valueOf(String name)
Returns the enum constant of this type with the specified name.static SubdocumentType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
MAIN
public static final SubdocumentType MAIN
-
FOOTNOTE
public static final SubdocumentType FOOTNOTE
-
HEADER
public static final SubdocumentType HEADER
-
MACRO
@Deprecated public static final SubdocumentType MACRO
Deprecated.
-
ANNOTATION
public static final SubdocumentType ANNOTATION
-
ENDNOTE
public static final SubdocumentType ENDNOTE
-
TEXTBOX
public static final SubdocumentType TEXTBOX
-
HEADER_TEXTBOX
public static final SubdocumentType HEADER_TEXTBOX
-
-
Field Detail
-
ORDERED
public static final SubdocumentType[] ORDERED
Array ofSubdocumentType
s ordered by document position and FIB field order
-
-
Method Detail
-
values
public static SubdocumentType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SubdocumentType c : SubdocumentType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SubdocumentType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
-