Package com.realobjects.pdfreactor.events

Interface ProgressEvent

public interface ProgressEvent

This interface defines a continuous progress event during PDF creation.

  • Method Summary

    Modifier and Type
    Method
    Description
    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(String message)
    Terminates the current conversion.

  • Method Details

    • 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

      String getDescription()

      The description of the current progress step.

      Returns:
      the description.

    • terminateConversion

      void terminateConversion(String message)

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

      Parameters:
      message - The message of the exception to be thrown.