Class: TabSection

TabSection

The Tab Section allows for controls to be organized in tabs and gives the user the ability to switch between the available tabs.. A TabSection control provides the following configuration properties in Process Designer:

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

Appearance

Color Style: Color style of the tabs
{Default | Primary | Success | Info | Warning | Danger}
string
Tabs Style: Affects the appearance of the tabs
{Default | Simple}
string

Events

On Load
me.setCurrentPane(1)
Javascript expression
On Tab Changed:
Description: This event is triggered when a the tab is changed.
Example:
if(oldTabIndex == 0){ ${ModalAlert}.setEnabled(true); }
Context Variables oldTabIndex {integer} tabIndex {integer}
Articles
Tab Section

new TabSection()

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

getCurrentPane(){integer}

Retrieve the index corresponding to the currently showing pane
Returns:
Type Description
integer returns -1 if no pane is showing

getTabCount(){integer}

Returns number of tabs in this control
Returns:
Type Description
integer
Example
TabSection1.getTabCount();

getTabText(index){integer}

Retrieve the tab text of the specified tab
Name Type Description
index integer nullable 0-based pane index. When null current pane text is returned
Returns:
Type Description
integer returns text of current tab

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string
Retrieve the coach view instance corresponding to the specified tab index (i.e. the view immediately contained under the tab)
Returns:
Type Description
com.ibm.bpm.coach.CoachView Returns undefined if the pane does not contain a view
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);

setCurrentPane(index)

Switches to the pane corresponding to the index specified
Name Type 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
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);

setTabText(tabText, index)

Set the tab text of the specified tab
Name Type Description
tabText string The text to set for the tab
index integer optional index of tab to set text for. if unspecified, the current tab will be used
Show/hide this view/control
Name Type 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"
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();