com.itextpdf.kernel.pdf.event

Class AbstractPdfDocumentEvent

java.lang.Object

com.itextpdf.kernel.pdf.event.AbstractPdfDocumentEvent

All Implemented Interfaces:

com.itextpdf.commons.actions.IEvent

Direct Known Subclasses:

PdfDocumentEvent

public abstract class AbstractPdfDocumentEvent
extends Object
implements com.itextpdf.commons.actions.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 and Description
protected String	type A type of event.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 Detail

type

protected String type

A type of event.

Constructor Detail

AbstractPdfDocumentEvent

protected AbstractPdfDocumentEvent(String type)

Creates an event of the specified type.

Parameters:

type - the type of event

Method Detail

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