Class ToolbarController

Hierarchy

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
set toolbarItems(newTree: ToolbarTreeSchema): void

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:52
Returns ToolbarTreeSchema
- Defined in packages/toolbar/src/browser/toolbar-controller.ts:56
Parameters
- newTree: ToolbarTreeSchema
Returns void

Methods

addItem

addItem(command: Command, area: ToolbarAlignment): Promise<boolean>

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:147
Parameters
- command: Command
- area: ToolbarAlignment
Returns Promise<boolean>

clearAll

clearAll(): Promise<boolean>

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:139
Returns Promise<boolean>

Protected doInit

doInit(): Promise<void>

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:100
Returns Promise<void>

getContributionByID

getContributionByID(id: string): undefined | ToolbarContribution

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:91
Parameters
- id: string
Returns undefined | ToolbarContribution

Protected inflateItems

inflateItems(schema: DeflatedToolbarTree): ToolbarTreeSchema

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:61
Parameters
- schema: DeflatedToolbarTree
Returns ToolbarTreeSchema

Protected init

init(): void

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:96
Returns void

insertGroup

insertGroup(position: ToolbarItemPosition, insertDirection: "left" | "right"): Promise<boolean>

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

moveItemToEmptySpace

moveItemToEmptySpace(draggedItemPosition: ToolbarItemPosition, column: ToolbarAlignment, centerPosition?: "left" | "right"): Promise<boolean>

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

openOrCreateJSONFile

openOrCreateJSONFile(doOpen?: boolean): Promise<undefined | Widget>

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

removeItem

removeItem(position: ToolbarItemPosition, id?: string): Promise<boolean>

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:154
Parameters
- position: ToolbarItemPosition
- Optional id: string
Returns Promise<boolean>

Protected resolveToolbarItems

resolveToolbarItems(): Promise<ToolbarTreeSchema>

- Defined in packages/toolbar/src/browser/toolbar-controller.ts:115
Returns Promise<ToolbarTreeSchema>

swapValues

swapValues(oldPosition: ToolbarItemPosition, newPosition: ToolbarItemPosition, direction: "location-left" | "location-right"): Promise<boolean>

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

withBusy

withBusy<T>(action: (() => MaybePromise<T>)): Promise<T>

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