SplitTabComponent | tabby-core

Split tab is a tab that contains other tabs and allows further splitting them You'll mainly encounter it inside AppService.tabs

Hierarchy

BaseTabComponent
- SplitTabComponent

Implements

AfterViewInit
OnDestroy

Properties

color

color: null | string = null

CSS color override for the tab's header

customTitle

customTitle: string

User-defined title override

hasActivity

hasActivity: boolean = false

Last tab activity state

hasFocus

hasFocus: boolean = false

hostView

hostView: ViewRef

ViewRef to the tab DOM element

parent

parent: null | BaseTabComponent = null

Parent tab (usually a SplitTabComponent)

Protected recoveryStateChangedHint

recoveryStateChangedHint: Subject<void> = ...

Ping this if your recovery state has been changed and you want your tab state to be saved sooner

root

root: SplitContainer

Top-level split container

title

title: string

Current tab title

Optional viewContainerEmbeddedRef

viewContainerEmbeddedRef?: EmbeddedViewRef<any>

Static DIRECTIONS

DIRECTIONS: SplitDirection[] = ...

Accessors

activity$

get activity$(): Observable<boolean>

- Defined in components/baseTab.component.ts:74
Returns Observable<boolean>

blurred$

get blurred$(): Observable<void>

- Defined in components/baseTab.component.ts:71
Returns Observable<void>

destroyed$

get destroyed$(): Observable<void>

- Defined in components/baseTab.component.ts:75
Returns Observable<void>

focusChanged$

get focusChanged$(): Observable<BaseTabComponent>

- Defined in components/splitTab.component.ts:229
Fired when a different sub-tab gains focus

Returns Observable<BaseTabComponent>

focused$

get focused$(): Observable<void>

- Defined in components/baseTab.component.ts:70
Returns Observable<void>

initialized$

get initialized$(): Observable<void>

- Defined in components/splitTab.component.ts:234
Fired once tab layout is created and child tabs can be added

Returns Observable<void>

progress$

get progress$(): Observable<null | number>

- Defined in components/baseTab.component.ts:73
Returns Observable<null | number>

recoveryStateChangedHint$

get recoveryStateChangedHint$(): Observable<void>

- Defined in components/baseTab.component.ts:76
Returns Observable<void>

splitAdjusted$

get splitAdjusted$(): Observable<SplitSpannerInfo>

- Defined in components/splitTab.component.ts:224
Fired when split ratio is changed for a given spanner

Returns Observable<SplitSpannerInfo>

tabAdded$

get tabAdded$(): Observable<BaseTabComponent>

- Defined in components/splitTab.component.ts:212
Returns Observable<BaseTabComponent>

tabAdopted$

get tabAdopted$(): Observable<BaseTabComponent>

- Defined in components/splitTab.component.ts:217
Fired when an existing top-level tab is dragged into this tab

Returns Observable<BaseTabComponent>

tabRemoved$

get tabRemoved$(): Observable<BaseTabComponent>

- Defined in components/splitTab.component.ts:219
Returns Observable<BaseTabComponent>

titleChange$

get titleChange$(): Observable<string>

- Defined in components/baseTab.component.ts:72
Returns Observable<string>

Methods

add

add(thing: BaseTabComponent | SplitContainer, relative: null | BaseTabComponent | SplitContainer, side: SplitDirection): Promise<void>

- Defined in components/splitTab.component.ts:384
Inserts a new tab to the side of the relative tab

Parameters
- thing: BaseTabComponent | SplitContainer
- relative: null | BaseTabComponent | SplitContainer
- side: SplitDirection
Returns Promise<void>

addEventListenerUntilDestroyed

addEventListenerUntilDestroyed(element: HTMLElement, event: string, handler: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Inherited from BaseTabComponent.addEventListenerUntilDestroyed
- Defined in components/base.component.ts:49
Parameters
- element: HTMLElement
- event: string
- handler: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

addTab

addTab(tab: BaseTabComponent, relative: null | BaseTabComponent, side: SplitDirection): Promise<void>

- Defined in components/splitTab.component.ts:377
Parameters
- tab: BaseTabComponent
- relative: null | BaseTabComponent
- side: SplitDirection
Returns Promise<void>

clearActivity

clearActivity(): void

Overrides BaseTabComponent.clearActivity
- Defined in components/splitTab.component.ts:616
Removes the acticity marker from the tab header

Returns void

destroy

destroy(): void

Overrides BaseTabComponent.destroy
- Defined in components/splitTab.component.ts:602
Called before the tab is closed

Returns void

displayActivity

displayActivity(): void

Inherited from BaseTabComponent.displayActivity
- Defined in components/baseTab.component.ts:115
Shows the acticity marker on the tab header

Returns void

emitBlurred

emitBlurred(): void

Inherited from BaseTabComponent.emitBlurred
- Defined in components/baseTab.component.ts:161
Returns void

emitFocused

emitFocused(): void

Inherited from BaseTabComponent.emitFocused
- Defined in components/baseTab.component.ts:157
Returns void

focus

focus(tab: BaseTabComponent): void

- Defined in components/splitTab.component.ts:342
Parameters
- tab: BaseTabComponent
Returns void

focusAnyIn

focusAnyIn(parent?: BaseTabComponent | SplitContainer): void

- Defined in components/splitTab.component.ts:366
Focuses the first available tab inside the given SplitContainer

Parameters
- Optional parent: BaseTabComponent | SplitContainer
Returns void

getAllTabs

getAllTabs(): BaseTabComponent[]

- Defined in components/splitTab.component.ts:330
Returns BaseTabComponent[]
Flat list of all sub-tabs

getFocusedTab

getFocusedTab(): null | BaseTabComponent

- Defined in components/splitTab.component.ts:334
Returns null | BaseTabComponent

getMaximizedTab

getMaximizedTab(): null | BaseTabComponent

- Defined in components/splitTab.component.ts:338
Returns null | BaseTabComponent

getParentOf

getParentOf(tab: BaseTabComponent | SplitContainer, root?: SplitContainer): null | SplitContainer

- Defined in components/splitTab.component.ts:551
Parameters
- tab: BaseTabComponent | SplitContainer
- Optional root: SplitContainer
Returns null | SplitContainer
the immediate parent of tab

insertIntoContainer

insertIntoContainer(container: ViewContainerRef): EmbeddedViewRef<any>

Inherited from BaseTabComponent.insertIntoContainer
- Defined in components/baseTab.component.ts:165
Parameters
- container: ViewContainerRef
Returns EmbeddedViewRef<any>

layout

layout(): void

- Defined in components/splitTab.component.ts:609
Returns void

maximize

maximize(tab: null | BaseTabComponent): void

- Defined in components/splitTab.component.ts:358
Parameters
- tab: null | BaseTabComponent
Returns void

navigate

navigate(dir: SplitDirection): void

- Defined in components/splitTab.component.ts:492
Moves focus in the given direction

Parameters
- dir: SplitDirection
Returns void

navigateLinear

navigateLinear(delta: number): void

- Defined in components/splitTab.component.ts:529
Parameters
- delta: number
Returns void

removeFromContainer

removeFromContainer(): void

Inherited from BaseTabComponent.removeFromContainer
- Defined in components/baseTab.component.ts:171
Returns void

removeTab

removeTab(tab: BaseTabComponent): void

- Defined in components/splitTab.component.ts:450
Parameters
- tab: BaseTabComponent
Returns void

replaceTab

replaceTab(tab: BaseTabComponent, newTab: BaseTabComponent): void

- Defined in components/splitTab.component.ts:473
Parameters
- tab: BaseTabComponent
- newTab: BaseTabComponent
Returns void

setProgress

setProgress(progress: null | number): void

Inherited from BaseTabComponent.setProgress
- Defined in components/baseTab.component.ts:100
Sets visual progressbar on the tab

Parameters
- progress: null | number
Returns void

setTitle

setTitle(title: string): void

Inherited from BaseTabComponent.setTitle
- Defined in components/baseTab.component.ts:88
Parameters
- title: string
Returns void

splitTab

splitTab(tab: BaseTabComponent, dir: SplitDirection): Promise<null | BaseTabComponent>

- Defined in components/splitTab.component.ts:540
Parameters
- tab: BaseTabComponent
- dir: SplitDirection
Returns Promise<null | BaseTabComponent>

subscribeUntilDestroyed

subscribeUntilDestroyed<T>(observable: Observable<T>, handler: (v: T) => void): void

Inherited from BaseTabComponent.subscribeUntilDestroyed
- Defined in components/base.component.ts:53
Type parameters
- T
Parameters
- observable: Observable<T>
- handler: (v: T) => void
  - - (v: T): void
    - Parameters
      - v: T
      Returns void
Returns void

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

color

customTitle

hasActivity

hasFocus

hostView

parent

Protected recoveryStateChangedHint

root

title

Optional viewContainerEmbeddedRef

Static DIRECTIONS

Accessors

activity$

Returns Observable<boolean>

blurred$

Returns Observable<void>

destroyed$

Returns Observable<void>

focusChanged$

Returns Observable<BaseTabComponent>

focused$

Returns Observable<void>

initialized$

Returns Observable<void>

progress$

Returns Observable<null | number>

recoveryStateChangedHint$

Returns Observable<void>

splitAdjusted$

Returns Observable<SplitSpannerInfo>

tabAdded$

Returns Observable<BaseTabComponent>

tabAdopted$

Returns Observable<BaseTabComponent>

tabRemoved$

Returns Observable<BaseTabComponent>

titleChange$

Returns Observable<string>

Methods

add

Parameters

thing: BaseTabComponent | SplitContainer

relative: null | BaseTabComponent | SplitContainer

side: SplitDirection

Returns Promise<void>

addEventListenerUntilDestroyed

Parameters

element: HTMLElement

event: string

handler: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

addTab

Parameters

tab: BaseTabComponent

relative: null | BaseTabComponent

side: SplitDirection

Returns Promise<void>

clearActivity

Returns void

destroy

Returns void

displayActivity

Returns void

emitBlurred

Returns void

emitFocused

Returns void

focus

Parameters

tab: BaseTabComponent

Returns void

focusAnyIn