Class InteractionBase<D, DImpl, F>`Abstract`

The base implementation of a user interaction.

Type Parameters

D extends InteractionData
The type of the interaction data.
DImpl extends D & Flushable
F extends FSM
The type of the FSM.

Implements

Interaction<D>

Index

Constructors

constructor

Accessors

data dynamicRegisteredNodes fsm name preventDefault registeredNodes stopImmediatePropagation

Constructors

`Protected` constructor

new InteractionBase<D, DImpl, F>(fsm, data, logger, name): InteractionBase<D, DImpl, F>
Creates the interaction.
Type Parameters
- D extends InteractionData
- DImpl extends InteractionData & Flushable
- F extends FSM
Parameters
- fsm: F
  The FSM that defines the behavior of the user interaction.
- data: DImpl
  The interaction data.
- logger: Logger
  The logger to use for this interaction
- name: string
  The real name of the interaction
Returns InteractionBase<D, DImpl, F>
- Defined in impl/interaction/InteractionBase.ts:101

Properties

`Protected` `Readonly` _data

_data: DImpl

The interaction data

`Protected` `Readonly` _dynamicRegisteredNodes

_dynamicRegisteredNodes: Set<unknown>

`Protected` `Readonly` _fsm

_fsm: F

`Protected` _log

_log: boolean

`Protected` `Readonly` _name

_name: string

`Protected` `Readonly` _registeredNodes

_registeredNodes: Set<unknown>

The current nodes that the interaction works on

`Private` `Optional` actionHandler

actionHandler?: EventListener

`Protected` activated

activated: boolean

Defines if the interaction is activated or not. If not, the interaction will not change on events.

`Protected` currentThrottling

currentThrottling: undefined | CancellablePromise

`Private` `Readonly` disposable

disposable: Subscription

`Private` `Optional` keyHandler

keyHandler?: ((e) => void)

Type declaration

- (e): void
- Parameters
  - e: KeyboardEvent
  Returns void

`Protected` latestThrottledEvent

latestThrottledEvent: undefined | Event

`Protected` `Readonly` logger

logger: Logger

`Private` `Optional` mouseHandler

mouseHandler?: ((e) => void)

Type declaration

- (e): void
- Parameters
  - e: MouseEvent
  Returns void

`Protected` `Readonly` mutationObservers

mutationObservers: MutationObserver[]

The current list of mutation observers. Used for listening changes in node lists.

`Private` preventDef

preventDef: boolean

`Private` stopImmediatePropag

stopImmediatePropag: boolean

`Protected` throttleTimeout

throttleTimeout: number

`Private` `Optional` touchHandler

touchHandler?: ((e) => void)

Type declaration

- (e): void
- Parameters
  - e: TouchEvent
  Returns void

`Private` `Optional` uiHandler

uiHandler?: ((e) => void)

Type declaration

- (e): void
- Parameters
  - e: UIEvent
  Returns void

Accessors

data

get data(): D
The interaction data of the user interaction. Cannot be null.

Returns D
Implementation of Interaction.data
- Defined in impl/interaction/InteractionBase.ts:124

dynamicRegisteredNodes

get dynamicRegisteredNodes(): ReadonlySet<unknown>
The nodes for which the user interaction will register their child nodes dynamically.

Returns ReadonlySet<unknown>
Implementation of Interaction.dynamicRegisteredNodes
- Defined in impl/interaction/InteractionBase.ts:491

fsm

get fsm(): F
The FSM of the user interaction.

Returns F
Implementation of Interaction.fsm
- Defined in impl/interaction/InteractionBase.ts:461

name

get name(): string
The real name of the interaction.

Returns string
Implementation of Interaction.name
- Defined in impl/interaction/InteractionBase.ts:128

preventDefault

get preventDefault(): boolean
Returns boolean
True if the default behavior associated to the event will be executed.
Implementation of Interaction.preventDefault
- Defined in impl/interaction/InteractionBase.ts:410
set preventDefault(prevent): void
Sets whether the default behavior associated to the event will be executed.
Parameters
- prevent: boolean
Returns void
Param: prevent
True: the default behavior associated to the event will be ignored.
Implementation of Interaction.preventDefault
- Defined in impl/interaction/InteractionBase.ts:403

registeredNodes

get registeredNodes(): ReadonlySet<unknown>
The registered nodes.

Returns ReadonlySet<unknown>
Implementation of Interaction.registeredNodes
- Defined in impl/interaction/InteractionBase.ts:487

stopImmediatePropagation

get stopImmediatePropagation(): boolean
Returns boolean
True if the user interaction will stop immediately the propagation of events processed by this user interaction to others listeners.
Implementation of Interaction.stopImmediatePropagation
- Defined in impl/interaction/InteractionBase.ts:399
set stopImmediatePropagation(stop): void
Sets whether the user interaction will stop immediately the propagation of events processed by this user interaction to others listeners.
Parameters
- stop: boolean
Returns void
Param: stop
True: the propagation of the events will stop immediately.
Implementation of Interaction.stopImmediatePropagation
- Defined in impl/interaction/InteractionBase.ts:391

Methods

acceptVisitor

acceptVisitor(visitor): void
Visiting the interaction and its FSM.
Parameters
- visitor: VisitorInteraction
  The visitor.
Returns void
Implementation of Interaction.acceptVisitor
- Defined in impl/interaction/InteractionBase.ts:483

`Private` callBackMutationObserver

callBackMutationObserver(mutationList): void
Parameters
- mutationList: readonly MutationRecord[]
Returns void
- Defined in impl/interaction/InteractionBase.ts:213

`Private` checkThrottlingEvent

checkThrottlingEvent(event): void
Parameters
- event: Event
Returns void
- Defined in impl/interaction/InteractionBase.ts:174

`Private` createThrottleTimeout

createThrottleTimeout(): void
Returns void
- Defined in impl/interaction/InteractionBase.ts:136

`Private` directEventProcess

directEventProcess(event): void
Parameters
- event: Event
Returns void
- Defined in impl/interaction/InteractionBase.ts:428

fullReinit

fullReinit(): void
Fully reinitialises the user interaction, its data and its FSM (flushes FSM revents)

Returns void
Implementation of Interaction.fullReinit
- Defined in impl/interaction/InteractionBase.ts:387

`Protected` getActionHandler

getActionHandler(): EventListener
Returns EventListener
- Defined in impl/interaction/InteractionBase.ts:338

`Protected` getCurrentAcceptedEvents

getCurrentAcceptedEvents(state): readonly ("input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel")[]
Parameters
- state: OutputState
Returns readonly ("input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel")[]
- Defined in impl/interaction/InteractionBase.ts:209

`Protected` getEventTypesOf

getEventTypesOf(state): ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">
Parameters
- state: OutputState
Returns ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">
- Defined in impl/interaction/InteractionBase.ts:224

`Protected` getKeyHandler

getKeyHandler(): EventListener
Returns EventListener
- Defined in impl/interaction/InteractionBase.ts:365

`Protected` getMouseHandler

getMouseHandler(): EventListener
Returns EventListener
- Defined in impl/interaction/InteractionBase.ts:347

`Protected` getTouchHandler

getTouchHandler(): EventListener
Returns EventListener
- Defined in impl/interaction/InteractionBase.ts:356

`Protected` getUIHandler

getUIHandler(): EventListener
Returns EventListener
- Defined in impl/interaction/InteractionBase.ts:374

isActivated

isActivated(): boolean
Returns boolean
True if the user interaction is activated.
Implementation of Interaction.isActivated
- Defined in impl/interaction/InteractionBase.ts:447

isRunning

isRunning(): boolean
Returns boolean
Whether the user interaction is running.
Implementation of Interaction.isRunning
- Defined in impl/interaction/InteractionBase.ts:383

log

log(log): void
Sets the logging of the user interaction.
Parameters
- log: boolean
  True: the user interaction will log information.
Returns void
Implementation of Interaction.log
- Defined in impl/interaction/InteractionBase.ts:442

onNewNodeRegistered

onNewNodeRegistered(node): void
Parameters
- node: unknown
Returns void
- Defined in impl/interaction/InteractionBase.ts:255

onNodeUnregistered

onNodeUnregistered(node): void
Parameters
- node: unknown
Returns void
- Defined in impl/interaction/InteractionBase.ts:249

processEvent

processEvent(event): void
Processes the given UI event.
Parameters
- event: Event
  The event to process.
Returns void
- Defined in impl/interaction/InteractionBase.ts:418

`Protected` registerActionHandlerClick

registerActionHandlerClick(node): void
Parameters
- node: EventTarget
Returns void
- Defined in impl/interaction/InteractionBase.ts:320

`Protected` registerActionHandlerInput

registerActionHandlerInput(node): void
Parameters
- node: EventTarget
Returns void
- Defined in impl/interaction/InteractionBase.ts:330

`Protected` registerEventToNode

registerEventToNode(eventType, node): void
Parameters
- eventType: "input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel"
- node: unknown
Returns void
- Defined in impl/interaction/InteractionBase.ts:275

registerToNodeChildren

registerToNodeChildren(elementToObserve): void
Permits to listen any change in the content (ie children) of the given node. For all child nodes of the given node, this interaction subscribes to it. This is dynamic: on new child nodes, the interaction registers to them. On child removals, the interaction unregisters to them.
Parameters
- elementToObserve: Node
  The node which children will be observed by the interaction.
Returns void
Implementation of Interaction.registerToNodeChildren
- Defined in impl/interaction/InteractionBase.ts:261

registerToNodes

registerToNodes(widgets): void
Parameters
- widgets: readonly unknown[]
Returns void
Implementation of Interaction.registerToNodes
- Defined in impl/interaction/InteractionBase.ts:235

reinit

reinit(): void
Reinitialises the user interaction, its data and its FSM

Returns void
Implementation of Interaction.reinit
- Defined in impl/interaction/InteractionBase.ts:465

reinitData

reinitData(): void
Reinitialises the interaction data

Returns void
Implementation of Interaction.reinitData
- Defined in impl/interaction/InteractionBase.ts:120

setActivated

setActivated(activated): void
Sets whether the user interaction is activated. When not activated, a user interaction does not process input events any more.
Parameters
- activated: boolean
  True: the user interaction will be activated.
Returns void
Implementation of Interaction.setActivated
- Defined in impl/interaction/InteractionBase.ts:451

setThrottleTimeout

setThrottleTimeout(timeout): void
Sets the timeout (in ms) to be used by the throttling.
Parameters
- timeout: number
  The throttling timeout in ms.
Returns void
Implementation of Interaction.setThrottleTimeout
- Defined in impl/interaction/InteractionBase.ts:132

uninstall

uninstall(): void
Uninstall the user interaction. Used to free memory. Then, user interaction can be used any more.

Returns void
Implementation of Interaction.uninstall
- Defined in impl/interaction/InteractionBase.ts:470

`Protected` unregisterActionHandlerClick

unregisterActionHandlerClick(node): void
Parameters
- node: EventTarget
Returns void
- Defined in impl/interaction/InteractionBase.ts:325

`Protected` unregisterActionHandlerInput

unregisterActionHandlerInput(node): void
Parameters
- node: EventTarget
Returns void
- Defined in impl/interaction/InteractionBase.ts:334

`Protected` unregisterEventToNode

unregisterEventToNode(eventType, node): void
Parameters
- eventType: "input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel"
- node: unknown
Returns void
- Defined in impl/interaction/InteractionBase.ts:298

`Protected` unregisterFromNodes

unregisterFromNodes(widgets): void
Parameters
- widgets: readonly unknown[]
Returns void
- Defined in impl/interaction/InteractionBase.ts:242

`Protected` updateEventsRegistered

updateEventsRegistered(newState, oldState): void
Parameters
- newState: OutputState
- oldState: OutputState
Returns void
- Defined in impl/interaction/InteractionBase.ts:189

Class InteractionBase<D, DImpl, F>Abstract

Type Parameters

D extends InteractionData

DImpl extends D & Flushable

F extends FSM

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

D extends InteractionData

DImpl extends InteractionData & Flushable

F extends FSM

Parameters

fsm: F

data: DImpl

logger: Logger

name: string

Returns InteractionBase<D, DImpl, F>

Properties

Protected Readonly _data

Protected Readonly _dynamicRegisteredNodes

Protected Readonly _fsm

Protected _log

Protected Readonly _name

Protected Readonly _registeredNodes

Private Optional actionHandler

Protected activated

Protected currentThrottling

Private Readonly disposable

Private Optional keyHandler

Type declaration

Parameters

e: KeyboardEvent

Returns void

Protected latestThrottledEvent

Protected Readonly logger

Private Optional mouseHandler

Type declaration

Parameters

e: MouseEvent

Returns void

Protected Readonly mutationObservers

Private preventDef

Private stopImmediatePropag

Protected throttleTimeout

Private Optional touchHandler

Type declaration

Parameters

e: TouchEvent

Returns void

Private Optional uiHandler

Type declaration

Parameters

e: UIEvent

Returns void

Accessors

data

Returns D

dynamicRegisteredNodes

Returns ReadonlySet<unknown>

fsm

Returns F

name

Returns string

preventDefault

Returns boolean

Parameters

prevent: boolean

Returns void

Param: prevent

registeredNodes

Returns ReadonlySet<unknown>

stopImmediatePropagation

Returns boolean

Class InteractionBase<D, DImpl, F>`Abstract`

`Protected` constructor

`Protected` `Readonly` _data

`Protected` `Readonly` _dynamicRegisteredNodes

`Protected` `Readonly` _fsm

`Protected` _log

`Protected` `Readonly` _name

`Protected` `Readonly` _registeredNodes

`Private` `Optional` actionHandler

`Protected` activated

`Protected` currentThrottling

`Private` `Readonly` disposable

`Private` `Optional` keyHandler

`Protected` latestThrottledEvent

`Protected` `Readonly` logger

`Private` `Optional` mouseHandler

`Protected` `Readonly` mutationObservers

`Private` preventDef

`Private` stopImmediatePropag

`Protected` throttleTimeout

`Private` `Optional` touchHandler

`Private` `Optional` uiHandler

`Private` callBackMutationObserver

`Private` checkThrottlingEvent

`Private` createThrottleTimeout

`Private` directEventProcess

`Protected` getActionHandler

`Protected` getCurrentAcceptedEvents

`Protected` getEventTypesOf

`Protected` getKeyHandler

`Protected` getMouseHandler

`Protected` getTouchHandler

`Protected` getUIHandler

`Protected` registerActionHandlerClick

`Protected` registerActionHandlerInput