Class SidePanelToolbar

Hierarchy (view full)

BaseWidget
- SidePanelToolbar

Constructors

constructor

new SidePanelToolbar(tabBarToolbarRegistry, tabBarToolbarFactory, side): SidePanelToolbar
Parameters
- tabBarToolbarRegistry: TabBarToolbarRegistry
- tabBarToolbarFactory: TabBarToolbarFactory
- side: "left" | "right"
Returns SidePanelToolbar
Overrides BaseWidget.constructor
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:33

Properties

`Private` _toolbarTitle

_toolbarTitle: undefined | Title<Widget>

`Readonly` onContextMenu

onContextMenu: Event<MouseEvent> = ...

`Protected` `Readonly` onContextMenuEmitter

onContextMenuEmitter: Emitter<MouseEvent> = ...

`Readonly` onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

`Protected` `Readonly` onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

`Readonly` onDidDispose

onDidDispose: Event<void> = ...

`Protected` `Readonly` onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

`Readonly` onScrollUp

onScrollUp: Event<void> = ...

`Protected` `Readonly` onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = ...

`Readonly` onScrollYReachEnd

onScrollYReachEnd: Event<void> = ...

`Protected` `Readonly` onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = ...

`Protected` `Optional` scrollBar

scrollBar?: PerfectScrollbar

`Protected` `Optional` scrollOptions

scrollOptions?: Options

`Protected` `Readonly` side

side: "left" | "right"

`Protected` `Readonly` tabBarToolbarFactory

tabBarToolbarFactory: TabBarToolbarFactory

`Protected` `Readonly` tabBarToolbarRegistry

tabBarToolbarRegistry: TabBarToolbarRegistry

`Protected` titleContainer

titleContainer: undefined | HTMLElement

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly` toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

`Protected` toolbar

toolbar: undefined | TabBarToolbar

Accessors

toolbarTitle

set toolbarTitle(title): void
Parameters
- title: undefined | Title<Widget>
Returns void
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:95

Methods

`Protected` addClipboardListener

addClipboardListener<K>(element, type, listener): void
Type Parameters
- K extends "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void
Inherited from BaseWidget.addClipboardListener
- Defined in packages/core/src/browser/widgets/widget.ts:217

`Protected` addEventListener

addEventListener<K>(element, type, listener, useCapture?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void
Inherited from BaseWidget.addEventListener
- Defined in packages/core/src/browser/widgets/widget.ts:206

`Protected` addKeyListener

addKeyListener<K>(element, keysOrKeyCodes, action, ...additionalEventTypes): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- keysOrKeyCodes: KeysOrKeyCodes | core.Predicate
- action: ((event) => boolean | void | Object)
  - - (event): boolean | void | Object
    - Parameters
      event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void
Inherited from BaseWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:210

`Protected` addUpdateListener

addUpdateListener<K>(element, type, useCapture?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void
Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:199

clearFlag

clearFlag(flag): void
Parameters
- flag: Flag
Returns void
Inherited from BaseWidget.clearFlag
- Defined in packages/core/src/browser/widgets/widget.ts:232

`Protected` disableScrollBarFocus

disableScrollBarFocus(scrollContainer): void
Parameters
- scrollContainer: HTMLElement
Returns void
Inherited from BaseWidget.disableScrollBarFocus
- Defined in packages/core/src/browser/widgets/widget.ts:181

dispose

dispose(): void
Returns void
Inherited from BaseWidget.dispose
- Defined in packages/core/src/browser/widgets/widget.ts:124

getPreviewNode

getPreviewNode(): undefined | Node
Returns undefined | Node
Inherited from BaseWidget.getPreviewNode
- Defined in packages/core/src/browser/widgets/widget.ts:221

`Protected` getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>
Returns MaybePromise<HTMLElement>
Inherited from BaseWidget.getScrollContainer
- Defined in packages/core/src/browser/widgets/widget.ts:177

`Protected` init

init(): void
Returns void
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:83

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Overrides BaseWidget.onAfterAttach
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:50

`Protected` onAfterDetach

onAfterDetach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onAfterDetach
- Defined in packages/core/src/browser/widgets/widget.ts:144

`Protected` onBeforeAttach

onBeforeAttach(msg): void
Parameters
- msg: Message
Returns void
Overrides BaseWidget.onBeforeAttach
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:43

`Protected` onBeforeDetach

onBeforeDetach(msg): void
Parameters
- msg: Message
Returns void
Overrides BaseWidget.onBeforeDetach
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:60

`Protected` onCloseRequest

onCloseRequest(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/src/browser/widgets/widget.ts:132

`Protected` onUpdateRequest

onUpdateRequest(msg): void
Parameters
- msg: Message
Returns void
Overrides BaseWidget.onUpdateRequest
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:70

setFlag

setFlag(flag): void
Parameters
- flag: Flag
Returns void
Inherited from BaseWidget.setFlag
- Defined in packages/core/src/browser/widgets/widget.ts:225

showMoreContextMenu

showMoreContextMenu(anchor): ContextMenuAccess
Parameters
- anchor: Anchor
Returns ContextMenuAccess
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:104

`Protected` updateToolbar

updateToolbar(): void
Returns void
- Defined in packages/core/src/browser/shell/side-panel-toolbar.ts:75

Class SidePanelToolbar

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SidePanelToolbar

Properties

Private _toolbarTitle

Readonly onContextMenu

Protected Readonly onContextMenuEmitter

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly side

Protected Readonly tabBarToolbarFactory

Protected Readonly tabBarToolbarRegistry

Protected titleContainer

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Protected toolbar

Accessors

toolbarTitle

Parameters

Returns void

Methods

Protected addClipboardListener

Type Parameters

Parameters

Returns void

Protected addEventListener

Type Parameters

Parameters

Returns void

Protected addKeyListener

Type Parameters

Parameters

Parameters

Returns boolean | void | Object

Returns void

Protected addUpdateListener

Type Parameters

Parameters

Returns void

clearFlag

Parameters

Returns void

Protected disableScrollBarFocus

Parameters

Returns void

dispose

Returns void

getPreviewNode

Returns undefined | Node

Protected getScrollContainer

Returns MaybePromise<HTMLElement>

Protected init

Returns void

Protected onAfterAttach

Parameters

Returns void

Protected onAfterDetach

Parameters

Returns void

Protected onBeforeAttach

Parameters

Returns void

Protected onBeforeDetach

Parameters

`Private` _toolbarTitle

`Readonly` onContextMenu

`Protected` `Readonly` onContextMenuEmitter

`Readonly` onDidChangeVisibility

`Protected` `Readonly` onDidChangeVisibilityEmitter

`Readonly` onDidDispose

`Protected` `Readonly` onDidDisposeEmitter

`Readonly` onScrollUp

`Protected` `Readonly` onScrollUpEmitter

`Readonly` onScrollYReachEnd

`Protected` `Readonly` onScrollYReachEndEmitter

`Protected` `Optional` scrollBar

`Protected` `Optional` scrollOptions

`Protected` `Readonly` side

`Protected` `Readonly` tabBarToolbarFactory

`Protected` `Readonly` tabBarToolbarRegistry

`Protected` titleContainer

`Protected` `Readonly` toDispose

`Protected` `Readonly` toDisposeOnDetach

`Protected` toolbar

`Protected` addClipboardListener

`Protected` addEventListener

`Protected` addKeyListener

`Protected` addUpdateListener

`Protected` disableScrollBarFocus

`Protected` getScrollContainer

`Protected` init

`Protected` onAfterAttach

`Protected` onAfterDetach

`Protected` onBeforeAttach

`Protected` onBeforeDetach

`Protected` onCloseRequest

`Protected` onUpdateRequest

`Protected` updateToolbar