Interface Interaction<D>

The concept of user interaction.

interface Interaction {
    data: D;
    dynamicRegisteredNodes: ReadonlySet<unknown>;
    fsm: FSM;
    name: string;
    preventDefault: boolean;
    registeredNodes: ReadonlySet<unknown>;
    stopImmediatePropagation: boolean;
    acceptVisitor(visitor): void;
    fullReinit(): void;
    isActivated(): boolean;
    isRunning(): boolean;
    log(log): void;
    registerToNodeChildren(elementToObserve): void;
    registerToNodes(widgets): void;
    reinit(): void;
    reinitData(): void;
    setActivated(activated): void;
    setThrottleTimeout(timeout): void;
    uninstall(): void;
}

Type Parameters

Implemented by

Properties

data dynamicRegisteredNodes fsm name preventDefault registeredNodes stopImmediatePropagation

Methods

acceptVisitor fullReinit isActivated isRunning log registerToNodeChildren registerToNodes reinit reinitData setActivated setThrottleTimeout uninstall

Properties

data

data: D

The interaction data of the user interaction. Cannot be null.

Readonly dynamicRegisteredNodes

dynamicRegisteredNodes: ReadonlySet<unknown>

The nodes for which the user interaction will register their child nodes dynamically.

Readonly fsm

fsm: FSM

The FSM of the user interaction.

Readonly name

name: string

The real name of the interaction.

preventDefault

preventDefault: boolean

Sets whether the default behavior associated to the event will be executed.

Param: prevent

True: the default behavior associated to the event will be ignored.

Readonly registeredNodes

registeredNodes: ReadonlySet<unknown>

The registered nodes.

stopImmediatePropagation

stopImmediatePropagation: boolean

Sets whether the user interaction will stop immediately the propagation of events processed by this user interaction to others listeners.

Param: stop

True: the propagation of the events will stop immediately.

Methods

acceptVisitor

fullReinit

isActivated

isRunning

log

  • log(log): void

  • Sets the logging of the user interaction.

    Parameters

    • log: boolean

      True: the user interaction will log information.

    Returns void

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

registerToNodes

reinit

reinitData

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

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

uninstall

  • uninstall(): void

  • Uninstall the user interaction. Used to free memory. Then, user interaction can be used any more.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc