Package org.docx4j.model.structure

Class HeaderFooterPolicy

java.lang.Object
org.docx4j.model.structure.HeaderFooterPolicy
public class HeaderFooterPolicy extends Object

  • Field Details

    • log

      protected static org.slf4j.Logger log

    • firstHeaderActive

      private HeaderPart firstHeaderActive

    • firstHeader

      private HeaderPart firstHeader

    • firstFooterActive

      private FooterPart firstFooterActive

    • firstFooter

      private FooterPart firstFooter

    • evenHeader

      private HeaderPart evenHeader

    • evenFooter

      private FooterPart evenFooter

    • defaultHeader

      private HeaderPart defaultHeader

    • defaultFooter

      private FooterPart defaultFooter

    • dummyHeaderFooterMutex

      private static Object dummyHeaderFooterMutex

    • dummyHeader

      private static HeaderPart dummyHeader

    • dummyFooter

      private static FooterPart dummyFooter

  • Constructor Details

    • HeaderFooterPolicy

      private HeaderFooterPolicy()

    • 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

    • getDummyHeader

      private HeaderPart getDummyHeader()

    • getDummyFooter

      private FooterPart getDummyFooter()

    • createDummyHeaderFooter

      private void createDummyHeaderFooter()

    • setHeaderReferences

      private void setHeaderReferences(List<CTRel> hdrFtrRefs, RelationshipsPart rels, BooleanDefaultTrue titlePage)

    • setFooterReferences

      private void setFooterReferences(List<CTRel> hdrFtrRefs, RelationshipsPart rels, BooleanDefaultTrue titlePage)

    • 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