gradum-kit - v0.1.0
    Preparing search index...

    Class GradumInteractor<ElementType, ViewType, ModelType, EmitterType>

    GradumInteractor

    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
    constructor
    keyName toolName manager options element view model emitter
    target
    setup initialize setupUIListeners setupChangedCallbacks
    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.

    manager: GradumEventManager

    The associated event manager. Defaults to GradumEventManager.instance.

    options: ListenerOptions

    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.

    target: Node

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

    • Protected Function

      setup

      Returns void

      Called in the constructor. Use for setup that should happen at instantiation, before this.initialize() is called.

    • Function

      initialize

      Returns void

      Initializes the operator. Specifically, it will set up the change callbacks.

    • Protected Function

      setupUIListeners

      Returns void

      Setup method for defining DOM and input event listeners.

    • Protected Function

      setupChangedCallbacks

      Returns void

      Setup method intended to initialize change listeners and callbacks.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods