Class UpdateBinder<C, I, A, D>

The base binding builder for bindings where commands can be updated while the user interaction is running.

Type Parameters

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

Hierarchy

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

Implements

CmdUpdateBinder<C>
InteractionCmdUpdateBinder<C, I, A, D>

Constructors

constructor

new UpdateBinder<C, I, A, D>(undoHistory, logger, observer?, binder?, acc?): UpdateBinder<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<UpdateBinder<C, I, A, D>>
- Optional acc: A
Returns UpdateBinder<C, I, A, D>
Overrides Binder.constructor
- Defined in impl/binder/UpdateBinder.ts:55

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

`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 InteractionCmdUpdateBinder.bind
Overrides Binder.bind
- Defined in impl/binder/UpdateBinder.ts:193

cancel

cancel(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.cancel
- Defined in impl/binder/UpdateBinder.ts:102

catch

catch(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.catch
Overrides Binder.catch
- Defined in impl/binder/UpdateBinder.ts:164

configureRules

configureRules(ruleName, severity): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.configureRules
Overrides Binder.configureRules
- Defined in impl/binder/UpdateBinder.ts:172

continuousExecution

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

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

`Protected` copyFnArrays

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

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

`Protected` copyFnArraysUpdate

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

`Protected` duplicate

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

end

end(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current builder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.end
Overrides Binder.end
- Defined in impl/binder/UpdateBinder.ts:148

endOrCancel

endOrCancel(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.endOrCancel
- Defined in impl/binder/UpdateBinder.ts:108

first

first(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.first
Overrides Binder.first
- Defined in impl/binder/UpdateBinder.ts:128

ifCannotExecute

ifCannotExecute(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
The binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.ifCannotExecute
Overrides Binder.ifCannotExecute
- Defined in impl/binder/UpdateBinder.ts:144

ifHadEffects

ifHadEffects(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
The binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.ifHadEffects
Overrides Binder.ifHadEffects
- Defined in impl/binder/UpdateBinder.ts:136

ifHadNoEffect

ifHadNoEffect(fn): UpdateBinder<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 UpdateBinder<C, I, A, D>
The binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.ifHadNoEffect
Overrides Binder.ifHadNoEffect
- Defined in impl/binder/UpdateBinder.ts:140

log

log(...level): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.log
Overrides Binder.log
- Defined in impl/binder/UpdateBinder.ts:152

name

name(name): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.name
Overrides Binder.name
- Defined in impl/binder/UpdateBinder.ts:168

on

on<W>(widget, ...widgets): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.on
Overrides Binder.on
- Defined in impl/binder/UpdateBinder.ts:120

onDynamic

onDynamic(node): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.onDynamic
Overrides Binder.onDynamic
- Defined in impl/binder/UpdateBinder.ts:124

preventDefault

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

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

stopImmediatePropagation

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

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

then

then(fn): UpdateBinder<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)
  The callback method that updates the command. This callback takes as arguments the command to update.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.then
- Defined in impl/binder/UpdateBinder.ts:90

throttle

throttle(timeout): UpdateBinder<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 UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.throttle
- Defined in impl/binder/UpdateBinder.ts:114

toProduce

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

toProduceAnon

toProduceAnon(fn): UpdateBinder<Command, I, A, D>
Parameters
- fn: (() => void)
  - - (): void
    - Returns void
Returns UpdateBinder<Command, I, A, D>
Overrides Binder.toProduceAnon
- Defined in impl/binder/UpdateBinder.ts:185

usingInteraction

usingInteraction<I2, A2, D2>(fn): UpdateBinder<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 UpdateBinder<C, I2, A2, D2>
A clone of the current binder to chain the building configuration.
Implementation of CmdUpdateBinder.usingInteraction
Overrides Binder.usingInteraction
- Defined in impl/binder/UpdateBinder.ts:176

when

when(fn, mode?): UpdateBinder<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: ((i, acc) => boolean)
  The predicate that checks whether the command can be initialised, updated, or executed.
  - - (i, acc): boolean
    - Parameters
      i: D
      acc: Readonly<A>
      Returns boolean
- Optional mode: WhenType
  The execution mode of the 'when' predicate. If not defined, the non-strict mode will be used.
Returns UpdateBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Implementation of InteractionCmdUpdateBinder.when
Overrides Binder.when
- Defined in impl/binder/UpdateBinder.ts:132

Class UpdateBinder<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<UpdateBinder<C, I, A, D>>

Optional acc: A

Returns UpdateBinder<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<UpdateBinder<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

`Protected` linterRules

`Protected` logLevels

`Protected` logger

`Protected` observer

`Protected` `Optional` onErrFn

`Protected` onErrFnArray

`Protected` prevDefault

`Protected` `Optional` produceFn

`Protected` stopPropagation

`Protected` `Optional` thenFn