Package com.datalogics.PDFL

Class ProgressMonitor

java.lang.Object
com.datalogics.PDFL.ProgressMonitor
public class ProgressMonitor extends Object
Represents the progress of an operation. The class can display a dialog if a process will take time, and the Progress method can indicate how long the process will last.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProgressMonitor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginOperation()
    Initializes the progress monitor and displays it with a current value of zero.
    void
    delete()
     
    void
    endOperation()
    Draws the progress monitor with its current value set to the progress monitor's duration (a full progress monitor), then removes the progress monitor from the display.
    int
    getCurrentValue()
    The current value of the progress monitor.
    int
    getDuration()
    The progress monitor's duration.
    void
    setCurrentValue(int currentValue)
    Sets the current value of the progress monitor and updates the display.
    void
    setDuration(int duration)
    Sets the value that corresponds to a full progress monitor display.
    void
    setText(String text)
    Display a text string in the progress monitor.
    void
    swigReleaseOwnership()
     
    void
    swigTakeOwnership()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ProgressMonitor

      public ProgressMonitor()

  • Method Details

    • delete

      public void delete()

    • swigReleaseOwnership

      public void swigReleaseOwnership()

    • swigTakeOwnership

      public void swigTakeOwnership()

    • beginOperation

      public void beginOperation()
      Initializes the progress monitor and displays it with a current value of zero. This method will be called first when the progress monitor is used.

    • endOperation

      public void endOperation()
      Draws the progress monitor with its current value set to the progress monitor's duration (a full progress monitor), then removes the progress monitor from the display.

    • setDuration

      public void setDuration(int duration)
      Sets the value that corresponds to a full progress monitor display. The progress monitor is subsequently filled in by setting its current value. This method will be called before setting the progress monitor's current value.

      Parameters:
      duration - The maximum value the progress monitor will be allowed to have.

    • setCurrentValue

      public void setCurrentValue(int currentValue)
      Sets the current value of the progress monitor and updates the display. The allowed value ranges from 0 (empty) to the value passed to SetDuration.

      For example, if the progress monitor's duration is 10, the current value must be between 0 and 10, inclusive.

      Parameters:
      currentValue - The progress monitor's current value.

    • getDuration

      public int getDuration()
      The progress monitor's duration.

    • getCurrentValue

      public int getCurrentValue()
      The current value of the progress monitor. The allowed value ranges from 0 (empty) to the value passed to SetDuration.

      For example, if the progress monitor's duration is 10, the current value must be between 0 and 10, inclusive.

    • setText

      public void setText(String text)
      Display a text string in the progress monitor.