TabControl

Tab control that hosts panes inside. See also TabPane

Constructors

new TabControl()

new TabControl(dart): TabControl

Parameters

Parameter	Type
dart	any

Returns

TabControl

Source

src/widgets.ts:583

Properties

Property	Type
dart	any

Accessors

currentPane

get currentPane(): TabPane

Currently visible pane

set currentPane(v): void

Parameters

Parameter	Type
v	TabPane

Returns

TabPane

Source

src/widgets.ts:624

---

header

get header(): HTMLDivElement

Header shown on top of the control

Returns

HTMLDivElement

Source

src/widgets.ts:598

---

onBeforeTabChanged

get onBeforeTabChanged(): Observable<any>

Occurs before the active pane is changed

Returns

Observable<any>

Source

src/widgets.ts:628

---

onTabAdded

get onTabAdded(): Observable<any>

Returns

Observable<any>

Source

src/widgets.ts:633

---

onTabChanged

get onTabChanged(): Observable<any>

Occurs after the active pane is changed

Returns

Observable<any>

Source

src/widgets.ts:631

---

onTabRemoved

get onTabRemoved(): Observable<any>

Returns

Observable<any>

Source

src/widgets.ts:634

---

panes

get panes(): TabPane[]

Panes currently present in the pane control. Do not change the array, use addPane instead

Returns

TabPane[]

Source

src/widgets.ts:604

---

root

get root(): HTMLDivElement

Visual root

Returns

HTMLDivElement

Source

src/widgets.ts:593

Methods

addPane()

addPane(name, getContent, icon, options?): TabPane

Adds a new pane with the specified name

Parameters

Parameter	Type	Default value
name	string	undefined
getContent	() => HTMLElement	undefined
icon	any	null
options?	object	undefined
options.allowClose?	boolean	undefined

Returns

TabPane

Source

src/widgets.ts:614

---

clear()

clear(): void

Removes all panes

Returns

void

Source

src/widgets.ts:619

---

getPane()

getPane(name): TabPane

Gets the pane with the specified name

Parameters

Parameter	Type
name	string

Returns

TabPane

Source

src/widgets.ts:609

---

create()

static create(vertical): TabControl

Creates a new TabControl

Parameters

Parameter	Type	Default value
vertical	boolean	false

Returns

TabControl

Source

src/widgets.ts:588