Class SelectionCommandHandler<S>

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

S extends Object

Hierarchy (View Summary)

SelectionCommandHandler

Implements

CommandHandler

Index

Constructors

Properties

options selectionService toSelection

Methods

execute getMultiSelection getSelection getSingleSelection isEnabled isMulti isVisible

Constructors

constructor

new SelectionCommandHandler<S extends Object>(
    selectionService: SelectionService,
    toSelection: (arg: any) => undefined | S,
    options: SelectionCommandHandler.Options<S>,
): SelectionCommandHandler<S>
Type Parameters
- S extends Object
Parameters
- selectionService: SelectionService
- toSelection: (arg: any) => undefined | S
- options: SelectionCommandHandler.Options<S>
Returns SelectionCommandHandler<S>
- Defined in packages/core/src/common/selection-command-handler.ts:23

Properties

`Protected` `Readonly`options

options: SelectionCommandHandler.Options<S>

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`toSelection

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

Methods

execute

execute(...args: any[]): undefined | Object
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns undefined | Object
Implementation of CommandHandler.execute
- Defined in packages/core/src/common/selection-command-handler.ts:29

`Protected`getMultiSelection

getMultiSelection(arg: undefined | Object): undefined | S[]
Parameters
- arg: undefined | Object
Returns undefined | S[]
- Defined in packages/core/src/common/selection-command-handler.ts:76

`Protected`getSelection

getSelection(...args: any[]): undefined | S | S[]
Parameters
- ...args: any[]
Returns undefined | S | S[]
- Defined in packages/core/src/common/selection-command-handler.ts:48

`Protected`getSingleSelection

getSingleSelection(arg: undefined | Object): undefined | S
Parameters
- arg: undefined | Object
Returns undefined | S
- Defined in packages/core/src/common/selection-command-handler.ts:60

isEnabled

isEnabled(...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns boolean
Implementation of CommandHandler.isEnabled
- Defined in packages/core/src/common/selection-command-handler.ts:39

`Protected`isMulti

isMulti(): boolean
Returns boolean
- Defined in packages/core/src/common/selection-command-handler.ts:44

isVisible

isVisible(...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns boolean
Implementation of CommandHandler.isVisible
- Defined in packages/core/src/common/selection-command-handler.ts:34