com.lowagie.text.pdf

Class PdfPageEventHelper

public class PdfPageEventHelper extends Object implements PdfPageEvent

Helps the use of PdfPageEvent by implementing all the interface methods. A class can extend PdfPageEventHelper and only implement the needed methods.

Note: do not use Document.add() inside a page event.

Author: Paulo Soares (psoares@consiste.pt)

Method Summary
voidonChapter(PdfWriter writer, Document document, float paragraphPosition, Paragraph title)
Called when a Chapter is written.
voidonChapterEnd(PdfWriter writer, Document document, float position)
Called when the end of a Chapter is reached.
voidonCloseDocument(PdfWriter writer, Document document)
Called when the document is closed.
voidonEndPage(PdfWriter writer, Document document)
Called when a page is finished, just before being written to the document.
voidonGenericTag(PdfWriter writer, Document document, Rectangle rect, String text)
Called when a Chunk with a generic tag is written.
voidonOpenDocument(PdfWriter writer, Document document)
Called when the document is opened.
voidonParagraph(PdfWriter writer, Document document, float paragraphPosition)
Called when a Paragraph is written.
voidonParagraphEnd(PdfWriter writer, Document document, float paragraphPosition)
Called when a Paragraph is written.
voidonSection(PdfWriter writer, Document document, float paragraphPosition, int depth, Paragraph title)
Called when a Section is written.
voidonSectionEnd(PdfWriter writer, Document document, float position)
Called when the end of a Section is reached.
voidonStartPage(PdfWriter writer, Document document)
Called when a page is initialized.

Method Detail

onChapter

public void onChapter(PdfWriter writer, Document document, float paragraphPosition, Paragraph title)
Called when a Chapter is written.

position will hold the height at which the chapter will be written to.

Parameters: writer the PdfWriter for this document document the document paragraphPosition the position the chapter will be written to title the title of the Chapter

onChapterEnd

public void onChapterEnd(PdfWriter writer, Document document, float position)
Called when the end of a Chapter is reached.

position will hold the height of the end of the chapter.

Parameters: writer the PdfWriter for this document document the document position the position of the end of the chapter.

onCloseDocument

public void onCloseDocument(PdfWriter writer, Document document)
Called when the document is closed.

Note that this method is called with the page number equal to the last page plus one.

Parameters: writer the PdfWriter for this document document the document

onEndPage

public void onEndPage(PdfWriter writer, Document document)
Called when a page is finished, just before being written to the document.

Parameters: writer the PdfWriter for this document document the document

onGenericTag

public void onGenericTag(PdfWriter writer, Document document, Rectangle rect, String text)
Called when a Chunk with a generic tag is written.

It is useful to pinpoint the Chunk location to generate bookmarks, for example.

Parameters: writer the PdfWriter for this document document the document rect the Rectangle containing the Chunk text the text of the tag

onOpenDocument

public void onOpenDocument(PdfWriter writer, Document document)
Called when the document is opened.

Parameters: writer the PdfWriter for this document document the document

onParagraph

public void onParagraph(PdfWriter writer, Document document, float paragraphPosition)
Called when a Paragraph is written.

paragraphPosition will hold the height at which the paragraph will be written to. This is useful to insert bookmarks with more control.

Parameters: writer the PdfWriter for this document document the document paragraphPosition the position the paragraph will be written to

onParagraphEnd

public void onParagraphEnd(PdfWriter writer, Document document, float paragraphPosition)
Called when a Paragraph is written.

paragraphPosition will hold the height of the end of the paragraph.

Parameters: writer the PdfWriter for this document document the document paragraphPosition the position of the end of the paragraph

onSection

public void onSection(PdfWriter writer, Document document, float paragraphPosition, int depth, Paragraph title)
Called when a Section is written.

position will hold the height at which the section will be written to.

Parameters: writer the PdfWriter for this document document the document paragraphPosition the position the section will be written to depth the number depth of the Section title the title of the section

onSectionEnd

public void onSectionEnd(PdfWriter writer, Document document, float position)
Called when the end of a Section is reached.

position will hold the height of the section end.

Parameters: writer the PdfWriter for this document document the document position the position of the end of the section

onStartPage

public void onStartPage(PdfWriter writer, Document document)
Called when a page is initialized.

Note that if even if a page is not written this method is still called. It is preferable to use onEndPage to avoid infinite loops.

Parameters: writer the PdfWriter for this document document the document