|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ProgressMonitor
A progress reporting interface.
| Field Summary | |
|---|---|
static int |
UNKNOWN
Constant indicating the total work units cannot be predicted. |
| Method Summary | |
|---|---|
void |
beginTask(java.lang.String title,
int totalWork)
Begin processing a single task. |
void |
endTask()
Finish the current task, so the next can begin. |
boolean |
isCancelled()
Check for user task cancellation. |
void |
start(int totalTasks)
Advise the monitor of the total number of subtasks. |
void |
update(int completed)
Denote that some work units have been completed. |
| Field Detail |
|---|
static final int UNKNOWN
| Method Detail |
|---|
void start(int totalTasks)
This should be invoked at most once per progress monitor interface.
totalTasks - the total number of tasks the caller will need to complete
their processing.
void beginTask(java.lang.String title,
int totalWork)
title - title to describe the task. Callers should publish these as
stable string constants that implementations could match
against for translation support.totalWork - total number of work units the application will perform;
UNKNOWN if it cannot be predicted in advance.void update(int completed)
This is an incremental update; if invoked once per work unit the correct
value for our argument is 1, to indicate a single unit of
work has been finished by the caller.
completed - the number of work units completed since the last call.void endTask()
boolean isCancelled()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||