Package org.apache.poi.hwpf.usermodel
Class HeaderStories
java.lang.Object
org.apache.poi.hwpf.usermodel.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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Are fields currently being stripped from the text that thisHeaderStories
returns? Default is false, but can be changedDeprecated.3.8 beta 4Deprecated.3.8 beta 4Deprecated.3.8 beta 4Deprecated.3.8 beta 4Deprecated.3.8 beta 4Deprecated.3.8 beta 4Deprecated.3.8 beta 4getFooter
(int pageNumber) Returns the correct, defined footer for the given one based pageDeprecated.3.8 beta 4Deprecated.3.8 beta 4Deprecated.3.8 beta 4getHeader
(int pageNumber) Returns the correct, defined header for the given one based pageDeprecated.3.8 beta 4Deprecated.3.8 beta 4protected PlexOfCps
getRange()
void
setAreFieldsStripped
(boolean stripFields) Should fields (eg macros) be stripped from the text that this class returns? Default is not to strip.
-
Constructor Details
-
HeaderStories
-
-
Method Details
-
getFootnoteSeparator
Deprecated.3.8 beta 4 -
getFootnoteContSeparator
Deprecated.3.8 beta 4 -
getFootnoteContNote
Deprecated.3.8 beta 4 -
getEndnoteSeparator
Deprecated.3.8 beta 4 -
getEndnoteContSeparator
Deprecated.3.8 beta 4 -
getEndnoteContNote
Deprecated.3.8 beta 4 -
getFootnoteSeparatorSubrange
-
getFootnoteContSeparatorSubrange
-
getFootnoteContNoteSubrange
-
getEndnoteSeparatorSubrange
-
getEndnoteContSeparatorSubrange
-
getEndnoteContNoteSubrange
-
getEvenHeader
Deprecated.3.8 beta 4 -
getOddHeader
Deprecated.3.8 beta 4 -
getFirstHeader
Deprecated.3.8 beta 4 -
getEvenHeaderSubrange
-
getOddHeaderSubrange
-
getFirstHeaderSubrange
-
getHeader
Returns the correct, defined header for the given one based page- Parameters:
pageNumber
- The one based page number
-
getRange
-
getPlcfHdd
-
areFieldsStripped
public boolean areFieldsStripped()Are fields currently being stripped from the text that thisHeaderStories
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
-
-