public interface UIProgressMonitor
Modifier and Type | Field and Description |
---|---|
static int |
UNKNOWN
Constant indicating an unknown amount of work.
|
Modifier and Type | Method and Description |
---|---|
void |
beginTask(String name,
int totalWork)
Notifies that the main task is beginning.
|
void |
done()
Notifies that the work is done; that is, either the main task is completed or the user canceled it.
|
boolean |
isCancelled()
Returns whether cancellation of current operation has been requested.
|
void |
setCancelled(boolean value)
Sets the cancel state to the given value.
|
void |
setTaskName(String name)
Sets the task name to the given value.
|
void |
subTask(String name)
Notifies that a subtask of the main task is beginning.
|
void |
worked(int work)
Notifies that a given number of work unit of the main task has been completed.
|
static final int UNKNOWN
void beginTask(String name, int totalWork)
name
- the name (or description) of the main tasktotalWork
- the total number of work units into which the main task is been subdivided. If the value is
UNKNOWN
the implementation is free to indicate progress in a way which doesn't require the
total number of work units in advance.void done()
boolean isCancelled()
true
if cancellation has been requested, and false
otherwisesetCancelled(boolean)
void setCancelled(boolean value)
value
- true
indicates that cancellation has been requested (but not necessarily acknowledged);
false
clears this flagisCancelled()
void setTaskName(String name)
name
- the name (or description) of the main taskbeginTask(java.lang.String, int)
void subTask(String name)
name
- the name (or description) of the subtaskvoid worked(int work)
work
- a non-negative number of work units just completedCopyright © 2014 JBoss by Red Hat. All rights reserved.