Constructor
new module:caplin/element/styler/ProgressCellStyler()
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.
Extends:
Extends
Methods
-
style(vValue, mAttributes, oControl)
-
Styles the supplied control with stale CSS styles, according to the supplied renderer attributes.
Parameters:
Name Type Description vValue
Variant the value. mAttributes
Map the map of attributes. Properties
Name Type Attributes Description TimeOutLeft
int the number of seconds left for the action to time-out. TimeOut
int the number of seconds initially allocated for the action to execute. BarColor
String colour of the progress bar. ImminentTimeoutPercentage
int <optional>
percentage progress remaining at which the progress bar should change colour to alert imminent timeout. ImminentTimeoutBarColor
int <optional>
progress bar colour to alert imminent timeout. oControl
module:caplin/control/Control the control. -
toString() → {String}
-
Returns a human-readable string representation of the styler, which is useful for debugging.
Returns:
The string representation- Type
- String