|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.core.alg.BasicProgressMonitor
de.cau.cs.kieler.core.ui.KielerProgressMonitor
public class KielerProgressMonitor
Wrapper class for Eclipse progress monitors.
Field Summary |
---|
Fields inherited from interface de.cau.cs.kieler.core.alg.IKielerProgressMonitor |
---|
UNKNOWN_WORK |
Constructor Summary | |
---|---|
KielerProgressMonitor(IProgressMonitor theprogressMonitor)
Creates a progress monitor wrapper for a given Eclipse progress monitor. |
|
KielerProgressMonitor(IProgressMonitor theprogressMonitor,
int maxLevels)
Creates a progress monitor wrapper with given maximal number of hierarchy levels. |
Method Summary | |
---|---|
protected void |
doBegin(String name,
float totalWork,
boolean topInstance,
int maxHierarchyLevels)
Reports to the integrated Eclipse progress monitor that the current task begins. |
protected void |
doDone(boolean topInstance,
int maxHierarchyLevels)
Reports to the integrated Eclipse progress monitor that the main task is done, if this is the top instance. |
BasicProgressMonitor |
doSubTask(float work,
int maxHierarchyLevels)
Creates a new instance of KielerProgressMonitor . |
protected void |
doWorked(float work,
float completedWork,
boolean topInstance)
Reports to the integrated Eclipse progress monitor that some work was done, if this is the top instance. |
boolean |
isCanceled()
Returns true if the integrated Eclipse progress monitor reports cancellation. |
Methods inherited from class de.cau.cs.kieler.core.alg.BasicProgressMonitor |
---|
begin, done, getExecutionTime, getParentMonitor, getSubMonitors, getTaskName, subTask, worked |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public KielerProgressMonitor(IProgressMonitor theprogressMonitor)
theprogressMonitor
- the progress monitorpublic KielerProgressMonitor(IProgressMonitor theprogressMonitor, int maxLevels)
theprogressMonitor
- the progress monitormaxLevels
- maximal number of hierarchy levels for which progress is reportedMethod Detail |
---|
protected void doBegin(String name, float totalWork, boolean topInstance, int maxHierarchyLevels)
doBegin
in class BasicProgressMonitor
name
- task nametotalWork
- total amount of work for the new tasktopInstance
- if true, this progress monitor is the top instancemaxHierarchyLevels
- maximal number of reported hierarchy levelsprotected void doDone(boolean topInstance, int maxHierarchyLevels)
doDone
in class BasicProgressMonitor
topInstance
- if true, this progress monitor is the top instancemaxHierarchyLevels
- maximal number of reported hierarchy levelspublic boolean isCanceled()
isCanceled
in interface IKielerProgressMonitor
isCanceled
in class BasicProgressMonitor
public BasicProgressMonitor doSubTask(float work, int maxHierarchyLevels)
KielerProgressMonitor
.
doSubTask
in class BasicProgressMonitor
work
- amount of work that is completed in the current monitor
instance when the sub-task endsmaxHierarchyLevels
- the maximal number of hierarchy levels for the parent
progress monitor
protected void doWorked(float work, float completedWork, boolean topInstance)
doWorked
in class BasicProgressMonitor
work
- amount of work that has just been donecompletedWork
- total number of work that is done for this tasktopInstance
- if true, this progress monitor is the top instance
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |