Class HeaderStories

java.lang.Object
org.apache.poi.hwpf.usermodel.HeaderStories

public final class HeaderStories extends Object
A HeaderStory is a Header, a Footer, or footnote/endnote separator. All the Header Stories get stored in the same Range in the document, and this handles getting out all the individual parts. WARNING - you shouldn't change the headers or footers, as offsets are not yet updated!
  • Constructor Details

  • Method Details

    • getFootnoteSeparator

      @Deprecated public String getFootnoteSeparator()
      Deprecated.
      3.8 beta 4
    • getFootnoteContSeparator

      @Deprecated public String getFootnoteContSeparator()
      Deprecated.
      3.8 beta 4
    • getFootnoteContNote

      @Deprecated public String getFootnoteContNote()
      Deprecated.
      3.8 beta 4
    • getEndnoteSeparator

      @Deprecated public String getEndnoteSeparator()
      Deprecated.
      3.8 beta 4
    • getEndnoteContSeparator

      @Deprecated public String getEndnoteContSeparator()
      Deprecated.
      3.8 beta 4
    • getEndnoteContNote

      @Deprecated public String getEndnoteContNote()
      Deprecated.
      3.8 beta 4
    • getFootnoteSeparatorSubrange

      public Range getFootnoteSeparatorSubrange()
    • getFootnoteContSeparatorSubrange

      public Range getFootnoteContSeparatorSubrange()
    • getFootnoteContNoteSubrange

      public Range getFootnoteContNoteSubrange()
    • getEndnoteSeparatorSubrange

      public Range getEndnoteSeparatorSubrange()
    • getEndnoteContSeparatorSubrange

      public Range getEndnoteContSeparatorSubrange()
    • getEndnoteContNoteSubrange

      public Range getEndnoteContNoteSubrange()
    • getEvenHeader

      @Deprecated public String getEvenHeader()
      Deprecated.
      3.8 beta 4
    • getOddHeader

      @Deprecated public String getOddHeader()
      Deprecated.
      3.8 beta 4
    • getFirstHeader

      @Deprecated public String getFirstHeader()
      Deprecated.
      3.8 beta 4
    • getEvenHeaderSubrange

      public Range getEvenHeaderSubrange()
    • getOddHeaderSubrange

      public Range getOddHeaderSubrange()
    • getFirstHeaderSubrange

      public Range getFirstHeaderSubrange()
    • getHeader

      public String getHeader(int pageNumber)
      Returns the correct, defined header for the given one based page
      Parameters:
      pageNumber - The one based page number
    • getEvenFooter

      @Deprecated public String getEvenFooter()
      Deprecated.
      3.8 beta 4
    • getOddFooter

      @Deprecated public String getOddFooter()
      Deprecated.
      3.8 beta 4
    • getFirstFooter

      @Deprecated public String getFirstFooter()
      Deprecated.
      3.8 beta 4
    • getEvenFooterSubrange

      public Range getEvenFooterSubrange()
    • getOddFooterSubrange

      public Range getOddFooterSubrange()
    • getFirstFooterSubrange

      public Range getFirstFooterSubrange()
    • getFooter

      public String getFooter(int pageNumber)
      Returns the correct, defined footer for the given one based page
      Parameters:
      pageNumber - The one based page number
    • getRange

      public Range getRange()
    • getPlcfHdd

      protected PlexOfCps getPlcfHdd()
    • areFieldsStripped

      public boolean areFieldsStripped()
      Are fields currently being stripped from the text that this HeaderStories returns? Default is false, but can be changed
    • setAreFieldsStripped

      public void setAreFieldsStripped(boolean stripFields)
      Should fields (eg macros) be stripped from the text that this class returns? Default is not to strip.
      Parameters:
      stripFields -