-
-
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");
-
getCurrentPane(){integer}
-
Retrieve the index corresponding to the currently showing pane
Returns:
Type |
Description |
integer
|
Returns -1 if no pane is showing |
-
-
Returns number of panes in this control
Returns:
Example
stack1.getPaneCount();
-
-
Get descriptive string representing the type of control
Returns:
-
-
Retrieve the coach view instance corresponding to the specified pane index (i.e. the view immediately contained under the pane)
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);
-
-
Switches to the pane corresponding to the index specified, if the index is greater than the number of panes, No pane is displayed
Name |
Type |
Description |
index |
integer
|
0-based pane index. Specify -1 to not display any pane |
Example
Stack1.setCurrentPane(1); // Switches to the 2nd pane in the stack
-
-
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
-
-
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);
-
-
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();