Horizontal split
Splits content that is displayed horizontally in a panel into two or more sections.
Appearance
| Height: | Optional - Default at 100% of its container (but container must have explicitly set height) | String |
| Pane specs: | Specify various appearance variables for each pane, such as width, handle location, etc. | SplitPaneSpec[] |
| Resizable panes: | Allow the panes to be resized by dragging the edges horizontally. | Boolean |
| Events | |||||||||
| On Load: |
| ||||||||
| On Pane Collapsed: |
| ||||||||
| On Pane Expanded: |
| ||||||||
| On Pane Resized: |
| ||||||||
Extends:
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"); |
collapsePane(index)
Collapse pane at the specified index
| Name | Type | Default | Description |
| index | {integer} | Pane index to collapse |
expandPane(index)
Expand pane at the specified index
| Name | Type | Default | Description |
| index | {integer} | Pane index to expand |
getHeight()
Returns:
{string}
Get configured height for section (including unit)
getPaneCount()
Returns:
{integer}
Count the number of panes
getType()
Returns:
{string}
Get descriptive string representing the type of control/section
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(); |
isPaneCollapsed(index)
Returns:
{boolean}
Check if pane at
index is collapsed| Name | Type | Default | Description |
| index | {integer} | Pane index to check |
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); |
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 |
setHeight(null)
Set height of section (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
{string} | height |
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); |
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
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' |
Inherited
setVisible(visible, collapse)
Show or hide the view.
| Name | Type | Default | Description |
| visible | {boolean} | Visibility flag (true to show the view, false to hide it) | |
| collapse | {boolean} | Set it to true to collapse the view space when the option visible is set to false. |
Examples
| MyView.setVisible(false, false); //Equivalent to MyView.hide() |
| MyView.setVisible(false, true); // Sets visibility to "None" |
Inherited
show()
Show this view.
Example
| MyView.show(); |
togglePane(index)
Toggle pane at the specified index between collapsed and expanded
| Name | Type | Default | Description |
| index | {integer} | Pane index to toggle |
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(); |