com.openhtmltopdf.pdfboxout

Interface PDFCreationListener

public interface PDFCreationListener

Callback listener for PDF creation. To use this, call ITextRenderer#setListener(PDFCreationListener). Note that with a handle on the ITextRenderer instance (provided in the callback arguments) you can access the com.itextpdf.text.pdf.PdfWriter instance being used to create the document, using ITextRenderer#getOutputDevice(), then calling ITextOutputDevice#getWriter().

Method Summary

Modifier and Type	Method and Description
void	onClose(PdfBoxRenderer renderer) Called immediately before the iText Document instance is closed, e.g.
void	preOpen(PdfBoxRenderer iTextRenderer) Called immediately after the iText Document instance is created but before the call to com.itextpdf.text.Document#open() is called.
void	preWrite(PdfBoxRenderer iTextRenderer, int pageCount) Called immediately before the pages of the PDF file are about to be written out.

Method Detail

preOpen

void preOpen(PdfBoxRenderer iTextRenderer)

Called immediately after the iText Document instance is created but before the call to com.itextpdf.text.Document#open() is called. At this point you may still modify certain properties of the PDF document header via the com.itextpdf.text.pdf.PdfWriter; once open() is called, you can't change, e.g. the version. See the iText documentation for what limitations there are at this phase of processing.

Parameters:

iTextRenderer - the renderer preparing the document

preWrite

void preWrite(PdfBoxRenderer iTextRenderer,
              int pageCount)

Called immediately before the pages of the PDF file are about to be written out. This is an opportunity to modify any document metadata that will be used to generate the PDF header fields (the document information dictionary). Document metadata may be accessed through the ITextOutputDevice that is returned by ITextRenderer#getOutputDevice().

Parameters:

iTextRenderer - the renderer preparing the document

pageCount - the number of pages that will be written to the PDF document

onClose

void onClose(PdfBoxRenderer renderer)

Called immediately before the iText Document instance is closed, e.g. before com.itextpdf.text.Document#close() is called.

Parameters:

renderer - the iTextRenderer preparing the document