Interface UriCommandHandler<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.

interface UriCommandHandler<T> {
    onDidChangeEnabled?: Event<void>;
    execute(uri, ...args): any;
    isEnabled?(uri, ...args): boolean;
    isToggled?(...args): boolean;
    isVisible?(uri, ...args): boolean;
}

Type Parameters

T extends MaybeArray<URI>

Hierarchy (view full)

CommandHandler
- UriCommandHandler
  - SingleUriCommandHandler
  - MultiUriCommandHandler

Implemented by

UriAwareCommandHandler

Index

Properties

onDidChangeEnabled?

Methods

execute isEnabled? isToggled? isVisible?

Properties

`Optional` onDidChangeEnabled

onDidChangeEnabled?: Event<void>

Methods

execute

execute(uri, ...args): any
Execute this handler.

Don't call it directly, use CommandService.executeCommand instead.
Parameters
- uri: T
- Rest ...args: any[]
Returns any
Overrides CommandHandler.execute
- Defined in packages/core/src/common/uri-command-handler.ts:27

`Optional` isEnabled

isEnabled(uri, ...args): boolean
Test whether this handler is enabled (active).
Parameters
- uri: T
- Rest ...args: any[]
Returns boolean
Overrides CommandHandler.isEnabled
- Defined in packages/core/src/common/uri-command-handler.ts:29

`Optional` isToggled

isToggled(...args): boolean
Test whether menu items for this handler should be toggled.
Parameters
- Rest ...args: any[]
Returns boolean
Inherited from CommandHandler.isToggled
- Defined in packages/core/src/common/command.ts:139

`Optional` isVisible

isVisible(uri, ...args): boolean
Test whether menu items for this handler should be visible.
Parameters
- uri: T
- Rest ...args: any[]
Returns boolean
Overrides CommandHandler.isVisible
- Defined in packages/core/src/common/uri-command-handler.ts:31