|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.usermodel.HeaderFooter
public abstract class HeaderFooter
Common class for HSSFHeader
and
HSSFFooter
.
Nested Class Summary | |
---|---|
static class |
HeaderFooter.Field
Represents a special field in a header or footer, eg the page number |
static class |
HeaderFooter.PairField
A special field that normally comes in a pair, eg turn on underline / turn off underline |
Field Summary | |
---|---|
static HeaderFooter.PairField |
BOLD_FIELD
|
protected java.lang.String |
center
|
static HeaderFooter.Field |
DATE_FIELD
|
static HeaderFooter.PairField |
DOUBLE_UNDERLINE_FIELD
|
static HeaderFooter.Field |
FILE_FIELD
|
static HeaderFooter.Field |
FULL_FILE_FIELD
|
static HeaderFooter.PairField |
ITALIC_FIELD
|
protected java.lang.String |
left
|
static HeaderFooter.Field |
NUM_PAGES_FIELD
|
static HeaderFooter.Field |
PAGE_FIELD
|
static HeaderFooter.Field |
PICTURE_FIELD
|
protected java.lang.String |
right
|
static HeaderFooter.Field |
SHEET_NAME_FIELD
|
static HeaderFooter.PairField |
STRIKETHROUGH_FIELD
|
static HeaderFooter.PairField |
SUBSCRIPT_FIELD
|
static HeaderFooter.PairField |
SUPERSCRIPT_FIELD
|
static HeaderFooter.Field |
TIME_FIELD
|
static HeaderFooter.PairField |
UNDERLINE_FIELD
|
Constructor Summary | |
---|---|
protected |
HeaderFooter(java.lang.String text)
|
Method Summary | |
---|---|
boolean |
areFieldsStripped()
Are fields currently being stripped from the text that this HeaderStories returns?
Default is false, but can be changed |
static java.lang.String |
date()
Returns the string representing the current date |
static java.lang.String |
endBold()
Returns the string representing the end bold |
static java.lang.String |
endDoubleUnderline()
Returns the string representing the end double underline |
static java.lang.String |
endUnderline()
Returns the string representing the end underline |
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 or footer. |
java.lang.String |
getLeft()
Get the left side of the header or footer. |
java.lang.String |
getRight()
Get the right side of the header or footer. |
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 |
setAreFieldsStripped(boolean stripFields)
Should fields (eg macros) be stripped from the text that this class returns? Default is not to strip. |
abstract void |
setCenter(java.lang.String newCenter)
|
abstract void |
setLeft(java.lang.String newLeft)
|
abstract void |
setRight(java.lang.String newRight)
|
static java.lang.String |
startBold()
Returns the string representing the start bold |
static java.lang.String |
startDoubleUnderline()
Returns the string representing the start double underline |
static java.lang.String |
startUnderline()
Returns the string representing the start underline |
static java.lang.String |
stripFields(java.lang.String text)
Removes any fields (eg macros, page markers etc) from the 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 |
Field Detail |
---|
protected java.lang.String left
protected java.lang.String center
protected java.lang.String right
public static final HeaderFooter.Field SHEET_NAME_FIELD
public static final HeaderFooter.Field DATE_FIELD
public static final HeaderFooter.Field FILE_FIELD
public static final HeaderFooter.Field FULL_FILE_FIELD
public static final HeaderFooter.Field PAGE_FIELD
public static final HeaderFooter.Field TIME_FIELD
public static final HeaderFooter.Field NUM_PAGES_FIELD
public static final HeaderFooter.Field PICTURE_FIELD
public static final HeaderFooter.PairField BOLD_FIELD
public static final HeaderFooter.PairField ITALIC_FIELD
public static final HeaderFooter.PairField STRIKETHROUGH_FIELD
public static final HeaderFooter.PairField SUBSCRIPT_FIELD
public static final HeaderFooter.PairField SUPERSCRIPT_FIELD
public static final HeaderFooter.PairField UNDERLINE_FIELD
public static final HeaderFooter.PairField DOUBLE_UNDERLINE_FIELD
Constructor Detail |
---|
protected HeaderFooter(java.lang.String text)
Method Detail |
---|
public java.lang.String getLeft()
public abstract void setLeft(java.lang.String newLeft)
public java.lang.String getCenter()
public abstract void setCenter(java.lang.String newCenter)
public java.lang.String getRight()
public abstract 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, one of regular, italic, bold, italic bold or bold italic
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()
public static java.lang.String startBold()
public static java.lang.String endBold()
public static java.lang.String startUnderline()
public static java.lang.String endUnderline()
public static java.lang.String startDoubleUnderline()
public static java.lang.String endDoubleUnderline()
public static java.lang.String stripFields(java.lang.String text)
public boolean areFieldsStripped()
HeaderStories
returns?
Default is false, but can be changed
public void setAreFieldsStripped(boolean stripFields)
stripFields
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |