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);
* Phrase that comes before the pagenumber. */
private Phrase before = null;
/** This is number of the page. */
private int pageN;
/** This is the Phrase that comes after the pagenumber. */
private Phrase after = null;
/** This is alignment of the header/footer. */
private int alignment;
// constructors
/**
* Constructs a HeaderFooter-object.
*
* @param before the Phrase before the pagenumber
* @param after the Phrase before the pagenumber
*/
public HeaderFooter(Phrase before, Phrase after) {
super(0, 0, 0, 0);
setBorder(TOP + BOTTOM);
setBorderWidth(1);
numbered = true;
this.before = before;
this.after = after;
}
/**
* Constructs a Header-object with a pagenumber at the end.
*
* @param before the Phrase before the pagenumber
* @param numbered true if the page has to be numbered
*/
public HeaderFooter(Phrase before, boolean numbered) {
super(0, 0, 0, 0);
setBorder(TOP + BOTTOM);
setBorderWidth(1);
this.numbered = numbered;
this.before = before;
}
// methods
/**
* Checks if the HeaderFooter contains a page number.
*
* @return true if the page has to be numbered
*/
public boolean isNumbered() {
return numbered;
}
/**
* Gets the part that comes before the pageNumber.
*
* @return a Phrase
*/
public Phrase getBefore() {
return before;
}
/**
* Gets the part that comes after the pageNumber.
*
* @return a Phrase
*/
public Phrase getAfter() {
return after;
}
/**
* Sets the page number.
*
* @param pageN the new page number
*/
public void setPageNumber(int pageN) {
this.pageN = pageN;
}
/**
* Sets the alignment.
*
* @param alignment the new alignment
*/
public void setAlignment(int alignment) {
this.alignment = alignment;
}
// methods to retrieve the membervariables
/**
* Gets the Paragraph that can be used as header or footer.
*
* @return a Paragraph
*/
public Paragraph paragraph() {
Paragraph paragraph = new Paragraph(before.leading());
paragraph.add(before);
if (numbered) {
paragraph.addSpecial(new Chunk(String.valueOf(pageN), before.font()));
}
if (after != null) {
paragraph.addSpecial(after);
}
paragraph.setAlignment(alignment);
return paragraph;
}
/**
* Gets the alignment of this HeaderFooter.
*
* @return alignment
*/
public int alignment() {
return alignment;
}
}