Class SelectionCommandHandler<S>

Type parameters

S

Hierarchy

SelectionCommandHandler

Implements

CommandHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SelectionCommandHandler<S>(selectionService: SelectionService, toSelection: (arg: any) => undefined | S, options: Options<S>): SelectionCommandHandler<S>

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

Properties

Protected Readonly options

options: Options<S>

Protected Readonly selectionService

selectionService: SelectionService

Protected Readonly toSelection

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

Type declaration

- (arg: any): undefined | S
- Parameters
  - arg: any
  Returns undefined | S

Methods

execute

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

Implementation of CommandHandler.execute
- Defined in packages/core/src/common/selection-command-handler.ts:29
Execute this handler.

Don't call it directly, use CommandService.executeCommand instead.

Parameters
- Rest ...args: any[]
Returns undefined | Object

Protected getMultiSelection

getMultiSelection(arg: undefined | Object): undefined | S[]

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

Protected getSelection

getSelection(...args: any[]): undefined | S | S[]

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

Protected getSingleSelection

getSingleSelection(arg: undefined | Object): undefined | S

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

isEnabled

isEnabled(...args: any[]): boolean

Implementation of CommandHandler.isEnabled
- Defined in packages/core/src/common/selection-command-handler.ts:39
Test whether this handler is enabled (active).

Parameters
- Rest ...args: any[]
Returns boolean

Protected isMulti

isMulti(): boolean

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

isVisible

isVisible(...args: any[]): boolean

Implementation of CommandHandler.isVisible
- Defined in packages/core/src/common/selection-command-handler.ts:34
Test whether menu items for this handler should be visible.

Parameters
- Rest ...args: any[]
Returns boolean