Alerts

Displays a non-intrusive alert when a condition you specify is met. For example, when a user enters a value that's greater than a specified limit. You can configure the alert to close when clicked, closed, or timed out.

Appearance

Default alert color style:	The default color style used for alerts when no color style is specified. {Primary \| Info \| Success \| Warning \| Danger}	`AlertColorStyle`
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`
Show alert icon:	The icon shows only for the Carbon theme.	`Boolean`

Behavior

Alert topic:	Alert topics the view 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`

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

Extends:

com.ibm.bpm.coach.CoachView

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

appendAlert(title, text, style, timeout, id, data, iconSetting.showIcon, iconSetting.iconName) Returns: {string}

Add an alert to list of alerts

Name	Type	Default	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
iconSetting.showIcon	`{boolean}`		config option to control showing icon, if the value is not set then use default value (carbon theme only)
iconSetting.iconName	`{string}`		config option for setting icon for current instance of alert, if the value is not set then use default value (carbon icon only)

clear()

Closes all current alerts

enableAlertIcon(show)

Change default showing icon value, applied for all alerts afterwards (if icon is valid)

Name	Type	Default	Description
show	`{boolean}`		displaying icon

getAlert(id) Returns: {AlertObj}

Get specific alert by id

Name	Type	Default	Description
id	`{string}`		ID of the alert to get

getType() Returns: {string}

Get descriptive string representing the type of control

Inherited hide(collapseFlag)

Hide this view/control

Name	Type	Default	Description
collapseFlag	`{boolean}`		Set to `true` to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}

Checks if the view is enabled or not

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Checks if control label is visible

Example

var labelVisible = MyView.isLabelVisible();

Inherited isVisible() Returns: {boolean}

Checks whether or not view is visible

Example

var visible = MyView.isVisible();

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

setAlertIcon(style, iconName)

Changing the default alert icon under different style, applying to all the alerts with same style afterwards

Name	Type	Default	Description
style	`{string}`		"S"=Success \| "I"=Info \| "P"=Primary \| "W"=Warning \| "D"=Danger
iconName	`{string}`		A carbon icon name

Inherited setEnabled(enabled, required)

Enable/disable this view/control

Name	Type	Default	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

Inherited setLabelVisible(visible)

Show/hide the label of this view/control

Name	Type	Default	Description
visible	`{boolean}`		Label visibility flag (`true` to show view label, `false` to hide)

Example

MyView.setLabelVisible(false);

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 binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options

Name	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 setVisible(visible, collapse)

Show/hide this view/control

Name	Type	Default	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"

Inherited show()

Show this view/control

Example

MyView.show();

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

Methods

Parent

Helpers