org.apache.poi.hssf.usermodel
Class HSSFHeader
java.lang.Object
org.apache.poi.hssf.usermodel.HeaderFooter
org.apache.poi.hssf.usermodel.HSSFHeader
- All Implemented Interfaces:
- Header, HeaderFooter
public class HSSFHeader
- extends HeaderFooter
- implements Header
Class to read and manipulate the header.
The header 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 HSSFHeader
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.
- Author:
- Shawn Laubach (slaubach at apache dot org)
Fields inherited from class org.apache.poi.hssf.usermodel.HeaderFooter |
BOLD_FIELD, center, DATE_FIELD, DOUBLE_UNDERLINE_FIELD, FILE_FIELD, FULL_FILE_FIELD, ITALIC_FIELD, left, NUM_PAGES_FIELD, PAGE_FIELD, PICTURE_FIELD, right, SHEET_NAME_FIELD, STRIKETHROUGH_FIELD, SUBSCRIPT_FIELD, SUPERSCRIPT_FIELD, TIME_FIELD, UNDERLINE_FIELD |
Method Summary |
protected java.lang.String |
getRawHeader()
|
void |
setCenter(java.lang.String newCenter)
Sets the center string. |
void |
setLeft(java.lang.String newLeft)
Sets the left string. |
void |
setRight(java.lang.String newRight)
Sets the right string. |
Methods inherited from class org.apache.poi.hssf.usermodel.HeaderFooter |
areFieldsStripped, date, endBold, endDoubleUnderline, endUnderline, file, font, fontSize, getCenter, getLeft, getRight, numPages, page, setAreFieldsStripped, startBold, startDoubleUnderline, startUnderline, stripFields, tab, time |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
HSSFHeader
protected HSSFHeader(HeaderRecord headerRecord)
- Constructor. Creates a new header interface from a header record
- Parameters:
headerRecord
- Header record to create the header with
setLeft
public void setLeft(java.lang.String newLeft)
- Sets the left string.
- Specified by:
setLeft
in interface Header
- Specified by:
setLeft
in interface HeaderFooter
- Specified by:
setLeft
in class HeaderFooter
- Parameters:
newLeft
- The string to set as the left side.
setCenter
public void setCenter(java.lang.String newCenter)
- Sets the center string.
- Specified by:
setCenter
in interface Header
- Specified by:
setCenter
in interface HeaderFooter
- Specified by:
setCenter
in class HeaderFooter
- Parameters:
newCenter
- The string to set as the center.
setRight
public void setRight(java.lang.String newRight)
- Sets the right string.
- Specified by:
setRight
in interface Header
- Specified by:
setRight
in interface HeaderFooter
- Specified by:
setRight
in class HeaderFooter
- Parameters:
newRight
- The string to set as the right side.
getRawHeader
protected java.lang.String getRawHeader()
Copyright 2009 The Apache Software Foundation or
its licensors, as applicable.