Class TheiaDockPanel

This specialization of DockPanel adds various events that are used for implementing the side panels of the application shell.

Hierarchy

DockPanel
- TheiaDockPanel

Constructors

constructor

new TheiaDockPanel(options?, preferences?): TheiaDockPanel
Parameters
- Optional options: IOptions
- Optional preferences: CorePreferences
Returns TheiaDockPanel
Overrides DockPanel.constructor
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:58

Properties

`Protected` _currentTitle

_currentTitle: undefined | Title<Widget>

`Protected` maximizedElement

maximizedElement: undefined | HTMLElement

`Protected` `Readonly` onDidChangeCurrentEmitter

onDidChangeCurrentEmitter: Emitter<undefined | Title<Widget>> = ...

`Readonly` onDidToggleMaximized

onDidToggleMaximized: Event<Widget> = ...

`Protected` `Readonly` onDidToggleMaximizedEmitter

onDidToggleMaximizedEmitter: Emitter<Widget> = ...

`Protected` `Optional` `Readonly` preferences

preferences?: CorePreferences

`Protected` `Readonly` toDisposeOnMarkAsCurrent

toDisposeOnMarkAsCurrent: DisposableCollection = ...

`Protected` `Readonly` toDisposeOnToggleMaximized

toDisposeOnToggleMaximized: DisposableCollection = ...

`Readonly` widgetActivated

widgetActivated: Signal<TheiaDockPanel, Widget> = ...

Emitted when a widget is activated by calling activateWidget.

`Readonly` widgetAdded

widgetAdded: Signal<TheiaDockPanel, Widget> = ...

Emitted when a widget is added to the panel.

`Readonly` widgetRemoved

widgetRemoved: Signal<TheiaDockPanel, Widget> = ...

Emitted when a widget is removed from the panel.

Accessors

currentTabBar

get currentTabBar(): undefined | TabBar<Widget>
Returns undefined | TabBar<Widget>
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:101

currentTitle

get currentTitle(): undefined | Title<Widget>
Returns undefined | Title<Widget>
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:97

onDidChangeCurrent

get onDidChangeCurrent(): Event<undefined | Title<Widget>>
Returns Event<undefined | Title<Widget>>
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:54

Methods

activateWidget

activateWidget(widget): void
Parameters
- widget: Widget
Returns void
Overrides DockPanel.activateWidget
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:148

addWidget

addWidget(widget, options?): void
Parameters
- widget: Widget
- Optional options: AddOptions
Returns void
Overrides DockPanel.addWidget
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:136

findTabBar

findTabBar(title): undefined | TabBar<Widget>
Parameters
- title: Title<Widget>
Returns undefined | TabBar<Widget>
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:105

`Protected` getMaximizedElement

getMaximizedElement(): HTMLElement
Returns HTMLElement
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:243

`Protected` handleMenuBarVisibility

handleMenuBarVisibility(newValue): void
Parameters
- newValue: string
Returns void
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:83

isElectron

isElectron(): boolean
Returns boolean
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:79

markActiveTabBar

markActiveTabBar(title?): void
Parameters
- Optional title: Title<Widget>
Returns void
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:124

markAsCurrent

markAsCurrent(title): void
Parameters
- title: undefined | Title<Widget>
Returns void
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:110

nextTabBarInPanel

nextTabBarInPanel(tabBar): undefined | TabBar<Widget>
Parameters
- tabBar: TabBar<Widget>
Returns undefined | TabBar<Widget>
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:165

nextTabBarWidget

nextTabBarWidget(widget): undefined | Widget
Parameters
- widget: Widget
Returns undefined | Widget
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:159

`Protected` onChildRemoved

onChildRemoved(msg): void
Parameters
- msg: ChildMessage
Returns void
Overrides DockPanel.onChildRemoved
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:154

previousTabBarInPanel

previousTabBarInPanel(tabBar): undefined | TabBar<Widget>
Parameters
- tabBar: TabBar<Widget>
Returns undefined | TabBar<Widget>
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:180

previousTabBarWidget

previousTabBarWidget(widget): undefined | Widget
Parameters
- widget: Widget
Returns undefined | Widget
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:174

toggleMaximized

toggleMaximized(): void
Returns void
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:190

Class TheiaDockPanel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TheiaDockPanel

Properties

Protected _currentTitle

Protected maximizedElement

Protected Readonly onDidChangeCurrentEmitter

Readonly onDidToggleMaximized

Protected Readonly onDidToggleMaximizedEmitter

Protected Optional Readonly preferences

Protected Readonly toDisposeOnMarkAsCurrent

Protected Readonly toDisposeOnToggleMaximized

Readonly widgetActivated

Readonly widgetAdded

Readonly widgetRemoved

Accessors

currentTabBar

Returns undefined | TabBar<Widget>

currentTitle

Returns undefined | Title<Widget>

onDidChangeCurrent

Returns Event<undefined | Title<Widget>>

Methods

activateWidget

Parameters

Returns void

addWidget

Parameters

Returns void

findTabBar

Parameters

Returns undefined | TabBar<Widget>

Protected getMaximizedElement

Returns HTMLElement

Protected handleMenuBarVisibility

Parameters

Returns void

isElectron

Returns boolean

markActiveTabBar

Parameters

Returns void

markAsCurrent

Parameters

Returns void

nextTabBarInPanel

Parameters

Returns undefined | TabBar<Widget>

nextTabBarWidget

Parameters

Returns undefined | Widget

Protected onChildRemoved

Parameters

Returns void

previousTabBarInPanel

Parameters

Returns undefined | TabBar<Widget>

previousTabBarWidget

Parameters

Returns undefined | Widget

toggleMaximized

Returns void

Settings

Member Visibility

Theme

On This Page

`Protected` _currentTitle

`Protected` maximizedElement

`Protected` `Readonly` onDidChangeCurrentEmitter

`Readonly` onDidToggleMaximized

`Protected` `Readonly` onDidToggleMaximizedEmitter

`Protected` `Optional` `Readonly` preferences

`Protected` `Readonly` toDisposeOnMarkAsCurrent

`Protected` `Readonly` toDisposeOnToggleMaximized

`Readonly` widgetActivated

`Readonly` widgetAdded

`Readonly` widgetRemoved

`Protected` getMaximizedElement

`Protected` handleMenuBarVisibility

`Protected` onChildRemoved