com.dpslink.base.util

Class XmlToPdf.PdfHeaderFooter

java.lang.Object

com.itextpdf.text.pdf.PdfPageEventHelper

com.dpslink.base.util.XmlToPdf.PdfHeaderFooter

All Implemented Interfaces:

com.itextpdf.text.pdf.PdfPageEvent, java.io.Serializable

Enclosing class:

XmlToPdf

protected class XmlToPdf.PdfHeaderFooter
extends com.itextpdf.text.pdf.PdfPageEventHelper
implements java.io.Serializable

Inner class that adds a header and a footer to PDF document pages.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	__covernum The page number shown in a cover page footer.
protected boolean	__coverpage A flag indicating that a cover page is being processed.
protected java.lang.String	__datetime The date and time shown in the footer.
protected org.w3c.dom.Element	__docroot The XML document's root node (report tag).
protected boolean	__footer The show footer flag.
protected boolean	__header The show header flag.
protected int	__numpages The total number of pages shown in the footer.
protected int	__pagenum The page number shown in the footer.
protected int	__tablenum The page number shown in a table of contents footer.
protected boolean	__tablepage A flag indicating that a table of contents page is being processed.
protected java.lang.String	__title The title shown in the header.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfHeaderFooter(org.w3c.dom.Element docroot, int numpages) Creates a new PDF header-footer instance.

Method Summary

Modifier and Type	Method and Description
int[]	getPageNumbers() Returns an array that contains the current page numbers for cover page(s), main content page(s) and table of contents page(s).
void	onChapter(com.itextpdf.text.pdf.PdfWriter writer, com.itextpdf.text.Document document, float position, com.itextpdf.text.Paragraph title) Called when a chapter is written.
void	onEndPage(com.itextpdf.text.pdf.PdfWriter writer, com.itextpdf.text.Document document) Called when a page is finished, just before being written to the document.
void	onSection(com.itextpdf.text.pdf.PdfWriter writer, com.itextpdf.text.Document document, float position, int depth, com.itextpdf.text.Paragraph title) Called when a section is written.

Methods inherited from class com.itextpdf.text.pdf.PdfPageEventHelper

onChapterEnd, onCloseDocument, onGenericTag, onOpenDocument, onParagraph, onParagraphEnd, onSectionEnd, onStartPage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

__docroot

protected org.w3c.dom.Element __docroot

The XML document's root node (report tag).

__header

protected boolean __header

The show header flag.

__footer

protected boolean __footer

The show footer flag.

__title

protected java.lang.String __title

The title shown in the header.

__pagenum

protected int __pagenum

The page number shown in the footer.

__numpages

protected int __numpages

The total number of pages shown in the footer.

__datetime

protected java.lang.String __datetime

The date and time shown in the footer.

__coverpage

protected boolean __coverpage

A flag indicating that a cover page is being processed.

__covernum

protected int __covernum

The page number shown in a cover page footer.

__tablepage

protected boolean __tablepage

A flag indicating that a table of contents page is being processed.

__tablenum

protected int __tablenum

The page number shown in a table of contents footer.

Constructor Detail

PdfHeaderFooter

protected PdfHeaderFooter(org.w3c.dom.Element docroot,
                          int numpages)

Creates a new PDF header-footer instance.

Parameters:

docroot - (Element) The XML document's root node.

numpages - (int) The total number of pages shown in the footer.

Method Detail

getPageNumbers

public int[] getPageNumbers()

Returns an array that contains the current page numbers for cover page(s), main content page(s) and table of contents page(s).

Returns:

int[] - The page numbers where element 0 is for cover pages, element 1 is for main content pages and element 2 is for table of contents pages.

onEndPage

public void onEndPage(com.itextpdf.text.pdf.PdfWriter writer,
                      com.itextpdf.text.Document document)

Called when a page is finished, just before being written to the document.

Specified by:

onEndPage in interface com.itextpdf.text.pdf.PdfPageEvent

Overrides:

onEndPage in class com.itextpdf.text.pdf.PdfPageEventHelper

Parameters:

writer - (PdfWriter) The writer for the document being created.

document - (Document) The document being created.

onChapter

public void onChapter(com.itextpdf.text.pdf.PdfWriter writer,
                      com.itextpdf.text.Document document,
                      float position,
                      com.itextpdf.text.Paragraph title)

Called when a chapter is written.

Specified by:

onChapter in interface com.itextpdf.text.pdf.PdfPageEvent

Overrides:

onChapter in class com.itextpdf.text.pdf.PdfPageEventHelper

Parameters:

writer - (PdfWriter) The writer for the document being created.

document - (Document) The document being created.

position - (float) The position the chapter will be written to.

title - (Paragraph) The title of the chapter.

onSection

public void onSection(com.itextpdf.text.pdf.PdfWriter writer,
                      com.itextpdf.text.Document document,
                      float position,
                      int depth,
                      com.itextpdf.text.Paragraph title)

Called when a section is written.

Specified by:

onSection in interface com.itextpdf.text.pdf.PdfPageEvent

Overrides:

onSection in class com.itextpdf.text.pdf.PdfPageEventHelper

Parameters:

writer - (PdfWriter) The writer for the document being created.

document - (Document) The document being created.

position - (float) The position the section will be written to.

depth - (int) The number depth of the section.

title - (Paragraph) The title of the section.