|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProgressMonitor
The IProgressMonitor
interface is implemented by objects that
monitor the progress of an activity; the methods in this interface are
invoked by code that performs the activity.
All activity is broken down into a linear sequence of tasks against which
progress is reported. When a task begins, a beginTask(String, int)
notification is reported,
followed by any number and mixture of progress reports (worked()
) and subtask notifications (subTask(String)
). When the task is
eventually completed, a done()
notification is reported. After
the done()
notification, the progress monitor cannot be reused;
i.e.,
beginTask(String, int)
cannot be called again after the call to
done()
.
A request to cancel an operation can be signaled using the
setCanceled
method. Operations taking a progress monitor are
expected to poll the monitor (using isCanceled
) periodically and
abort at their earliest convenience. Operation can however choose to ignore
cancelation requests.
Since notification is synchronous with the activity itself, the listener should provide a fast and robust implementation. If the handling of notifications would involve blocking operations, or operations which might throw uncaught exceptions, the notifications should be queued, and the actual processing deferred (or perhaps delegated to a separate thread).
Clients may implement this interface.
Field Summary | |
---|---|
static int |
UNKNOWN
Constant indicating an unknown amount of work. |
Method Summary | |
---|---|
void |
beginTask(java.lang.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. |
void |
finished(java.lang.Object element,
java.lang.Object context)
Notifies that overall process was finished. |
void |
internalWorked(double work)
Internal method to handle scaling correctly. |
boolean |
isCanceled()
Returns whether cancelation of current operation has been requested. |
void |
postTask(java.lang.Object element,
java.lang.Object context)
Notifies that a task was finished. |
void |
preTask(java.lang.Object element,
java.lang.Object context)
Notifies that a task will be started. |
void |
setCanceled(boolean value)
Sets the cancel state to the given value. |
void |
setTaskName(java.lang.String name)
Sets the task name to the given value. |
void |
started(java.lang.Object element,
java.lang.Object context)
Notifies that overall process was started. |
void |
subTask(java.lang.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. |
Field Detail |
---|
static final int UNKNOWN
Method Detail |
---|
void beginTask(java.lang.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
implemenation is free to indicate progress in a way which
doesn't require the total number of work units in advance.void done()
void internalWorked(double work)
work
- the amount of work doneboolean isCanceled()
true
if cancellation has been requested, and
false
otherwisesetCanceled(boolean)
void setCanceled(boolean value)
value
- true
indicates that cancelation has been
requested (but not necessarily acknowledged);
false
clears this flagisCanceled()
void setTaskName(java.lang.String name)
name
- the name (or description) of the main taskbeginTask(java.lang.String, int)
void subTask(java.lang.String name)
name
- the name (or description) of the subtaskvoid worked(int work)
work
- the number of work units just completedvoid preTask(java.lang.Object element, java.lang.Object context)
postTask()
call.
element
- The element that fired that notificationcontext
- the context of executionvoid postTask(java.lang.Object element, java.lang.Object context)
preTask()
call.
element
- The element that fired that notificationcontext
- the context of executionvoid started(java.lang.Object element, java.lang.Object context)
element
- The element that fired that notificationcontext
- the context of executionvoid finished(java.lang.Object element, java.lang.Object context)
element
- The element that fired that notificationcontext
- the context of execution
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |