com.gnostice.documents

Class ConverterEvent

java.lang.Object

java.util.EventObject

com.gnostice.documents.ConverterEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AddAttachmentEvent, ConverterBeginInputDocumentEvent, ConverterBeginInputPageEvent, ConverterBeginJobEvent, ConverterEndInputDocumentEvent, ConverterEndInputPageEvent, ConverterEndJobEvent, ConverterErrorEvent, ConverterNeedFileNameEvent, ConverterNeedOutputStreamEvent, ConverterNeedPasswordEvent, ConverterOutputPageReadyEvent, ConverterOutputReadyEvent

public class ConverterEvent
extends EventObject

This is a base class for DocumentConverter events.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConverterEvent(Object source, ConverterJobInfoEvent jobInfo)

Method Summary

Modifier and Type	Method and Description
ConverterJobInfoEvent	getJobInfo() Returns information about the current conversion job.
boolean	isCancel() Returns whether the current conversion operation needs to be cancelled.
void	setCancel(boolean cancel) Prevents the DocumentConverter from proceeding with the current conversion job.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConverterEvent

public ConverterEvent(Object source,
                      ConverterJobInfoEvent jobInfo)

Method Detail

getJobInfo

public ConverterJobInfoEvent getJobInfo()

Returns information about the current conversion job.

Returns:

information about the current conversion job

isCancel

public boolean isCancel()

Returns whether the current conversion operation needs to be cancelled.

Returns:

true if it needs to be cancelled; false if otherwise

setCancel

public void setCancel(boolean cancel)

Prevents the DocumentConverter from proceeding with the current conversion job.

Parameters:

cancel - true if the job needs to be cancelled; false if otherwise