Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Singleton
caplin.element.styler

ProgressCellStyler

Extends caplin.element.Styler.
Applies CSS styles to reflect an action's progress as a progress bar. ProgressCellStyler is typically used in the XML Renderer Framework, as a styler for a ProgressGridCellControl. The rendered progress bar is displayed as a right-aligned bar decreasing in length as time elapses.

Constructor Summary

Attributes Name and Description
caplin.element.styler.ProgressCellStyler()

Method Summary

Attributes Name and Description
void style(Variant vValue, Map mAttributes, caplin.control.Control oControl)

Styles the supplied control with stale CSS styles, according to the supplied renderer attributes.
String toString()

Returns a human-readable string representation of the styler, which is useful for debugging.

Constructor Detail

► caplin.element.styler.ProgressCellStyler()

Method Detail

► void style(Variant vValue, Map mAttributes, caplin.control.Control oControl)

Styles the supplied control with stale CSS styles, according to the supplied renderer attributes.

Attribute Options:

Option Description
TimeOutLeft the number of seconds left for the action to time-out (required)
TimeOut the number of seconds initially allocated for the action to execute (required)
BarColor colour of the progress bar (required)
ImminentTimeoutPercentage percentage progress remaining at which the progress bar should change colour to alert imminent timeout (optional)
ImminentTimeoutBarColor progress bar colour to alert imminent timeout (optional)

Parameters
Variant vValue the value.
Map mAttributes the map of attributes.
caplin.control.Control oControl the control.

► String toString()

Returns a human-readable string representation of the styler, which is useful for debugging.

Returns
The string representation