ModalSection

Modal section

Creates a section separate from the main user interface that you can use to handle a tangent task or display something. To resume work on the user interface, you must close the modal section.

Appearance

Modal placeholder width: Width of modal "well" in which the modal content is displayed (in px, em, %). \r\nNote\: If a modal width is specified, what is contained in it should always be sized to 100% width, otherwise the modal section may not close reliably when the dark area is clicked. String

Show buttons: Show the buttons in the modal. Boolean

Text on primary button: The text on the button that allows you to confirm the action in the modal. For example, Save or OK. String

Text on secondary button: The text on the button that allows you to dismiss the action in the modal. For example, Close or Cancel. String

Color style: The color style of the primary button.
{Default | Primary | Info | Success | Warning | Danger | Dark} ButtonColorStyle

Behavior

Close on click: If this is checked, you can close the modal section by clicking outside of the modal section (dark area).\r\nNote\: If a modal well width is specified, what is contained in it should always be sized to 100% width, otherwise the modal section may not close reliably when the dark area is clicked. Boolean

Events

On Load:

Description: This event is fired when the control is loaded.

Example:

me.setVisible(true);

On Load:

Description: This event is fired when the control is closed.

Example:

${Output_Text1}.setText("Modal section closed...");

On Show:

Description: This event is fired when the control is opened.

Example:

me.setText("Modal section 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");

getCloseOnClick()

Returns a boolean as to whether a user can close the modal section by clicking outside of the modal section (gray area)

getColorStyle() Returns: {string}

Gets color style of modal primary button. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"

getPrimaryButtonText() Returns: {string}

Gets primary button text for modal

getSecondaryButtonText() Returns: {string}

Gets secondary button text for modal

getShowModalButtonGroup() Returns: {boolean}

Gets showModalButtonGroup for modal

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

setCloseOnClick(flag)

Sets whether user can close the control without a button.

Name Type Default Description

flag {boolean} sets the boolean for whether a user can close the modal section by clicking outside of the modal section. If true, user can close the modal section by clicking outside of the modal section (gray area)

setColorStyle(style)

Sets color style of modal primary button. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"

Name Type Default Description

style {string} "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"PRI"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|ERROR|ERR"|"E"|"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);

setPrimaryButtonEnabled(enabled)

Enable/disable primary button

Name Type Default Description

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

setPrimaryButtonText(str)

Sets the primary button's text

Name Type Default Description

str {string} Primary button's text

setSecondaryButtonText(str)

Sets the secondary button's text

Name Type Default Description

str {string} Secondary button's text

setShowModalButtonGroup(value)

Sets showModalButtonGroup for modal

Name Type Default Description

value {boolean} True for showing the button group

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)

Set visibility of control

Name Type Default Description

flag {boolean} true to show the section, false to hide it

show()

Display's the modal section

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