Class ToolbarController

Constructors

constructor

new ToolbarController(): ToolbarController
Returns ToolbarController

Properties

`Protected` _toolbarItems

_toolbarItems: ToolbarTreeSchema

`Protected` `Readonly` appState

appState: FrontendApplicationStateService

`Protected` `Readonly` defaultsFactory

defaultsFactory: (() => DeflatedToolbarTree)

Type declaration

- (): DeflatedToolbarTree
- Returns DeflatedToolbarTree

`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:51
set toolbarItems(newTree): void
Parameters
- newTree: ToolbarTreeSchema
Returns void
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:55

Methods

addItem

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

clearAll

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

`Protected` doInit

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

getContributionByID

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

`Protected` inflateItems

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

`Protected` init

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

insertGroup

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

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

openOrCreateJSONFile

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

removeItem

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

`Protected` resolveToolbarItems

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

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

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