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?, maximizeCallback?): TheiaDockPanel
Parameters
- Optional options: IOptions
- Optional preferences: CorePreferences
- Optional maximizeCallback: ((area) => void)
  - - (area): void
    - Parameters
      area: TheiaDockPanel
      Returns void
Returns TheiaDockPanel
Overrides DockPanel.constructor
- Defined in packages/core/src/browser/shell/theia-dock-panel.ts:55

Properties

`Protected` _currentTitle

_currentTitle: undefined | Title<Widget>

`Protected` `Optional` `Readonly` maximizeCallback

maximizeCallback?: ((area) => void)

Type declaration

- (area): void
- Parameters
  - area: TheiaDockPanel
  Returns void

`Protected` `Readonly` onDidChangeCurrentEmitter

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

`Protected` `Optional` `Readonly` preferences

preferences?: CorePreferences

`Protected` `Readonly` toDisposeOnMarkAsCurrent

toDisposeOnMarkAsCurrent: 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:94

currentTitle

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

onDidChangeCurrent

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

Methods

activateWidget

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

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:129

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:98

isElectron

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

markActiveTabBar

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

markAsCurrent

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

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:158

nextTabBarWidget

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

`Protected` onChildRemoved

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

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:173

previousTabBarWidget

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

toggleMaximized

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

Class TheiaDockPanel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Parameters

Returns void

Returns TheiaDockPanel

Properties

Protected _currentTitle

Protected Optional Readonly maximizeCallback

Type declaration

Parameters

Returns void

Protected Readonly onDidChangeCurrentEmitter

Protected Optional Readonly preferences

Protected Readonly toDisposeOnMarkAsCurrent

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>

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` `Optional` `Readonly` maximizeCallback

`Protected` `Readonly` onDidChangeCurrentEmitter

`Protected` `Optional` `Readonly` preferences

`Protected` `Readonly` toDisposeOnMarkAsCurrent

`Readonly` widgetActivated

`Readonly` widgetAdded

`Readonly` widgetRemoved

`Protected` onChildRemoved