|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.core.runtime.ProgressMonitorWrapper
An abstract wrapper around a progress monitor which,
unless overridden, forwards IProgressMonitor
methods to the wrapped progress monitor.
Clients may subclass.
Field Summary |
Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor |
UNKNOWN |
Constructor Summary | |
protected |
ProgressMonitorWrapper(IProgressMonitor monitor)
Creates a new wrapper around the given monitor. |
Method Summary | |
void |
beginTask(String name,
int totalWork)
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
void |
done()
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
IProgressMonitor |
getWrappedProgressMonitor()
Returns the wrapped progress monitor. |
void |
internalWorked(double work)
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
boolean |
isCanceled()
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
void |
setCanceled(boolean b)
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
void |
setTaskName(String name)
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
void |
subTask(String name)
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
void |
worked(int work)
This implementation of a IProgressMonitor
method forwards to the wrapped progress monitor. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ProgressMonitorWrapper(IProgressMonitor monitor)
monitor
- the progress monitor to forward toMethod Detail |
public void beginTask(String name, int totalWork)
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
beginTask
in interface IProgressMonitor
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.IProgressMonitor.beginTask(java.lang.String, int)
public void done()
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
done
in interface IProgressMonitor
IProgressMonitor.done()
public IProgressMonitor getWrappedProgressMonitor()
public void internalWorked(double work)
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
internalWorked
in interface IProgressMonitor
IProgressMonitor.internalWorked(double)
public boolean isCanceled()
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
isCanceled
in interface IProgressMonitor
true
if cancellation has been requested,
and false
otherwiseIProgressMonitor.isCanceled()
public void setCanceled(boolean b)
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
setCanceled
in interface IProgressMonitor
b
- true
indicates that cancelation has
been requested (but not necessarily acknowledged);
false
clears this flagIProgressMonitor.setCanceled(boolean)
public void setTaskName(String name)
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
setTaskName
in interface IProgressMonitor
name
- the name (or description) of the main taskIProgressMonitor.setTaskName(java.lang.String)
public void subTask(String name)
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
subTask
in interface IProgressMonitor
name
- the name (or description) of the subtaskIProgressMonitor.subTask(java.lang.String)
public void worked(int work)
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
worked
in interface IProgressMonitor
work
- the number of work units just completedIProgressMonitor.worked(int)
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |