Java Platform 1.2
Beta 4



public class ProgressMonitor
extends Object
A class to monitor the progress of some operation. If it looks like it will take a while, a progress dialog will be popped up. When the ProgressMonitor is created it is given a numeric range and a descriptive string. As the operation progresses, call the setProgress method to indicate how far along the [min,max] range the operation is. Initially, there is no ProgressDialog. After the first millisToDecideToPopup milliseconds (default 500) the progress monitor will predict how long the operation will take. If it is longer than millisToPopup (default 2000, 2 seconds) a ProgressDialog will be popped up.

From time to time, when the Dialog box is visible, the progress bar will be updated when setProgress is called. setProgress won't always update the progress bar, it will only be done if the amount of progress is visibly significant.

See Also:

Constructor Summary
ProgressMonitor(Component parentComponent, Object message, String note, int min, int max)
Method Summary
 void close()
          Indicate that the operation is complete.
 int getMaximum()
 int getMillisToDecideToPopup()
 int getMillisToPopup()
 int getMinimum()
 String getNote()
 boolean isCanceled()
          Returns true if the user does some UI action to cancel this operation. (like hitting the Cancel button on the progress dialog).
 void setMaximum(int m)
 void setMillisToDecideToPopup(int millisToDecideToPopup)
 void setMillisToPopup(int millisToPopup)
 void setMinimum(int m)
 void setNote(String note)
 void setProgress(int nv)
          Indicate the progress of the operation being monitored.
Methods inherited from class java.lang.Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

Constructor Detail


public ProgressMonitor(Component parentComponent,
                       Object message,
                       String note,
                       int min,
                       int max)
parentComponent - the parent component for the dialog box
message - a descriptive message that will be shown to the user to indicate what operation is being monitored. This does not change as the operation progresses. See the message parameters to methods in JOptionsPane#message for the range of values.
note - a short note describing the state of the operation. As the operation progresses, you can call setNote to change the note displayed. This is used, for example, in operations that iterate through a list of files to show the name of the file being processes. If note is initially null, there will be no note line in the dialog box and setNote will be ineffective
min - the lower bound of the range
max - the upper bound of the range
See Also:
JDialog, JOptionPane
Method Detail


public void setProgress(int nv)
Indicate the progress of the operation being monitored.


public void close()
Indicate that the operation is complete. This happens automatically when the value set by setProgress is >= max, but it may be called earlier if the operation ends early.


public int getMinimum()


public void setMinimum(int m)


public int getMaximum()


public void setMaximum(int m)


public boolean isCanceled()
Returns true if the user does some UI action to cancel this operation. (like hitting the Cancel button on the progress dialog).


public void setMillisToDecideToPopup(int millisToDecideToPopup)


public int getMillisToDecideToPopup()


public void setMillisToPopup(int millisToPopup)


public int getMillisToPopup()


public void setNote(String note)


public String getNote()

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.