Module flying.saucer.pdf

Package org.xhtmlrenderer.pdf

Class DefaultPDFCreationListener

java.lang.Object

org.xhtmlrenderer.pdf.DefaultPDFCreationListener

All Implemented Interfaces:

PDFCreationListener

Direct Known Subclasses:

XHtmlMetaToPdfInfoAdapter

public class DefaultPDFCreationListener
extends Object
implements PDFCreationListener

No-op implementation of a PDFCreationListener. Override methods as needed.

Constructor Summary

Constructors

Constructor	Description
DefaultPDFCreationListener()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPDFCreationListener

public DefaultPDFCreationListener()

Method Details

preOpen

public void preOpen(ITextRenderer iTextRenderer)

Description copied from interface: PDFCreationListener

Called immediately after the iText Document instance is created but before the call to Document.open() is called. At this point you may still modify certain properties of the PDF document header via the 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.

Specified by:

preOpen in interface PDFCreationListener

Parameters:

iTextRenderer - the renderer preparing the document

preWrite

public void preWrite(ITextRenderer iTextRenderer,
 int pageCount)

Description copied from interface: PDFCreationListener

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().

Specified by:

preWrite in interface PDFCreationListener

Parameters:

iTextRenderer - the renderer preparing the document

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

onClose

public void onClose(ITextRenderer renderer)

Description copied from interface: PDFCreationListener

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

Specified by:

onClose in interface PDFCreationListener

Parameters:

renderer - the iTextRenderer preparing the document