Class TurboTool<ElementType, ViewType, ModelType, EmitterType>

TurboTool

Description

Class representing a tool in MVC, bound to the provided element.

Type Parameters

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

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,
                "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>,
        >,
    >,
>(
    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,
          "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>,
      >,
  >
Parameters
- properties: TurboToolProperties<ElementType, ViewType, ModelType, EmitterType>
Returns TurboTool<ElementType, ViewType, ModelType, EmitterType>
Overrides TurboController.constructor
- Defined in src/mvc/tool/tool.ts:71

Properties

element

element: ElementType

Description

The element it is bound to.

view

view: ViewType

Description

The MVC view.

model

model: ModelType

Description

The MVC model.

emitter

emitter: EmitterType

Description

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

Description

The name of the tool.

`Readonly`embeddedTarget

embeddedTarget: Node

Description

The target of this tool. If defined, will embed the tool.

`Readonly`manager

manager: TurboEventManager

Description

The associated event manager. Defaults to TurboEventManager.instance.

`Readonly`activationEvent

activationEvent: string = DefaultEventName.click

Description

Custom activation event to listen to. Defaults to the default click event name.

`Readonly`clickMode

clickMode: ClickMode = ClickMode.left

Description

Click mode that will hold this tool when activated. Defaults to ClickMode.left.

`Readonly`key

key: string

Description

Optional keyboard key to map to this tool. When pressed, it will be set as the current key tool.

Methods

`Protected`setupChangedCallbacks

setupChangedCallbacks(): void
Protected Function
setupChangedCallbacks

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

initialize

initialize(): void
Function
initialize

Returns void
Description
Initialization function that calls makeTool on this.element, sets it up, and attaches all the defined tool behaviors.
Overrides TurboController.initialize
- Defined in src/mvc/tool/tool.ts:91

customActivation

customActivation(element: Turbo<Element>, manager?: TurboEventManager): void
Function
customActivation
Parameters
- element: Turbo<Element>
  The tool element itself.
- Optionalmanager: TurboEventManager
  The event manager instance this tool should register against. Defaults to TurboEventManager.instance.
Returns void
Description
Custom activation function.
- Defined in src/mvc/tool/tool.types.ts:61

onActivate

onActivate(): void
Function
onActivate

Returns void
Description
Function to execute when the tool is activated.
- Defined in src/mvc/tool/tool.types.ts:67

onDeactivate

onDeactivate(): void
Function
onDeactivate

Returns void
Description
Function to execute when the tool is deactivated.
- Defined in src/mvc/tool/tool.types.ts:73

clickStart

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

click

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

clickEnd

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

move

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

dragStart

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

drag

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

dragEnd

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

input

input(e: Event, target: Node): any
Parameters
- e: Event
- target: Node
Returns any
- Defined in src/mvc/tool/tool.types.ts:124

focus

focus(e: Event, target: Node): any
Parameters
- e: Event
- target: Node
Returns any
- Defined in src/mvc/tool/tool.types.ts:126

blur

blur(e: Event, target: Node): any
Parameters
- e: Event
- target: Node
Returns any
- Defined in src/mvc/tool/tool.types.ts:128

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

element

Description

view

Description

model

Description

emitter

Description

keyName

Description

toolName

Description

ReadonlyembeddedTarget

Description

Readonlymanager

Description

ReadonlyactivationEvent

Description

ReadonlyclickMode

Description

Readonlykey

Description

Methods

ProtectedsetupChangedCallbacks

Returns void

Description

initialize

Returns void

Description

customActivation

Parameters

Returns void

Description

onActivate

Returns void

Description

onDeactivate

Returns void

Description

clickStart

Parameters

Returns any

Description

click

Parameters

Returns any

Description

clickEnd

Parameters

Returns any

Description

move

Parameters

Returns any

Description

dragStart

Parameters

Returns any

Description

drag

Parameters

Returns any

Description

dragEnd

Parameters

Returns any

`Readonly`embeddedTarget

`Readonly`manager

`Readonly`activationEvent

`Readonly`clickMode

`Readonly`key

`Protected`setupChangedCallbacks