TabPanel

open class TabPanel(tabPosition: TabPosition, sideTabSize: SideTabSize, scrollableTabs: Boolean, draggableTabs: Boolean, className: String?, init: TabPanel.() -> Unit?) : SimplePanel

The container rendering its children as tabs.

It supports activating children by a JavaScript route.

Parameters

tabPosition

tab position

sideTabSize

side tab size

scrollableTabs

determines if tabs are scrollable (default: false)

draggableTabs

determines if tabs are draggable (default: false)

className

CSS class names

init

an initializer extension function

Constructors

TabPanel

fun TabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, draggableTabs: Boolean = false, className: String? = null, init: TabPanel.() -> Unit? = null)

Types

TabPanelContent

class TabPanelContent(tabPanel: TabPanel) : SimplePanel

A helper component for rendering tab content.

TabPanelNav

class TabPanelNav(tabPanel: TabPanel, className: String) : SimplePanel

A helper component for rendering tabs.

Functions

add

open override fun add(child: Component): TabPanel

open override fun add(position: Int, child: Component): TabPanel

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addAll

open override fun addAll(children: List<Component>): TabPanel

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

addCssClass

open override fun addCssClass(css: String): Widget

addCssStyle

open override fun addCssStyle(css: Style): Widget

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String): Widget

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style): Widget

addTab

open fun addTab(title: String, panel: Component, icon: String? = null, image: ResString? = null, closable: Boolean = false, route: String? = null): TabPanel

Creates and adds new tab component.

blur

open fun blur()

clearDragDropData

open fun clearDragDropData()

clearParent

open override fun clearParent(): Widget

dispatchEvent

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

dispose

open override fun dispose()

disposeAll

open override fun disposeAll(): TabPanel

findTabWithComponent

open fun findTabWithComponent(component: Component): Tab?

Find the tab which contains the given component.

focus

open fun focus()

getAttribute

open override fun getAttribute(name: String): String?

getChildren

open override fun getChildren(): List<Component>

getElement

open override fun getElement(): Node?

getElementD

open override fun getElementD(): dynamic

getRoot

open override fun getRoot(): Root?

getSize

open fun getSize(): Int

Returns the number of tabs.

getSnStyle

open fun getSnStyle(): dynamic

getStyle

fun getStyle(name: String): String?

getTab

open fun getTab(index: Int): Tab?

Get the Tab component by index.

getTabIndex

open fun getTabIndex(tab: Tab): Int

Get the index of the given tab.

getTabs

open fun getTabs(): List<Tab>

Returns the list of tabs.

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open fun hide(): Widget

invoke

open operator fun invoke(vararg children: Component): Container

moveTab

open fun moveTab(fromIndex: Int, toIndex: Int)

Move the tab to a different position.

refresh

open override fun refresh(): Widget

remove

open override fun remove(child: Component): TabPanel

removeAll

open override fun removeAll(): TabPanel

removeAt

open override fun removeAt(position: Int): TabPanel

removeAttribute

open override fun removeAttribute(name: String): Widget

removeCssClass

open override fun removeCssClass(css: String): Widget

removeCssStyle

open override fun removeCssStyle(css: Style): Widget

removeEventListener

open fun removeEventListener(id: Int): Widget

removeEventListeners

open fun removeEventListeners(): Widget

removeStyle

fun removeStyle(name: String): StyledComponent

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String): Widget

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style): Widget

removeTab

open fun removeTab(index: Int): TabPanel

Removes tab at given index.

renderVNode

open override fun renderVNode(): VNode

setAttribute

open override fun setAttribute(name: String, value: String): Widget

setDragDropData

open fun setDragDropData(format: String, data: String)

setDropTarget

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

setStyle

fun setStyle(name: String, value: String): StyledComponent

show

open fun show(): Widget

singleRender

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

toggleVisible

open fun toggleVisible(): Widget

translate

open fun translate(text: String): String

open fun translate(text: String?): String?

unaryPlus

open operator fun String.unaryPlus()

Properties

_archivedState

var _archivedState: dynamic

activeIndex

var activeIndex: Int

The index of the active tab.

activeTab

var activeTab: Tab?

The active tab.

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

background

open var background: Background?

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRadius

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

boxShadow

open var boxShadow: BoxShadow?

boxShadowList

open var boxShadowList: List<BoxShadow>?

clear

open var clear: Clear?

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

display

open var display: Display?

draggable

var draggable: Boolean?

draggableTabs

val draggableTabs: Boolean = false

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: CssSize?

flexDirection

open var flexDirection: FlexDirection?

flexGrow

open var flexGrow: Int?

flexShrink

open var flexShrink: Int?

flexWrap

open var flexWrap: FlexWrap?

float

open var float: PosFloat?

fontFamily

open var fontFamily: String?

fontSize

open var fontSize: CssSize?

fontStyle

open var fontStyle: FontStyle?

fontVariant

open var fontVariant: FontVariant?

fontWeight

open var fontWeight: FontWeight?

gridArea

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

gridAutoRows

open var gridAutoRows: String?

gridColumnEnd

open var gridColumnEnd: String?

gridColumnGap

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

gridRowEnd

open var gridRowEnd: String?

gridRowGap

open var gridRowGap: Int?

gridRowStart

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

height

open var height: CssSize?

var id: String?

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

margin

open var margin: CssSize?

marginBottom

open var marginBottom: CssSize?

marginLeft

open var marginLeft: CssSize?

marginRight

open var marginRight: CssSize?

marginTop

open var marginTop: CssSize?

maxHeight

open var maxHeight: CssSize?

maxWidth

open var maxWidth: CssSize?

minHeight

open var minHeight: CssSize?

minWidth

open var minWidth: CssSize?

opacity

open var opacity: Double?

order

open var order: Int?

outline

open var outline: Outline?

overflow

open var overflow: Overflow?

overflowWrap

open var overflowWrap: OverflowWrap?

padding

open var padding: CssSize?

paddingBottom

open var paddingBottom: CssSize?

paddingLeft

open var paddingLeft: CssSize?

paddingRight

open var paddingRight: CssSize?

paddingTop

open var paddingTop: CssSize?

parent

open override var parent: Container?

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

resize

open var resize: Resize?

right

open var right: CssSize?

role

var role: String?

scrollableTabs

val scrollableTabs: Boolean = false

tabindex

var tabindex: Int?

textAlign

open var textAlign: TextAlign?

textDecoration

open var textDecoration: TextDecoration?

textDirection

open var textDirection: Direction?

textIndent

open var textIndent: CssSize?

textOverflow

open var textOverflow: TextOverflow?

textShadow

open var textShadow: TextShadow?

textTransform

open var textTransform: TextTransform?

title

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

transition

open var transition: Transition?

transitionList

open var transitionList: List<Transition>?

unicodeBidi

open var unicodeBidi: UnicodeBidi?

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

open var zIndex: Int?

Extensions

tab

fun TabPanel.tab(label: String? = null, icon: String? = null, image: ResString? = null, closable: Boolean = false, route: String? = null, init: Tab.() -> Unit? = null): Tab

DSL builder extension function.