Class DockPanelRenderer

A renderer for dock panels that supports context menus on tabs.

Implements

DockLayout.IRenderer

Index

Constructors

Properties

breadcrumbsRendererFactory corePreferences document? tabBarClasses tabBarRendererFactory tabBarToolbarFactory tabBarToolbarRegistry

Accessors

onDidCreateTabBar

Methods

createHandle createTabBar onCurrentTabChanged

Constructors

constructor

new DockPanelRenderer(
    tabBarRendererFactory: TabBarRendererFactory,
    tabBarToolbarRegistry: TabBarToolbarRegistry,
    tabBarToolbarFactory: TabBarToolbarFactory,
    breadcrumbsRendererFactory: BreadcrumbsRendererFactory,
    corePreferences: CorePreferences,
): DockPanelRenderer
Parameters
- tabBarRendererFactory: TabBarRendererFactory
- tabBarToolbarRegistry: TabBarToolbarRegistry
- tabBarToolbarFactory: TabBarToolbarFactory
- breadcrumbsRendererFactory: BreadcrumbsRendererFactory
- corePreferences: CorePreferences
Returns DockPanelRenderer
- Defined in packages/core/src/browser/shell/application-shell.ts:99

Properties

`Protected` `Readonly`breadcrumbsRendererFactory

breadcrumbsRendererFactory: BreadcrumbsRendererFactory

`Protected` `Readonly`corePreferences

corePreferences: CorePreferences

`Optional`document

document?: Document | ShadowRoot

In case of DockPanels rendered in secondary windows, will be set to the document of that window

`Readonly`tabBarClasses

tabBarClasses: string[] = []

`Protected` `Readonly`tabBarRendererFactory

tabBarRendererFactory: TabBarRendererFactory

`Protected` `Readonly`tabBarToolbarFactory

tabBarToolbarFactory: TabBarToolbarFactory

`Protected` `Readonly`tabBarToolbarRegistry

tabBarToolbarRegistry: TabBarToolbarRegistry

Accessors

onDidCreateTabBar

get onDidCreateTabBar(): Event<TabBar<Widget>>
Returns Event<TabBar<Widget>>
- Defined in packages/core/src/browser/shell/application-shell.ts:107

Methods

createHandle

createHandle(): HTMLDivElement
Create a new handle node for use with a dock layout.

Returns HTMLDivElement
A new handle node for a dock layout.
Implementation of IRenderer.createHandle
- Defined in packages/core/src/browser/shell/application-shell.ts:159

createTabBar

createTabBar(): TabBar<Widget>
Create a new tab bar for use with a dock layout.

Returns TabBar<Widget>
A new tab bar for a dock layout.
Implementation of IRenderer.createTabBar
- Defined in packages/core/src/browser/shell/application-shell.ts:111

`Protected`onCurrentTabChanged

onCurrentTabChanged(
sender: ToolbarAwareTabBar,
__namedParameters: TabBar.ICurrentChangedArgs<Widget>,
): void
Parameters
- sender: ToolbarAwareTabBar
- __namedParameters: TabBar.ICurrentChangedArgs<Widget>
Returns void
- Defined in packages/core/src/browser/shell/application-shell.ts:163