ModalAlert

Modal alert

Creates a warning that alerts users about something important and prompts them to take the appropriate action before closing the alert window.

Appearance

Color style: The color style of the modal alert
{Primary | Info | Success | Warning | Danger} AlertColorStyle

Button label: The label of the modal alert button. The default is OK. 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")

On Show:

Description: This event is fired when the modal alert is opened.

Example:

me.setText("Modal Alert is open")

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

getButtonLabel() Returns: {string}

Gets the button label of the control

getColorStyle() Returns: {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"

getText() Returns: {string}

Gets the text of the control

getTitle() Returns: {string}

Gets the title of the control

getType() Returns: {string}

Get descriptive string representing the type of control

Inherited hide(collapseFlag)

Hide the view.

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}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

setButtonLabel(text)

Sets the button label for the control

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

style {string} "DEFAULT"|"DEF"|"INFO"|"INF"|"I"=Default | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger

Inherited setEnabled(enabled, required)

Enable or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

MyView.setEnabled(false); //Make MyView read-only

Inherited setLabelVisible(visible)

Show or hide the view label.

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

text {string} the text of the control

setTitle(title)

Set the string representing the title of control

Name Type Default Description

title {string} title label

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter creates a pseudo binding if there is no current binding.

Example

MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

setVisible(flag)

Sets the visibility of the control

Name Type Default Description

flag {boolean} the visibility of the control

show()

Display's the modal alert

Inherited triggerFormulaUpdates([phase])

Broadcast 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