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

Index

Accessors

Properties

Protected activity

activity: BehaviorSubject<boolean> = ...

Protected config

config: ConfigService

customTitle

customTitle: string

User-defined title override

disableDynamicTitle

disableDynamicTitle: boolean = false

Disables display of dynamic window/tab title provided by the shell

Private focusChanged

focusChanged: Subject<BaseTabComponent> = ...

hasActivity

hasActivity: boolean = false

Last tab activity state

hasFocus

hasFocus: boolean = false

hostView

hostView: ViewRef

ViewRef to the tab DOM element

Private initialized

initialized: Subject<void> = ...

Private maximizedTab

maximizedTab: null | BaseTabComponent = null

parent

parent: null | BaseTabComponent = null

Parent tab (usually a SplitTabComponent)

Protected progress

progress: BehaviorSubject<null | number> = ...

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

Private splitAdjusted

splitAdjusted: Subject<SplitSpannerInfo> = ...

Private tabAdded

tabAdded: Subject<BaseTabComponent> = ...

Private tabAdopted

tabAdopted: Subject<BaseTabComponent> = ...

Private tabRemoved

tabRemoved: Subject<BaseTabComponent> = ...

title

title: string

Current tab title

Optional viewContainerEmbeddedRef

viewContainerEmbeddedRef?: EmbeddedViewRef<any>

Private viewRefs

viewRefs: Map<BaseTabComponent, EmbeddedViewRef<any>> = ...

Protected visibility

visibility: BehaviorSubject<boolean> = ...

Static DIRECTIONS

DIRECTIONS: SplitDirection[] = ...

Accessors

activity$

get activity$(): Observable<boolean>

Inherited from BaseTabComponent.activity$
- Defined in tabby-core/src/components/baseTab.component.ts:91
Returns Observable<boolean>

blurred$

get blurred$(): Observable<void>

Inherited from BaseTabComponent.blurred$
- Defined in tabby-core/src/components/baseTab.component.ts:86
Returns Observable<void>

color

get color(): null | string
set color(color: null | string): void

Overrides BaseTabComponent.color
- Defined in tabby-core/src/components/splitTab.component.ts:805
Returns null | string
Overrides BaseTabComponent.color
- Defined in tabby-core/src/components/splitTab.component.ts:809
Parameters
- color: null | string
Returns void

destroyed$

get destroyed$(): Observable<void>

Inherited from BaseTabComponent.destroyed$
- Defined in tabby-core/src/components/baseTab.component.ts:92
Returns Observable<void>

focusChanged$

get focusChanged$(): Observable<BaseTabComponent>

- Defined in tabby-core/src/components/splitTab.component.ts:251
Fired when a different sub-tab gains focus

Returns Observable<BaseTabComponent>

focused$

get focused$(): Observable<void>

Inherited from BaseTabComponent.focused$
- Defined in tabby-core/src/components/baseTab.component.ts:85
Returns Observable<void>

icon

get icon(): null | string
set icon(icon: null | string): void

Overrides BaseTabComponent.icon
- Defined in tabby-core/src/components/splitTab.component.ts:795
Returns null | string
Overrides BaseTabComponent.icon
- Defined in tabby-core/src/components/splitTab.component.ts:799
Parameters
- icon: null | string
Returns void

initialized$

get initialized$(): Observable<void>

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

Returns Observable<void>

progress$

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

Inherited from BaseTabComponent.progress$
- Defined in tabby-core/src/components/baseTab.component.ts:90
Returns Observable<null | number>

recoveryStateChangedHint$

get recoveryStateChangedHint$(): Observable<void>

Inherited from BaseTabComponent.recoveryStateChangedHint$
- Defined in tabby-core/src/components/baseTab.component.ts:93
Returns Observable<void>

splitAdjusted$

get splitAdjusted$(): Observable<SplitSpannerInfo>

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

Returns Observable<SplitSpannerInfo>

tabAdded$

get tabAdded$(): Observable<BaseTabComponent>

- Defined in tabby-core/src/components/splitTab.component.ts:234
Returns Observable<BaseTabComponent>

tabAdopted$

get tabAdopted$(): Observable<BaseTabComponent>

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

Returns Observable<BaseTabComponent>

tabRemoved$

get tabRemoved$(): Observable<BaseTabComponent>

- Defined in tabby-core/src/components/splitTab.component.ts:241
Returns Observable<BaseTabComponent>

titleChange$

get titleChange$(): Observable<string>

Inherited from BaseTabComponent.titleChange$
- Defined in tabby-core/src/components/baseTab.component.ts:89
Returns Observable<string>

topmostParent

get topmostParent(): null | BaseTabComponent

Inherited from BaseTabComponent.topmostParent
- Defined in tabby-core/src/components/baseTab.component.ts:206
Returns null | BaseTabComponent

visibility$

get visibility$(): Observable<boolean>

Inherited from BaseTabComponent.visibility$
- Defined in tabby-core/src/components/baseTab.component.ts:88
Returns Observable<boolean>

Methods

add

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

- Defined in tabby-core/src/components/splitTab.component.ts:454
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 tabby-core/src/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 tabby-core/src/components/splitTab.component.ts:447
Parameters
- tab: BaseTabComponent
- relative: null | BaseTabComponent
- side: SplitDirection
Returns Promise<void>

Private attachTabView

attachTabView(tab: BaseTabComponent): void

- Defined in tabby-core/src/components/splitTab.component.ts:833
Parameters
- tab: BaseTabComponent
Returns void

clearActivity

clearActivity(): void

Overrides BaseTabComponent.clearActivity
- Defined in tabby-core/src/components/splitTab.component.ts:788
Removes the activity marker from the tab header

Returns void

destroy

destroy(): void

Overrides BaseTabComponent.destroy
- Defined in tabby-core/src/components/splitTab.component.ts:774
Called before the tab is closed

Returns void

displayActivity

displayActivity(): void

Inherited from BaseTabComponent.displayActivity
- Defined in tabby-core/src/components/baseTab.component.ts:133
Shows the activity marker on the tab header

Returns void

emitBlurred

emitBlurred(): void

Inherited from BaseTabComponent.emitBlurred
- Defined in tabby-core/src/components/baseTab.component.ts:179
Returns void

emitFocused

emitFocused(): void

Inherited from BaseTabComponent.emitFocused
- Defined in tabby-core/src/components/baseTab.component.ts:175
Returns void

emitVisibility

emitVisibility(visibility: boolean): void

Inherited from BaseTabComponent.emitVisibility
- Defined in tabby-core/src/components/baseTab.component.ts:184
Parameters
- visibility: boolean
Returns void

equalize

equalize(): void

- Defined in tabby-core/src/components/splitTab.component.ts:815
Returns void

focus

focus(tab: BaseTabComponent): void

- Defined in tabby-core/src/components/splitTab.component.ts:412
Parameters
- tab: BaseTabComponent
Returns void

focusAnyIn

focusAnyIn(parent?: BaseTabComponent | SplitContainer): void

- Defined in tabby-core/src/components/splitTab.component.ts:436
Focuses the first available tab inside the given SplitContainer

Parameters
- Optional parent: BaseTabComponent | SplitContainer
Returns void

getAllTabs

getAllTabs(): BaseTabComponent[]

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

getFocusedTab

getFocusedTab(): null | BaseTabComponent

- Defined in tabby-core/src/components/splitTab.component.ts:404
Returns null | BaseTabComponent

getMaximizedTab

getMaximizedTab(): null | BaseTabComponent

- Defined in tabby-core/src/components/splitTab.component.ts:408
Returns null | BaseTabComponent

getNearestPaneInDirection

getNearestPaneInDirection(from: BaseTabComponent, direction: SplitDirection): BaseTabComponent

- Defined in tabby-core/src/components/splitTab.component.ts:644
Parameters
- from: BaseTabComponent
- direction: SplitDirection
Returns BaseTabComponent

Private getPaneRect

getPaneRect(pane: BaseTabComponent): DOMRect

- Defined in tabby-core/src/components/splitTab.component.ts:638
Parameters
- pane: BaseTabComponent
Returns DOMRect

getParentOf

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

- Defined in tabby-core/src/components/splitTab.component.ts:718
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 tabby-core/src/components/baseTab.component.ts:188
Parameters
- container: ViewContainerRef
Returns EmbeddedViewRef<any>

layout

layout(): void

- Defined in tabby-core/src/components/splitTab.component.ts:781
Returns void

Private layoutInternal

layoutInternal(root: SplitContainer, x: number, y: number, w: number, h: number): void

- Defined in tabby-core/src/components/splitTab.component.ts:890
Parameters
- root: SplitContainer
- x: number
- y: number
- w: number
- h: number
Returns void

maximize

maximize(tab: null | BaseTabComponent): void

- Defined in tabby-core/src/components/splitTab.component.ts:428
Parameters
- tab: null | BaseTabComponent
Returns void

navigate

navigate(dir: SplitDirection): void

- Defined in tabby-core/src/components/splitTab.component.ts:679
Moves focus in the given direction

Parameters
- dir: SplitDirection
Returns void

navigateLinear

navigateLinear(delta: number): void

- Defined in tabby-core/src/components/splitTab.component.ts:687
Parameters
- delta: number
Returns void

navigateSpecific

navigateSpecific(target: number): void

- Defined in tabby-core/src/components/splitTab.component.ts:698
Parameters
- target: number
Returns void

Private observeUntilChildDetached

observeUntilChildDetached<T>(tab: BaseTabComponent, event: Observable<T>): Observable<T>

- Defined in tabby-core/src/components/splitTab.component.ts:876
Type Parameters
- T
Parameters
- tab: BaseTabComponent
- event: Observable<T>
Returns Observable<T>

Private onAfterTabAdded

onAfterTabAdded(tab: BaseTabComponent): void

- Defined in tabby-core/src/components/splitTab.component.ts:882
Parameters
- tab: BaseTabComponent
Returns void

Private recoverContainer

recoverContainer(root: SplitContainer, state: any): Promise<void>

- Defined in tabby-core/src/components/splitTab.component.ts:1030
Parameters
- root: SplitContainer
- state: any
Returns Promise<void>

removeFromContainer

removeFromContainer(): void

Inherited from BaseTabComponent.removeFromContainer
- Defined in tabby-core/src/components/baseTab.component.ts:194
Returns void

removeTab

removeTab(tab: BaseTabComponent): void

- Defined in tabby-core/src/components/splitTab.component.ts:530
Parameters
- tab: BaseTabComponent
Returns void

replaceTab

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

- Defined in tabby-core/src/components/splitTab.component.ts:553
Parameters
- tab: BaseTabComponent
- newTab: BaseTabComponent
Returns void

resizePane

resizePane(direction: ResizeDirection): void

- Defined in tabby-core/src/components/splitTab.component.ts:572
Changes the size of the focused pane in the given direction

Parameters
- direction: ResizeDirection
Returns void

setProgress

setProgress(progress: null | number): void

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

Parameters
- progress: null | number
Returns void

setTitle

setTitle(title: string): void

Inherited from BaseTabComponent.setTitle
- Defined in tabby-core/src/components/baseTab.component.ts:114
Parameters
- title: string
Returns void

splitTab

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

- Defined in tabby-core/src/components/splitTab.component.ts:707
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 tabby-core/src/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

Private updateTitle

updateTitle(): void

- Defined in tabby-core/src/components/splitTab.component.ts:820
Returns void

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

Protected activity

Protected config

customTitle

disableDynamicTitle

Private focusChanged

hasActivity

hasFocus

hostView

Private initialized

Private maximizedTab

parent

Protected progress

Protected recoveryStateChangedHint

root

Private splitAdjusted

Private tabAdded

Private tabAdopted

Private tabRemoved

title

Optional viewContainerEmbeddedRef

Private viewRefs

Protected visibility

Static DIRECTIONS

Accessors

activity$

Returns Observable<boolean>

blurred$

Returns Observable<void>

color

Returns null | string

Parameters

color: null | string

Returns void

destroyed$

Returns Observable<void>

focusChanged$

Returns Observable<BaseTabComponent>

focused$

Returns Observable<void>

icon

Returns null | string

Parameters

icon: null | string

Returns 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>

topmostParent

Returns null | BaseTabComponent

visibility$

Returns Observable<boolean>

Methods

add

Parameters

thing: BaseTabComponent | SplitContainer

relative: null | BaseTabComponent | SplitContainer

side: SplitDirection

Returns Promise<void>

addEventListenerUntilDestroyed

Parameters