ProgressDisplay

Overview

The ProgressDisplay Components provide easy and customizable ways to provide feedback to users regarding the progress of some process, most likely a loading process.

The displays come in two flavors: (i) the ProgressDisplayIndeterminate component, and the (ii) ProgressDisplayDeterminate component.

Creating the ProgressDisplays

Both ProgressDisplays extend the Ardisia Pane class.

"ProgressDisplayIndeterminate" vs. "ProgressDisplayDeterminate"

The "ProgressDisplayIndeterminate" component has no determined time to end. This is why it is indeterminate. The "ProgressDisplayDeterminate" is designed to track the progress of a process explicitly and close upon completion. This is why it is determinate.

This is why the default ProgressDisplayIndeterminate skin plays a snake animation (no beginning or end) and the default ProgressDisplayDeterminate skin displays an arc that has a specific beginning and end.

Using the ProgressDisplays

Both display types are not designed to be directly added to the displayList. Rather, they are designed to be initialized and opened by calling show() and removed by calling close(). Use the modal flag to make the progress displays modal and blocking.

To set a timeout for the display of the ProgressDisplays use the "timeoutDuration" property. This is useful in case the process never completes so the display will eventually be removed.

A delay before display can be added via the "delayBeforeFloat" property. This is useful to cancel the display of the ProgressDisplay if the duration would have been very short or the user changed his/her mind. Similarly, the "minimumFloatTime" property can be set to ensure that the display will be visible for at least a certain duration. Useful to prevent short or flickering display durations.

To delay removal after close() is called, use the "delayAfterCloseFloat" property.

Messages

Update the label message delivered by the displays via the "label" property. Not supported by the default skin for the ProgressDisplayDeterminate class. To add support to the ProgressDisplayDeterminate class, add the relevant skin part to a custom skin.

Themes & Skinning

Skins are provided for the Determinate and Indeterminate ProgressDisplays for the Spark theme. By default, the ProgressDisplayIndeterminate skin uses a snake animation and the ProgressDisplayDeterminate skin draws an arc as the process progresses.

Example

See the ProgressDisplays demo application for example code.

Back To Top