|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.dlsc.flexgantt.swing.GanttChartProgressMonitor
public class GanttChartProgressMonitor
A progress monitor implementation for the Gantt chart. The monitor will
delegate all calls to an instance of ProgressMonitor
.
Field Summary |
---|
Fields inherited from interface com.dlsc.flexgantt.command.IProgressMonitor |
---|
UNKNOWN |
Constructor Summary | |
---|---|
GanttChartProgressMonitor(AbstractGanttChart gc)
Constructs a new progress monitor for the given Gantt chart. |
Method Summary | |
---|---|
void |
beginTask(java.lang.String name,
int totalWork)
Notifies that the main task is beginning. |
void |
done()
Notifies that the work is done; that is, either the main task is completed or the user canceled it. |
void |
internalWorked(double work)
Internal method to handle scaling correctly. |
boolean |
isCanceled()
Returns whether cancelation of current operation has been requested. |
void |
setCanceled(boolean value)
Sets the cancel state to the given value. |
void |
setTaskName(java.lang.String name)
Sets the task name to the given value. |
void |
subTask(java.lang.String name)
Notifies that a subtask of the main task is beginning. |
void |
worked(int work)
Notifies that a given number of work unit of the main task has been completed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GanttChartProgressMonitor(AbstractGanttChart gc)
gc
- the parent Gantt chartMethod Detail |
---|
public void beginTask(java.lang.String name, int totalWork)
IProgressMonitor
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
implementation is free to indicate progress in a way which
doesn't require the total number of work units in advance.public void done()
IProgressMonitor
done
in interface IProgressMonitor
public void setCanceled(boolean value)
IProgressMonitor
setCanceled
in interface IProgressMonitor
value
- true
indicates that cancelation has been
requested (but not necessarily acknowledged);
false
clears this flagIProgressMonitor.isCanceled()
public boolean isCanceled()
IProgressMonitor
isCanceled
in interface IProgressMonitor
true
if cancellation has been requested, and
false
otherwiseIProgressMonitor.setCanceled(boolean)
public void setTaskName(java.lang.String name)
IProgressMonitor
setTaskName
in interface IProgressMonitor
name
- the name (or description) of the main taskIProgressMonitor.beginTask(java.lang.String, int)
public void subTask(java.lang.String name)
IProgressMonitor
subTask
in interface IProgressMonitor
name
- the name (or description) of the subtaskpublic void worked(int work)
IProgressMonitor
worked
in interface IProgressMonitor
work
- the number of work units just completedpublic void internalWorked(double work)
IProgressMonitor
internalWorked
in interface IProgressMonitor
work
- the amount of work done
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |