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

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

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

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/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'

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

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