com.lowagie.text

Class HeaderFooter

Implemented Interfaces:
Element, MarkupAttributes
Known Direct Subclasses:
RtfHeaderFooter, RtfHeaderFooter, RtfHeaderFooterGroup, RtfHeaderFooters

public class HeaderFooter
extends Rectangle
implements MarkupAttributes

A HeaderFooter-object is a Rectangle with text that can be put above and/or below every page.

Example:

 HeaderFooter header = new HeaderFooter(new Phrase("This is a header."), false);
 HeaderFooter footer = new HeaderFooter(new Phrase("This is page "), new Phrase("."));
 document.setHeader(header);
 document.setFooter(footer);
 

Field Summary

private Phrase
after
This is the Phrase that comes after the pagenumber.
private int
alignment
This is alignment of the header/footer.
private Phrase
before
This is the Phrase that comes before the pagenumber.
private boolean
numbered
Does the page contain a pagenumber?
private int
pageN
This is number of the page.

Fields inherited from class com.lowagie.text.Rectangle

BOTTOM, BOX, LEFT, NO_BORDER, RIGHT, TOP, UNDEFINED, background, border, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, color, grayFill, llx, lly, markupAttributes, rotation, urx, ury, useVariableBorders

Fields inherited from interface com.lowagie.text.Element

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITTG3_1D, CCITTG3_2D, CCITTG4, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE

Constructor Summary

HeaderFooter(Phrase before, boolean numbered)
Constructs a Header-object with a pagenumber at the end.
HeaderFooter(Phrase before, Phrase after)
Constructs a HeaderFooter-object.

Method Summary

int
alignment()
Gets the alignment of this HeaderFooter.
Phrase
getAfter()
Gets the part that comes after the pageNumber.
Phrase
getBefore()
Gets the part that comes before the pageNumber.
boolean
isNumbered()
Checks if the HeaderFooter contains a page number.
Paragraph
paragraph()
Gets the Paragraph that can be used as header or footer.
void
setAlignment(int alignment)
Sets the alignment.
void
setPageNumber(int pageN)
Sets the page number.

Methods inherited from class com.lowagie.text.Rectangle

backgroundColor, border, borderColor, borderWidth, bottom, bottom, cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getChunks, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getRotation, getVariableBorderWidth, grayFill, hasBorder, hasBorders, height, isUseVariableBorders, left, left, normalize, process, rectangle, right, right, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setMarkupAttribute, setMarkupAttributes, setRight, setTop, setUseVariableBorders, top, top, type, updateBorderBasedOnWidth, width

Field Details

after

private Phrase after
This is the Phrase that comes after the pagenumber.

alignment

private int alignment
This is alignment of the header/footer.

before

private Phrase before
This is the Phrase that comes before the pagenumber.

numbered

private boolean numbered
Does the page contain a pagenumber?

pageN

private int pageN
This is number of the page.

Constructor Details

HeaderFooter

public HeaderFooter(Phrase before,
                    boolean numbered)
Constructs a Header-object with a pagenumber at the end.
Parameters:
before - the Phrase before the pagenumber
numbered - true if the page has to be numbered

HeaderFooter

public HeaderFooter(Phrase before,
                    Phrase after)
Constructs a HeaderFooter-object.
Parameters:
before - the Phrase before the pagenumber
after - the Phrase before the pagenumber

Method Details

alignment

public int alignment()
Gets the alignment of this HeaderFooter.
Returns:
alignment

getAfter

public Phrase getAfter()
Gets the part that comes after the pageNumber.
Returns:
a Phrase

getBefore

public Phrase getBefore()
Gets the part that comes before the pageNumber.
Returns:
a Phrase

isNumbered

public boolean isNumbered()
Checks if the HeaderFooter contains a page number.
Returns:
true if the page has to be numbered

paragraph

public Paragraph paragraph()
Gets the Paragraph that can be used as header or footer.
Returns:
a Paragraph

setAlignment

public void setAlignment(int alignment)
Sets the alignment.
Parameters:
alignment - the new alignment

setPageNumber

public void setPageNumber(int pageN)
Sets the page number.
Parameters:
pageN - the new page number