|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFHeader
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.
Constructor Summary | |
protected |
HSSFHeader(HeaderRecord headerRecord)
Constructor. |
Method Summary | |
static java.lang.String |
date()
Returns the string representing the current date |
static java.lang.String |
file()
Returns the string representing the current file name |
static java.lang.String |
font(java.lang.String font,
java.lang.String style)
Returns the string that represents the change in font. |
static java.lang.String |
fontSize(short size)
Returns the string that represents the change in font size. |
java.lang.String |
getCenter()
Get the center of the header. |
java.lang.String |
getLeft()
Get the left side of the header. |
java.lang.String |
getRight()
Get the right side of the header. |
static java.lang.String |
numPages()
Returns the string representing the number of pages. |
static java.lang.String |
page()
Returns the string representing the current page number |
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. |
static java.lang.String |
tab()
Returns the string representing the current tab (sheet) name |
static java.lang.String |
time()
Returns the string representing the current time |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected HSSFHeader(HeaderRecord headerRecord)
headerRecord
- Header record to create the header withMethod Detail |
public java.lang.String getLeft()
public void setLeft(java.lang.String newLeft)
public java.lang.String getCenter()
public void setCenter(java.lang.String newCenter)
public java.lang.String getRight()
public void setRight(java.lang.String newRight)
public static java.lang.String fontSize(short size)
size
- the new font size
public static java.lang.String font(java.lang.String font, java.lang.String style)
font
- the new fontstyle
- the fonts style
public static java.lang.String page()
public static java.lang.String numPages()
public static java.lang.String date()
public static java.lang.String time()
public static java.lang.String file()
public static java.lang.String tab()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |