public class HSSFFooter extends Object
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.
Modifier and Type | Field and Description |
---|---|
(package private) String |
center |
(package private) FooterRecord |
footerRecord |
(package private) String |
left |
(package private) String |
right |
Modifier | Constructor and Description |
---|---|
protected |
HSSFFooter(FooterRecord footerRecord)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
private void |
createFooterString()
Creates the complete footer string based on the left, center, and middle
strings.
|
static String |
date()
Returns the string representing the current date
|
static String |
endDoubleUnderline()
Returns the string representing the end double underline
|
static String |
endUnderline()
Returns the string representing the end underline
|
static String |
file()
Returns the string representing the current file name
|
static String |
font(String font,
String style)
Returns the string that represents the change in font.
|
static String |
fontSize(short size)
Returns the string that represents the change in font size.
|
String |
getCenter()
Get the center of the footer.
|
String |
getLeft()
Get the left side of the footer.
|
String |
getRight()
Get the right side of the footer.
|
static String |
numPages()
Returns the string representing the number of pages.
|
static String |
page()
Returns the string representing the current page number
|
void |
setCenter(String newCenter)
Sets the center string.
|
void |
setLeft(String newLeft)
Sets the left string.
|
void |
setRight(String newRight)
Sets the right string.
|
static String |
startDoubleUnderline()
Returns the string representing the start double underline
|
static String |
startUnderline()
Returns the string representing the start underline
|
static String |
tab()
Returns the string representing the current tab (sheet) name
|
static String |
time()
Returns the string representing the current time
|
FooterRecord footerRecord
String left
String center
String right
protected HSSFFooter(FooterRecord footerRecord)
footerRecord
- Footer record to create the footer withpublic String getLeft()
public void setLeft(String newLeft)
newLeft
- The string to set as the left side.public String getCenter()
public void setCenter(String newCenter)
newCenter
- The string to set as the center.public String getRight()
public void setRight(String newRight)
newRight
- The string to set as the right side.private void createFooterString()
public static String fontSize(short size)
size
- the new font sizepublic static String font(String font, String style)
font
- the new fontstyle
- the fonts stylepublic static String page()
public static String numPages()
public static String date()
public static String time()
public static String file()
public static String tab()
public static String startUnderline()
public static String endUnderline()
public static String startDoubleUnderline()
public static String endDoubleUnderline()
Copyright © 2016 Open Microscopy Environment