|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sodius.mdw.core.util.progress.ProgressMonitorWrapper
public class ProgressMonitorWrapper
An abstract wrapper around a progress monitor which forwards ProgressMonitor
methods to the wrapped progress monitor.
Clients may subclass.
| Field Summary |
|---|
| Fields inherited from interface com.sodius.mdw.core.util.progress.ProgressMonitor |
|---|
UNKNOWN |
| Constructor Summary | |
|---|---|
ProgressMonitorWrapper(ProgressMonitor monitor)
Creates a new wrapper around the given monitor. |
|
| Method Summary | |
|---|---|
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. |
ProgressMonitor |
getWrappedProgressMonitor()
Returns the wrapped progress monitor. |
void |
internalWorked(double work)
Internal method to handle scaling correctly. |
boolean |
isCanceled()
Returns whether cancelation of current operation has been requested. |
void |
setCanceled(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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ProgressMonitorWrapper(ProgressMonitor monitor)
monitor - the progress monitor to forward to.| Method Detail |
|---|
public ProgressMonitor getWrappedProgressMonitor()
public void beginTask(String name,
int totalWork)
ProgressMonitor
beginTask in interface ProgressMonitorname - 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.public void done()
ProgressMonitor
done in interface ProgressMonitorpublic void internalWorked(double work)
ProgressMonitor
internalWorked in interface ProgressMonitorwork - the amount of work donepublic boolean isCanceled()
ProgressMonitor
isCanceled in interface ProgressMonitortrue if cancellation has been requested,
and false otherwiseProgressMonitor.setCanceled(boolean)public void setCanceled(boolean value)
ProgressMonitor
setCanceled in interface ProgressMonitorvalue - true indicates that cancelation has
been requested (but not necessarily acknowledged);
false clears this flagProgressMonitor.isCanceled()public void setTaskName(String name)
ProgressMonitor
setTaskName in interface ProgressMonitorname - the name (or description) of the main taskProgressMonitor.beginTask(java.lang.String, int)public void subTask(String name)
ProgressMonitor
subTask in interface ProgressMonitorname - the name (or description) of the subtaskpublic void worked(int work)
ProgressMonitor
worked in interface ProgressMonitorwork - the number of work units just completed
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||