Package loci.poi.hssf.usermodel
Class HSSFHeader
java.lang.Object
loci.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.
- Author:
- Shawn Laubach (slaubach at apache dot org)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Stringdate()Returns the string representing the current datestatic StringReturns the string representing the end double underlinestatic StringReturns the string representing the end underlinestatic Stringfile()Returns the string representing the current file namestatic StringReturns the string that represents the change in font.static StringfontSize(short size) Returns the string that represents the change in font size.Get the center of the header.getLeft()Get the left side of the header.getRight()Get the right side of the header.static StringnumPages()Returns the string representing the number of pages.static Stringpage()Returns the string representing the current page numbervoidSets the center string.voidSets the left string.voidSets the right string.static StringReturns the string representing the start double underlinestatic StringReturns the string representing the start underlinestatic Stringtab()Returns the string representing the current tab (sheet) namestatic Stringtime()Returns the string representing the current time
-
Constructor Details
-
HSSFHeader
Constructor. Creates a new header interface from a header record- Parameters:
headerRecord- Header record to create the header with
-
-
Method Details
-
getLeft
Get the left side of the header.- Returns:
- The string representing the left side.
-
setLeft
Sets the left string.- Parameters:
newLeft- The string to set as the left side.
-
getCenter
Get the center of the header.- Returns:
- The string representing the center.
-
setCenter
Sets the center string.- Parameters:
newCenter- The string to set as the center.
-
getRight
Get the right side of the header.- Returns:
- The string representing the right side.
-
setRight
Sets the right string.- Parameters:
newRight- The string to set as the right side.
-
fontSize
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
Returns the string that represents the change in font.- Parameters:
font- the new fontstyle- the fonts style- Returns:
- The special string to represent a new font size
-
page
Returns the string representing the current page number- Returns:
- The special string for page number
-
numPages
Returns the string representing the number of pages.- Returns:
- The special string for the number of pages
-
date
Returns the string representing the current date- Returns:
- The special string for the date
-
time
Returns the string representing the current time- Returns:
- The special string for the time
-
file
Returns the string representing the current file name- Returns:
- The special string for the file name
-
tab
Returns the string representing the current tab (sheet) name- Returns:
- The special string for tab name
-
startUnderline
Returns the string representing the start underline- Returns:
- The special string for start underline
-
endUnderline
Returns the string representing the end underline- Returns:
- The special string for end underline
-
startDoubleUnderline
Returns the string representing the start double underline- Returns:
- The special string for start double underline
-
endDoubleUnderline
Returns the string representing the end double underline- Returns:
- The special string for end double underline
-