Class XTouchDnD<T, S>

The X-touch represents any touch interaction that involve more than one touch. This class is usually used to build more complex touch interactions.

Type Parameters

Hierarchy

Constructors

constructor

Properties

_data _dynamicRegisteredNodes _fsm _log _name _registeredNodes activated currentThrottling latestThrottledEvent logger mutationObservers throttleTimeout

Accessors

data dynamicRegisteredNodes fsm name preventDefault registeredNodes stopImmediatePropagation

Methods

acceptVisitor fullReinit getActionHandler getCurrentAcceptedEvents getEventTypesOf getKeyHandler getMouseHandler getTouchHandler getUIHandler isActivated isRunning log onNewNodeRegistered onNodeUnregistered processEvent registerActionHandlerClick registerActionHandlerInput registerEventToNode registerToNodeChildren registerToNodes reinit reinitData setActivated setTgtData setThrottleTimeout uninstall unregisterActionHandlerClick unregisterActionHandlerInput unregisterEventToNode unregisterFromNodes updateEventsRegistered

Constructors

constructor

  • new XTouchDnD<T, S>(nbTouches, logger, dataImpl, name?, fsm?, movementRequired?): XTouchDnD<T, S>

  • Creates the interaction.

    Type Parameters

    Parameters

    • nbTouches: number

      The number of touches of the interaction

    • logger: Logger

      The logger to use for this interaction

    • dataImpl: S

      The interaction data instance to use.

    • Optional name: string

      The name of the user interaction

    • Optional fsm: MultiTouchFSM

      The optional FSM provided for the interaction

    • Optional movementRequired: boolean

      Whether the DnD starts after the touch point has begun moving (default) or as soon as the screen is touched. The latter is used for the MultiTouch interaction.

    Returns XTouchDnD<T, S>

Properties

Protected Readonly _data

_data: S

The interaction data

Protected Readonly _dynamicRegisteredNodes

_dynamicRegisteredNodes: Set<unknown>

Protected Readonly _fsm

_fsm: MultiTouchFSM

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

dynamicRegisteredNodes

  • get dynamicRegisteredNodes(): ReadonlySet<unknown>

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

    Returns ReadonlySet<unknown>

fsm

name

preventDefault

  • get preventDefault(): boolean

  • Returns boolean

    True if the default behavior associated to the event will be executed.

  • 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.

registeredNodes

  • get registeredNodes(): ReadonlySet<unknown>

  • The registered nodes.

    Returns ReadonlySet<unknown>

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.

  • 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.

Methods

acceptVisitor

fullReinit

Protected getActionHandler

getCurrentAcceptedEvents

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

  • Parameters

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

Protected getEventTypesOf

  • getEventTypesOf(state): ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">

  • Parameters

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

Protected getKeyHandler

Protected getMouseHandler

Protected getTouchHandler

Protected getUIHandler

isActivated

isRunning

log

onNewNodeRegistered

onNodeUnregistered

processEvent

Protected registerActionHandlerClick

Protected registerActionHandlerInput

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

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

Protected setTgtData

setThrottleTimeout

uninstall

Protected unregisterActionHandlerClick

Protected unregisterActionHandlerInput

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

Protected unregisterFromNodes

Protected updateEventsRegistered

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc