Package com.itextpdf.kernel.pdf.event

Class AbstractPdfDocumentEvent

java.lang.Object

com.itextpdf.kernel.pdf.event.AbstractPdfDocumentEvent

All Implemented Interfaces:

IEvent

Direct Known Subclasses:

PdfDocumentEvent, SignatureContainerGenerationEvent, SignatureDocumentClosingEvent

       public abstract class AbstractPdfDocumentEvent extends Object implements IEvent
      

Describes abstract PDF document event of the specified type.

Use PdfDocument.dispatchEvent(AbstractPdfDocumentEvent) to fire an event and PdfDocument.addEventHandler(String, AbstractPdfDocumentEventHandler) to register AbstractPdfDocumentEventHandler handler for that type of event.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	type	A type of event.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPdfDocumentEvent(String type)	Creates an event of the specified type.

Method Summary

Modifier and Type	Method	Description
PdfDocument	getDocument()	Retrieves the document associated with this event.
String	getType()	Returns the type of this event.
AbstractPdfDocumentEvent	setDocument(PdfDocument document)	Sets the document associated with this event.

Methods inherited from class java.lang.Object

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

Field Details

type

             protected String type
            

A type of event.

Constructor Details

AbstractPdfDocumentEvent

             protected AbstractPdfDocumentEvent
             (String type)
            

Creates an event of the specified type.

Parameters:

type - the type of event

Method Details

getType

             public String getType()
            

Returns the type of this event.

Returns:

type of this event

getDocument

             public PdfDocument getDocument()
            

Retrieves the document associated with this event.

Returns:

PdfDocument that triggered this event

setDocument

             public AbstractPdfDocumentEvent setDocument
             (PdfDocument document)
            

Sets the document associated with this event.

Parameters:

document - PdfDocument that triggered this event

Returns:

this AbstractPdfDocumentEvent instance