NavigationEvent

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:

Description:

This event is triggered when the NavigationEvent is loaded.

On Trigger:

Description:	This event is triggered when the NavigationEvent is Triggered.
Example:	`console.log("Navigation Event Triggered - exiting coach view.")`

On Boundary Event:

Description:	This event is triggered when the Boundary Event for NavigationEvent is called. For information on the status context variable see the context.trigger() method in the Knowledge Center.
Example:	`console.log(status)`

Context Variables	status

Extends:

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

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

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}

Indicate the bound status of the view.

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the 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 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.

Name Type Default Description

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 triggerFormulaUpdates([phase])

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

Methods

Parent

Helpers