public interface ProgressMonitor
| Modifier and Type | Method and Description |
|---|---|
void |
beginTask(String label,
int totalWork)
Informs the progress monitor that a new task has been started, with a given number of expected steps.
|
void |
done()
Informs the progress monitor that all is completed.
|
boolean |
isCanceled()
Typically used by the (long-running) process to determine whether the user has requested cancellation.
|
void |
setCanceled(boolean value)
Typically called from a parallel thread triggered by the user, this informs the progress monitor that it needs to
return
true for isCanceled. |
void |
setTaskName(String value)
Changes the name or label of the current task.
|
void |
subTask(String label)
Sets the label that serves as sub-task, typically printed under the main task name.
|
void |
worked(int amount)
Informs the progress monitor that one or more steps have been completed towards the current task (see
beginTask). |
boolean isCanceled()
void beginTask(String label, int totalWork)
label - the name of the tasktotalWork - the number of steps (see worked) that is expected to be needed to complete the taskvoid done()
void setCanceled(boolean value)
true for isCanceled.
Once a process has been canceled, it should not be un-canceled.value - true if canceledvoid setTaskName(String value)
value - void subTask(String label)
label - the subtask labelvoid worked(int amount)
beginTask).amount - the number of steps completedCopyright © 2019 TopQuadrant, Inc.. All rights reserved.