|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hwpf.usermodel.HeaderStories
public class HeaderStories
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 |
---|
public HeaderStories(HWPFDocument doc)
Method Detail |
---|
public java.lang.String getFootnoteSeparator()
public java.lang.String getFootnoteContSeparator()
public java.lang.String getFootnoteContNote()
public java.lang.String getEndnoteSeparator()
public java.lang.String getEndnoteContSeparator()
public java.lang.String getEndnoteContNote()
public java.lang.String getEvenHeader()
public java.lang.String getOddHeader()
public java.lang.String getFirstHeader()
public java.lang.String getHeader(int pageNumber)
pageNumber
- The one based page number
public java.lang.String getEvenFooter()
public java.lang.String getOddFooter()
public java.lang.String getFirstFooter()
public java.lang.String getFooter(int pageNumber)
pageNumber
- The one based page number
public Range getRange()
protected PlexOfCps getPlcfHdd()
public boolean areFieldsStripped()
HeaderStories
returns?
Default is false, but can be changed
public void setAreFieldsStripped(boolean stripFields)
stripFields
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |