Tab Section
The Tab Section allows for controls to be organized in tabs and gives the user the ability to switch between the available tabs..
Appearance
| Color style: | Color style of the tabs {Default | Primary | Success | Info | Warning | Danger} |
TabColorStyle |
| Tabs style: | Affects the appearance of the tabs {Default | Simple} |
TabsStyle |
| Size: | Size-based styling for this control (default, large, small, extra-small) {Default | Large | Small | Extra-Small} |
ButtonSizeStyle |
Behavior
| Default pane index: | 0-based index for the pane to show by default. If this value is not specified and if the data binding is not specifed, defaults to 0. Use -1 to show no pane at all. | Integer |
| Events | |||||||||
| On Load | | Javascript expression | |||||||
| On Tab Changed: |
| ||||||||
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"); |
getCurrentPane()
Returns:
{integer}
Retrieve the index corresponding to the currently showing pane
getTabCount()
Returns:
{integer}
Returns number of tabs in this control
Example
| TabSection1.getTabCount(); |
getTabText(index)
Returns:
{integer}
Retrieve the tab text of the specified tab
| Name | Type | Default | Description |
| index | {?integer} | 0-based pane index. When null current pane text is returned |
getType()
Returns:
{string}
Get descriptive string representing the type of control
getViewInPane()
Returns:
{com.ibm.bpm.coach.CoachView}
Retrieve the coach view instance corresponding to the specified tab index (i.e. the view immediately contained under the tab)
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); |
setCurrentPane(index)
Switches to the pane corresponding to the index specified
| Name | Type | Default | Description |
| index | {integer} | 0-based pane index. Specify -1 to not display any pane |
Example
| TabSection1.setCurrentPane(1); // Switches to the 2nd pane in the tabSection |
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); |
setTabText(tabText, [index])
Set the tab text of the specified tab
| Name | Type | Default | Description |
| tabText | {string} | The text to set for the tab | |
| index | {integer} | index of tab to set text for. if unspecified, the current tab will be used |
Inherited
setVisible(visible, collapse)
Show/hide this view/control
| Name | Type | Default | Description |
| visible | {boolean} | Visibility flag (true to show view, false to hide) | |
| collapse | {boolean} | Set to true to collapse the control space when 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/control
Example
| MyView.show(); |
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(); |