-
-
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");
-
-
Programmatically click this icon
-
-
Gets color style of icon. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"|"T"
Returns:
-
-
Get configured size for icon (including unit)
Returns:
-
-
Get descriptive string representing the type of control
Returns:
-
-
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();
-
-
Indicates bound status of control.
Returns:
Type |
Description |
boolean
|
True if the control is bound to coach data. |
-
-
Checks if the view is enabled or not
Returns:
Type |
Description |
boolean
|
Enabled status |
Example
var enabled = MyView.isEnabled();
-
-
Checks if control label is visible
Returns:
Type |
Description |
boolean
|
Label visibility status |
Example
var labelVisible = MyView.isLabelVisible();
-
-
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);
-
-
Sets color style of icon. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"|"T"
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 | "TRANSPARENT"|"T"=Transparent |
-
-
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
-
-
Sets icon to display on the icon
Name |
Type |
Description |
icon |
string
|
See icon reference for possible values (note the "fa-" prefix is optional) |
-
-
Sets size of icon. Note that this changes the size of the icon itself (the image), not the container
Name |
Type |
Description |
size |
string
|
Icon size |
-
-
Show/hide the label of this view/control
Name |
Type |
Description |
visible |
boolean
|
Label visibility flag (true to show view label, false to hide) |
Example
MyView.setLabelVisible(false);
-
-
Sets outline style of icon
Name |
Type |
Description |
outline |
boolean
|
{true | false} Set to true to use outline only |
-
-
Sets radius (roundness) of icon
Name |
Type |
Description |
radius |
string
|
Radius of curvature for icon container corners |
-
-
Set size of icon (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name |
Type |
Description |
size |
string
|
Size of icon container |
-
-
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 when visible is set to false . |
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"
-
-
Show this view/control
Example
MyView.show();
-
-
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();