Class ProgressMonitor


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.

Build Information

Author Fred McGuirk
Date Dec 11, 2006
Outputfile ProgressMonitor.pvc
Forcelinenumbers false

Constructor

Get a reference to a ProgressMonitor from the [Java Class:views/UIManager] object

ParameterDescription
initName$ The name for this task
initTotalWork An integer for the units of work to be completed (Indeterminate = -1)

Properties

No Properties

Methods

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

ParameterDescription
initBool A boolean value (0=False, 1=True) to indicate the state to be set for the dialogue window
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

ParameterDescription
initText$ A string variable that contains the description to be displayed
FUNCTION setTaskName(initTaskName$)

Set / Change the name of this task

ParameterDescription
initTaskName$ A string varible that contains the new name for the 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.

ParameterDescription
initWork The total units of work that have been completed