Class 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.

Hierarchy (View Summary)

SelectionCommandHandler<FileSelection>
- CommandHandler

Index

Constructors

Properties

options selectionService toSelection

Methods

execute getMultiSelection getSelection getSingleSelection isEnabled isMulti isVisible

Constructors

constructor

new CommandHandler(
selectionService: SelectionService,
options: SelectionCommandHandler.Options<FileSelection>,
): FileSelection.CommandHandler
Parameters
- selectionService: SelectionService
- options: SelectionCommandHandler.Options<FileSelection>
Returns FileSelection.CommandHandler
Overrides SelectionCommandHandler.constructor
- Defined in packages/filesystem/src/browser/file-selection.ts:31

Properties

`Protected` `Readonly`options

options: SelectionCommandHandler.Options<FileSelection>

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`toSelection

toSelection: (arg: any) => undefined | FileSelection

Methods

execute

execute(...args: any[]): undefined | Object
Execute this handler.

Don't call it directly, use CommandService.executeCommand instead.
Parameters
- ...args: any[]
Returns undefined | Object
Inherited from SelectionCommandHandler.execute
- Defined in packages/core/lib/common/selection-command-handler.d.ts:8

`Protected`getMultiSelection

getMultiSelection(arg: undefined | Object): undefined | FileSelection[]
Parameters
- arg: undefined | Object
Returns undefined | FileSelection[]
Inherited from SelectionCommandHandler.getMultiSelection
- Defined in packages/core/lib/common/selection-command-handler.d.ts:14

`Protected`getSelection

getSelection(...args: any[]): undefined | FileSelection | FileSelection[]
Parameters
- ...args: any[]
Returns undefined | FileSelection | FileSelection[]
Inherited from SelectionCommandHandler.getSelection
- Defined in packages/core/lib/common/selection-command-handler.d.ts:12

`Protected`getSingleSelection

getSingleSelection(arg: undefined | Object): undefined | FileSelection
Parameters
- arg: undefined | Object
Returns undefined | FileSelection
Inherited from SelectionCommandHandler.getSingleSelection
- Defined in packages/core/lib/common/selection-command-handler.d.ts:13

isEnabled

isEnabled(...args: any[]): boolean
Test whether this handler is enabled (active).
Parameters
- ...args: any[]
Returns boolean
Inherited from SelectionCommandHandler.isEnabled
- Defined in packages/core/lib/common/selection-command-handler.d.ts:10

`Protected`isMulti

isMulti(): boolean
Returns boolean
Inherited from SelectionCommandHandler.isMulti
- Defined in packages/core/lib/common/selection-command-handler.d.ts:11

isVisible

isVisible(...args: any[]): boolean
Test whether menu items for this handler should be visible.
Parameters
- ...args: any[]
Returns boolean
Inherited from SelectionCommandHandler.isVisible
- Defined in packages/core/lib/common/selection-command-handler.d.ts:9