loci.poi.hssf.usermodel

Class HSSFFooter

java.lang.Object

loci.poi.hssf.usermodel.HSSFFooter

public class HSSFFooter
extends Object

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.

Author:

Shawn Laubach (slaubach at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String	center
(package private) FooterRecord	footerRecord
(package private) String	left
(package private) String	right

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HSSFFooter(FooterRecord footerRecord) Constructor.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

footerRecord

FooterRecord footerRecord

left

String left

center

String center

right

String right

Constructor Detail

HSSFFooter

protected HSSFFooter(FooterRecord footerRecord)

Constructor. Creates a new footer interface from a footer record

Parameters:

footerRecord - Footer record to create the footer with

Method Detail

getLeft

public String getLeft()

Get the left side of the footer.

Returns:

The string representing the left side.

setLeft

public void setLeft(String newLeft)

Sets the left string.

Parameters:

newLeft - The string to set as the left side.

getCenter

public String getCenter()

Get the center of the footer.

Returns:

The string representing the center.

setCenter

public void setCenter(String newCenter)

Sets the center string.

Parameters:

newCenter - The string to set as the center.

getRight

public String getRight()

Get the right side of the footer.

Returns:

The string representing the right side.

setRight

public void setRight(String newRight)

Sets the right string.

Parameters:

newRight - The string to set as the right side.

createFooterString

private void createFooterString()

Creates the complete footer string based on the left, center, and middle strings.

fontSize

public static String fontSize(short size)

Returns the string that represents the change in font size.

Parameters:

size - the new font size

Returns:

The special string to represent a new font size

font

public static String font(String font,
          String style)

Returns the string that represents the change in font.

Parameters:

font - the new font

style - the fonts style

Returns:

The special string to represent a new font size

page

public static String page()

Returns the string representing the current page number

Returns:

The special string for page number

numPages

public static String numPages()

Returns the string representing the number of pages.

Returns:

The special string for the number of pages

date

public static String date()

Returns the string representing the current date

Returns:

The special string for the date

time

public static String time()

Returns the string representing the current time

Returns:

The special string for the time

file

public static String file()

Returns the string representing the current file name

Returns:

The special string for the file name

tab

public static String tab()

Returns the string representing the current tab (sheet) name

Returns:

The special string for tab name

startUnderline

public static String startUnderline()

Returns the string representing the start underline

Returns:

The special string for start underline

endUnderline

public static String endUnderline()

Returns the string representing the end underline

Returns:

The special string for end underline

startDoubleUnderline

public static String startDoubleUnderline()

Returns the string representing the start double underline

Returns:

The special string for start double underline

endDoubleUnderline

public static String endDoubleUnderline()

Returns the string representing the end double underline

Returns:

The special string for end double underline