|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.dlsc.flexgantt.command.ProgressMonitorWrapper com.dlsc.flexgantt.command.SubProgressMonitor
public class SubProgressMonitor
A progress monitor that uses a given amount of work ticks from a parent monitor. It can be used as follows:
try { pm.beginTask("Main Task", 100); doSomeWork(pm, 30); SubProgressMonitor subMonitor= new SubProgressMonitor(pm, 40); try { subMonitor.beginTask("", 300); doSomeWork(subMonitor, 300); } finally { subMonitor.done(); } doSomeWork(pm, 30); } finally { pm.done(); }
This class may be instantiated or subclassed by clients.
Field Summary | |
---|---|
static int |
PREPEND_MAIN_LABEL_TO_SUBTASK
Style constant indicating that the main task label should be prepended to the subtask label. |
static int |
SUPPRESS_SUBTASK_LABEL
Style constant indicating that calls to subTask
should not have any effect. |
Fields inherited from interface com.dlsc.flexgantt.command.IProgressMonitor |
---|
UNKNOWN |
Constructor Summary | |
---|---|
SubProgressMonitor(IProgressMonitor monitor,
int ticks)
Creates a new sub-progress monitor for the given monitor. |
|
SubProgressMonitor(IProgressMonitor monitor,
int ticks,
int style)
Creates a new sub-progress monitor for the given monitor. |
Method Summary | |
---|---|
void |
beginTask(java.lang.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. |
void |
internalWorked(double work)
This implementation of a IProgressMonitor method forwards
to the wrapped progress monitor. |
void |
subTask(java.lang.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 com.dlsc.flexgantt.command.ProgressMonitorWrapper |
---|
getWrappedProgressMonitor, isCanceled, setCanceled, setTaskName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int SUPPRESS_SUBTASK_LABEL
subTask
should not have any effect.
SubProgressMonitor(IProgressMonitor,int,int)
,
Constant Field Valuespublic static final int PREPEND_MAIN_LABEL_TO_SUBTASK
SubProgressMonitor(IProgressMonitor,int,int)
,
Constant Field ValuesConstructor Detail |
---|
public SubProgressMonitor(IProgressMonitor monitor, int ticks)
monitor
- the parent progress monitorticks
- the number of work ticks allocated from the
parent monitorpublic SubProgressMonitor(IProgressMonitor monitor, int ticks, int style)
monitor
- the parent progress monitorticks
- the number of work ticks allocated from the
parent monitorstyle
- one of
SUPPRESS_SUBTASK_LABEL
PREPEND_MAIN_LABEL_TO_SUBTASK
SUPPRESS_SUBTASK_LABEL
,
PREPEND_MAIN_LABEL_TO_SUBTASK
Method Detail |
---|
public void beginTask(java.lang.String name, int totalWork)
ProgressMonitorWrapper
IProgressMonitor
method forwards
to the wrapped progress monitor. Clients may override this method to do
additional processing.
beginTask
in interface IProgressMonitor
beginTask
in class ProgressMonitorWrapper
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
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 done()
ProgressMonitorWrapper
IProgressMonitor
method forwards
to the wrapped progress monitor. Clients may override this method to do
additional processing.
done
in interface IProgressMonitor
done
in class ProgressMonitorWrapper
IProgressMonitor.done()
public void internalWorked(double work)
ProgressMonitorWrapper
IProgressMonitor
method forwards
to the wrapped progress monitor. Clients may override this method to do
additional processing.
internalWorked
in interface IProgressMonitor
internalWorked
in class ProgressMonitorWrapper
work
- the amount of work doneIProgressMonitor.internalWorked(double)
public void subTask(java.lang.String name)
ProgressMonitorWrapper
IProgressMonitor
method forwards
to the wrapped progress monitor. Clients may override this method to do
additional processing.
subTask
in interface IProgressMonitor
subTask
in class ProgressMonitorWrapper
name
- the name (or description) of the subtaskIProgressMonitor.subTask(String)
public void worked(int work)
ProgressMonitorWrapper
IProgressMonitor
method forwards
to the wrapped progress monitor. Clients may override this method to do
additional processing.
worked
in interface IProgressMonitor
worked
in class ProgressMonitorWrapper
work
- the number of work units just completedIProgressMonitor.worked(int)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |