-
-
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 button
-
-
Set focus on this control
-
-
Gets color style of button. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"
Returns:
-
-
Get help text for button
Returns:
-
-
Gets shape style of button. NOTE: This always returns the shape style as set, to avoid ambiguity always set the shape style using "D"|"R"|"F"
Returns:
-
-
Gets size style of button. NOTE: This always returns the size style as set, to avoid ambiguity always set the size style using "D"|"S"|"L"|"X"
Returns:
-
-
Get tab index for Button control
Returns:
-
-
Get text of button
Returns:
-
-
Get descriptive string representing the type of control
Returns:
-
-
Get configured width for button (including unit)
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 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 button. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"
Name |
Type |
Description |
style |
string
|
"DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"PRI"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|ERROR|ERR"|"E"|"G"=Danger |
-
-
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
-
-
Set help text for button
Name |
Type |
Description |
text |
string
|
Rollover text to be set |
-
-
Sets icon to display on the button
Name |
Type |
Description |
icon |
string
|
visit http://fontawesome.io/icons/ for icon options |
-
-
Sets outline style of button
Name |
Type |
Description |
outline |
boolean
|
{true | false} |
-
-
Sets shape style of button. NOTE: to avoid ambiguity always set the shape style using "D"|"R"|"F"
Name |
Type |
Description |
style |
string
|
"Default"|"D"=Default | "ROUNDED"|ROUND"|"R"=Rounded | "FLAT"|"F"=Flat |
-
-
Sets size style of button. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"|"X"
Name |
Type |
Description |
style |
string
|
"DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large | "EXTRA-SMALL"|"X-SMALL"|"XS"|"X"=X-small |
-
-
Sets tab index of Button control
Name |
Type |
Description |
tabIndex |
integer
|
Tab indices start at 1 and may be set sparsely |
-
-
Set text of button
Name |
Type |
Description |
text |
string
|
Text to be set on the button |
-
-
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"
-
-
Set width of button (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name |
Type |
Description |
width |
string
|
Button width |
-
-
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();