Class UriAwareCommandHandler<T>

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.

Type Parameters

T extends MaybeArray<URI>

Implements

UriCommandHandler<T>

Index

Constructors

Properties

handler options? selectionService

Methods

execute getArgsWithUri getUri isEnabled isMulti isVisible

Constructors

constructor

new UriAwareCommandHandler<T>(selectionService, handler, options?): UriAwareCommandHandler<T>
Type Parameters
- T extends MaybeArray<URI>
Parameters
- selectionService: SelectionService
- handler: UriCommandHandler<T>
- Optional options: core.Options
Returns UriAwareCommandHandler<T>
Deprecated
since 1.6.0. Please use UriAwareCommandHandler.MonoSelect or UriAwareCommandHandler.MultiSelect.
- Defined in packages/core/src/common/uri-command-handler.ts:53

Properties

`Protected` `Readonly` handler

handler: UriCommandHandler<T>

`Protected` `Optional` `Readonly` options

options?: core.Options

`Protected` `Readonly` selectionService

selectionService: SelectionService

Methods

execute

execute(...args): undefined | object
Execute this handler.

Don't call it directly, use CommandService.executeCommand instead.
Parameters
- Rest ...args: any[]
Returns undefined | object
Implementation of UriCommandHandler.execute
- Defined in packages/core/src/common/uri-command-handler.ts:87

`Protected` getArgsWithUri

getArgsWithUri(...args): [undefined | T, ...any[]]
Parameters
- Rest ...args: any[]
Returns [undefined | T, ...any[]]
- Defined in packages/core/src/common/uri-command-handler.ts:78

`Protected` getUri

getUri(...args): undefined | T
Parameters
- Rest ...args: any[]
Returns undefined | T
- Defined in packages/core/src/common/uri-command-handler.ts:59

isEnabled

isEnabled(...args): boolean
Test whether this handler is enabled (active).
Parameters
- Rest ...args: any[]
Returns boolean
Implementation of UriCommandHandler.isEnabled
- Defined in packages/core/src/common/uri-command-handler.ts:103

`Protected` isMulti

isMulti(): undefined | boolean
Returns undefined | boolean
- Defined in packages/core/src/common/uri-command-handler.ts:114

isVisible

isVisible(...args): boolean
Test whether menu items for this handler should be visible.
Parameters
- Rest ...args: any[]
Returns boolean
Implementation of UriCommandHandler.isVisible
- Defined in packages/core/src/common/uri-command-handler.ts:92