|
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.NullProgressMonitor
A default progress monitor implementation suitable for subclassing.
This implementation supports cancelation. The default implementations of the other methods do nothing.
Field Summary |
Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor |
UNKNOWN |
Constructor Summary | |
NullProgressMonitor()
Constructs a new progress monitor. |
Method Summary | |
void |
beginTask(String name,
int totalWork)
This implementation does nothing. |
void |
done()
This implementation does nothing. |
void |
internalWorked(double work)
This implementation does nothing. |
boolean |
isCanceled()
This implementation returns the value of the internal state variable set by setCanceled . |
void |
setCanceled(boolean cancelled)
This implementation sets the value of an internal state variable. |
void |
setTaskName(String name)
This implementation does nothing. |
void |
subTask(String name)
This implementation does nothing. |
void |
worked(int work)
This implementation does nothing. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public NullProgressMonitor()
Method Detail |
public void beginTask(String name, int totalWork)
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()
done
in interface IProgressMonitor
IProgressMonitor.done()
public void internalWorked(double work)
internalWorked
in interface IProgressMonitor
IProgressMonitor.internalWorked(double)
public boolean isCanceled()
setCanceled
.
Subclasses which override this method should
override setCanceled
as well.
isCanceled
in interface IProgressMonitor
true
if cancellation has been requested,
and false
otherwiseIProgressMonitor.isCanceled()
,
IProgressMonitor.setCanceled(boolean)
public void setCanceled(boolean cancelled)
isCanceled
as well.
setCanceled
in interface IProgressMonitor
cancelled
- true
indicates that cancelation has
been requested (but not necessarily acknowledged);
false
clears this flagIProgressMonitor.isCanceled()
,
IProgressMonitor.setCanceled(boolean)
public void setTaskName(String name)
setTaskName
in interface IProgressMonitor
name
- the name (or description) of the main taskIProgressMonitor.setTaskName(java.lang.String)
public void subTask(String name)
subTask
in interface IProgressMonitor
name
- the name (or description) of the subtaskIProgressMonitor.subTask(java.lang.String)
public void worked(int work)
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 |