Class ToolbarAwareTabBar

Specialized scrollable tab-bar which comes with toolbar support. Instead of the following DOM structure.

+-------------------------+ |[TAB_0][TAB_1][TAB_2][TAB| +-------------Scrollable--+

There is a dedicated HTML element for toolbar which does not contained in the scrollable element.

+-------------------------+-----------------+ |[TAB_0][TAB_1][TAB_2][TAB| Toolbar | +-------------Scrollable--+-Non-Scrollable-+

Hierarchy (view full)

ScrollableTabBar
- ToolbarAwareTabBar

Constructors

constructor

new ToolbarAwareTabBar(tabBarToolbarRegistry, tabBarToolbarFactory, breadcrumbsRendererFactory, options?, scrollbarOptions?, dynamicTabOptions?): ToolbarAwareTabBar
Parameters
- tabBarToolbarRegistry: TabBarToolbarRegistry
- tabBarToolbarFactory: (() => TabBarToolbar)
  - - (): TabBarToolbar
    - Returns TabBarToolbar
- breadcrumbsRendererFactory: BreadcrumbsRendererFactory
- Optional options: IOptions<Widget>
- Optional scrollbarOptions: Options
- Optional dynamicTabOptions: core.Options
Returns ToolbarAwareTabBar
Overrides ScrollableTabBar.constructor
- Defined in packages/core/src/browser/shell/tab-bars.ts:944

Properties

`Protected` `Optional` _dynamicTabOptions

_dynamicTabOptions?: core.Options

`Protected` breadcrumbsContainer

breadcrumbsContainer: HTMLElement

`Protected` `Readonly` breadcrumbsRenderer

breadcrumbsRenderer: BreadcrumbsRenderer

`Protected` `Readonly` breadcrumbsRendererFactory

breadcrumbsRendererFactory: BreadcrumbsRendererFactory

`Protected` contentContainer

contentContainer: HTMLElement

`Protected` dockPanel

dockPanel: TheiaDockPanel

`Protected` isMouseOver

isMouseOver: boolean = false

`Protected` needsRecompute

needsRecompute: boolean = false

`Protected` openTabsContainer

openTabsContainer: HTMLDivElement

`Protected` openTabsRoot

openTabsRoot: Root

`Protected` `Optional` pendingReveal

pendingReveal?: Promise<void>

`Protected` scrollBar

scrollBar: undefined | PerfectScrollbar

`Protected` `Optional` `Readonly` scrollbarOptions

scrollbarOptions?: Options

`Protected` `Readonly` tabBarToolbarFactory

tabBarToolbarFactory: (() => TabBarToolbar)

Type declaration

- (): TabBarToolbar
- Returns TabBarToolbar

`Protected` `Readonly` tabBarToolbarRegistry

tabBarToolbarRegistry: TabBarToolbarRegistry

`Protected` tabSize

tabSize: number = 0

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` toolbar

toolbar: undefined | TabBarToolbar

`Protected` topRow

topRow: HTMLElement

Accessors

dynamicTabOptions

get dynamicTabOptions(): undefined | core.Options
Returns undefined | core.Options
Inherited from ScrollableTabBar.dynamicTabOptions
- Defined in packages/core/src/browser/shell/tab-bars.ts:742
set dynamicTabOptions(options): void
Parameters
- options: undefined | core.Options
Returns void
Inherited from ScrollableTabBar.dynamicTabOptions
- Defined in packages/core/src/browser/shell/tab-bars.ts:737

Methods

dispose

dispose(): void
Returns void
Inherited from ScrollableTabBar.dispose
- Defined in packages/core/src/browser/shell/tab-bars.ts:746

`Protected` doReleaseMouse

doReleaseMouse(): void
Returns void
Inherited from ScrollableTabBar.doReleaseMouse
- Defined in packages/core/src/browser/shell/tab-bars.ts:767

handleEvent

handleEvent(event): void
Parameters
- event: Event
Returns void
Overrides ScrollableTabBar.handleEvent
- Defined in packages/core/src/browser/shell/tab-bars.ts:1032

`Protected` isOver

isOver(event, element): boolean
Parameters
- event: Event
- element: Element
Returns boolean
- Defined in packages/core/src/browser/shell/tab-bars.ts:1046

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Overrides ScrollableTabBar.onAfterAttach
- Defined in packages/core/src/browser/shell/tab-bars.ts:997

`Protected` onAfterDetach

onAfterDetach(msg): void
Parameters
- msg: Message
Returns void
Inherited from ScrollableTabBar.onAfterDetach
- Defined in packages/core/src/browser/shell/tab-bars.ts:760

`Protected` onBeforeAttach

onBeforeAttach(msg): void
Parameters
- msg: Message
Returns void
Inherited from ScrollableTabBar.onBeforeAttach
- Defined in packages/core/src/browser/shell/tab-bars.ts:754

`Protected` onBeforeDetach

onBeforeDetach(msg): void
Parameters
- msg: Message
Returns void
Overrides ScrollableTabBar.onBeforeDetach
- Defined in packages/core/src/browser/shell/tab-bars.ts:1011

`Protected` onResize

onResize(msg): void
Parameters
- msg: ResizeMessage
Returns void
Inherited from ScrollableTabBar.onResize
- Defined in packages/core/src/browser/shell/tab-bars.ts:848

`Protected` onUpdateRequest

onUpdateRequest(msg): void
Parameters
- msg: Message
Returns void
Overrides ScrollableTabBar.onUpdateRequest
- Defined in packages/core/src/browser/shell/tab-bars.ts:1018

revealTab

revealTab(index): Promise<void>
Reveal the tab with the given index by moving the scroll bar if necessary.
Parameters
- index: number
Returns Promise<void>
Inherited from ScrollableTabBar.revealTab
- Defined in packages/core/src/browser/shell/tab-bars.ts:864

setDockPanel

setDockPanel(panel): void
Parameters
- panel: TheiaDockPanel
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:987

`Protected` updateBreadcrumbs

updateBreadcrumbs(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/shell/tab-bars.ts:991

`Protected` updateTabs

updateTabs(): void
Returns void
Inherited from ScrollableTabBar.updateTabs
- Defined in packages/core/src/browser/shell/tab-bars.ts:793

`Protected` updateToolbar

updateToolbar(): void
Returns void
- Defined in packages/core/src/browser/shell/tab-bars.ts:1023

Class ToolbarAwareTabBar

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TabBarToolbar

Returns ToolbarAwareTabBar

Properties

Protected Optional _dynamicTabOptions

Protected breadcrumbsContainer

Protected Readonly breadcrumbsRenderer

Protected Readonly breadcrumbsRendererFactory

Protected contentContainer

Protected dockPanel

Protected isMouseOver

Protected needsRecompute

Protected openTabsContainer

Protected openTabsRoot

Protected Optional pendingReveal

Protected scrollBar

Protected Optional Readonly scrollbarOptions

Protected Readonly tabBarToolbarFactory

Type declaration

Returns TabBarToolbar

Protected Readonly tabBarToolbarRegistry

Protected tabSize

Protected Readonly toDispose

Protected toolbar

Protected topRow

Accessors

dynamicTabOptions

Returns undefined | core.Options

Parameters

Returns void

Methods

dispose

Returns void

Protected doReleaseMouse

Returns void

handleEvent

Parameters

Returns void

Protected isOver

Parameters

Returns boolean

Protected onAfterAttach

Parameters

Returns void

Protected onAfterDetach

Parameters

Returns void

Protected onBeforeAttach

Parameters

Returns void

Protected onBeforeDetach

Parameters

Returns void

Protected onResize

Parameters

Returns void

Protected onUpdateRequest

Parameters

Returns void

revealTab

Parameters

Returns Promise<void>

setDockPanel

Parameters

Returns void

Protected updateBreadcrumbs

Returns Promise<void>

Protected updateTabs

Returns void

Protected updateToolbar

Returns void

`Protected` `Optional` _dynamicTabOptions

`Protected` breadcrumbsContainer

`Protected` `Readonly` breadcrumbsRenderer

`Protected` `Readonly` breadcrumbsRendererFactory

`Protected` contentContainer

`Protected` dockPanel

`Protected` isMouseOver

`Protected` needsRecompute

`Protected` openTabsContainer

`Protected` openTabsRoot

`Protected` `Optional` pendingReveal

`Protected` scrollBar

`Protected` `Optional` `Readonly` scrollbarOptions

`Protected` `Readonly` tabBarToolbarFactory

`Protected` `Readonly` tabBarToolbarRegistry

`Protected` tabSize

`Protected` `Readonly` toDispose

`Protected` toolbar

`Protected` topRow

`Protected` doReleaseMouse

`Protected` isOver

`Protected` onAfterAttach

`Protected` onAfterDetach

`Protected` onBeforeAttach

`Protected` onBeforeDetach

`Protected` onResize

`Protected` onUpdateRequest

`Protected` updateBreadcrumbs

`Protected` updateTabs

`Protected` updateToolbar