public class RestartableProgressBar
extends java.lang.Object
implements java.lang.Runnable
Constructor and Description |
---|
RestartableProgressBar(java.awt.Component parent, java.lang.String dialogTitle, java.lang.Runnable runnable, boolean useBusyBar)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
getStatus() |
boolean |
hasUserCancelled()
The client code's run() method that implements the long-running process should call this method to determine if the user has pressed the Cancel button on the ProgressBar's dialog to terminate the long-running process.
|
boolean |
isCancelable() |
void |
run()
The entrypoint for the thread that executes the long-running process.
|
void |
setCancelable(boolean canCancel) |
void |
setDoneStatus()
The client code should call this when the long-running process is complete.
|
void |
setThreadComplete(boolean complete) |
void |
sleepForUIToRepaint()
The client code should call this in it's run() method that implements the long-running process.
|
void |
start(java.lang.String initialText, java.lang.String stepText)
Starts the ProgressBar.
|
void |
updateProgress(int completionStatus, java.lang.String progressText, java.lang.String stepText)
The client code's run() method that implements the long-running process should use this method to update the ProgressBar to indicate the progress made in the long-running process.
|
void |
updateProgress(java.lang.String progressText, java.lang.String stepText)
The client code's run() method that implements the long-running process should use this method to update the ProgressBar to indicate the progress made in the long-running process.
|
void |
waitUntilDone()
The client code should call this to wait until the long-running process is complete.
|
public RestartableProgressBar(java.awt.Component parent, java.lang.String dialogTitle, java.lang.Runnable runnable, boolean useBusyBar)
parent
- The UI object to use as the ProgressBar dialog's parentdialogTitle
- The title to use for the ProgressBar dialogrunnable
- The Runnable object whose run() method implements the long-running processuseBusyBar
- Set to true when the task is indeterminate; false when the the task is determinatepublic void setCancelable(boolean canCancel)
public boolean isCancelable()
public void start(java.lang.String initialText, java.lang.String stepText)
initialText
- The text to display just above the progress indicator. An example might be "Downloading components."stepText
- The text to display just below the progress indicator. An example might be "Retrieving file abc.jar."public void updateProgress(int completionStatus, java.lang.String progressText, java.lang.String stepText)
completionStatus
- The amount of progress that has been made.progressText
- The text to display just above the progress indicator. If a null string or zero-length string is passed in the text will not be updated.stepText
- The text to display just below the progress indicator. If a null string or zero-length string is passed in the text will not be updated.public void updateProgress(java.lang.String progressText, java.lang.String stepText)
progressText
- The text to display just above the progress indicator. If a null string or zero-length string is passed in the text will not be updated.stepText
- The text to display just below the progress indicator. If a null string or zero-length string is passed in the text will not be updated.public boolean hasUserCancelled()
public void sleepForUIToRepaint()
public void waitUntilDone()
public void setDoneStatus()
public void run()
run
in interface java.lang.Runnable
public int getStatus()
public void setThreadComplete(boolean complete)