Class: NavigationEvent

NavigationEvent

The Navigation Event Control is used to control pages without the use of buttons, page navigation can be controlled with commands instead. A NavigationEvent control provides the following configuration properties in Process Designer:

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
Articles
Navigation Event
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");

confirmAndFire(confirmationMessage, eventData)

Fire the boundary event based on the return from the confirmation message
Name Type Description
confirmationMessage string Text of the confirmation message
eventData * optional Additional data (payload) associated with the navigation event

fire(eventData)

Fire the boundary event
Name Type Description
eventData * optional Additional data (payload) associated with the navigation event

getEventData()

Get data associated with the navigation event

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
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);

setEventData(*)

Set data associated with the navigation event
Name Type Description
* optional eventData Data to add to navigation event
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();