Class: Data

Data

The Data control functions as a hidden input field on the page.  It can be bound to data that has no presentation need, but is used in supporting code. A Data control provides the following configuration properties in Process Designer:

Formula

Value Formula: Formula/expression to use for calculating value of data stored in this control string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setValue(${Text1}.getText())
On Change:
Description: Triggers when the bound data changes.
Example:
${Text2}.setText(me.getValue())
Article(s)
Data

new Data()

This constructor is never used explicitly.

Extends

Members

Methods

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");
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();

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getValue(){*}

Get the value of the data control
Returns:
Type Description
*
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();
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);
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'
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);

setValue(value)

Sets the value of the data control
Name Type Description
value * May be any type, depending on what the Data control is bound to, including complex types
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();