Class ToolbarController

Constructors

constructor

new ToolbarController(): ToolbarController
Returns ToolbarController

Properties

`Protected` _toolbarItems

_toolbarItems: ToolbarTreeSchema

`Protected` `Readonly` appState

appState: FrontendApplicationStateService

commandRegistry

commandRegistry: CommandRegistry

contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly` defaultsFactory

defaultsFactory: (() => DeflatedToolbarTree)

Type declaration

- (): DeflatedToolbarTree
- Returns DeflatedToolbarTree

keybindingRegistry

keybindingRegistry: KeybindingRegistry

labelParser

labelParser: LabelParser

`Protected` `Readonly` messageService

messageService: MessageService

`Readonly` onToolbarDidChangeBusyState

onToolbarDidChangeBusyState: Event<boolean> = ...

`Readonly` onToolbarModelDidUpdate

onToolbarModelDidUpdate: Event<void> = ...

`Readonly` ready

ready: Deferred<void> = ...

`Protected` `Readonly` storageProvider

storageProvider: ToolbarStorageProvider

`Protected` toolbarModelDidUpdateEmitter

toolbarModelDidUpdateEmitter: Emitter<void> = ...

`Protected` toolbarProviderBusyEmitter

toolbarProviderBusyEmitter: Emitter<boolean> = ...

`Protected` widgetContributions

widgetContributions: ContributionProvider<ToolbarContribution>

Accessors

toolbarItems

get toolbarItems(): ToolbarTreeSchema
Returns ToolbarTreeSchema
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:58
set toolbarItems(newTree): void
Parameters
- newTree: ToolbarTreeSchema
Returns void
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:62

Methods

addItem

addItem(command, area): Promise<boolean>
Parameters
- command: Command
- area: ToolbarAlignment
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:153

clearAll

clearAll(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:145

`Protected` doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:106

getContributionByID

getContributionByID(id): undefined | ToolbarContribution
Parameters
- id: string
Returns undefined | ToolbarContribution
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:97

`Protected` inflateItems

inflateItems(schema): ToolbarTreeSchema
Parameters
- schema: DeflatedToolbarTree
Returns ToolbarTreeSchema
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:67

`Protected` init

init(): void
Returns void
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:102

insertGroup

insertGroup(position, insertDirection): Promise<boolean>
Parameters
- position: ToolbarItemPosition
- insertDirection: "left" | "right"
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:178

moveItemToEmptySpace

moveItemToEmptySpace(draggedItemPosition, column, centerPosition?): Promise<boolean>
Parameters
- draggedItemPosition: ToolbarItemPosition
- column: ToolbarAlignment
- Optional centerPosition: "left" | "right"
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:167

openOrCreateJSONFile

openOrCreateJSONFile(doOpen?): Promise<undefined | Widget>
Parameters
- doOpen: boolean = false
Returns Promise<undefined | Widget>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:149

removeItem

removeItem(position, id?): Promise<boolean>
Parameters
- position: ToolbarItemPosition
- Optional id: string
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:160

`Protected` resolveToolbarItems

resolveToolbarItems(): Promise<ToolbarTreeSchema>
Returns Promise<ToolbarTreeSchema>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:121

swapValues

swapValues(oldPosition, newPosition, direction): Promise<boolean>
Parameters
- oldPosition: ToolbarItemPosition
- newPosition: ToolbarItemPosition
- direction: "location-left" | "location-right"
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:134

withBusy

withBusy<T>(action): Promise<T>
Type Parameters
- T = unknown
Parameters
- action: (() => MaybePromise<T>)
  - - (): MaybePromise<T>
    - Returns MaybePromise<T>
Returns Promise<T>
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:185

Class ToolbarController

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ToolbarController

Properties

Protected _toolbarItems

Protected Readonly appState

commandRegistry

contextKeyService

Protected Readonly defaultsFactory

Type declaration

Returns DeflatedToolbarTree

keybindingRegistry

labelParser

Protected Readonly messageService

Readonly onToolbarDidChangeBusyState

Readonly onToolbarModelDidUpdate

Readonly ready

Protected Readonly storageProvider

Protected toolbarModelDidUpdateEmitter

Protected toolbarProviderBusyEmitter

Protected widgetContributions

Accessors

toolbarItems

Returns ToolbarTreeSchema

Parameters

Returns void

Methods

addItem

Parameters

Returns Promise<boolean>

clearAll

Returns Promise<boolean>

Protected doInit

Returns Promise<void>

getContributionByID

Parameters

Returns undefined | ToolbarContribution

Protected inflateItems

Parameters

Returns ToolbarTreeSchema

Protected init

Returns void

insertGroup

Parameters

Returns Promise<boolean>

moveItemToEmptySpace

Parameters

Returns Promise<boolean>

openOrCreateJSONFile

Parameters

Returns Promise<undefined | Widget>

removeItem

Parameters

Returns Promise<boolean>

Protected resolveToolbarItems

Returns Promise<ToolbarTreeSchema>

swapValues

Parameters

Returns Promise<boolean>

withBusy

Type Parameters

Parameters

Returns MaybePromise<T>

Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

`Protected` _toolbarItems

`Protected` `Readonly` appState

`Protected` `Readonly` defaultsFactory

`Protected` `Readonly` messageService

`Readonly` onToolbarDidChangeBusyState

`Readonly` onToolbarModelDidUpdate

`Readonly` ready

`Protected` `Readonly` storageProvider

`Protected` toolbarModelDidUpdateEmitter

`Protected` toolbarProviderBusyEmitter

`Protected` widgetContributions

`Protected` doInit

`Protected` inflateItems

`Protected` init

`Protected` resolveToolbarItems