com.gnostice.documents

Interface ConverterListener

All Known Implementing Classes:

ConverterListenerAdapter

public interface ConverterListener

This interface defines events for implementing user classes that use the DocumentConverter.

Method Summary

Modifier and Type	Method and Description
void	addAttachment(AddAttachmentEvent e) Occurs when the attachment is added to a PDF portfolio.
void	beginDigitizePage(ConverterBeginDigitizePageEvent e) Occurs when a page is about to be digitized.
void	beginDocument(ConverterBeginInputDocumentEvent e) Occurs when a document is about to be converted.
void	beginJob(ConverterBeginJobEvent e) Occurs when a conversion job for a set of documents is about to start.
void	beginPage(ConverterBeginInputPageEvent e) Occurs when conversion of a page is about to start.
void	endDigitizePage(ConverterEndDigitizePageEvent e) Occurs when a page has been just been digitized.
void	endDocument(ConverterEndInputDocumentEvent e) Occurs when the conversion ends for a document.
void	endJob(ConverterEndJobEvent e) Occurs when conversion of a document has ended.
void	endPage(ConverterEndInputPageEvent e) Occurs when a page in a page has been converted.
void	error(ConverterErrorEvent e) Occurs when there is an error with the conversion operation.
void	needFileName(ConverterNeedFileNameEvent e) Occurs when a file name can be specified for saving a converted document.
void	needOutputStream(ConverterNeedOutputStreamEvent e) Occurs when a stream is required for saving the converted document.
void	needPassword(ConverterNeedPasswordEvent e) Occurs when a password is required to decrypt a document.
void	outputPageReady(ConverterOutputPageReadyEvent e) Occurs when a page has been converted.
void	outputReady(ConverterOutputReadyEvent e) Occurs when the conversion job has completed and the output documents have been saved.

Method Detail

beginJob

void beginJob(ConverterBeginJobEvent e)

Occurs when a conversion job for a set of documents is about to start.

Parameters:

e - details about the event

beginDocument

void beginDocument(ConverterBeginInputDocumentEvent e)

Occurs when a document is about to be converted.

Parameters:

e - details about an event

beginPage

void beginPage(ConverterBeginInputPageEvent e)

Occurs when conversion of a page is about to start.

Parameters:

e - details about an event

beginDigitizePage

void beginDigitizePage(ConverterBeginDigitizePageEvent e)

Occurs when a page is about to be digitized.

Parameters:

e - details about an event

endDigitizePage

void endDigitizePage(ConverterEndDigitizePageEvent e)

Occurs when a page has been just been digitized.

Parameters:

e - details about an event

endPage

void endPage(ConverterEndInputPageEvent e)

Occurs when a page in a page has been converted.

Parameters:

e - details about an event

outputPageReady

void outputPageReady(ConverterOutputPageReadyEvent e)

Occurs when a page has been converted.

Parameters:

e - details about an event

addAttachment

void addAttachment(AddAttachmentEvent e)

Occurs when the attachment is added to a PDF portfolio.

Parameters:

e - details about an event

endDocument

void endDocument(ConverterEndInputDocumentEvent e)

Occurs when the conversion ends for a document.

Parameters:

e - details about an event

endJob

void endJob(ConverterEndJobEvent e)

Occurs when conversion of a document has ended.

Parameters:

e - details about an event

error

void error(ConverterErrorEvent e)

Occurs when there is an error with the conversion operation.

Parameters:

e - details about an event

needPassword

void needPassword(ConverterNeedPasswordEvent e)

Occurs when a password is required to decrypt a document.

Parameters:

e - details about an event

needFileName

void needFileName(ConverterNeedFileNameEvent e)

Occurs when a file name can be specified for saving a converted document.

Parameters:

e - details about an event

needOutputStream

void needOutputStream(ConverterNeedOutputStreamEvent e)

Occurs when a stream is required for saving the converted document.

Parameters:

e - details about an event

outputReady

void outputReady(ConverterOutputReadyEvent e)

Occurs when the conversion job has completed and the output documents have been saved.

Parameters:

e - details about an event