Navigation event
Allows users to handle page navigation with commands instead of buttons. This view can only be used in combination with other views.
Behavior
Event data: | Data to pass into the navigation event | ANY |
Events | ||||||||
Onload event: |
| |||||||
On Trigger: |
| |||||||
On Boundary Event: |
|
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
Name | Type | Default | 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} | 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"); |
confirmAndFire(confirmationMessage, [eventData])
Fire the boundary event based on the return from the confirmation message
Name | Type | Default | Description |
confirmationMessage | {string} | Text of the confirmation message | |
eventData | {*} | Additional data (payload) associated with the navigation event |
fire([eventData])
Fire the boundary event
Name | Type | Default | Description |
eventData | {*} | Additional data (payload) associated with the navigation event |
getEventData()
Get data associated with the navigation event
getType()
Returns:
{string}
Get descriptive string representing the type of control
Inherited
isBound()
Returns:
{boolean}
Indicates bound status of control.
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagates value change of control up through parent views
Name | Type | Default | Description |
event | {Event} | Value change event (usually an onchange event) |
Example
MyView.propagateUp(event); |
setEventData([*])
Set data associated with the navigation event
Name | Type | Default | Description |
* |
| eventData Data to add to navigation event |
Inherited
setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
binding.set
pattern detailed in the Knowlege Center section Binding Data and Configuration OptionsName | Type | Default | Description |
data | {Object} | Value of bound data. The type of this parameter must match the type of the bound data. | |
createPseudoBinding | {boolean} | If set to true, creates a pseudo binding if there is no current binding. |
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
Inherited
triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
Name | Type | Default | Description |
phase | {int} | bpmext.ui.PHASE_NORMAL | The phase we are currently in |
Example
MyView.triggerFormulaUpdates(); |