org.apache.poi.xssf.usermodel
Class XSSFFirstFooter
java.lang.Object
org.apache.poi.xssf.usermodel.extensions.XSSFHeaderFooter
org.apache.poi.xssf.usermodel.XSSFFirstFooter
- All Implemented Interfaces:
- org.apache.poi.ss.usermodel.Footer, HeaderFooter
public class XSSFFirstFooter
- extends XSSFHeaderFooter
- implements org.apache.poi.ss.usermodel.Footer
First page footer content. Corresponds to first printed page.
The first logical page in the sheet may not be printed, for example, if the print area is specified to
be a range such that it falls outside the first page's scope.
Constructor Summary |
protected |
XSSFFirstFooter(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter headerFooter)
Create an instance of XSSFFirstFooter from the supplied XML bean |
Method Summary |
java.lang.String |
getText()
Get the content text representing the footer |
void |
setText(java.lang.String text)
Set a text for the footer. |
Methods inherited from class org.apache.poi.xssf.usermodel.extensions.XSSFHeaderFooter |
areFieldsStripped, getCenter, getHeaderFooter, getLeft, getRight, getValue, setAreFieldsStripped, setCenter, setLeft, setRight, stripFields |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.poi.ss.usermodel.Footer |
getCenter, getLeft, getRight, setCenter, setLeft, setRight |
XSSFFirstFooter
protected XSSFFirstFooter(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter headerFooter)
- Create an instance of XSSFFirstFooter from the supplied XML bean
- Parameters:
headerFooter
- - See Also:
XSSFSheet.getFirstFooter()
getText
public java.lang.String getText()
- Get the content text representing the footer
- Specified by:
getText
in class XSSFHeaderFooter
- Returns:
- text
setText
public void setText(java.lang.String text)
- Set a text for the footer. If null unset the value.
- Specified by:
setText
in class XSSFHeaderFooter
- Parameters:
text
- - a string representing the footer.- See Also:
to see how to create a string with Header/Footer Formatting Syntax
Copyright 2008 The Apache Software Foundation or
its licensors, as applicable.