public interface

ProgressMonitor

com.pdftron.pdf.ProgressMonitor

Class Overview

ProgressMonitor is an interface that an application can use to indicate the progress of a lengthy operation (such as PDFDoc.Save()). ProgressMonitor has a range and a current position. The range represents the entire duration of the operation, and the current position represents the progress the application has made toward completing the operation.

Summary

Public Methods
abstract int getPos()
Get the current position of the progress monitor.
abstract int getRangeFinish()
Gets the upper limit of the range of the progress monitor.
abstract int getRangeStart()
Gets the lower limit of the range of the progress monitor.
abstract int offsetPos(int offset)
Advances the current position of a progress monitor by a specified increment and redraws the bar to reflect the new position.
abstract int setPos(int pos)
Set the current position for a progress monitor and redraws the bar to reflect the new ranges.
abstract void setRange(int start, int finish)
set upper and lower limit of the progress monitor
abstract int setStep(int nstep)
Specifies the step increment for a progress bar monitor.
abstract int stepIt()
Advances the current position for a progress monitor by the step increment (see SetStep) and redraws the monitor to reflect the new position.

Public Methods

public abstract int getPos ()

Get the current position of the progress monitor.

Returns
  • position of the progress monitor

public abstract int getRangeFinish ()

Gets the upper limit of the range of the progress monitor.

Returns
  • end of the range

public abstract int getRangeStart ()

Gets the lower limit of the range of the progress monitor.

Returns
  • start of the range

public abstract int offsetPos (int offset)

Advances the current position of a progress monitor by a specified increment and redraws the bar to reflect the new position.

Parameters
offset - advances the current position of a progress bar control by a specified increment and redraws the bar to reflect the new position.
Returns
  • - the previous position of the progress monitor

public abstract int setPos (int pos)

Set the current position for a progress monitor and redraws the bar to reflect the new ranges.

Parameters
pos - the new position of the progress monitor
Returns
  • - the previous position of the progress monitor

public abstract void setRange (int start, int finish)

set upper and lower limit of the progress monitor

public abstract int setStep (int nstep)

Specifies the step increment for a progress bar monitor.

Parameters
nstep - new step increment.
Returns
  • - the previous step increment

public abstract int stepIt ()

Advances the current position for a progress monitor by the step increment (see SetStep) and redraws the monitor to reflect the new position.

Returns
  • new postion after stepping