Tab¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A Panel of Tabs for containing sub panels
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| Tab | getBlinkColorFormula() | String | Returns the blink color formula. |
| Tab | getBlinkPeriodFormula() | Integer | Returns an Integer that is the blink period formula. |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| Tab | getId() | String | Returns the id of the tab. |
| Tab | getInnerPanel() | Panel | Returns the tab panel that this tab is a member of. |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| Tab | getPosition() | Integer | Returns the zero-indexed position of this tab. |
| Tab | getSelectColorFormula() | String | Returns the background color formula of the tab when selected/active. |
| Tab | getSelectTextColorFormula() | String | Returns the font color formula of the tab title when selected/active. |
| Tab | getStatus() | String | Returns the status of the tab, either: DOCKED, UNDOCKED or POPPEDOUT. |
| Tab | getTabsPanel() | TabsPanel | Returns the tab panel that this tab is a member of. |
| Tab | getTitle() | String | Returns the title of the tab. |
| Tab | getUndockedWindow() | Window | Returns the window that this undocked tab is contained in. If not undocked returns null |
| Tab | getUnselectColorFormula() | String | Returns the background color formula of the tab when not selected/active. |
| Tab | getUnselectTextColorFormula() | String | Gets the font color formula of the tab title when not selected/active. |
| Tab | hideTab() | Tab | Hides this tab from the tabs bar and selects the nearest visible tab. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| Tab | isHidden() | Boolean | Returns true if the tab is hidden, false otherwise. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| Tab | popout() | Object | Pops out the tab. |
| Tab | popout(position) | Object | Pops out the tab at a specific location. |
| Tab | redock() | Object | Redocks the tab. |
| Tab | setBlinkColorFormula(formula) | Boolean | Sets the blink color formula. Pass null or empty string to stop blinking. |
| Tab | setBlinkPeriodFormula(formula) | Boolean | Sets the blink period formula (i.e myTab.setBlinkPeriodFormula(500) would blink myTab every 500 milliseconds). Passing null or a number less than 100 defaults to 100. |
| Tab | setHidden(isHidden) | Tab | Changes the visiblity of this tab in the tab bar. Note, this does NOT change the currently selected tab, see showTab() and hideTab() for also updating tab selection. |
| Tab | setPosition(position) | Integer | Set the zero-indexed position of the tab. |
| Tab | setSelectColorFormula(formula) | Boolean | Sets the background color formula of the tab when selected/active. |
| Tab | setSelectTextColorFormula(formula) | Boolean | Sets the font color formula of the tab title when selected/active. |
| Tab | setTitle(formula) | Boolean | Sets the title formula with the given name. |
| Tab | setUnselectColorFormula(formula) | Boolean | Sets the background color formula of the tab when not selected/active. |
| Tab | setUnselectTextColorFormula(formula) | Boolean | Sets the font color formula of the tab title when not selected/active. |
| Tab | showTab() | Tab | Shows this tab in the tabs bar and makes it the selected tab. |
| Object | toJson() | String | Returns a json representation of this object. |
| Tab | undock() | Object | Undocks the tab. |
| Tab | undock(position) | Object | Undocks the tab at a specific location. |
Method Definitions¶
getBlinkColorFormula()¶
String Tab::getBlinkColorFormula()
Description¶
Returns the blink color formula.
getBlinkPeriodFormula()¶
Integer Tab::getBlinkPeriodFormula()
Description¶
Returns an Integer that is the blink period formula.
getId()¶
Description¶
Returns the id of the tab.
getInnerPanel()¶
Description¶
Returns the tab panel that this tab is a member of.
getPosition()¶
Description¶
Returns the zero-indexed position of this tab.
getSelectColorFormula()¶
String Tab::getSelectColorFormula()
Description¶
Returns the background color formula of the tab when selected/active.
getSelectTextColorFormula()¶
String Tab::getSelectTextColorFormula()
Description¶
Returns the font color formula of the tab title when selected/active.
getStatus()¶
Description¶
Returns the status of the tab, either: DOCKED, UNDOCKED or POPPEDOUT.
getTabsPanel()¶
Description¶
Returns the tab panel that this tab is a member of.
getTitle()¶
Description¶
Returns the title of the tab.
getUndockedWindow()¶
Window Tab::getUndockedWindow()
Description¶
Returns the window that this undocked tab is contained in. If not undocked returns null
getUnselectColorFormula()¶
String Tab::getUnselectColorFormula()
Description¶
Returns the background color formula of the tab when not selected/active.
getUnselectTextColorFormula()¶
String Tab::getUnselectTextColorFormula()
Description¶
Gets the font color formula of the tab title when not selected/active.
hideTab()¶
Description¶
Hides this tab from the tabs bar and selects the nearest visible tab.
isHidden()¶
Description¶
Returns true if the tab is hidden, false otherwise.
popout()¶
Description¶
Pops out the tab.
popout(position)¶
Object Tab::popout(Rectangle position)
Description¶
Pops out the tab at a specific location.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| position | Rectangle | absolute position on the screen |
redock()¶
Description¶
Redocks the tab.
setBlinkColorFormula(formula)¶
Boolean Tab::setBlinkColorFormula(String formula)
Description¶
Sets the blink color formula. Pass null or empty string to stop blinking.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | blink color formula |
setBlinkPeriodFormula(formula)¶
Boolean Tab::setBlinkPeriodFormula(Integer formula)
Description¶
Sets the blink period formula (i.e myTab.setBlinkPeriodFormula(500) would blink myTab every 500 milliseconds). Passing null or a number less than 100 defaults to 100.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | Integer | blink period formula in milliseconds |
setHidden(isHidden)¶
Tab Tab::setHidden(Boolean isHidden)
Description¶
Changes the visiblity of this tab in the tab bar. Note, this does NOT change the currently selected tab, see showTab() and hideTab() for also updating tab selection.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| isHidden | Boolean | true=hidden, false=visible,null=default for this tab |
setPosition(position)¶
Integer Tab::setPosition(Integer position)
Description¶
Set the zero-indexed position of the tab.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| position | Integer | zero indexed position to move tab to, null or negative will set to first location and numbers exceeding tab count will move to end |
setSelectColorFormula(formula)¶
Boolean Tab::setSelectColorFormula(String formula)
Description¶
Sets the background color formula of the tab when selected/active.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | select color formula |
setSelectTextColorFormula(formula)¶
Boolean Tab::setSelectTextColorFormula(String formula)
Description¶
Sets the font color formula of the tab title when selected/active.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | select text color formula |
setTitle(formula)¶
Boolean Tab::setTitle(String formula)
Description¶
Sets the title formula with the given name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | title formula |
setUnselectColorFormula(formula)¶
Boolean Tab::setUnselectColorFormula(String formula)
Description¶
Sets the background color formula of the tab when not selected/active.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | unselect color formula |
setUnselectTextColorFormula(formula)¶
Boolean Tab::setUnselectTextColorFormula(String formula)
Description¶
Sets the font color formula of the tab title when not selected/active.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | unselect text color formula |
showTab()¶
Description¶
Shows this tab in the tabs bar and makes it the selected tab.
undock()¶
Description¶
Undocks the tab.
undock(position)¶
Object Tab::undock(Rectangle position)
Description¶
Undocks the tab at a specific location.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| position | Rectangle | position on desktop |