com.gnostice.documents

Class ConverterOutputPageReadyEvent

java.lang.Object

java.util.EventObject

com.gnostice.documents.ConverterEvent

com.gnostice.documents.ConverterOutputPageReadyEvent

All Implemented Interfaces:

Serializable

public class ConverterOutputPageReadyEvent
extends ConverterEvent

This class represents an event when a user class instance implementing the ConverterListener has converted a page.

See Also:

ConverterListener.outputPageReady(ConverterOutputPageReadyEvent), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConverterOutputPageReadyEvent(Object source, ConverterJobInfoEvent jobInfo, ConverterInputDocumentInfoEvent inputDocumentInfo, int inputPageNumber, IPage outputPage, int outputPageNumber)

Method Summary

Modifier and Type	Method and Description
ConverterInputDocumentInfoEvent	getInputDocumentInfo() Returns details about the document that is being converted.
int	getInputPageNumber() Returns number of the page in the document that was converted.
IPage	getOutputPage() Returns the page that was converted from the output document.
int	getOutputPageNumber() Returns number of the page in the output document.
boolean	isSkipRemainingPages() Returns whether remaining pages are not to be converted.
void	setSkipRemainingPages(boolean skipRemainingPages) Specifies whether remaining pages need to be converted.

Methods inherited from class com.gnostice.documents.ConverterEvent

getJobInfo, isCancel, setCancel

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

ConverterOutputPageReadyEvent

public ConverterOutputPageReadyEvent(Object source,
                                     ConverterJobInfoEvent jobInfo,
                                     ConverterInputDocumentInfoEvent inputDocumentInfo,
                                     int inputPageNumber,
                                     IPage outputPage,
                                     int outputPageNumber)

Method Detail

getInputDocumentInfo

public ConverterInputDocumentInfoEvent getInputDocumentInfo()

Returns details about the document that is being converted.

Returns:

details about the document that is being converted

getInputPageNumber

public int getInputPageNumber()

Returns number of the page in the document that was converted.

Returns:

number of the current page from the input document

getOutputPage

public IPage getOutputPage()

Returns the page that was converted from the output document.

Returns:

page that was converted from the output document

getOutputPageNumber

public int getOutputPageNumber()

Returns number of the page in the output document.

Returns:

number of the current page in the output document

isSkipRemainingPages

public boolean isSkipRemainingPages()

Returns whether remaining pages are not to be converted.

Returns:

true if they are not to be converted; false if otherwise

setSkipRemainingPages

public void setSkipRemainingPages(boolean skipRemainingPages)

Specifies whether remaining pages need to be converted.

Parameters:

skipRemainingPages - true if they need to be converted; false if otherwise