Class: ModalAlert

ModalAlert

The Modal Alert control is an alert that can to be fired when a specified event has occurred.  When the Modal Alert appears on the screen, the user needs to handle this control or close it out before the user can return to the main screen. A ModalAlert control provides the following configuration properties in Process Designer:

Appearance

Color Style: The color style of the modal alert
{Primary | Info | Success | Warning | Danger}
string
Button Label: Label for modal alert button string

Events

On Load:
Description: This event is fired when the modal alert is clicked.
Example:
me.setVisible(true)
On Close:
Description: This event is fired when the modal alert is clicked.
Example:
${Text}.setText("Modal Alert is closed")
Article(s)
Modal Alert

new ModalAlert()

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

getButtonLabel(){string}

Gets the button label of the control
Returns:
Type Description
string Returns the button label of the control

getColorStyle(){string}

Get the string representing the color style of the control. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "I"|"S"|"W"|"G"
Returns:
Type Description
string

getText(){string}

Gets the text of the control
Returns:
Type Description
string Gets the text of the control

getTitle(){string}

Gets the title of the control
Returns:
Type Description
string The title of the control

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

setButtonLabel(text)

Sets the button label for the control
Name Type Description
text string the label of the button

setColorStyle(style)

Sets the color style of the control. NOTE: to avoid ambiguity always set the color using "I"|"S"|"W"|"G"
Name Type Description
style string "DEFAULT"|"DEF"|"INFO"|"INF"|"I"=Default | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=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
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);

setText(text)

Sets the text
Name Type Description
text string the text of the control

setTitle(title)

Set the string representing the title of control
Name Type Description
title string title label

setVisible(flag)

Sets the visibility of the control
Name Type Description
flag boolean the visibility of the control
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();