|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.runtime.ProgressMonitorWrapper
public abstract class ProgressMonitorWrapper
An abstract wrapper around a progress monitor which,
unless overridden, forwards IProgressMonitor
and IProgressMonitorWithBlocking methods to the wrapped progress monitor.
This class can be used without OSGi running.
Clients may subclass.
| 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 |
clearBlocked()
This implementation of a IProgressMonitorWithBlocking
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 |
setBlocked(IStatus reason)
This implementation of a IProgressMonitorWithBlocking
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 to| Method 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 IProgressMonitorname - 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.IProgressMonitor.beginTask(String, int)public void clearBlocked()
IProgressMonitorWithBlocking
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
clearBlocked in interface IProgressMonitorWithBlockingIProgressMonitorWithBlocking.clearBlocked()public void done()
IProgressMonitor
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
done in interface IProgressMonitorIProgressMonitor.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 IProgressMonitorwork - the amount of work doneIProgressMonitor.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 IProgressMonitortrue if cancellation has been requested,
and false otherwiseIProgressMonitor.isCanceled()public void setBlocked(IStatus reason)
IProgressMonitorWithBlocking
method forwards to the wrapped progress monitor.
Clients may override this method to do additional
processing.
setBlocked in interface IProgressMonitorWithBlockingreason - an optional status object whose message describes the
reason why this operation is blocked, or null if this
information is not available.IProgressMonitorWithBlocking.setBlocked(IStatus)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 IProgressMonitorb - 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 IProgressMonitorname - the name (or description) of the main taskIProgressMonitor.setTaskName(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 IProgressMonitorname - the name (or description) of the subtaskIProgressMonitor.subTask(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 IProgressMonitorwork - the number of work units just completedIProgressMonitor.worked(int)
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.