org.apache.poi.hwpf.usermodel
Class HeaderStories

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

public class HeaderStories
extends java.lang.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 Summary
HeaderStories(HWPFDocument doc)
           
 
Method Summary
 boolean areFieldsStripped()
          Are fields currently being stripped from the text that this HeaderStories returns? Default is false, but can be changed
 java.lang.String getEndnoteContNote()
           
 java.lang.String getEndnoteContSeparator()
           
 java.lang.String getEndnoteSeparator()
           
 java.lang.String getEvenFooter()
           
 java.lang.String getEvenHeader()
           
 java.lang.String getFirstFooter()
           
 java.lang.String getFirstHeader()
           
 java.lang.String getFooter(int pageNumber)
          Returns the correct, defined footer for the given one based page
 java.lang.String getFootnoteContNote()
           
 java.lang.String getFootnoteContSeparator()
           
 java.lang.String getFootnoteSeparator()
           
 java.lang.String getHeader(int pageNumber)
          Returns the correct, defined header for the given one based page
 java.lang.String getOddFooter()
           
 java.lang.String getOddHeader()
           
protected  PlexOfCps getPlcfHdd()
           
 Range getRange()
           
 void setAreFieldsStripped(boolean stripFields)
          Should fields (eg macros) be stripped from the text that this class returns? Default is not to strip.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeaderStories

public HeaderStories(HWPFDocument doc)
Method Detail

getFootnoteSeparator

public java.lang.String getFootnoteSeparator()

getFootnoteContSeparator

public java.lang.String getFootnoteContSeparator()

getFootnoteContNote

public java.lang.String getFootnoteContNote()

getEndnoteSeparator

public java.lang.String getEndnoteSeparator()

getEndnoteContSeparator

public java.lang.String getEndnoteContSeparator()

getEndnoteContNote

public java.lang.String getEndnoteContNote()

getEvenHeader

public java.lang.String getEvenHeader()

getOddHeader

public java.lang.String getOddHeader()

getFirstHeader

public java.lang.String getFirstHeader()

getHeader

public java.lang.String getHeader(int pageNumber)
Returns the correct, defined header for the given one based page

Parameters:
pageNumber - The one based page number
Returns:

getEvenFooter

public java.lang.String getEvenFooter()

getOddFooter

public java.lang.String getOddFooter()

getFirstFooter

public java.lang.String getFirstFooter()

getFooter

public java.lang.String getFooter(int pageNumber)
Returns the correct, defined footer for the given one based page

Parameters:
pageNumber - The one based page number
Returns:

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 -


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.