Class KeysBinder<C, I, A, D>

The base binding builder to create bindings between a keys pressure interaction and a given command.

Type Parameters

C extends Command
The type of the command to produce.
I extends Interaction<D>
A
D extends InteractionData = InteractionDataType<I>

Hierarchy

UpdateBinder<C, I, A, D>
- KeysBinder

Implements

KeyInteractionCmdUpdateBinder<C, I, A, D>

Constructors

constructor

new KeysBinder<C, I, A, D>(undoHistory, logger, observer?, binder?, acc?): KeysBinder<C, I, A, D>
Type Parameters
- C extends Command
- I extends Interaction<D>
- A
- D extends InteractionData = InteractionDataType<I>
Parameters
- undoHistory: UndoHistoryBase
- logger: Logger
- Optional observer: BindingsObserver
- Optional binder: Partial<KeysBinder<C, I, A, D>>
- Optional acc: A
Returns KeysBinder<C, I, A, D>
Overrides UpdateBinder.constructor
- Defined in impl/binder/KeysBinder.ts:46

Properties

`Protected` accInit

accInit: undefined | A

`Protected` bindingName

bindingName: undefined | string

`Protected` `Optional` cancelFn

cancelFn?: ((i, acc) => void)

Type declaration

- (i, acc): void
- Parameters
  - i: D
  - acc: A
  Returns void

`Protected` cancelFnArray

cancelFnArray: ((i, acc) => void)[] = []

Type declaration

- (i, acc): void
- Parameters
  - i: D
  - acc: A
  Returns void

`Protected` `Optional` cannotExecFn

cannotExecFn?: ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` cannotExecFnArray

cannotExecFnArray: ((c, i, acc) => void)[] = []

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` continuousCmdExecution

continuousCmdExecution: boolean

`Protected` dynamicNodes

dynamicNodes: readonly Node[]

`Protected` `Optional` endFn

endFn?: ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` endFnArray

endFnArray: ((c, i, acc) => void)[] = []

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` `Optional` endOrCancelFn

endOrCancelFn?: ((i, acc) => void)

Type declaration

- (i, acc): void
- Parameters
  - i: D
  - acc: A
  Returns void

`Protected` endOrCancelFnArray

endOrCancelFnArray: ((i, acc) => void)[] = []

Type declaration

- (i, acc): void
- Parameters
  - i: D
  - acc: A
  Returns void

`Protected` `Optional` firstFn

firstFn?: ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` firstFnArray

firstFnArray: ((c, i, acc) => void)[] = []

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` `Optional` hadEffectsFn

hadEffectsFn?: ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` hadEffectsFnArray

hadEffectsFnArray: ((c, i, acc) => void)[] = []

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` `Optional` hadNoEffectFn

hadNoEffectFn?: ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` hadNoEffectFnArray

hadNoEffectFnArray: ((c, i, acc) => void)[] = []

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Private` isCode

isCode: boolean

`Private` keysOrCodes

keysOrCodes: readonly string[]

`Protected` linterRules

linterRules: Map<RuleName, Severity>

`Protected` logLevels

logLevels: readonly LogLevel[]

`Protected` logger

logger: Logger

`Protected` observer

observer: undefined | BindingsObserver

`Protected` `Optional` onErrFn

onErrFn?: ((ex) => void)

Type declaration

- (ex): void
- Parameters
  - ex: unknown
  Returns void

`Protected` onErrFnArray

onErrFnArray: ((ex) => void)[] = []

Type declaration

- (ex): void
- Parameters
  - ex: unknown
  Returns void

`Protected` prevDefault

prevDefault: boolean

`Protected` `Optional` produceFn

produceFn?: ((i) => C)

Type declaration

- (i): C
- Parameters
  - i: undefined | D
  Returns C

`Protected` stopPropagation

stopPropagation: boolean

`Protected` `Optional` thenFn

thenFn?: ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` thenFnArray

thenFnArray: ((c, i, acc) => void)[] = []

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` throttleTimeout

throttleTimeout: number

`Protected` undoHistory

undoHistory: UndoHistoryBase

`Protected` `Optional` usingFn

usingFn?: (() => I)

Type declaration

- (): I
- Returns I

`Protected` whenFnArray

whenFnArray: When<D, A>[] = []

`Protected` widgets

widgets: readonly unknown[]

Methods

bind

bind(): Binding<C, I, A, D>
Executes the binder to create and install an Interacto binding.

Returns Binding<C, I, A, D>
Implementation of KeyInteractionCmdUpdateBinder.bind
Overrides UpdateBinder.bind
- Defined in impl/binder/KeysBinder.ts:196

cancel

cancel(fn): KeysBinder<C, I, A, D>
Defines what to do when a command is cancelled (because the interaction is cancelled). The undoable command is automatically cancelled so that nothing must be done on the command. A binder can have several cummulative 'cancel' routines.
Parameters
- fn: ((i, acc) => void)
  - - (i, acc): void
    - Parameters
      i: D
      acc: A
      Returns void
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.cancel
Overrides UpdateBinder.cancel
- Defined in impl/binder/KeysBinder.ts:159

catch

catch(fn): KeysBinder<C, I, A, D>
Allows the processing of errors during the execution of the binding. Errors reported here are errors thrown in arrow functions provided to the the different routines of the binder and errors triggered by the command. A binder can have several cummulative 'catch' routines.
Parameters
- fn: ((ex) => void)
  The function to process the error caught by the binding during its execution
  - - (ex): void
    - Parameters
      ex: unknown
      Returns void
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.catch
Overrides UpdateBinder.catch
- Defined in impl/binder/KeysBinder.ts:167

`Private` completeWhenWithKeysPredicates

completeWhenWithKeysPredicates(): void
Returns void
- Defined in impl/binder/KeysBinder.ts:63

configureRules

configureRules(ruleName, severity): KeysBinder<C, I, A, D>
Configures a linter rule specifically for the binding.
Parameters
- ruleName: RuleName
  The name of the rule.
- severity: Severity
  The severity level of the rule.
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.configureRules
Overrides UpdateBinder.configureRules
- Defined in impl/binder/KeysBinder.ts:175

continuousExecution

continuousExecution(): KeysBinder<C, I, A, D>
Specifies whether the command must be executed on each evolution of the interaction (if 'when' predicate is ok).

Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.continuousExecution
Overrides UpdateBinder.continuousExecution
- Defined in impl/binder/KeysBinder.ts:151

`Protected` copyFnArrays

copyFnArrays(): void
Clones the arrays containing the routine functions after a binder is copied.

Returns void
Inherited from UpdateBinder.copyFnArrays
- Defined in impl/binder/Binder.ts:117

`Protected` copyFnArraysUpdate

copyFnArraysUpdate(): void
Returns void
Inherited from UpdateBinder.copyFnArraysUpdate
- Defined in impl/binder/UpdateBinder.ts:67

`Protected` duplicate

duplicate(): KeysBinder<C, I, A, D>
Returns KeysBinder<C, I, A, D>
Overrides UpdateBinder.duplicate
- Defined in impl/binder/KeysBinder.ts:192

end

end(fn): KeysBinder<C, I, A, D>
Defines actions to perform when a binding ends. A binder can have several cummulative 'end' routines.
Parameters
- fn: ((c, i, acc) => void)
  The command to execute on each binding end.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeysBinder<C, I, A, D>
A clone of the current builder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.end
Overrides UpdateBinder.end
- Defined in impl/binder/KeysBinder.ts:130

endOrCancel

endOrCancel(fn): KeysBinder<C, I, A, D>
Defines what to do when a command is cancelled (because the interaction is cancelled). The undoable command is automatically cancelled so that nothing must be done on the command. A binder can have several cummulative 'endOrCancel' routines.
Parameters
- fn: ((i, acc) => void)
  - - (i, acc): void
    - Parameters
      i: D
      acc: A
      Returns void
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.endOrCancel
Overrides UpdateBinder.endOrCancel
- Defined in impl/binder/KeysBinder.ts:163

first

first(fn): KeysBinder<C, I, A, D>
Specifies the initialisation of the command when the interaction starts. Each time the interaction starts, an instance of the command is created and configured by the given callback. A binder can have several cummulative 'first' routines.
Parameters
- fn: ((c, i, acc) => void)
  The callback method that initialises the command. This callback takes as arguments the command to configure.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.first
Overrides UpdateBinder.first
- Defined in impl/binder/KeysBinder.ts:110

ifCannotExecute

ifCannotExecute(fn): KeysBinder<C, I, A, D>
Specifies what to do end when an interaction ends and the command could not be executed. A binder can have several cummulative 'ifCannotExecute' routines.
Parameters
- fn: ((c, i, acc) => void)
  The callback method to specify what to do when an interaction ends and the command could not be executed.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeysBinder<C, I, A, D>
The binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.ifCannotExecute
Overrides UpdateBinder.ifCannotExecute
- Defined in impl/binder/KeysBinder.ts:126

ifHadEffects

ifHadEffects(fn): KeysBinder<C, I, A, D>
Specifies what to do end when an interaction ends (after the end/endOrCancel routines) and the command has produced an effect. A binder can have several cummulative 'ifHadEffects' routines.
Parameters
- fn: ((c, i, acc) => void)
  The callback method to specify what to do when an interaction ends and the command produced an effect.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeysBinder<C, I, A, D>
The binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.ifHadEffects
Overrides UpdateBinder.ifHadEffects
- Defined in impl/binder/KeysBinder.ts:118

ifHadNoEffect

ifHadNoEffect(fn): KeysBinder<C, I, A, D>
Specifies what to do end when an interaction ends (after the end/endOrCancel routines) and the command did not produce an effect. A binder can have several cummulative 'ifHadNoEffect' routines.
Parameters
- fn: ((c, i, acc) => void)
  The callback method to specify what to do when an interaction ends and the command did not produce an effect.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeysBinder<C, I, A, D>
The binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.ifHadNoEffect
Overrides UpdateBinder.ifHadNoEffect
- Defined in impl/binder/KeysBinder.ts:122

log

log(...level): KeysBinder<C, I, A, D>
Specifies the logging level to use. A binder can have several cummulative 'log' routines, eg: log(LogLevel.INTERACTION).log(LogLevel.COMMAND)
Parameters
- Rest ...level: readonly LogLevel[]
  The logging level to use.
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.log
Overrides UpdateBinder.log
- Defined in impl/binder/KeysBinder.ts:134

name

name(name): KeysBinder<C, I, A, D>
Specifies the name of the Interacto binding. This name will be used in the logging system. It should be unique, but no mechanism will check that.
Parameters
- name: string
  The name of the binding
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.name
Overrides UpdateBinder.name
- Defined in impl/binder/KeysBinder.ts:171

on

on<W>(widget, ...widgets): KeysBinder<C, I, A, D>
Specifies the widgets on which the binding will operate. When a widget is added to this list, this widget is binded to this binding. When widget is removed from this list, this widget is unbinded from this binding.
Type Parameters
- W
Parameters
- widget: Widget<W> | readonly Widget<W>[]
  The mandatory first widget
- Rest ...widgets: readonly Widget<W>[]
  The list of the widgets involved in the bindings.
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.on
Overrides UpdateBinder.on
- Defined in impl/binder/KeysBinder.ts:102

onDynamic

onDynamic(node): KeysBinder<C, I, A, D>
Specifies the node the binding will observe its children. The binding observes its children list, so that additions and removals from it are managed by the binding.
Parameters
- node: Widget<Node>
  The binding will observe the children of this node.
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.onDynamic
Overrides UpdateBinder.onDynamic
- Defined in impl/binder/KeysBinder.ts:106

preventDefault

preventDefault(): KeysBinder<C, I, A, D>
The default behavior associated to the event will be ignored.

Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.preventDefault
Overrides UpdateBinder.preventDefault
- Defined in impl/binder/KeysBinder.ts:142

stopImmediatePropagation

stopImmediatePropagation(): KeysBinder<C, I, A, D>
If called, all the events the interaction will process will be consumed and not propagated to next listeners.

Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.stopImmediatePropagation
Overrides UpdateBinder.stopImmediatePropagation
- Defined in impl/binder/KeysBinder.ts:138

then

then(fn): KeysBinder<C, I, A, D>
Permits to update the command on each interaction update. A binder can have several cummulative 'then' routines. This routine is called only if 'when' returns true (ie only if the condition for producing the command is respected). See 'ifCannotExecute' for a 'then' when this condition is not respected.
Parameters
- fn: ((c, i, acc) => void) | ((c) => void)
  The callback method that updates the command. This callback takes as arguments the command to update.
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.then
Overrides UpdateBinder.then
- Defined in impl/binder/KeysBinder.ts:147

throttle

throttle(timeout): KeysBinder<C, I, A, D>
Backpressure operation. Instead of emitting all the events, successive events of the same type are factorized modulo a timeout. The timeout is used to send at max one event of the same type in a given duration (the timeout). For example with three mouse moves and a time out of 10ms. The first move is received and processed. The timer starts. A second mouse moves is received at T+5ms. It is for the moment not processed. A third mouse move is received at T+8ms. The second move is finally ignored and this third one not processed yet. At T+10s the third event is finally processed. Based on our own experiments, the given timeout value should be greater than 10ms to throttle some UI events.
Parameters
- timeout: number
  The timeout used by the throttle operation. In ms.
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.throttle
Overrides UpdateBinder.throttle
- Defined in impl/binder/KeysBinder.ts:155

toProduce

toProduce<C2>(fn): KeysBinder<C2, I, A, D>
Type Parameters
- C2 extends Command
Parameters
- fn: ((i) => C2)
  - - (i): C2
    - Parameters
      i: D
      Returns C2
Returns KeysBinder<C2, I, A, D>
Implementation of KeyInteractionCmdUpdateBinder.toProduce
Overrides UpdateBinder.toProduce
- Defined in impl/binder/KeysBinder.ts:179

toProduceAnon

toProduceAnon(fn): KeysBinder<Command, I, A, D>
Parameters
- fn: (() => void)
  - - (): void
    - Returns void
Returns KeysBinder<Command, I, A, D>
Implementation of KeyInteractionCmdUpdateBinder.toProduceAnon
Overrides UpdateBinder.toProduceAnon
- Defined in impl/binder/KeysBinder.ts:183

usingInteraction

usingInteraction<I2, A2, D2>(fn): KeysBinder<C, I2, A2, D2>
Defines how to create the user interaction that the binding will use to create UI commands.
Type Parameters
- I2 extends Interaction<D2>
  The user interaction type
- A2
- D2 extends InteractionData = InteractionDataType<I2>
  The user interaction data type
Parameters
- fn: (() => I2)
  The supplier that will return a new user interaction.
  - - (): I2
    - Returns I2
Returns KeysBinder<C, I2, A2, D2>
A clone of the current binder to chain the building configuration.
Overrides UpdateBinder.usingInteraction
- Defined in impl/binder/KeysBinder.ts:187

when

when(fn, mode?): KeysBinder<C, I, A, D>
Specifies the conditions to fulfill to initialise, update, or execute the command while the interaction is running. A binder can have several cummulative 'when' routines.
Parameters
- fn: (() => boolean) | ((i, acc) => boolean)
  The predicate that checks whether the command can be initialised, updated, or executed. This predicate takes as arguments the data of the ongoing user interaction involved in the binding.
- Optional mode: WhenType
Returns KeysBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.when
Overrides UpdateBinder.when
- Defined in impl/binder/KeysBinder.ts:114

with

with(isCode, ...keysOrCodes): KeysBinder<C, I, A, D>
Defines the key values the binding will check. On a key interaction, the pressed keys will be checked against the given key values. The set of pressed keys must match the given key values.
Parameters
- isCode: boolean
  If true, key codes will be used instead of key values. Keep in mind that key codes ignore the user's keyboard layout. See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code.
- Rest ...keysOrCodes: readonly string[]
  The key values to match, or key codes if isCode is set to true.
Returns KeysBinder<C, I, A, D>
A clone of the current builder to chain the building configuration.
Implementation of KeyInteractionCmdUpdateBinder.with
- Defined in impl/binder/KeysBinder.ts:95

Class KeysBinder<C, I, A, D>

Type Parameters

C extends Command

I extends Interaction<D>

A

D extends InteractionData = InteractionDataType<I>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

C extends Command

I extends Interaction<D>

A

D extends InteractionData = InteractionDataType<I>

Parameters

undoHistory: UndoHistoryBase

logger: Logger

Optional observer: BindingsObserver

Optional binder: Partial<KeysBinder<C, I, A, D>>

Optional acc: A

Returns KeysBinder<C, I, A, D>

Properties

Protected accInit

Protected bindingName

Protected Optional cancelFn

Type declaration

Parameters

i: D

acc: A

Returns void

Protected cancelFnArray

Type declaration

Parameters

i: D

acc: A

Returns void

Protected Optional cannotExecFn

Type declaration

Parameters

c: C

i: D

acc: A

Returns void

Protected cannotExecFnArray

Type declaration

Parameters

c: C

i: D

acc: A

Returns void

Protected continuousCmdExecution

Protected dynamicNodes

Protected Optional endFn

Type declaration

Parameters

c: C

i: D

acc: A

Returns void

Protected endFnArray

Type declaration

Parameters

c: C

i: D

acc: A

Returns void

Protected Optional endOrCancelFn

Type declaration

Parameters

i: D

acc: A

Returns void

Protected endOrCancelFnArray

Type declaration

Parameters

`Optional` observer: BindingsObserver

`Optional` binder: Partial<KeysBinder<C, I, A, D>>

`Optional` acc: A

`Protected` accInit

`Protected` bindingName

`Protected` `Optional` cancelFn

`Protected` cancelFnArray

`Protected` `Optional` cannotExecFn

`Protected` cannotExecFnArray

`Protected` continuousCmdExecution

`Protected` dynamicNodes

`Protected` `Optional` endFn

`Protected` endFnArray

`Protected` `Optional` endOrCancelFn

`Protected` endOrCancelFnArray

`Protected` `Optional` firstFn

`Protected` firstFnArray

`Protected` `Optional` hadEffectsFn

`Protected` hadEffectsFnArray

`Protected` `Optional` hadNoEffectFn

`Protected` hadNoEffectFnArray

`Private` isCode

`Private` keysOrCodes

`Protected` linterRules

`Protected` logLevels

`Protected` logger

`Protected` observer

`Protected` `Optional` onErrFn

`Protected` onErrFnArray

`Protected` prevDefault

`Protected` `Optional` produceFn

`Protected` stopPropagation

`Protected` `Optional` thenFn