Class RenderedToolbarItemImpl

Hierarchy

AbstractToolbarItemImpl<RenderedToolbarAction>
- RenderedToolbarItemImpl

Implements

TabBarToolbarItem

Constructors

constructor

new RenderedToolbarItemImpl(
    commandRegistry: CommandRegistry,
    contextKeyService: ContextKeyService,
    keybindingRegistry: KeybindingRegistry,
    labelParser: LabelParser,
    action: RenderedToolbarAction,
): RenderedToolbarItemImpl
Parameters
- commandRegistry: CommandRegistry
- contextKeyService: ContextKeyService
- keybindingRegistry: KeybindingRegistry
- labelParser: LabelParser
- action: RenderedToolbarAction
Returns RenderedToolbarItemImpl
Overrides AbstractToolbarItemImpl<RenderedToolbarAction>.constructor
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:101

Properties

`Protected` `Readonly`action

action: RenderedToolbarAction

`Protected` `Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected`contextKeyListener

contextKeyListener: undefined | Disposable

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Protected`disposables

disposables: DisposableCollection = ...

`Protected` `Readonly`keybindingRegistry

keybindingRegistry: KeybindingRegistry

`Protected` `Readonly`labelParser

labelParser: LabelParser

`Protected` `Readonly`onDidChangeEmitter

onDidChangeEmitter: Emitter<void> = ...

Accessors

group

get group(): undefined | string
Returns undefined | string
Implementation of TabBarToolbarItem.group
Inherited from AbstractToolbarItemImpl.group
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:68

id

get id(): string
Returns string
Implementation of TabBarToolbarItem.id
Inherited from AbstractToolbarItemImpl.id
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:62

onDidChange

get onDidChange(): undefined | Event<void>
Returns undefined | Event<void>
Implementation of TabBarToolbarItem.onDidChange
Overrides AbstractToolbarItemImpl.onDidChange
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:173

priority

get priority(): undefined | number
Returns undefined | number
Implementation of TabBarToolbarItem.priority
Inherited from AbstractToolbarItemImpl.priority
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:71

when

get when(): undefined | string
Returns undefined | string
Implementation of TabBarToolbarItem.when
Inherited from AbstractToolbarItemImpl.when
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:65

Methods

dispose

dispose(): void
Returns void
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:117

`Protected`doExecuteCommand

doExecuteCommand(e: SyntheticEvent<HTMLElement>, widget: Widget): void
Parameters
- e: SyntheticEvent<HTMLElement>
- widget: Widget
Returns void
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:210

`Protected`executeCommand

executeCommand(e: MouseEvent<HTMLElement>, widget: Widget): void
Parameters
- e: MouseEvent<HTMLElement>
- widget: Widget
Returns void
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:206

`Protected`getToolbarItemClassNames

getToolbarItemClassNames(widget: Widget): string[]
Parameters
- widget: Widget
Returns string[]
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:141

isEnabled

isEnabled(widget: Widget): boolean
Parameters
- widget: Widget
Returns boolean
Implementation of TabBarToolbarItem.isEnabled
Inherited from AbstractToolbarItemImpl.isEnabled
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:89

isToggled

isToggled(widget: Widget): boolean
Parameters
- widget: Widget
Returns boolean
Implementation of TabBarToolbarItem.isToggled
Inherited from AbstractToolbarItemImpl.isToggled
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:92

isVisible

isVisible(widget: Widget, contextMatcher: ContextMatcher): boolean
Parameters
- widget: Widget
- contextMatcher: ContextMatcher
  evaluates when clauses with the values that describe the given widget. Keys scoped to a DOM node keep resolving against the focused element, as no context node is passed here.
Returns boolean
Implementation of TabBarToolbarItem.isVisible
Inherited from AbstractToolbarItemImpl.isVisible
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:79

`Protected`onKeyDownEvent

onKeyDownEvent(e: KeyboardEvent<HTMLElement>, widget: Widget): void
Parameters
- e: KeyboardEvent<HTMLElement>
- widget: Widget
Returns void
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:221

`Protected`onMouseDownEvent

onMouseDownEvent(e: MouseEvent<HTMLElement>): void
Parameters
- e: MouseEvent<HTMLElement>
Returns void
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:196

`Protected`onMouseUpEvent

onMouseUpEvent(e: MouseEvent<HTMLElement>): void
Parameters
- e: MouseEvent<HTMLElement>
Returns void
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:202

render

render(widget: Widget): ReactNode
Parameters
- widget: Widget
Returns ReactNode
Implementation of TabBarToolbarItem.render
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:137

`Protected`renderItem

renderItem(widget: Widget): ReactNode
Parameters
- widget: Widget
Returns ReactNode
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:227

`Protected`resolveKeybindingForCommand

resolveKeybindingForCommand(widget: Widget, command: undefined | string): string
Parameters
- widget: Widget
- command: undefined | string
Returns string
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:152

`Optional`toMenuNode

toMenuNode?(): MenuNode
Returns MenuNode
Implementation of TabBarToolbarItem.toMenuNode
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:177

updateContextKeyListener

updateContextKeyListener(when: string): void
Parameters
- when: string
Returns void
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-toolbar-item.tsx:121

Class RenderedToolbarItemImpl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderedToolbarItemImpl

Properties

Protected Readonlyaction

Protected ReadonlycommandRegistry

ProtectedcontextKeyListener

Protected ReadonlycontextKeyService

Protecteddisposables

Protected ReadonlykeybindingRegistry

Protected ReadonlylabelParser

Protected ReadonlyonDidChangeEmitter

Accessors

group

Returns undefined | string

id

Returns string

onDidChange

Returns undefined | Event<void>

priority

Returns undefined | number

when

Returns undefined | string

Methods

dispose

Returns void

ProtecteddoExecuteCommand

Parameters

Returns void

ProtectedexecuteCommand

Parameters

Returns void

ProtectedgetToolbarItemClassNames

Parameters

Returns string[]

isEnabled

Parameters

Returns boolean

isToggled

Parameters

Returns boolean

isVisible

Parameters

Returns boolean

ProtectedonKeyDownEvent

Parameters

Returns void

ProtectedonMouseDownEvent

Parameters

Returns void

ProtectedonMouseUpEvent

Parameters

Returns void

render

Parameters

Returns ReactNode

ProtectedrenderItem

Parameters

Returns ReactNode

ProtectedresolveKeybindingForCommand

Parameters

Returns string

OptionaltoMenuNode

Returns MenuNode

updateContextKeyListener

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`action

`Protected` `Readonly`commandRegistry

`Protected`contextKeyListener

`Protected` `Readonly`contextKeyService

`Protected`disposables

`Protected` `Readonly`keybindingRegistry

`Protected` `Readonly`labelParser

`Protected` `Readonly`onDidChangeEmitter

`Protected`doExecuteCommand

`Protected`executeCommand

`Protected`getToolbarItemClassNames

`Protected`onKeyDownEvent

`Protected`onMouseDownEvent

`Protected`onMouseUpEvent

`Protected`renderItem

`Protected`resolveKeybindingForCommand

`Optional`toMenuNode