Class TurboTool<ElementType, ViewType, ModelType, EmitterType>

TurboController

Description

The MVC base controller class. Its main job is to handle (some part of or all of) the logic of the component. It has access to the element, the model to read and write data, the view to update the UI, and the emitter to listen for changes in the model. It can only communicate with other controllers via the emitter (by firing or listening for changes on a certain key).

Type Parameters

ElementType extends object = object
The type of the main component.
ViewType extends TurboView = TurboView<any, any>
The element's MVC view type.
ModelType extends TurboModel = TurboModel
The element's MVC model type.
EmitterType extends TurboEmitter = TurboEmitter
The element's MVC emitter type.

Hierarchy (View Summary)

TurboController<ElementType, ViewType, ModelType, EmitterType>
- TurboTool

Index

Constructors

constructor

new TurboTool<
    ElementType extends object = object,
    ViewType extends
        TurboView<
            object,
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            TurboEmitter<
                TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            >,
        > = TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        >,
    >,
    ModelType extends
        TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>> = TurboModel<
        any,
        any,
        any,
        "array"
        | "map",
        MvcDataBlock<any, any>,
    >,
    EmitterType extends
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        > = TurboEmitter<
        TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
    >,
>(
    properties: TurboToolProperties<
        ElementType,
        ViewType,
        ModelType,
        EmitterType,
    >,
): TurboTool<ElementType, ViewType, ModelType, EmitterType>
Type Parameters
- ElementType extends object = object
- ViewType extends TurboView<
      object,
      TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      TurboEmitter<
          TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      >,
  > = TurboView<
      any,
      any,
      TurboEmitter<
          TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      >,
  >
- ModelType extends TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>> = TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>
- EmitterType extends TurboEmitter<TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>> = TurboEmitter<TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>>
Parameters
- properties: TurboToolProperties<ElementType, ViewType, ModelType, EmitterType>
Returns TurboTool<ElementType, ViewType, ModelType, EmitterType>
Overrides TurboController.constructor
- Defined in src/mvc/tool/tool.ts:36

Properties

`Protected`element

element: ElementType

Description

A reference to the component.

`Protected` `Optional`view

view?: ViewType

Description

A reference to the MVC view.

`Protected` `Optional`model

model?: ModelType

Description

A reference to the MVC model.

`Protected` `Optional`emitter

emitter?: EmitterType

Description

A reference to the MVC emitter.

keyName

keyName: string

Description

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

toolName

toolName: string

`Readonly`embeddedTarget

embeddedTarget: Node

`Readonly`manager

manager: TurboEventManager

`Readonly`activationEvent

activationEvent: string

`Readonly`clickMode

clickMode: ClickMode

`Readonly`key

key: string

Methods

`Protected`setupChangedCallbacks

setupChangedCallbacks(): void
Protected
setupChangedCallbacks

Returns void
Description
Setup method intended to initialize change listeners and callbacks.
Inherited from TurboController.setupChangedCallbacks
- Defined in src/mvc/logic/controller.ts:75

initialize

initialize(): void
initialize

Returns void
Description
Initializes the controller. Specifically, it will setup the change callbacks.
Overrides TurboController.initialize
- Defined in src/mvc/tool/tool.ts:46

customActivation

customActivation(element: Turbo, manager: TurboEventManager): void
Parameters
- element: Turbo
- manager: TurboEventManager
Returns void
- Defined in src/mvc/tool/tool.types.ts:26

onActivation

onActivation(): void
Returns void
- Defined in src/mvc/tool/tool.types.ts:27

onDeactivation

onDeactivation(): void
Returns void
- Defined in src/mvc/tool/tool.types.ts:28

clickStart

clickStart(e: Event, target: Node): boolean
Parameters
- e: Event
- target: Node
Returns boolean
Description
Fired on click start
- Defined in src/mvc/tool/tool.types.ts:35

click

click(e: Event, target: Node): boolean
Parameters
- e: Event
- target: Node
Returns boolean
Description
Fired on click
- Defined in src/mvc/tool/tool.types.ts:42

clickEnd

clickEnd(e: Event, target: Node): boolean
Parameters
- e: Event
- target: Node
Returns boolean
Description
Fired on click end
- Defined in src/mvc/tool/tool.types.ts:49

move

move(e: Event, target: Node): boolean
Parameters
- e: Event
- target: Node
Returns boolean
Description
Fired on pointer move
- Defined in src/mvc/tool/tool.types.ts:56

dragStart

dragStart(e: Event, target: Node): boolean
Parameters
- e: Event
- target: Node
Returns boolean
Description
Fired on drag start
- Defined in src/mvc/tool/tool.types.ts:63

drag

drag(e: Event, target: Node): boolean
Parameters
- e: Event
- target: Node
Returns boolean
Description
Fired on drag
- Defined in src/mvc/tool/tool.types.ts:70

dragEnd

dragEnd(e: Event, target: Node): boolean
Parameters
- e: Event
- target: Node
Returns boolean
Description
Fired on drag end
- Defined in src/mvc/tool/tool.types.ts:77

Class TurboTool<ElementType, ViewType, ModelType, EmitterType>

Description

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TurboTool<ElementType, ViewType, ModelType, EmitterType>

Properties

Protectedelement

Description

Protected Optionalview

Description

Protected Optionalmodel

Description

Protected Optionalemitter

Description

keyName

Description

toolName

ReadonlyembeddedTarget

Readonlymanager

ReadonlyactivationEvent

ReadonlyclickMode

Readonlykey

Methods

ProtectedsetupChangedCallbacks

Returns void

Description

initialize

Returns void

Description

customActivation

Parameters

Returns void

onActivation

Returns void

onDeactivation

Returns void

clickStart

Parameters

Returns boolean

Description

click

Parameters

Returns boolean

Description

clickEnd

Parameters

Returns boolean

Description

move

Parameters

Returns boolean

Description

dragStart

Parameters

Returns boolean

Description

drag

Parameters

Returns boolean

Description

dragEnd

Parameters

Returns boolean

Description

Settings

On This Page

`Protected`element

`Protected` `Optional`view

`Protected` `Optional`model

`Protected` `Optional`emitter

`Readonly`embeddedTarget

`Readonly`manager

`Readonly`activationEvent

`Readonly`clickMode

`Readonly`key

`Protected`setupChangedCallbacks