Methods
# inner getSelectedTabIndex() → {number}
Returns the index of the selected tab (index starts at '0').
number
# inner getTabLabel(tabIndex) → {string}
Returns the name of the given tab.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab (starts at '0') |
string
# inner isTabActive(tabIndex) → {boolean}
Returns true if the tab is active, otherwise false.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab (starts at '0') |
boolean
# inner isTabVisible(tabIndex) → {boolean}
Returns true if the given tab is visible, otherwise false.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab (starts at '0') |
boolean
# inner setActiveTabRule(tabIndex, condCallback, listenedVariablesopt)
Sets the callback function that is to be executed to check whether the given tab is active or not.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
tabIndex |
number | Index of the tab | ||
condCallback |
module:RMP_TabPanel~callbackCondition | Callback that handles the tab active rule | ||
listenedVariables |
Array.<string> |
<optional> |
[] | Variables that should be replaced by their values inside the `condCallback` script |
# inner setOnclickScript(tabIndex, callBK)
Sets the callback function that is to be executed when the given tab is clicked.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab |
callBK |
module:RMP_TabPanel~callbackFunction | Callback that handles the onClick script field |
# inner setSelectedTabIndex(tabIndex)
Sets the given tab to selected.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab (starts at '0') |
# inner setTabActive(tabIndex, active)
Sets the given tab to active or inactive.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab (starts at '0') |
active |
boolean | true: active, false: inactive |
# inner setTabLabel(tabIndex, label)
Sets the name of the given tab.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab (starts at '0') |
label |
string | Value (name) of the tab |
# inner setTabVisible(tabIndex, visible)
Sets the given tab to visible or hidden.
Parameters:
Name | Type | Description |
---|---|---|
tabIndex |
number | Index of the tab (starts at '0') |
visible |
boolean | true: visible, false: invisible |
# inner setVisibleTabRule(tabIndex, condCallback, listenedVariablesopt)
Sets the callback function that is to be executed to check whether the given tab
is visible or not.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
tabIndex |
number | Index of the tab | ||
condCallback |
module:RMP_TabPanel~callbackCondition | Callback that handles the tab visible rule | ||
listenedVariables |
Array.<string> |
<optional> |
[] | Variables that should be replaced by their values inside the `condCallback` script |