com.itextpdf.kernel.pdf.event

Class PdfDocumentEvent

java.lang.Object

com.itextpdf.kernel.pdf.event.AbstractPdfDocumentEvent

com.itextpdf.kernel.pdf.event.PdfDocumentEvent

All Implemented Interfaces:

com.itextpdf.commons.actions.IEvent

public class PdfDocumentEvent
extends AbstractPdfDocumentEvent

Event dispatched by PdfDocument.

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_PAGE Dispatched before page is flushed to a document.
static String	INSERT_PAGE Dispatched after page is inserted/added into a document.
protected PdfPage	page The PdfPage associated with this event.
static String	REMOVE_PAGE Dispatched after page is removed from a document.
static String	START_DOCUMENT_CLOSING Dispatched after writer is flushed to a document.
static String	START_PAGE Dispatched after page is created.
static String	START_WRITER_CLOSING Dispatched before writer is closed.

Fields inherited from class com.itextpdf.kernel.pdf.event.AbstractPdfDocumentEvent

type

Constructor Summary

Constructors

Constructor and Description
PdfDocumentEvent(String type) Creates a PdfDocumentEvent.
PdfDocumentEvent(String type, PdfPage page) Creates a PdfDocumentEvent.

Method Summary

Modifier and Type	Method and Description
PdfPage	getPage() Returns the PdfPage associated with this event.

Methods inherited from class com.itextpdf.kernel.pdf.event.AbstractPdfDocumentEvent

getDocument, getType, setDocument

Methods inherited from class java.lang.Object

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

Field Detail

START_PAGE

public static final String START_PAGE

Dispatched after page is created.

See Also:

Constant Field Values

INSERT_PAGE

public static final String INSERT_PAGE

Dispatched after page is inserted/added into a document.

See Also:

Constant Field Values

REMOVE_PAGE

public static final String REMOVE_PAGE

Dispatched after page is removed from a document.

See Also:

Constant Field Values

END_PAGE

public static final String END_PAGE

Dispatched before page is flushed to a document. This event isn't necessarily dispatched when a successive page has been created. Keep it in mind when using with highlevel iText API.

See Also:

Constant Field Values

START_WRITER_CLOSING

public static final String START_WRITER_CLOSING

Dispatched before writer is closed.

See Also:

Constant Field Values

START_DOCUMENT_CLOSING

public static final String START_DOCUMENT_CLOSING

Dispatched after writer is flushed to a document.

See Also:

Constant Field Values

page

protected PdfPage page

The PdfPage associated with this event.

Constructor Detail

PdfDocumentEvent

public PdfDocumentEvent(String type)

Creates a PdfDocumentEvent.

Parameters:

type - type of the event that fired this event

PdfDocumentEvent

public PdfDocumentEvent(String type,
                        PdfPage page)

Creates a PdfDocumentEvent.

Parameters:

type - type of the event that fired this event

page - page that fired this event

Method Detail

getPage

public PdfPage getPage()

Returns the PdfPage associated with this event. Warning: this can be null.

Returns:

the PdfPage associated with this event