Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkspaceFrontendContribution

Hierarchy

  • WorkspaceFrontendContribution

Implements

  • CommandContribution
  • KeybindingContribution
  • MenuContribution
  • FrontendApplicationContribution

Index

Constructors

Properties

Methods

Constructors

constructor

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 preferences

preferences: WorkspacePreferences

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

Protected closeWorkspace

  • closeWorkspace(): Promise<void>

configure

  • configure(): void

Protected createMultiRootWorkspace

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

Protected doOpen

  • doOpen(): Promise<undefined | URI>

Protected doOpenFile

  • doOpenFile(): 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.

    Caveat: this behaves differently on different platforms, the workspace.supportMultiRootWorkspace preference value does matter, and electron/browser version has impact too. See here for more details.

    Legend:

    • workspace.supportMultiRootWorkspace is false: => N
    • workspace.supportMultiRootWorkspace is true: => Y
    • Folders only: => F
    • Workspace files only: => W
    • Folders and workspace files: => FW

    |---------|-----------|-----------|------------|------------|

    browser Y browser N electron Y electron N
    Linux FW F W F
    Windows FW F W F
    OS X FW F FW FW
    --------- ----------- ----------- ------------ ------------

    Returns Promise<undefined | URI>

Protected doUpdateState

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

Private getCurrentWorkspaceUri

  • getCurrentWorkspaceUri(): undefined | URI

Protected getOpenableWorkspaceUri

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

Private isElectron

  • isElectron(): boolean

onWillStop

  • onWillStop(): undefined | OnWillStopAction<boolean>

Protected openWorkspaceOpenFileDialogProps

  • openWorkspaceOpenFileDialogProps(): Promise<OpenFileDialogProps>

registerCommands

  • registerCommands(commands: CommandRegistry): void

registerKeybindings

  • registerKeybindings(keybindings: KeybindingRegistry): void

registerMenus

  • registerMenus(menus: MenuModelRegistry): void

saveAs

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

Protected saveWorkspaceAs

  • saveWorkspaceAs(): Promise<boolean>

Protected updateEncodingOverrides

  • updateEncodingOverrides(): void

Protected updateStyles

  • updateStyles(): void

Protected updateWorkbenchStateKey

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

Protected updateWorkspaceStateKey

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