|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.hwpf.usermodel.HeaderStories
public final 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()
Deprecated. |
Range |
getEndnoteContNoteSubrange()
|
java.lang.String |
getEndnoteContSeparator()
Deprecated. |
Range |
getEndnoteContSeparatorSubrange()
|
java.lang.String |
getEndnoteSeparator()
Deprecated. |
Range |
getEndnoteSeparatorSubrange()
|
java.lang.String |
getEvenFooter()
Deprecated. |
Range |
getEvenFooterSubrange()
|
java.lang.String |
getEvenHeader()
Deprecated. |
Range |
getEvenHeaderSubrange()
|
java.lang.String |
getFirstFooter()
Deprecated. |
Range |
getFirstFooterSubrange()
|
java.lang.String |
getFirstHeader()
Deprecated. |
Range |
getFirstHeaderSubrange()
|
java.lang.String |
getFooter(int pageNumber)
Returns the correct, defined footer for the given one based page |
java.lang.String |
getFootnoteContNote()
Deprecated. |
Range |
getFootnoteContNoteSubrange()
|
java.lang.String |
getFootnoteContSeparator()
Deprecated. |
Range |
getFootnoteContSeparatorSubrange()
|
java.lang.String |
getFootnoteSeparator()
Deprecated. |
Range |
getFootnoteSeparatorSubrange()
|
java.lang.String |
getHeader(int pageNumber)
Returns the correct, defined header for the given one based page |
java.lang.String |
getOddFooter()
Deprecated. |
Range |
getOddFooterSubrange()
|
java.lang.String |
getOddHeader()
Deprecated. |
Range |
getOddHeaderSubrange()
|
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 |
---|
@Deprecated public java.lang.String getFootnoteSeparator()
@Deprecated public java.lang.String getFootnoteContSeparator()
@Deprecated public java.lang.String getFootnoteContNote()
@Deprecated public java.lang.String getEndnoteSeparator()
@Deprecated public java.lang.String getEndnoteContSeparator()
@Deprecated public java.lang.String getEndnoteContNote()
public Range getFootnoteSeparatorSubrange()
public Range getFootnoteContSeparatorSubrange()
public Range getFootnoteContNoteSubrange()
public Range getEndnoteSeparatorSubrange()
public Range getEndnoteContSeparatorSubrange()
public Range getEndnoteContNoteSubrange()
@Deprecated public java.lang.String getEvenHeader()
@Deprecated public java.lang.String getOddHeader()
@Deprecated public java.lang.String getFirstHeader()
public Range getEvenHeaderSubrange()
public Range getOddHeaderSubrange()
public Range getFirstHeaderSubrange()
public java.lang.String getHeader(int pageNumber)
pageNumber
- The one based page number@Deprecated public java.lang.String getEvenFooter()
@Deprecated public java.lang.String getOddFooter()
@Deprecated public java.lang.String getFirstFooter()
public Range getEvenFooterSubrange()
public Range getOddFooterSubrange()
public Range getFirstFooterSubrange()
public java.lang.String getFooter(int pageNumber)
pageNumber
- The one based page numberpublic 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 |