-
-
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");
-
-
Set focus on this control
-
-
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type |
Description |
Object
|
Value of bound data. undefined if the view has no data binding. |
Example
var dec1 = MyDecimal.getData();
-
-
Gets the label associated with the control
Returns:
-
getLabelPlacement(){string}
-
Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"
Returns:
-
-
Get placeholder text associated with the control
Returns:
-
-
Gets size style of text control
Returns:
Type |
Description |
string
|
{"L"=Large | "S"=Small | "D"=Default} |
-
-
Gets tab index for the control
Returns:
-
-
Gets text for the control
Returns:
-
-
Get descriptive string representing the type of control
Returns:
-
getValidationExpression(){string}
-
Get validation (regular) expression for the control
Returns:
-
-
Gets configured width for the control (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();
-
isLabelVisible(){boolean}
-
Gets label visibility for the control
Returns:
-
-
Get whether or not all text is selected on focus
Returns:
-
-
Returns the valid status as last set by the setValid() method.
Returns:
Type |
Description |
boolean
|
Validity status. true if setValid(false, ...) was never called |
Example
var valid = MyView.isValid();
-
-
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);
-
-
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula for this view (if a formula has been specified). If the view is not formula-enabled, recalculate()
does nothing.
Example
Text1.recalculate(); //If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time
-
-
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name |
Type |
Description |
value |
Object
|
Value of bound data. The type of this parameter must match the type of the bound data. |
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
-
-
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 the label for the control
Name |
Type |
Description |
label |
string
|
the label for the control |
-
setLabelPlacement(placement)
-
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name |
Type |
Description |
placement |
string
|
"T"|"TOP"=Top | "L"|"LEFT"=Left |
Example
me.setLabelPlacement("L")
-
-
Sets label visibility for the control
Name |
Type |
Description |
flag |
boolean
|
set visibility |
-
-
Set placeholder text for the control
Name |
Type |
Description |
text |
string
|
sets placeholder text |
-
-
Sets size style of control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
Name |
Type |
Description |
style |
string
|
"DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large |
-
-
Sets tab index of the control
Name |
Type |
Description |
tabIndex |
integer
|
tab indices start at 1 and may be set sparsely |
-
-
Sets text for the control
Name |
Type |
Description |
text |
string
|
to be set in the control |
-
-
Flag this view/control as valid or invalid
Name |
Type |
Description |
valid |
boolean
|
Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator) |
errorText |
string
|
Validation error text to show on the invalid-styled view |
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid
-
setValidationExpression(re)
-
Set validation (regular) expression of the control
Name |
Type |
Description |
re |
string
|
regular expression |
-
-
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"
-
-
Sets width of the control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name |
Type |
Description |
width |
string
|
sets the width of the control |
-
-
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();