public class HeaderFooter extends Rectangle
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);
Modifier and Type | Field and Description |
---|---|
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.
|
backgroundColor, border, borderColor, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, LEFT, llx, lly, NO_BORDER, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
Constructor and Description |
---|
HeaderFooter(Phrase before,
boolean numbered)
Constructs a
Header -object with a pagenumber at the end. |
HeaderFooter(Phrase before,
Phrase after)
Constructs a
HeaderFooter -object. |
Modifier and Type | Method and Description |
---|---|
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.
|
cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getChunks, getGrayFill, getHeight, getLeft, getLeft, getRight, getRight, getRotation, getTop, getTop, getWidth, hasBorder, hasBorders, isContent, isNestable, isUseVariableBorders, normalize, process, rectangle, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setRight, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString, type
private boolean numbered
private Phrase before
Phrase
that comes before the pagenumber.private int pageN
private Phrase after
Phrase
that comes after the pagenumber.private int alignment
public HeaderFooter(Phrase before, Phrase after)
HeaderFooter
-object.before
- the Phrase
before the pagenumberafter
- the Phrase
before the pagenumberpublic HeaderFooter(Phrase before, boolean numbered)
Header
-object with a pagenumber at the end.before
- the Phrase
before the pagenumbernumbered
- true
if the page has to be numberedpublic boolean isNumbered()
public Phrase getBefore()
public Phrase getAfter()
public void setPageNumber(int pageN)
pageN
- the new page numberpublic void setAlignment(int alignment)
alignment
- the new alignmentpublic Paragraph paragraph()
Paragraph
that can be used as header or footer.Paragraph
public int alignment()