70 lines
2.4 KiB
Markdown
70 lines
2.4 KiB
Markdown
# TabControl
|
|
_The TabControl is a container that provides tabbed interface functionality_
|
|
|
|
Extends: `Container`
|
|
|
|
## Properties
|
|
|
|
|Property|Type|Default|Description|
|
|
|---|---|---|---|
|
|
|activeTab|number|The|currently active tab ID|
|
|
|tabHeight|number|Height|of the tab header area|
|
|
|tabs|table|List|of tab definitions|
|
|
|headerBackground|color|Background|color for the tab header area|
|
|
|activeTabBackground|color|Background|color for the active tab|
|
|
|activeTabTextColor|color|Foreground|color for the active tab text|
|
|
|scrollableTab|boolean|Enables|scroll mode for tabs if they exceed width|
|
|
|tabScrollOffset|number|Current|scroll offset for tabs in scrollable mode|
|
|
|
|
## Functions
|
|
|
|
|Method|Returns|Description|
|
|
|---|---|---|
|
|
|[TabControl:newTab](#tabcontrol-newtab-title)|table|Creates a new tab handler proxy|
|
|
|[TabControl:setTab](#tabcontrol-settab-element-tabid)|TabControl|Sets an element to belong to a specific tab|
|
|
|[TabControl:addElement](#tabcontrol-addelement-elementtype-tabid)|table|Adds an element to the TabControl and assigns it to the active tab|
|
|
|[TabControl:setActiveTab](#tabcontrol-setactivetab-tabid)|-|Sets the active tab|
|
|
|[TabControl:scrollTabs](#tabcontrol-scrolltabs-direction)|TabControl|Scrolls the tab header left or right if scrollableTab is enabled|
|
|
|[TabControl:setCursor](#tabcontrol-setcursor)|-|Sets the cursor position; accounts for tab header offset when delegating to parent|
|
|
|
|
## TabControl:newTab(title)
|
|
|
|
returns a proxy for adding elements to the tab
|
|
|
|
### Parameters
|
|
* `title` `string` The title of the tab
|
|
|
|
### Returns
|
|
* `table` `tabHandler` The tab handler proxy for adding elements to the new tab
|
|
|
|
## TabControl:setTab(element, tabId)
|
|
### Parameters
|
|
* `element` `table` The element to assign to a tab
|
|
* `tabId` `number` The ID of the tab to assign the element to
|
|
|
|
### Returns
|
|
* `TabControl` `self` For method chaining
|
|
|
|
## TabControl:addElement(elementType, tabId)
|
|
### Parameters
|
|
* `elementType` `string` The type of element to add
|
|
* `tabId` `number` Optional tab ID, defaults to active tab
|
|
|
|
### Returns
|
|
* `table` `element` The created element
|
|
|
|
## TabControl:setActiveTab(tabId)
|
|
### Parameters
|
|
* `tabId` `number` The ID of the tab to activate
|
|
|
|
## TabControl:scrollTabs(direction)
|
|
|
|
Scrolls the tab header left or right if scrollableTab is enabled
|
|
|
|
### Parameters
|
|
* `direction` `number` -1 to scroll left, 1 to scroll right
|
|
|
|
### Returns
|
|
* `TabControl` `self` For method chaining
|
|
|
|
## TabControl:setCursor() |