turbodombuilder - v0.9.22
    Preparing search index...

    Class TurboInteractor<ElementType, ViewType, ModelType, EmitterType>

    TurboInteractor

    Class representing an MVC interactor. It holds event listeners to set up on the element itself, or the custom defined target.

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    • Type Parameters

      • ElementType extends object = object
      • ViewType extends TurboView<
            object,
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
            TurboEmitter<
                TurboModel<
                    any,
                    any,
                    any,
                    "map"
                    | "array",
                    TurboDataBlock<any, any, any, any, any>,
                >,
            >,
        > = TurboView<
            any,
            any,
            TurboEmitter<
                TurboModel<
                    any,
                    any,
                    any,
                    "map"
                    | "array",
                    TurboDataBlock<any, any, any, any, any>,
                >,
            >,
        >
      • ModelType extends TurboModel<
            any,
            any,
            any,
            "map"
            | "array",
            TurboDataBlock<any, any, any, any, any>,
        > = TurboModel<
            any,
            any,
            any,
            "map"
            | "array",
            TurboDataBlock<any, any, any, any, any>,
        >
      • EmitterType extends TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        > = TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >

      Returns TurboInteractor<ElementType, ViewType, ModelType, EmitterType>

    Properties

    keyName: string

    The key of the interactor. Used to retrieve it in the main component. If not set, if the element's class name is MyElement and the interactor's class name is MyElementSomethingInteractor, the key would default to "something".

    toolName: string

    The name of the tool (if any) to listen for.

    The associated event manager. Defaults to TurboEventManager.instance.

    Optional custom options to define per event type.

    element: ElementType

    The element it is bound to.

    view: ViewType

    The MVC view.

    model: ModelType

    The MVC model.

    emitter: EmitterType

    The MVC emitter.

    Accessors

    target: any

    The target of the event listeners. Defaults to the element itself.

    Methods

    • Function

      initialize

      Returns void

      Initialization function that sets up all the defined evnt listeners and attaches them to the target.

    • Parameters

      Returns any

      Fired on click start

    • Parameters

      Returns any

      Fired on click

    • Parameters

      Returns any

      Fired on click end

    • Parameters

      Returns any

      Fired on pointer move

    • Parameters

      Returns any

      Fired on drag start

    • Parameters

      Returns any

      Fired on drag

    • Parameters

      Returns any

      Fired on drag end

    • Parameters

      Returns any

    • Parameters

      Returns any

    • Parameters

      Returns any

    • Protected Function

      setupChangedCallbacks

      Returns void

      Setup method intended to initialize change listeners and callbacks.