Communicator UI: 5 FoamProgressDialog

When performing a time-consuming task, it is wise to prevent user frustration and use a FoamProcessDialogClass which informs the user of the task's progress and offers much-appreciated feedback.

The FoamProgress dialog provides the following functionality:

A default animation of gears in motion, informing the user that an action is taking place.
A "status indicator" consisting of a series of five dots. These five dots get displayed as the task gets closer to completion. Next to this status indicator, you may include status text, if desired.
Text which describes the task.
A default Cancel trigger.

As with a Flashing Note, a FoamProgress dialog should be placed as the root of an unattached tree within its own UI block (resource). To initiate the Foam Progress dialog, call the routine PutUpDialogViaUIThread(), passing the optr of the dialog box template. This routine will copy the template resource, attach it to the application tree, and manage its thread of execution. The dialog will be run within the specific UI thread, avoiding blocking the application thread.

The dialog can be taken down with TakeDownDialogViaUIThread() or by placing HINT_FOAM_PROGRESS_DIALOG_DESTROY_SELF_AFTER_DISMISS on the object.

FoamProgressDialog Instance Data

Setting Up the Template

Using a FoamProgressDialog

GEOS SDK TechDocs |

4 FlashingNoteClass | Next:

6 Routines for Lists