This class is used to display a progress bar to monitor the work performed to complete a task. It is a wrapper for the [Java Class:views/MonitorState] class. |
Author | Fred McGuirk |
Date | Dec 11, 2006 |
Outputfile | ProgressMonitor.pvc |
Forcelinenumbers | false |
Get a reference to a ProgressMonitor from the [Java Class:views/UIManager] object | ||||||
|
No Properties |
FUNCTION done() This method is used to indicate that the process has completed. | ||||
FUNCTION getName$() Return the name of the task | ||||
FUNCTION getTotalWork() Return the total amount of work to be performed for this task | ||||
FUNCTION getWorked() Return the amount of work that has been recored up to this point in time | ||||
FUNCTION isActive() Return true (1) if the initialization of the class was successful | ||||
FUNCTION isCancelled() Return true (1) if the task has been cancelled | ||||
FUNCTION setDialogueVisible(initBool) Show/hide the dialogue window that shows the progress bar | ||||
| ||||
FUNCTION setPerCentageWorked(initPerCent) Set the per centage of work that has been completed | ||||
FUNCTION setTaskDetail(initText$) Update the task detail with a short description of the current activity | ||||
| ||||
FUNCTION setTaskName(initTaskName$) Set / Change the name of this task | ||||
| ||||
FUNCTION setWorked(initWork) Add to the units of work that have been completed. This value cannot be larger that the total work set for the task. | ||||
|
![]() |