public class IndeterminateProgressMonitor
extends java.lang.Object
A progress monitor implementation for indeterminate progress feedback.
DeterminateProgressMonitor
Constructor and Description |
---|
IndeterminateProgressMonitor(java.awt.Component parent,
java.lang.String title) |
IndeterminateProgressMonitor(java.awt.Component parent,
java.lang.String title,
java.lang.Object message,
java.lang.String note) |
Modifier and Type | Method and Description |
---|---|
void |
addCancellationListener(javax.swing.event.ChangeListener l)
Adds a listener for progress dialog cancellation.
|
void |
close()
Indicates that the operation is complete.
|
protected void |
closeImpl() |
protected javax.swing.JProgressBar |
createProgressBar() |
void |
display()
Forces the progress dialog to be displayed, regardless of timing.
|
protected void |
displayImpl() |
void |
finish()
Finishes progress indication by setting the level to its maximum ahead
of monitor closure.
|
protected void |
finishImpl(javax.swing.JProgressBar progressBar) |
boolean |
getCloseOnFinish()
Asks whether the monitor's dialog will close when responding to the
finish() method. |
java.awt.Component |
getComponent()
Gets the progress monitor dialog component, if created.
|
java.awt.Component |
getDetailContent()
Returns the content of the dialog to appear in a 'details' section.
|
int |
getMillisToPopup()
Returns the amount of time it will take for the popup to appear.
|
ProgressPanel |
getPanel()
Gets the panel component for this progress monitor.
|
boolean |
isBarVisible()
Returns the visibility of the dialog's progress bar before it is shown.
|
boolean |
isCanceled()
Returns true if the user hits the Cancel button in the progress dialog.
|
boolean |
isCancellable()
Returns whether the progress dialog can be cancelled.
|
boolean |
isCancelled()
Returns true if the user hits the Cancel button in the progress dialog.
|
boolean |
isDetailVisible()
Gets whether the dialog detail content is made visible by default.
|
boolean |
isModal() |
static void |
main(java.lang.String[] argv) |
void |
removeCancellationListener(javax.swing.event.ChangeListener l)
Removes a listener for progress dialog cancellation.
|
void |
setBarVisible(boolean barVisible)
Specifies the visibility of the dialog's progress bar before it is shown.
|
void |
setCancellable(boolean cancellable)
Specifies whether the progress dialog can be cancelled.
|
void |
setCloseOnFinish(boolean closeOnFinish)
Sets whether the monitor's dialog should close when responding to the
finish() method. |
void |
setDetailContent(java.awt.Component detailContent)
Specifies the content of the dialog to appear in a 'details' section.
|
void |
setDetailVisible(boolean detailVisible)
Sets whether the dialog detail content is made visible by default.
|
void |
setMillisToPopup(int millisToPopup)
Specifies the amount of time it will take for the popup to appear.
|
void |
setModal(boolean isModal) |
void |
start()
Starts the monitor, ensuring the dialog will be displayed after the
configured delay.
|
void |
startImpl()
Starts the monitor, ensuring the dialog will be displayed after the
configured delay.
|
void |
uncancel()
Resets the cancelled state of the progress dialog.
|
public IndeterminateProgressMonitor(java.awt.Component parent, java.lang.String title)
public IndeterminateProgressMonitor(java.awt.Component parent, java.lang.String title, java.lang.Object message, java.lang.String note)
public void startImpl()
protected javax.swing.JProgressBar createProgressBar()
protected void displayImpl()
protected void finishImpl(javax.swing.JProgressBar progressBar)
protected void closeImpl()
public static void main(java.lang.String[] argv) throws java.lang.Exception
java.lang.Exception
public void setCloseOnFinish(boolean closeOnFinish)
finish()
method. By default, this is true
.closeOnFinish
- a decision on dialog closure.public boolean getCloseOnFinish()
finish()
method.public void start()
public void finish()
public void close()
public boolean isCanceled()
public void addCancellationListener(javax.swing.event.ChangeListener l)
public void removeCancellationListener(javax.swing.event.ChangeListener l)
public void setMillisToPopup(int millisToPopup)
millisToPopup
- an int specifying the time in millisecondsgetMillisToPopup()
public int getMillisToPopup()
setMillisToPopup(int)
public void setDetailContent(java.awt.Component detailContent)
detailContent
- the detail content component.getDetailContent()
public java.awt.Component getDetailContent()
setDetailContent(java.awt.Component)
public void setDetailVisible(boolean detailVisible)
detailVisible
- true
if dialog detail will be made visible.public boolean isDetailVisible()
true
if dialog detail will be made visible.public void setBarVisible(boolean barVisible)
true
.barVisible
- the visibility value.isBarVisible()
public boolean isBarVisible()
setBarVisible(boolean)
public void setCancellable(boolean cancellable)
true
.cancellable
- the cancellable value.isCancellable()
public boolean isCancellable()
setCancellable(boolean)
public void display()
close()
public java.awt.Component getComponent()
public boolean isCancelled()
public void uncancel()
public ProgressPanel getPanel()
public final boolean isModal()
public final void setModal(boolean isModal)