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: |
| |||||
| On Load: |
| |||||
| On Show: |
| |||||
Extends:
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"); |
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 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); |
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/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); |
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/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
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)
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])
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(); |