Home » openjdk-7 » javax » swing » [javadoc | source]
javax.swing
public class: ProgressMonitor [javadoc | source]
java.lang.Object
   javax.swing.ProgressMonitor

All Implemented Interfaces:
    Accessible

Direct Known Subclasses:
    ProgressMonitorListener

A class to monitor the progress of some operation. If it looks like the operation 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.

For further documentation and examples see How to Monitor Progress, a section in The Java Tutorial.

Nested Class Summary:
protected class  ProgressMonitor.AccessibleProgressMonitor  AccessibleProgressMonitor implements accessibility support for the ProgressMonitor class. 
Field Summary
protected  AccessibleContext accessibleContext    The AccessibleContext for the ProgressMonitor
    since: 1.5 -
 
Constructor:
 public ProgressMonitor(Component parentComponent,
    Object message,
    String note,
    int min,
    int max) 
    Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.
    Parameters:
    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 JOptionPane#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
    Also see:
    JDialog
    JOptionPane
Method from javax.swing.ProgressMonitor Summary:
close,   getAccessibleContext,   getMaximum,   getMillisToDecideToPopup,   getMillisToPopup,   getMinimum,   getNote,   isCanceled,   setMaximum,   setMillisToDecideToPopup,   setMillisToPopup,   setMinimum,   setNote,   setProgress
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.ProgressMonitor Detail:
 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 AccessibleContext getAccessibleContext() 
    Gets the AccessibleContext for the ProgressMonitor
 public int getMaximum() 
    Returns the maximum value -- the higher end of the progress value.
 public int getMillisToDecideToPopup() 
    Returns the amount of time this object waits before deciding whether or not to popup a progress monitor.
 public int getMillisToPopup() 
    Returns the amount of time it will take for the popup to appear.
 public int getMinimum() 
    Returns the minimum value -- the lower end of the progress value.
 public String getNote() 
    Specifies the additional note that is displayed along with the progress message.
 public boolean isCanceled() 
    Returns true if the user hits the Cancel button in the progress dialog.
 public  void setMaximum(int m) 
    Specifies the maximum value.
 public  void setMillisToDecideToPopup(int millisToDecideToPopup) 
    Specifies the amount of time to wait before deciding whether or not to popup a progress monitor.
 public  void setMillisToPopup(int millisToPopup) 
    Specifies the amount of time it will take for the popup to appear. (If the predicted time remaining is less than this time, the popup won't be displayed.)
 public  void setMinimum(int m) 
    Specifies the minimum value.
 public  void setNote(String note) 
    Specifies the additional note that is displayed along with the progress message. Used, for example, to show which file the is currently being copied during a multiple-file copy.
 public  void setProgress(int nv) 
    Indicate the progress of the operation being monitored. If the specified value is >= the maximum, the progress monitor is closed.