Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public final Class HSSFFooter

extends HeaderFooter
implements Footer
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.Footer, org.apache.poi.ss.usermodel.HeaderFooter
Imports
org.apache.poi.hssf.record.FooterRecord, org.apache.poi.hssf.record.aggregates.PageSettingsBlock, org.apache.poi.ss.usermodel.Footer

Class to read and manipulate the footer.

The footer works by having a left, center, and right side. The total cannot be more that 255 bytes long. One uses this class by getting the HSSFFooter from HSSFSheet and then getting or setting the left, center, and right side. For special things (such as page numbers and date), one can use a the methods that return the characters used to represent these. One can also change the fonts by using similar methods.

Field Summary

Modifier and TypeField and Description
private final PageSettingsBlock

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
protected String
protected void
setHeaderFooterText(String
the new header footer text (contains mark-up tags). Possibly empty string never null
text
)

Implements abstract org.apache.poi.hssf.usermodel.HeaderFooter.setHeaderFooterText.

Inherited from org.apache.poi.hssf.usermodel.HeaderFooter:
dateendBoldendDoubleUnderlineendUnderlinefilefontfontSizegetCentergetLeftgetRightnumPagespagesetCentersetLeftsetRightstartBoldstartDoubleUnderlinestartUnderlinestripFieldstabtime

Field Detail

_psbback to summary
private final PageSettingsBlock _psb

Constructor Detail

HSSFFooterback to summary
protected HSSFFooter(PageSettingsBlock psb)

Method Detail

getRawTextback to summary
protected String getRawText()

Implements abstract org.apache.poi.hssf.usermodel.HeaderFooter.getRawText.

Returns:String

Doc from org.apache.poi.hssf.usermodel.HeaderFooter.getRawText.

the internal text representation (combining center, left and right parts). Possibly empty string if no header or footer is set. Never null.

setHeaderFooterTextback to summary
protected void setHeaderFooterText(String text)

Implements abstract org.apache.poi.hssf.usermodel.HeaderFooter.setHeaderFooterText.

Parameters
text:String

Doc from org.apache.poi.hssf.usermodel.HeaderFooter.setHeaderFooterText.

the new header footer text (contains mark-up tags). Possibly empty string never null

Annotations
@Override