new ProgressBar()
This constructor is never used explicitly.
Extends
Members
Methods
-
inherited addClass(name, replaced)
-
Add/replace CSS class(es) for this control
Name Type Description name
string CSS class name(s) to add to the control. Separate class names by a space if more than one class. replaced
string optional CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class. Example
Button.addClass("green");
-
getHeight(){string}
-
Get configured height for progressBar (including unit)
Returns:
Type Description string -
getProgress(){decimal}
-
Gets the current value associated with the Progress Bar.
Returns:
Type Description decimal -
getType(){string}
-
Get descriptive string representing the type of control
Returns:
Type Description string -
getWidth(){string}
-
Get configured width for progressBar (including unit)
Returns:
Type Description string -
inherited hide(collapseFlag)
-
Hide this view/control
Name Type Description collapseFlag
boolean Set to true
to collapse the view (equivalent to a view setting of "NONE")Example
MyView.hide();
-
inherited isBound(){boolean}
-
Indicates bound status of control.
Returns:
Type Description boolean True if the control is bound to coach data. -
inherited isEnabled(){boolean}
-
Checks if the view is enabled or not
Returns:
Type Description boolean Enabled status Example
var enabled = MyView.isEnabled();
-
inherited isVisible(){boolean}
-
Checks whether or not view is visible
Returns:
Type Description boolean Visibility status Example
var visible = MyView.isVisible();
-
inherited propagateUpValueChange(event){boolean}
-
Propagates value change of control up through parent views
Name Type Description event
Event Value change event (usually an onchange event) Returns:
Type Description boolean True if a formula update was triggered on the control's parent, otherwise false Example
MyView.propagateUp(event);
-
setColorStyle(style)
-
Sets color style of progressBar. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"
Name Type Description style
string "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger -
inherited setEnabled(enabled, required)
-
Enable/disable this view/control
Name Type Description enabled
boolean Enabled/read-only flag ( true
to enable view,false
to disable/make read-only)required
boolean Enable/disable required field flag for control Example
MyView.setEnabled(false); //Make MyView read-only
-
setHeight(height)
-
Set height of progressBar (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description height
string -
setMaximum(value)
-
Sets the maximum value associated with the progress bar
Name Type Description value
decimal Maximum value of bar (what constitutes 100%). Note that it is possible for progress to be set past this value, though it will not be apparent. -
setProgress(value)
-
Sets progress status
Name Type Description value
decimal Progress of bar -
setRadius(radius)
-
Sets radius (roundness) of progressBar
Name Type Description radius
string Radius of curvature for progress bar corners -
inherited setVisible(visible, collapse)
-
Show/hide this view/control
Name Type Description visible
boolean Visibility flag ( true
to show view,false
to hide)collapse
boolean Set to true
to collapse the control space whenvisible
is set tofalse
.Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"
-
setWidth(width)
-
Set width of progressBar (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description width
string -
Show this view/control
Example
MyView.show();
-
inherited triggerFormulaUpdates(phase)
-
Broadcasts the expression trigger for the specified view
Name Type Default Description phase
int bpmext.ui.PHASE_NORMAL optional The phase we are currently in Example
MyView.triggerFormulaUpdates();