Class: Notification

Notification

The Notification control displays textual or numerical content and is commonly used for bringing the user's attention to a specific area on the coach.  Note that the text which displays comes from the control's label. A Notification control provides the following configuration properties in Process Designer:

Formula

Notification Formula: Formula/expression to use for calculating the notification text string

Appearance

Color Style: Color-based styling for this control (default, primary, success, warning, danger)
{Default | Primary | Info | Success | Warning | Danger}
string
Icon: Notification icon name, for example: calendar, clock-o, camera, cloud-upload, bell, info, file-text, etc... Check http://fontawesome.io/icons for a comprehensive list. (Note that the "fa-" prefix is optional) string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setText(${NumNotifs}.getValue())
On Click:
Description: Triggers whenever the notification is clicked.
Example:
alert("Notification [" + me.getText() + "] fired");
Article(s)
Notification

new Notification()

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

getColorStyle(){string}

Gets teh color style of the control. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"
Returns:
Type Description
string

getIcon(){string}

Gets notification icon
Returns:
Type Description
string

getText(){string}

Gets the notification text
Returns:
Type Description
string

getType(){string}

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

setColorStyle(style)

Sets the color style of the control. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"
Name Type Description
style string "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "ERROR"|"ERR"|"DANGER"|"E"=Danger
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

setIcon(icon)

Sets the icon to display on the notification
Name Type Description
icon string See icon reference for valid values

setText(text)

Sets the notification text
Name Type Description
text string Notification text
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();