com.gnostice.documents

Class ConverterBeginInputPageEvent

java.lang.Object

java.util.EventObject

com.gnostice.documents.ConverterEvent

com.gnostice.documents.ConverterBeginInputPageEvent

All Implemented Interfaces:

Serializable

public class ConverterBeginInputPageEvent
extends ConverterEvent

This class represents an event when a user class instance implementing the ConverterListener begins processing a page for conversion.

See Also:

ConverterListener.beginPage(ConverterBeginInputPageEvent), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConverterBeginInputPageEvent(Object source, ConverterJobInfoEvent jobInfo, ConverterInputDocumentInfoEvent inputDocumentInfo, int inputPageNumber, IPage inputPage)

Method Summary

Modifier and Type	Method and Description
ConverterInputDocumentInfoEvent	getInputDocumentInfo() Returns details about the document that is being converted.
IPage	getInputPage() Returns the current page that is being converted.
int	getInputPageNumber() Returns number of the current page that is being converted.
boolean	isSkipCurrentAndRemainingPages() Returns whether the conversion of the current and all subsequent pages is set to be abandoned.
boolean	isSkipPage() Returns whether the current page should not be converted.
void	setSkipCurrentAndRemainingPages(boolean skipCurrentAndRemainingPages) Specifies whether the conversion of the current and all subsequent pages need to be abandoned.
void	setSkipPage(boolean skipPage) Specifies whether the current page should not 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

ConverterBeginInputPageEvent

public ConverterBeginInputPageEvent(Object source,
                                    ConverterJobInfoEvent jobInfo,
                                    ConverterInputDocumentInfoEvent inputDocumentInfo,
                                    int inputPageNumber,
                                    IPage inputPage)

Method Detail

getInputDocumentInfo

public ConverterInputDocumentInfoEvent getInputDocumentInfo()

Returns details about the document that is being converted.

Returns:

details about the document that is being converted

isSkipCurrentAndRemainingPages

public boolean isSkipCurrentAndRemainingPages()

Returns whether the conversion of the current and all subsequent pages is set to be abandoned.

Returns:

true if the conversion is set to be abandoned; false if otherwise

setSkipCurrentAndRemainingPages

public void setSkipCurrentAndRemainingPages(boolean skipCurrentAndRemainingPages)

Specifies whether the conversion of the current and all subsequent pages need to be abandoned.

Parameters:

skipCurrentAndRemainingPages - if the conversion needs to be abandoned; false if otherwise

isSkipPage

public boolean isSkipPage()

Returns whether the current page should not be converted.

Returns:

true if the page should not be converted; false if otherwise

setSkipPage

public void setSkipPage(boolean skipPage)

Specifies whether the current page should not be converted.

Parameters:

skipPage - if the page should not be converted; false if otherwise

getInputPageNumber

public int getInputPageNumber()

Returns number of the current page that is being converted.

Returns:

number of the current page

getInputPage

public IPage getInputPage()

Returns the current page that is being converted.

Returns:

current page