com.realobjects.pdfreactor.events

Interface ProgressEvent

public interface ProgressEvent

This interface defines a continuous progress event during PDF creation.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription() The description of the current progress step.
int	getProgressEndValue() Returns the endValue the progress value will finally reach upon completion.
int	getProgressValue() Returns the current progress value.
void	terminateConversion(java.lang.String message) Terminates the current conversion.

Method Detail

getProgressValue

int getProgressValue()

Returns the current progress value.

Returns:

the progress value

getProgressEndValue

int getProgressEndValue()

Returns the endValue the progress value will finally reach upon completion.

Returns:

the progress end value.

getDescription

java.lang.String getDescription()

The description of the current progress step.

Returns:

the description.

terminateConversion

void terminateConversion(java.lang.String message)

Terminates the current conversion. A TerminationException will be thrown by PDFreactor.

Parameters:

message - The message of the exception to be thrown.