Class ToolbarStorageProvider

Implements

Disposable

Constructors

constructor

new ToolbarStorageProvider(): ToolbarStorageProvider
Returns ToolbarStorageProvider

Properties

`Protected` `Readonly` USER_TOOLBAR_URI

USER_TOOLBAR_URI: URI

`Protected` `Readonly` _ready

_ready: Deferred<void> = ...

`Protected` `Readonly` appState

appState: FrontendApplicationStateService

`Protected` editorManager

editorManager: EditorManager

`Protected` `Readonly` fileService

fileService: FileService

`Protected` lateInjector

lateInjector: (<T>(id) => T)

Type declaration

- <T>(id): T
- Type Parameters
  - T
  Parameters
  - id: ServiceIdentifier<T>
  Returns T

`Protected` `Readonly` messageService

messageService: MessageService

`Protected` model

model: undefined | MonacoEditorModel

`Protected` monacoWorkspace

monacoWorkspace: MonacoWorkspace

`Readonly` onToolbarItemsChanged

onToolbarItemsChanged: Event<void> = ...

`Protected` `Readonly` textModelService

textModelService: MonacoTextModelService

`Protected` toDispose

toDispose: DisposableCollection = ...

toolbarItems

toolbarItems: undefined | DeflatedToolbarTree

`Protected` toolbarItemsUpdatedEmitter

toolbarItemsUpdatedEmitter: Emitter<void> = ...

Accessors

ready

get ready(): Promise<void>
Returns Promise<void>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:54

Methods

addItem

addItem(command, alignment): Promise<boolean>
Parameters
- command: Command
- alignment: ToolbarAlignment
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:121

addItemToEmptyColumn

addItemToEmptyColumn(item, alignment): Promise<boolean>
Parameters
- item: ToolbarItemDeflated
- alignment: ToolbarAlignment
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:167

clearAll

clearAll(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:256

dispose

dispose(): void
Returns void
Implementation of Disposable.dispose
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:349

`Protected` doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:75

`Protected` init

init(): void
Returns void
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:71

insertGroup

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

moveItemToEmptySpace

moveItemToEmptySpace(oldPosition, newAlignment, centerPosition?): Promise<boolean>
Parameters
- oldPosition: ToolbarItemPosition
- newAlignment: ToolbarAlignment
- Optional centerPosition: "left" | "right"
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:176

openOrCreateJSONFile

openOrCreateJSONFile(state, doOpen?): Promise<undefined | Widget>
Parameters
- state: ToolbarTreeSchema
- doOpen: boolean = false
Returns Promise<undefined | Widget>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:326

`Protected` parse

parse(fileContent): undefined | DeflatedToolbarTree
Parameters
- fileContent: string
Returns undefined | DeflatedToolbarTree
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:317

`Protected` parseContent

parseContent(fileContent): undefined | DeflatedToolbarTree
Parameters
- fileContent: string
Returns undefined | DeflatedToolbarTree
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:309

`Protected` readConfiguration

readConfiguration(): void
Returns void
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:93

`Protected` removeEmptyGroupsFromToolbar

removeEmptyGroupsFromToolbar(toolbarItems): undefined | DeflatedToolbarTree
Parameters
- toolbarItems: undefined | DeflatedToolbarTree
Returns undefined | DeflatedToolbarTree
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:237

removeItem

removeItem(position): Promise<boolean>
Parameters
- position: ToolbarItemPosition
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:110

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-storage-provider.ts:140

`Protected` writeToFile

writeToFile(path, value, insertion?): Promise<boolean>
Parameters
- path: JSONPath
- value: unknown
- insertion: boolean = false
Returns Promise<boolean>
- Defined in packages/toolbar/src/browser/toolbar-storage-provider.ts:272

Class ToolbarStorageProvider

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ToolbarStorageProvider

Properties

Protected Readonly USER_TOOLBAR_URI

Protected Readonly _ready

Protected Readonly appState

Protected editorManager

Protected Readonly fileService

Protected lateInjector

Type declaration

Type Parameters

Parameters

Returns T

Protected Readonly messageService

Protected model

Protected monacoWorkspace

Readonly onToolbarItemsChanged

Protected Readonly textModelService

Protected toDispose

toolbarItems

Protected toolbarItemsUpdatedEmitter

Accessors

ready

Returns Promise<void>

Methods

addItem

Parameters

Returns Promise<boolean>

addItemToEmptyColumn

Parameters

Returns Promise<boolean>

clearAll

Returns Promise<boolean>

dispose

Returns void

Protected doInit

Returns Promise<void>

Protected init

Returns void

insertGroup

Parameters

Returns Promise<boolean>

moveItemToEmptySpace

Parameters

Returns Promise<boolean>

openOrCreateJSONFile

Parameters

Returns Promise<undefined | Widget>

Protected parse

Parameters

Returns undefined | DeflatedToolbarTree

Protected parseContent

Parameters

Returns undefined | DeflatedToolbarTree

Protected readConfiguration

Returns void

Protected removeEmptyGroupsFromToolbar

Parameters

Returns undefined | DeflatedToolbarTree

removeItem

Parameters

Returns Promise<boolean>

swapValues

Parameters

Returns Promise<boolean>

Protected writeToFile

Parameters

Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

`Protected` `Readonly` USER_TOOLBAR_URI

`Protected` `Readonly` _ready

`Protected` `Readonly` appState

`Protected` editorManager

`Protected` `Readonly` fileService

`Protected` lateInjector

`Protected` `Readonly` messageService

`Protected` model

`Protected` monacoWorkspace

`Readonly` onToolbarItemsChanged

`Protected` `Readonly` textModelService

`Protected` toDispose

`Protected` toolbarItemsUpdatedEmitter

`Protected` doInit

`Protected` init

`Protected` parse

`Protected` parseContent

`Protected` readConfiguration

`Protected` removeEmptyGroupsFromToolbar

`Protected` writeToFile