Class: Alerts

Alerts

The Alerts control allows developers to create non-intrusive alerts which will not interrupt the user.  This control is the "listener", the alerts are sent using bpmext.ui.alert() method.  An Alerts control provides the following configuration properties in Process Designer:

Behavior

Alert Topic: Alert topics control should listen for. Use * to listen for alerts with unspecified topics string[]
Default Auto-Close Delay: Set how long (in milliseconds) each alert should wait before closing itself. A value of 0 means the alert will not close itself. integer

Appearance

Default Alert Color Style: Default color style to use for alerts when no color style is specified
{Primary | Info | Success | Warning | Danger}
string
Dark Style: When true, alert colors will be darker boolean
No Vertical Spacing: Show no vertical spacing between alerts boolean
Animate: When set to true, alerts will slide into view. Otherwise, alerts will simply appear on screen boolean

Events

On Alert Click:
Description: Triggers when user clicks the alert.
Example:
${WarningNavigationEvent}.fire()
Context Variables item {object}
Properties id
title
text
style
element
id
data
On Alert Close:
Description: Triggers when user closes alert
Example:
me.ui.invoke("addNotif", item)
Context Variables item {object}
Properties id
title
text
style
element
id
data
On Alert Expired:
Description: Triggers if alert closes by itself due to timeout.
Example:
me.ui.invoke("addNotif", item)
Context Variables item {object}
Properties id
title
text
style
element
id
data
Article(s)
Alerts

new Alerts()

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

appendAlert(title, text, style, timeout, id, data){string}

Add an alert to list of alerts
Name Type Description
title string Alert title
text string Alert text
style string "S"=Success | "I"=Info | "P"=Primary | "W"=Warning | "D"=Danger
timeout integer time (in milliseconds) before alert automatically closes
id string unique id for this alert
data ANY any extra data to associate with this alert
Returns:
Type Description
string

clear()

Closes all current alerts

getAlert(id){AlertObj}

Get specific alert by id
Name Type Description
id string ID of the alert to get
Returns:
Type Description
AlertObj returns an Alert object, which includes title, text, style, id, and data

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
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);
Enable/disable this view/control
Name Type Description
enabled boolean Enabled/read-only flag (true to enable view, false to disable/make read-only)
required boolean Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only
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);
Show/hide this view/control
Name Type Description
visible boolean Visibility flag (true to show view, false to hide)
collapse boolean Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"
Show this view/control
Example
MyView.show();
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();