HeaderFooterPolicy (docx4j-core 11.2.9 API)

java.lang.Object

org.docx4j.model.structure.HeaderFooterPolicy

public class HeaderFooterPolicy
extends java.lang.Object

Field Summary

Fields

Modifier and Type Field Description

protected static org.slf4j.Logger log

Constructor Summary

Constructors
Constructor	Description
`HeaderFooterPolicy(SectPr sectPr, HeaderFooterPolicy previousHF, RelationshipsPart rels, BooleanDefaultTrue evenAndOddHeaders)`	Figures out the policy for the given section, and creates any header and footer objects as required.

Method Summary

Modifier and Type	Method	Description
`FooterPart`	`getDefaultFooter()`	If an even footer is present this is the odd footer otherwise it is both, even and odd footer
`HeaderPart`	`getDefaultHeader()`	If an even header is present this is the odd header otherwise it is both, even and odd header
`FooterPart`	`getEvenFooter()`
`HeaderPart`	`getEvenHeader()`
`FooterPart`	`getFirstFooter()`
`HeaderPart`	`getFirstHeader()`
`FooterPart`	`getFooter(int pageNumber)`	Get the footer that applies to the given (1 based) page.
`HeaderPart`	`getHeader(int pageNumber)`	Get the header that applies to the given (1 based) page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- log
  
  protected static org.slf4j.Logger log
Constructor Details
- HeaderFooterPolicy
  
  public HeaderFooterPolicy(SectPr sectPr, HeaderFooterPolicy previousHF, RelationshipsPart rels, BooleanDefaultTrue evenAndOddHeaders)
  
  Figures out the policy for the given section, and creates any header and footer objects as required.
Method Details
- getFirstHeader
  
  public HeaderPart getFirstHeader()
- getFirstFooter
  
  public FooterPart getFirstFooter()
- getEvenHeader
  
  public HeaderPart getEvenHeader()
- getEvenFooter
  
  public FooterPart getEvenFooter()
- getDefaultHeader
  
  public HeaderPart getDefaultHeader()
  
  If an even header is present this is the odd header otherwise it is both, even and odd header
- getDefaultFooter
  
  public FooterPart getDefaultFooter()
  
  If an even footer is present this is the odd footer otherwise it is both, even and odd footer
- getHeader
  
  public HeaderPart getHeader(int pageNumber)
  
  Get the header that applies to the given (1 based) page.
  
  Parameters:
  
  pageNumber - The one based page number
- getFooter
  
  public FooterPart getFooter(int pageNumber)
  
  Get the footer that applies to the given (1 based) page.
  
  Parameters:
  
  pageNumber - The one based page number