Class WorkspaceCommandContribution

The command contribution should be implemented to register custom commands and handler.

Implements

CommandContribution

Constructors

constructor

new WorkspaceCommandContribution(): WorkspaceCommandContribution
Returns WorkspaceCommandContribution

Properties

`Protected` `Readonly`app

app: FrontendApplication

`Protected` `Readonly`clipboardService

clipboardService: ClipboardService

`Protected` `Readonly`compareHandler

compareHandler: WorkspaceCompareHandler

`Protected` `Readonly`deleteHandler

deleteHandler: WorkspaceDeleteHandler

`Protected` `Readonly`duplicateHandler

duplicateHandler: WorkspaceDuplicateHandler

`Protected` `Readonly`fileDialogService

fileDialogService: FileDialogService

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`messageService

messageService: MessageService

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`preferences

preferences: WorkspacePreferences

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

onDidCreateNewFile

get onDidCreateNewFile(): Event<DidCreateNewResourceEvent>
Returns Event<DidCreateNewResourceEvent>
- Defined in packages/workspace/src/browser/workspace-commands.ts:211

onDidCreateNewFolder

get onDidCreateNewFolder(): Event<DidCreateNewResourceEvent>
Returns Event<DidCreateNewResourceEvent>
- Defined in packages/workspace/src/browser/workspace-commands.ts:215

Methods

`Protected`addFolderToWorkspace

addFolderToWorkspace(...uris: URI[]): Promise<void>
Parameters
- ...uris: URI[]
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-commands.ts:438

`Protected`areWorkspaceRoots

areWorkspaceRoots(uris: URI[]): boolean
Parameters
- uris: URI[]
Returns boolean
- Defined in packages/workspace/src/browser/workspace-commands.ts:453

`Protected`fireCreateNewFile

fireCreateNewFile(uri: DidCreateNewResourceEvent): void
Parameters
- uri: DidCreateNewResourceEvent
Returns void
- Defined in packages/workspace/src/browser/workspace-commands.ts:219

`Protected`fireCreateNewFolder

fireCreateNewFolder(uri: DidCreateNewResourceEvent): void
Parameters
- uri: DidCreateNewResourceEvent
Returns void
- Defined in packages/workspace/src/browser/workspace-commands.ts:223

`Protected`getDefaultFileConfig

getDefaultFileConfig(): { fileExtension: string; fileName: string }
Returns { fileExtension: string; fileName: string }
- Defined in packages/workspace/src/browser/workspace-commands.ts:462

`Protected`getDirectory

getDirectory(candidate: URI): Promise<undefined | FileStat>
Parameters
- candidate: URI
Returns Promise<undefined | FileStat>
- Defined in packages/workspace/src/browser/workspace-commands.ts:419

`Protected`getParent

getParent(candidate: URI): Promise<undefined | FileStat>
Parameters
- candidate: URI
Returns Promise<undefined | FileStat>
- Defined in packages/workspace/src/browser/workspace-commands.ts:430

`Protected`isWorkspaceRoot

isWorkspaceRoot(uri: URI): boolean
Parameters
- uri: URI
Returns boolean
- Defined in packages/workspace/src/browser/workspace-commands.ts:457

`Protected`newMultiUriAwareCommandHandler

newMultiUriAwareCommandHandler(
handler: UriCommandHandler<URI[]>,
): UriAwareCommandHandler<URI[]>
Parameters
- handler: UriCommandHandler<URI[]>
Returns UriAwareCommandHandler<URI[]>
- Defined in packages/workspace/src/browser/workspace-commands.ts:363

`Protected`newUriAwareCommandHandler

newUriAwareCommandHandler(
handler: UriCommandHandler<URI>,
): UriAwareCommandHandler<URI>
Parameters
- handler: UriCommandHandler<URI>
Returns UriAwareCommandHandler<URI>
- Defined in packages/workspace/src/browser/workspace-commands.ts:359

`Protected`newWorkspaceRootUriAwareCommandHandler

newWorkspaceRootUriAwareCommandHandler(
handler: UriCommandHandler<URI>,
): WorkspaceRootUriAwareCommandHandler
Parameters
- handler: UriCommandHandler<URI>
Returns WorkspaceRootUriAwareCommandHandler
- Defined in packages/workspace/src/browser/workspace-commands.ts:367

registerCommands

registerCommands(registry: CommandRegistry): void
Register commands and handlers.
Parameters
- registry: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in packages/workspace/src/browser/workspace-commands.ts:227

`Protected`removeFolderFromWorkspace

removeFolderFromWorkspace(uris: URI[]): Promise<void>
Removes the list of folders from the workspace upon confirmation from the user.
Parameters
- uris: URI[]
  the list of folder uris to remove.
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-commands.ts:473

saveWorkspaceWithPrompt

saveWorkspaceWithPrompt(registry: CommandRegistry): Promise<void>
Parameters
- registry: CommandRegistry
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-commands.ts:512

`Protected`trimFileName

trimFileName(name: string): string
Parameters
- name: string
Returns string
- Defined in packages/workspace/src/browser/workspace-commands.ts:412

`Protected`validateFileName

validateFileName(
    name: string,
    parent: FileStat,
    allowNested?: boolean,
): Promise<string>
Returns an error message if the file name is invalid. Otherwise, an empty string.
Parameters
- name: string
  the simple file name of the file to validate.
- parent: FileStat
  the parent directory's file stat.
- allowNested: boolean = false
  allow file or folder creation using recursive path
Returns Promise<string>
- Defined in packages/workspace/src/browser/workspace-commands.ts:385

`Protected`validateFileRename

validateFileRename(
    oldName: string,
    newName: string,
    parent: FileStat,
): Promise<string>
Parameters
- oldName: string
- newName: string
- parent: FileStat
Returns Promise<string>
- Defined in packages/workspace/src/browser/workspace-commands.ts:371