Class KeysTyped

A user interaction for typing several keyboard keys. One can type on multiple keys. The interaction ends after a timeout (a delay after the latest typed key).

Hierarchy

InteractionBase<KeysData, KeysDataImpl, KeysTypedFSM>
- KeysTyped

Constructors

constructor

new KeysTyped(logger, name?): KeysTyped
Creates the user interaction.
Parameters
- logger: Logger
  The logger to use for this interaction
- Optional name: string
  The name of the user interaction
Returns KeysTyped
Overrides InteractionBase.constructor
- Defined in impl/interaction/library/KeysTyped.ts:82

Properties

`Protected` `Readonly` _data

_data: KeysDataImpl

The interaction data

`Protected` `Readonly` _dynamicRegisteredNodes

_dynamicRegisteredNodes: Set<unknown>

`Protected` `Readonly` _fsm

_fsm: KeysTypedFSM

`Protected` _log

_log: boolean

`Protected` `Readonly` _name

_name: string

`Protected` `Readonly` _registeredNodes

_registeredNodes: Set<unknown>

The current nodes that the interaction works on

`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

`Protected` latestThrottledEvent

latestThrottledEvent: undefined | Event

`Protected` `Readonly` logger

logger: Logger

`Protected` `Readonly` mutationObservers

mutationObservers: MutationObserver[]

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

`Protected` throttleTimeout

throttleTimeout: number

Accessors

data

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

Returns D
Inherited from InteractionBase.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>
Inherited from InteractionBase.dynamicRegisteredNodes
- Defined in impl/interaction/InteractionBase.ts:491

fsm

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

Returns F
Inherited from InteractionBase.fsm
- Defined in impl/interaction/InteractionBase.ts:461

name

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

Returns string
Inherited from InteractionBase.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.
Inherited from InteractionBase.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.
Inherited from InteractionBase.preventDefault
- Defined in impl/interaction/InteractionBase.ts:403

registeredNodes

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

Returns ReadonlySet<unknown>
Inherited from InteractionBase.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.
Inherited from InteractionBase.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.
Inherited from InteractionBase.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
Inherited from InteractionBase.acceptVisitor
- Defined in impl/interaction/InteractionBase.ts:483

fullReinit

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

Returns void
Inherited from InteractionBase.fullReinit
- Defined in impl/interaction/InteractionBase.ts:387

`Protected` getActionHandler

getActionHandler(): EventListener
Returns EventListener
Inherited from InteractionBase.getActionHandler
- 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")[]
Inherited from InteractionBase.getCurrentAcceptedEvents
- 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">
Inherited from InteractionBase.getEventTypesOf
- Defined in impl/interaction/InteractionBase.ts:224

`Protected` getKeyHandler

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

`Protected` getMouseHandler

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

`Protected` getTouchHandler

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

`Protected` getUIHandler

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

isActivated

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

isRunning

isRunning(): boolean
Returns boolean
Whether the user interaction is running.
Inherited from InteractionBase.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
Inherited from InteractionBase.log
- Defined in impl/interaction/InteractionBase.ts:442

onNewNodeRegistered

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

onNodeUnregistered

onNodeUnregistered(node): void
Parameters
- node: unknown
Returns void
Inherited from InteractionBase.onNodeUnregistered
- 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
Inherited from InteractionBase.processEvent
- Defined in impl/interaction/InteractionBase.ts:418

`Protected` registerActionHandlerClick

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

`Protected` registerActionHandlerInput

registerActionHandlerInput(node): void
Parameters
- node: EventTarget
Returns void
Inherited from InteractionBase.registerActionHandlerInput
- 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
Inherited from InteractionBase.registerEventToNode
- 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
Inherited from InteractionBase.registerToNodeChildren
- Defined in impl/interaction/InteractionBase.ts:261

registerToNodes

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

reinit

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

Returns void
Inherited from InteractionBase.reinit
- Defined in impl/interaction/InteractionBase.ts:465

reinitData

reinitData(): void
Reinitialises the interaction data

Returns void
Inherited from InteractionBase.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
Inherited from InteractionBase.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
Inherited from InteractionBase.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
Inherited from InteractionBase.uninstall
- Defined in impl/interaction/InteractionBase.ts:470

`Protected` unregisterActionHandlerClick

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

`Protected` unregisterActionHandlerInput

unregisterActionHandlerInput(node): void
Parameters
- node: EventTarget
Returns void
Inherited from InteractionBase.unregisterActionHandlerInput
- 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
Inherited from InteractionBase.unregisterEventToNode
- Defined in impl/interaction/InteractionBase.ts:298

`Protected` unregisterFromNodes

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

`Protected` updateEventsRegistered

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

Class KeysTyped

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

logger: Logger

Optional name: string

Returns KeysTyped

Properties

Protected Readonly _data

Protected Readonly _dynamicRegisteredNodes

Protected Readonly _fsm

Protected _log

Protected Readonly _name

Protected Readonly _registeredNodes

Protected activated

Protected currentThrottling

Protected latestThrottledEvent

Protected Readonly logger

Protected Readonly mutationObservers

Protected throttleTimeout

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

Parameters

stop: boolean

Returns void

Param: stop

Methods

acceptVisitor

Parameters

visitor: VisitorInteraction

Returns void

fullReinit

Returns void

Protected getActionHandler

Returns EventListener

Protected getCurrentAcceptedEvents

Parameters

state: OutputState

Returns readonly ("input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel")[]

Protected getEventTypesOf

Parameters

state: OutputState

Returns ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">

Protected getKeyHandler

Returns EventListener

Protected getMouseHandler

Returns EventListener

Protected getTouchHandler

Returns EventListener

Protected getUIHandler

Returns EventListener

isActivated

Returns boolean

isRunning

Returns boolean

log

Parameters

`Optional` name: string

`Protected` `Readonly` _data

`Protected` `Readonly` _dynamicRegisteredNodes

`Protected` `Readonly` _fsm

`Protected` _log

`Protected` `Readonly` _name

`Protected` `Readonly` _registeredNodes

`Protected` activated

`Protected` currentThrottling

`Protected` latestThrottledEvent

`Protected` `Readonly` logger

`Protected` `Readonly` mutationObservers

`Protected` throttleTimeout

`Protected` getActionHandler

`Protected` getCurrentAcceptedEvents

`Protected` getEventTypesOf

`Protected` getKeyHandler

`Protected` getMouseHandler

`Protected` getTouchHandler

`Protected` getUIHandler

`Protected` registerActionHandlerClick

`Protected` registerActionHandlerInput

`Protected` registerEventToNode

`Protected` unregisterActionHandlerClick

`Protected` unregisterActionHandlerInput

`Protected` unregisterEventToNode

`Protected` unregisterFromNodes

`Protected` updateEventsRegistered