Class WorkspaceFrontendContribution

Hierarchy

WorkspaceFrontendContribution

Implements

CommandContribution
KeybindingContribution
MenuContribution
FrontendApplicationContribution

Constructors

constructor

new WorkspaceFrontendContribution(): WorkspaceFrontendContribution

Returns WorkspaceFrontendContribution

Properties

Protected Readonly contextKeyService

contextKeyService: ContextKeyService

Protected Readonly encodingRegistry

encodingRegistry: EncodingRegistry

Protected Readonly fileDialogService

fileDialogService: FileDialogService

Protected Readonly fileService

fileService: FileService

Protected Readonly messageService

messageService: MessageService

Protected Readonly openerService

openerService: OpenerService

Protected Readonly preferenceConfigurations

preferenceConfigurations: PreferenceConfigurations

Protected Readonly quickOpenWorkspace

quickOpenWorkspace: QuickOpenWorkspace

Protected Readonly saveService

saveService: FilesystemSaveResourceService

Protected Readonly toDisposeOnUpdateEncodingOverrides

toDisposeOnUpdateEncodingOverrides: DisposableCollection = ...

Protected Readonly workspaceService

workspaceService: WorkspaceService

Methods

canBeSavedAs

canBeSavedAs(widget: undefined | Widget): widget is Widget & SaveableSource & Navigatable

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:422
Parameters
- widget: undefined | Widget
Returns widget is Widget & SaveableSource & Navigatable

Protected closeWorkspace

closeWorkspace(): Promise<void>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:383
Returns Promise<void>

configure

configure(): void

Implementation of FrontendApplicationContribution.configure
- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:77
Returns void

Protected createMultiRootWorkspace

createMultiRootWorkspace(roots: FileStat[]): Promise<URI>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:349
Parameters
- roots: FileStat[]
Returns Promise<URI>

Protected doOpen

doOpen(): Promise<undefined | URI>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:253
This is the generic Open method. Opens files and directories too. Resolves to the opened URI. Except when you are on either Windows or Linux AND running in electron. If so, it opens a file.

Returns Promise<undefined | URI>

Protected doOpenFile

doOpenFile(): Promise<undefined | URI>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:283
Opens a file after prompting the Open File dialog. Resolves to undefined, if
- the workspace root is not set,
- the file to open does not exist, or
- it was not a file, but a directory.
Otherwise, resolves to the URI of the file.
Returns Promise<undefined | URI>

Protected doOpenFolder

doOpenFolder(): Promise<undefined | URI>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:310
Opens one or more folders after prompting the Open Folder dialog. Resolves to undefined, if
- the user's selection is empty or contains only files.
- the new workspace is equal to the old workspace.
Otherwise, resolves to the URI of the new workspace:
- a single folder if a single folder was selected.
- a new, untitled workspace file if multiple folders were selected.
Returns Promise<undefined | URI>

Protected doOpenWorkspace

doOpenWorkspace(): Promise<undefined | URI>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:364
Opens a workspace after raising the Open Workspace dialog. Resolves to the URI of the recently opened workspace, if it was successful. Otherwise, resolves to undefined.

Returns Promise<undefined | URI>

Protected doUpdateState

doUpdateState(): "empty" | "workspace" | "folder"

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:438
Returns "empty" | "workspace" | "folder"

Private getCurrentWorkspaceUri

getCurrentWorkspaceUri(): undefined | URI

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:454
Get the current workspace URI.

Returns undefined | URI
the current workspace URI.

Protected getOpenableWorkspaceUri

getOpenableWorkspaceUri(uris: MaybeArray<URI>): Promise<undefined | URI>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:331
Parameters
- uris: MaybeArray<URI>
Returns Promise<undefined | URI>

Private isElectron

isElectron(): boolean

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:445
Returns boolean

onWillStop

onWillStop(): undefined | OnWillStopAction<boolean>

Implementation of FrontendApplicationContribution.onWillStop
- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:458
Returns undefined | OnWillStopAction<boolean>

registerCommands

registerCommands(commands: CommandRegistry): void

Implementation of CommandContribution.registerCommands
- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:124
Parameters
- commands: CommandRegistry
Returns void

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void

Implementation of KeybindingContribution.registerKeybindings
- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:219
Parameters
- keybindings: KeybindingRegistry
Returns void

registerMenus

registerMenus(menus: MenuModelRegistry): void

Implementation of MenuContribution.registerMenus
- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:168
Parameters
- menus: MenuModelRegistry
Returns void

saveAs

saveAs(widget: Widget & SaveableSource & Navigatable): Promise<void>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:426
Parameters
- widget: Widget & SaveableSource & Navigatable
Returns Promise<void>

Protected saveWorkspaceAs

saveWorkspaceAs(): Promise<boolean>

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:390
Returns Promise<boolean>
whether the file was successfully saved.

Protected updateEncodingOverrides

updateEncodingOverrides(): void

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:105
Returns void

Protected updateStyles

updateStyles(): void

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:115
Returns void

Protected updateWorkbenchStateKey

updateWorkbenchStateKey(): "empty" | "workspace" | "folder"

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:434
Returns "empty" | "workspace" | "folder"

Protected updateWorkspaceStateKey

updateWorkspaceStateKey(): "empty" | "workspace" | "folder"

- Defined in packages/workspace/src/browser/workspace-frontend-contribution.ts:430
Returns "empty" | "workspace" | "folder"