public class GuaranteedProgressMonitor
extends java.lang.Object
implements javax.accessibility.Accessible
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
Modifier and Type | Class and Description |
---|---|
protected class |
GuaranteedProgressMonitor.AccessibleProgressMonitor
AccessibleProgressMonitor implements accessibility support
for the ProgressMonitor class. |
Modifier and Type | Field and Description |
---|---|
protected javax.accessibility.AccessibleContext |
accessibleContext
The
AccessibleContext for the ProgressMonitor |
Constructor and Description |
---|
GuaranteedProgressMonitor(java.awt.Component parentComponent,
java.lang.Object message,
java.lang.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.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Indicate that the operation is complete.
|
static java.awt.Window |
findWindow(java.awt.Component c) |
javax.accessibility.AccessibleContext |
getAccessibleContext()
Gets the
AccessibleContext for the
ProgressMonitor |
int |
getMaximum()
Returns the maximum value -- the higher end of the progress value.
|
int |
getMinimum()
Returns the minimum value -- the lower end of the progress value.
|
java.lang.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 |
setIndeterminate() |
void |
setMaximum(int m)
Specifies the maximum value.
|
void |
setMinimum(int m)
Specifies the minimum value.
|
void |
setNote(java.lang.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.
|
protected javax.accessibility.AccessibleContext accessibleContext
AccessibleContext
for the ProgressMonitor
public GuaranteedProgressMonitor(java.awt.Component parentComponent, java.lang.Object message, java.lang.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
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 setIndeterminate()
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 setNote(java.lang.String note)
note
- a String specifying the note to displaygetNote()
public java.lang.String getNote()
setNote(java.lang.String)
public javax.accessibility.AccessibleContext getAccessibleContext()
AccessibleContext
for the
ProgressMonitor
getAccessibleContext
in interface javax.accessibility.Accessible
AccessibleContext
for the
ProgressMonitor
public static java.awt.Window findWindow(java.awt.Component c)