|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.swing.ProgressMonitor
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.
ProgressMonitorInputStream
Nested Class Summary | |
private class |
ProgressMonitor.ProgressOptionPane
|
Field Summary | |
private Object[] |
cancelOption
|
private JDialog |
dialog
|
private int |
lastDisp
|
private int |
max
|
private Object |
message
|
private int |
millisToDecideToPopup
|
private int |
millisToPopup
|
private int |
min
|
private JProgressBar |
myBar
|
private String |
note
|
private JLabel |
noteLabel
|
private JOptionPane |
pane
|
private Component |
parentComponent
|
private int |
reportDelta
|
private ProgressMonitor |
root
|
private long |
T0
|
private int |
v
|
Constructor Summary | |
|
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. |
private |
ProgressMonitor(Component parentComponent,
Object message,
String note,
int min,
int max,
ProgressMonitor group)
|
Method Summary | |
void |
close()
Indicate that the operation is complete. |
int |
getMaximum()
Returns the maximum value -- the higher end of the progress value. |
int |
getMillisToDecideToPopup()
Returns the amount of time this object waits before deciding whether or not to popup a progress monitor. |
int |
getMillisToPopup()
Returns the amount of time it will take for the popup to appear. |
int |
getMinimum()
Returns the minimum value -- the lower end of the progress value. |
String |
getNote()
Specifies the additional note that is displayed along with the progress message. |
boolean |
isCanceled()
Returns true if the user hits the Cancel button in the progress dialog. |
void |
setMaximum(int m)
Specifies the maximum value. |
void |
setMillisToDecideToPopup(int millisToDecideToPopup)
Specifies the amount of time to wait before deciding whether or not to popup a progress monitor. |
void |
setMillisToPopup(int millisToPopup)
Specifies the amount of time it will take for the popup to appear. |
void |
setMinimum(int m)
Specifies the minimum value. |
void |
setNote(String note)
Specifies the additional note that is displayed along with the progress message. |
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 |
Field Detail |
private ProgressMonitor root
private JDialog dialog
private JOptionPane pane
private JProgressBar myBar
private JLabel noteLabel
private Component parentComponent
private String note
private Object[] cancelOption
private Object message
private long T0
private int millisToDecideToPopup
private int millisToPopup
private int min
private int max
private int v
private int lastDisp
private int reportDelta
Constructor Detail |
public ProgressMonitor(Component parentComponent, Object message, String note, int min, int max)
parentComponent
- the parent component for the dialog boxmessage
- 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 ineffectivemin
- the lower bound of the rangemax
- the upper bound of the rangeJDialog
,
JOptionPane
private ProgressMonitor(Component parentComponent, Object message, String note, int min, int max, ProgressMonitor group)
Method Detail |
public void setProgress(int nv)
nv
- an int specifying the current value, between the
maximum and minimum specified for this componentsetMinimum(int)
,
setMaximum(int)
,
close()
public void close()
public int getMinimum()
setMinimum(int)
public void setMinimum(int m)
m
- an int specifying the minimum valuegetMinimum()
public int getMaximum()
setMaximum(int)
public void setMaximum(int m)
m
- an int specifying the maximum valuegetMaximum()
public boolean isCanceled()
public void setMillisToDecideToPopup(int millisToDecideToPopup)
millisToDecideToPopup
- an int specifying the time to wait,
in millisecondsgetMillisToDecideToPopup()
public int getMillisToDecideToPopup()
setMillisToDecideToPopup(int)
public void setMillisToPopup(int millisToPopup)
millisToPopup
- an int specifying the time in millisecondsgetMillisToPopup()
public int getMillisToPopup()
setMillisToPopup(int)
public void setNote(String note)
note
- a String specifying the note to displaygetNote()
public String getNote()
setNote(java.lang.String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |