Interface CommandHandler

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 CommandHandler {
    onDidChangeEnabled?: Event<void>;
    execute(...args): any;
    isEnabled?(...args): boolean;
    isToggled?(...args): boolean;
    isVisible?(...args): boolean;
}

Hierarchy (view full)

CommandHandler
- TabBarContextMenuCommandHandler
- UriCommandHandler

Implemented by

Index

Properties

onDidChangeEnabled?

Methods

execute isEnabled? isToggled? isVisible?

Properties

`Optional` onDidChangeEnabled

onDidChangeEnabled?: Event<void>

Methods

execute

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

Don't call it directly, use CommandService.executeCommand instead.
Parameters
- Rest ...args: any[]
Returns any
- Defined in packages/core/src/common/command.ts:123

`Optional` isEnabled

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

`Optional` isToggled

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

`Optional` isVisible

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