Class WorkspaceRootUriAwareCommandHandler

A command handler is an implementation of a command.

A command can have multiple handlers but they should be active in different contexts, otherwise first active will be executed.

Hierarchy (View Summary)

UriAwareCommandHandler<URI>
- WorkspaceRootUriAwareCommandHandler

Index

Constructors

Properties

handler options? selectionService workspaceService

Methods

execute getArgsWithUri getUri isEnabled isMulti isVisible

Constructors

constructor

new WorkspaceRootUriAwareCommandHandler(
    workspaceService: WorkspaceService,
    selectionService: SelectionService,
    handler: UriCommandHandler<URI>,
): WorkspaceRootUriAwareCommandHandler
Parameters
- workspaceService: WorkspaceService
- selectionService: SelectionService
- handler: UriCommandHandler<URI>
Returns WorkspaceRootUriAwareCommandHandler
Overrides UriAwareCommandHandler.constructor
- Defined in packages/workspace/src/browser/workspace-commands.ts:526

Properties

`Protected` `Readonly`handler

handler: UriCommandHandler<URI>

`Protected` `Optional` `Readonly`options

options?: UriAwareCommandHandler.Options

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Methods

execute

execute(...args: any[]): undefined | object
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns undefined | object
Inherited from UriAwareCommandHandler.execute
- Defined in packages/core/lib/common/uri-command-handler.d.ts:30

`Protected`getArgsWithUri

getArgsWithUri(...args: any[]): [undefined | URI, ...any[]]
Parameters
- ...args: any[]
Returns [undefined | URI, ...any[]]
Inherited from UriAwareCommandHandler.getArgsWithUri
- Defined in packages/core/lib/common/uri-command-handler.d.ts:29

`Protected`getUri

getUri(...args: any[]): undefined | URI
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns undefined | URI
Overrides UriAwareCommandHandler.getUri
- Defined in packages/workspace/src/browser/workspace-commands.ts:545

isEnabled

isEnabled(...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns boolean
Overrides UriAwareCommandHandler.isEnabled
- Defined in packages/workspace/src/browser/workspace-commands.ts:535

`Protected`isMulti

isMulti(): undefined | boolean
Returns undefined | boolean
Inherited from UriAwareCommandHandler.isMulti
- Defined in packages/core/lib/common/uri-command-handler.d.ts:33

isVisible

isVisible(...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns boolean
Overrides UriAwareCommandHandler.isVisible
- Defined in packages/workspace/src/browser/workspace-commands.ts:540