Package org.apache.poi.wp.usermodel
Enum Class HeaderFooterType
- All Implemented Interfaces:
Serializable
,Comparable<HeaderFooterType>
,Constable
- Since:
- POI v3.16 beta 1
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThis is the default header or Footer, It is displayed on every page where a more specific header or footer is not specified.This is an even page header or footer, it is displayed on even pages that are not the first page of the section.This is a first page header or footer It is displayed on the first page of the section. -
Method Summary
Modifier and TypeMethodDescriptionstatic HeaderFooterType
forInt
(int i) int
toInt()
static HeaderFooterType
Returns the enum constant of this class with the specified name.static HeaderFooterType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
DEFAULT
This is the default header or Footer, It is displayed on every page where a more specific header or footer is not specified. It is always displayed on ODD pages that are not the first page of the section. -
EVEN
This is an even page header or footer, it is displayed on even pages that are not the first page of the section. -
FIRST
This is a first page header or footer It is displayed on the first page of the section.
-
-
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
-
toInt
public int toInt() -
forInt
-