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)
*/
public class PdfPageEventHelper implements PdfPageEvent {
/**
* Called when the document is opened.
*
* @param writer the PdfWriter for this document
* @param document the document
*/
public void onOpenDocument(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.
*
* @param writer the PdfWriter for this document
* @param document the document
*/
public void onStartPage(PdfWriter writer,Document document) {
}
/**
* Called when a page is finished, just before being written to the document.
*
* @param writer the PdfWriter for this document
* @param document the document
*/
public void onEndPage(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.
*
* @param writer the PdfWriter for this document
* @param document the document
*/
public void onCloseDocument(PdfWriter writer,Document document) {
}
/**
* 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.
*
* @param writer the PdfWriter for this document
* @param document the document
* @param paragraphPosition the position the paragraph will be written to
*/
public void onParagraph(PdfWriter writer,Document document,float paragraphPosition) {
}
/**
* Called when a Paragraph is written.
*
* paragraphPosition will hold the height of the end of the paragraph.
*
* @param writer the PdfWriter for this document
* @param document the document
* @param paragraphPosition the position of the end of the paragraph
*/
public void onParagraphEnd(PdfWriter writer,Document document,float paragraphPosition) {
}
/**
* Called when a Chapter is written.
*
* position will hold the height at which the
* chapter will be written to.
*
* @param writer the PdfWriter for this document
* @param document the document
* @param paragraphPosition the position the chapter will be written to
* @param title the title of the Chapter
*/
public void onChapter(PdfWriter writer,Document document,float paragraphPosition,Paragraph title) {
}
/**
* Called when the end of a Chapter is reached.
*
* position will hold the height of the end of the chapter.
*
* @param writer the PdfWriter for this document
* @param document the document
* @param position the position of the end of the chapter.
*/
public void onChapterEnd(PdfWriter writer,Document document,float position) {
}
/**
* Called when a Section is written.
*
* position will hold the height at which the
* section will be written to.
*
* @param writer the PdfWriter for this document
* @param document the document
* @param paragraphPosition the position the section will be written to
* @param depth the number depth of the Section
* @param title the title of the section
*/
public void onSection(PdfWriter writer,Document document,float paragraphPosition,int depth,Paragraph title) {
}
/**
* Called when the end of a Section is reached.
*
* position will hold the height of the section end.
*
* @param writer the PdfWriter for this document
* @param document the document
* @param position the position of the end of the section
*/
public void onSectionEnd(PdfWriter writer,Document document,float position) {
}
/**
* Called when a Chunk with a generic tag is written.
*
* It is usefull to pinpoint the Chunk location to generate
* bookmarks, for example.
*
* @param writer the PdfWriter for this document
* @param document the document
* @param rect the Rectangle containing the Chunk
* @param text the text of the tag
*/
public void onGenericTag(PdfWriter writer,Document document,Rectangle rect,String text) {
}
}