Enum Class HeaderFooterType

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

public enum HeaderFooterType extends Enum<HeaderFooterType>
Since:
POI v3.16 beta 1
  • Enum Constant Details

    • DEFAULT

      public static final HeaderFooterType 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

      public static final HeaderFooterType 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

      public static final HeaderFooterType FIRST
      This is a first page header or footer It is displayed on the first page of the section.
  • Method Details

    • values

      public static HeaderFooterType[] 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 HeaderFooterType 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
    • toInt

      public int toInt()
    • forInt

      public static HeaderFooterType forInt(int i)