Class WorkspaceFrontendContribution

Protected Readonly contextKeyService

Protected Readonly encodingRegistry

Protected Readonly fileDialogService

Protected Readonly fileService

Protected Readonly messageService

Protected Readonly openerService

Protected Readonly preferenceConfigurations

Protected Readonly quickOpenWorkspace

Protected Readonly saveService

Protected Readonly toDisposeOnUpdateEncodingOverrides

Protected Readonly workspaceFileService

Protected Readonly workspaceService

Protected closeWorkspace

• closeWorkspace(): Promise<void>

• Returns Promise<void>

Protected createMultiRootWorkspace

• createMultiRootWorkspace(roots): Promise<URI>

• Parameters

  • roots: FileStat[]

  Returns Promise<URI>

Protected doOpen

• doOpen(): Promise<undefined | URI[]>

• 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[]>

• Opens a set of files 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 set of URIs of the files.

  Returns Promise<undefined | URI[]>

Protected doOpenFolder

• doOpenFolder(): Promise<undefined | URI>

• 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>

• 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(): "workspace" | "folder" | "empty"

• Returns "workspace" | "folder" | "empty"

Protected getOpenableWorkspaceUri

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

• Parameters

  • uris: MaybeArray<URI>

  Returns Promise<undefined | URI>

Protected getWorkspaceDialogFileFilters

• getWorkspaceDialogFileFilters(): FileDialogTreeFilters

• Returns FileDialogTreeFilters

Protected saveWorkspaceAs

• saveWorkspaceAs(): Promise<boolean>

• Returns Promise<boolean>

  whether the file was successfully saved.

Protected updateEncodingOverrides

• updateEncodingOverrides(): void

• Returns void

Protected updateStyles

• updateStyles(): void

• Returns void

Protected updateWorkbenchStateKey

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

• Returns "workspace" | "folder" | "empty"

Protected updateWorkspaceStateKey

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

• Returns "workspace" | "folder" | "empty"