Methods

setVisible
setValid
setViewData
isValid
show
isVisible
setEnabled
hide
isBound
isLabelVisible
isEnabled
setLabelVisible
propagateUpValueChange
triggerFormulaUpdates
recalculate
getData
addClass

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
CoachView
The following methods extend the IBM BPM Coach CoachView class and are therefore available in all BPM UI controls.
Methods:
Inherited setVisible(visible, collapse)
Show or hide the view.
NameTypeDefaultDescription
visible{boolean}Visibility flag (true to show the view, false to hide it)
collapse{boolean}Set it to true to collapse the view space when the option visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"
Inherited setValid(valid, errorText)
Flag the view as valid or invalid.
NameTypeDefaultDescription
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, "Fix your data entry"); //Make MyView invalid
Inherited setViewData(data, createPseudoBinding)
Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.
NameTypeDefaultDescription
data{Object}The value of the bound data. The parameter type must match the type of the bound data.
createPseudoBinding{boolean}If the value is set to true, the parameter creates a pseudo binding if there is no current binding.
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'
Inherited isValid() Returns: {boolean}
Return the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();
Inherited show()
Show this view.
Example
MyView.show();
Inherited isVisible() Returns: {boolean}
Check whether the view is visible.
Example
var visible = MyView.isVisible();
Inherited setEnabled(enabled, required)
Enable or disable the view.
NameTypeDefaultDescription
enabled{boolean}Enabled/read-only flag (true to enable view, false to disable/make read-only)
required{boolean}Enable or disable the required field flag for the view.
Example
MyView.setEnabled(false); //Make MyView read-only
Inherited hide(collapseFlag)
Hide the view.
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Inherited isBound() Returns: {boolean}
Indicate the bound status of the view.
Inherited isLabelVisible() Returns: {boolean}
Check whether the view label is visible.
Example
var labelVisible = MyView.isLabelVisible();
Inherited isEnabled() Returns: {boolean}
Check whether the view is enabled.
Example
var enabled = MyView.isEnabled();
Inherited setLabelVisible(visible)
Show or hide the view label.
NameTypeDefaultDescription
visible{boolean}Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);
Inherited propagateUpValueChange(event) Returns: {boolean}
Propagate the value change of the view up through the parent views.
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
Inherited triggerFormulaUpdates([phase])
Broadcast the expression trigger for the specified view.
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();
Inherited recalculate()
Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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
Inherited getData() Returns: {Object}
Retrieve the bound data associated with the view. It applies only to views with bound data.
Example
var dec1 = MyDecimal.getData();
Inherited addClass(name, [replaced])
Add or replace the CSS classes for this view.
NameTypeDefaultDescription
name{string}The CSS class names to add to the view. For multiple classes, use space to separate the class names.
replaced{string}The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.
Example
Button.addClass("green");