Skip to content

TabControl

The TabControl is a container that provides tabbed interface functionality

Extends: Container

Properties

PropertyTypeDefaultDescription
activeTabnumberThecurrently active tab ID
tabHeightnumberHeightof the tab header area
tabstableListof tab definitions
headerBackgroundcolorBackgroundcolor for the tab header area
activeTabBackgroundcolorBackgroundcolor for the active tab
activeTabTextColorcolorForegroundcolor for the active tab text

Functions

MethodReturnsDescription
TabControl:newTabtableCreates a new tab handler proxy
TabControl:setTabTabControlSets an element to belong to a specific tab
TabControl:addElementtableAdds an element to the TabControl and assigns it to the active tab
TabControl:setActiveTab-Sets the active tab
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:setCursor()

Released under the MIT License.