Class: ModalSection

ModalSection

The Modal Section is a container control that displays modally.  I.E. you cannot continue on the main window until it is dismissed. A ModalSection control provides the following configuration properties in Process Designer:

Appearance

Modal Placeholder Width: Width of modal "well" in which the modal content is displayed (in px, em, %). Note: 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

Behavior

Close on Click: If this is checked, you can close the modal section by clicking outside of the modal section (dark area). Note: 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...");
Articles
Modal Section

new ModalSection()

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

getCloseOnClick(){boolean}

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

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

setCloseOnClick(flag)

Sets whether user can close the control without a button.
Name Type 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)
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);

setVisible(flag)

Set visibility of control
Name Type Description
flag boolean true to show the section, false to hide it
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();