Class Mvc<ElementType, ViewType, DataType, ModelType, EmitterType>

Mvc

Description

MVC -- Model-View-Component -- handler. Generates and manages an MVC structure for a certain object.

Type Parameters

ElementType extends object = object
The type of the object that will be turned into MVC.
ViewType extends TurboView = TurboView<any, any>
The element's view type.
DataType extends object = object
The element's data type.
ModelType extends TurboModel = TurboModel
The element's model type.
EmitterType extends TurboEmitter = TurboEmitter<any>
The element's emitter type.

Constructors

constructor

new Mvc<
    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>,
            >,
        >,
    >,
    DataType extends object = object,
    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<any>,
>(
    properties: MvcProperties<
        ElementType,
        ViewType,
        DataType,
        ModelType,
        EmitterType,
    >,
): Mvc<ElementType, ViewType, DataType, 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>,
          >,
      >,
  >
- DataType extends object = object
- 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<any>
Parameters
- properties: MvcProperties<ElementType, ViewType, DataType, ModelType, EmitterType>
Returns Mvc<ElementType, ViewType, DataType, ModelType, EmitterType>
- Defined in src/mvc/mvc.ts:50

Properties

`Readonly`element

element: ElementType

Description

The element/root of the MVC structure.

Accessors

view

get view(): ViewType
Returns ViewType
Description
The view (if any) of the current MVC structure. Setting it will update the view and link it with the existing pieces.
- Defined in src/mvc/mvc.ts:60
set view(
value: ViewType | (new (properties: TurboViewProperties) => ViewType),
): void
Parameters
- value: ViewType | (new (properties: TurboViewProperties) => ViewType)
Returns void
- Defined in src/mvc/mvc.ts:64

model

get model(): ModelType
Returns ModelType
Description
The model (if any) of the current MVC structure. Setting it will update the model and link it with the existing pieces.
- Defined in src/mvc/mvc.ts:73
set model(
    model:
        | ModelType
        | (new (data?: any, dataBlocksType?: "map" | "array") => ModelType),
): void
Parameters
- model: ModelType | (new (data?: any, dataBlocksType?: "map" | "array") => ModelType)
Returns void
- Defined in src/mvc/mvc.ts:77

emitter

get emitter(): EmitterType
Returns EmitterType
Description
The emitter (if any) of the current MVC structure. Setting it will update the emitter and link it with the existing pieces.
- Defined in src/mvc/mvc.ts:89
set emitter(
emitter: EmitterType | (new (properties: ModelType) => EmitterType),
): void
Parameters
- emitter: EmitterType | (new (properties: ModelType) => EmitterType)
Returns void
- Defined in src/mvc/mvc.ts:93

controllers

get controllers(): TurboController<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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 TurboController<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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>,
        >,
    >,
>[]
Description
The controllers (if any) of the current MVC structure. Setting it will not override the existing controllers, but only add the new values and link them with the existing pieces.
- Defined in src/mvc/mvc.ts:102
set controllers(
    value: MvcManyInstancesOrConstructors<
        TurboController<
            object,
            TurboView<
                any,
                any,
                TurboEmitter<
                    TurboModel<
                        any,
                        any,
                        any,
                        "map"
                        | "array",
                        TurboDataBlock<any, any, any, any, any>,
                    >,
                >,
            >,
            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>,
                >,
            >,
        >,
        TurboControllerProperties,
    >,
): void
Parameters
- value: MvcManyInstancesOrConstructors<
      TurboController<
          object,
          TurboView<
              any,
              any,
              TurboEmitter<
                  TurboModel<
                      any,
                      any,
                      any,
                      "map"
                      | "array",
                      TurboDataBlock<any, any, any, any, any>,
                  >,
              >,
          >,
          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>,
              >,
          >,
      >,
      TurboControllerProperties,
  >
Returns void
- Defined in src/mvc/mvc.ts:106

handlers

get handlers(): TurboHandler<
    TurboModel<
        any,
        any,
        any,
        "map"
        | "array",
        TurboDataBlock<any, any, any, any, any>,
    >,
>[]
Returns TurboHandler<
    TurboModel<
        any,
        any,
        any,
        "map"
        | "array",
        TurboDataBlock<any, any, any, any, any>,
    >,
>[]
Description
The handlers (if any) of the current MVC structure. Setting it will not override the existing handlers, but only add the new values and link them with the existing pieces.
- Defined in src/mvc/mvc.ts:116
set handlers(
    value: MvcManyInstancesOrConstructors<
        TurboHandler<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
): void
Parameters
- value: MvcManyInstancesOrConstructors<
      TurboHandler<
          TurboModel<
              any,
              any,
              any,
              "map"
              | "array",
              TurboDataBlock<any, any, any, any, any>,
          >,
      >,
  >
Returns void
- Defined in src/mvc/mvc.ts:120

interactors

get interactors(): TurboInteractor<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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>,
        >,
    >,
>[]
Description
The interactors (if any) of the current MVC structure. Setting it will not override the existing interactors, but only add the new values and link them with the existing pieces.
- Defined in src/mvc/mvc.ts:129
set interactors(
    value: MvcManyInstancesOrConstructors<
        TurboInteractor<
            object,
            TurboView<
                any,
                any,
                TurboEmitter<
                    TurboModel<
                        any,
                        any,
                        any,
                        "map"
                        | "array",
                        TurboDataBlock<any, any, any, any, any>,
                    >,
                >,
            >,
            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>,
                >,
            >,
        >,
        TurboInteractorProperties,
    >,
): void
Parameters
- value: MvcManyInstancesOrConstructors<
      TurboInteractor<
          object,
          TurboView<
              any,
              any,
              TurboEmitter<
                  TurboModel<
                      any,
                      any,
                      any,
                      "map"
                      | "array",
                      TurboDataBlock<any, any, any, any, any>,
                  >,
              >,
          >,
          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>,
              >,
          >,
      >,
      TurboInteractorProperties,
  >
Returns void
- Defined in src/mvc/mvc.ts:133

tools

get tools(): TurboTool<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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 TurboTool<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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>,
        >,
    >,
>[]
Description
The tools (if any) of the current MVC structure. Setting it will not override the existing tools, but only add the new values and link them with the existing pieces.
- Defined in src/mvc/mvc.ts:143
set tools(
    value: MvcManyInstancesOrConstructors<
        TurboTool<
            object,
            TurboView<
                any,
                any,
                TurboEmitter<
                    TurboModel<
                        any,
                        any,
                        any,
                        "map"
                        | "array",
                        TurboDataBlock<any, any, any, any, any>,
                    >,
                >,
            >,
            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>,
                >,
            >,
        >,
        TurboToolProperties,
    >,
): void
Parameters
- value: MvcManyInstancesOrConstructors<
      TurboTool<
          object,
          TurboView<
              any,
              any,
              TurboEmitter<
                  TurboModel<
                      any,
                      any,
                      any,
                      "map"
                      | "array",
                      TurboDataBlock<any, any, any, any, any>,
                  >,
              >,
          >,
          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>,
              >,
          >,
      >,
      TurboToolProperties,
  >
Returns void
- Defined in src/mvc/mvc.ts:147

substrates

get substrates(): TurboSubstrate<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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 TurboSubstrate<
    object,
    TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<
                any,
                any,
                any,
                "map"
                | "array",
                TurboDataBlock<any, any, any, any, any>,
            >,
        >,
    >,
    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>,
        >,
    >,
>[]
Description
The substrates (if any) of the current MVC structure. Setting it will not override the existing substrates, but only add the new values and link them with the existing pieces.
- Defined in src/mvc/mvc.ts:157
set substrates(
    value: MvcManyInstancesOrConstructors<
        TurboSubstrate<
            object,
            TurboView<
                any,
                any,
                TurboEmitter<
                    TurboModel<
                        any,
                        any,
                        any,
                        "map"
                        | "array",
                        TurboDataBlock<any, any, any, any, any>,
                    >,
                >,
            >,
            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>,
                >,
            >,
        >,
        TurboSubstrateProperties,
    >,
): void
Parameters
- value: MvcManyInstancesOrConstructors<
      TurboSubstrate<
          object,
          TurboView<
              any,
              any,
              TurboEmitter<
                  TurboModel<
                      any,
                      any,
                      any,
                      "map"
                      | "array",
                      TurboDataBlock<any, any, any, any, any>,
                  >,
              >,
          >,
          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>,
              >,
          >,
      >,
      TurboSubstrateProperties,
  >
Returns void
- Defined in src/mvc/mvc.ts:161

data

get data(): DataType
Returns DataType
Description
The main data block (if any) attached to the model (if any).
- Defined in src/mvc/mvc.ts:170
set data(data: DataType): void
Parameters
- data: DataType
Returns void
- Defined in src/mvc/mvc.ts:174

dataId

get dataId(): string
Returns string
Description
The ID of the main data block (if any) attached to the model (if any).
- Defined in src/mvc/mvc.ts:181
set dataId(value: string): void
Parameters
- value: string
Returns void
- Defined in src/mvc/mvc.ts:185

dataIndex

get dataIndex(): number
Returns number
Description
The numerical index of the main data block (if any) attached to the model (if any).
- Defined in src/mvc/mvc.ts:192
set dataIndex(value: number): void
Parameters
- value: number
Returns void
- Defined in src/mvc/mvc.ts:196

dataSize

get dataSize(): number
Returns number
Description
The size (number) of the main data block (if any) attached to the model (if any).
- Defined in src/mvc/mvc.ts:203

Methods

getController

getController(key: string): TurboController
Function
getController
Parameters
- key: string
  The controller's key.
Returns TurboController
- The controller.
Description
Retrieves the attached MVC controller with the given key. By default, unless manually defined in the controller, if the element's class name is MyElement and the controller's class name is MyElementSomethingController, the key would be "something".
- Defined in src/mvc/mvc.ts:215

addController

addController(controller: TurboController): void
Function
addController
Parameters
- controller: TurboController
  The controller to add.
Returns void
Description
Adds the given controller to the MVC structure.
- Defined in src/mvc/mvc.ts:224

getHandler

getHandler(key: string): TurboHandler
Function
getHandler
Parameters
- key: string
  The handler's key.
Returns TurboHandler
- The handler.
Description
Retrieves the attached MVC handler with the given key. By default, unless manually defined in the handler, if the element's class name is MyElement and the handler's class name is MyElementSomethingHandler, the key would be "something".
- Defined in src/mvc/mvc.ts:239

addHandler

addHandler(handler: TurboHandler): void
Function
addHandler
Parameters
- handler: TurboHandler
  The handler to add.
Returns void
Description
Adds the given handler to the MVC structure.
- Defined in src/mvc/mvc.ts:248

getInteractor

getInteractor(key: string): TurboInteractor
Function
getInteractor
Parameters
- key: string
  The interactor's key.
Returns TurboInteractor
- The interactor.
Description
Retrieves the attached MVC interactor with the given key. By default, unless manually defined in the interactor, if the element's class name is MyElement and the interactor's class name is MyElementSomethingInteractor, the key would be "something".
- Defined in src/mvc/mvc.ts:263

addInteractor

addInteractor(interactor: TurboInteractor): void
Function
addInteractor
Parameters
- interactor: TurboInteractor
  The interactor to add.
Returns void
Description
Adds the given interactor to the MVC structure.
- Defined in src/mvc/mvc.ts:272

getTool

getTool(key: string): TurboTool
Function
getTool
Parameters
- key: string
  The tool's key.
Returns TurboTool
- The tool.
Description
Retrieves the attached MVC Tool with the given key. By default, unless manually defined in the tool, if the element's class name is MyElement and the tool's class name is MyElementSomethingTool, the key would be "something".
- Defined in src/mvc/mvc.ts:287

addTool

addTool(tool: TurboTool): void
Function
addTool
Parameters
- tool: TurboTool
  The tool to add.
Returns void
Description
Adds the given tool to the MVC structure.
- Defined in src/mvc/mvc.ts:296

getSubstrate

getSubstrate(key: string): TurboSubstrate
Function
getSubstrate
Parameters
- key: string
  The substrate's key.
Returns TurboSubstrate
- The substrate.
Description
Retrieves the attached MVC Substrate with the given key. By default, unless manually defined in the substrate, if the element's class name is MyElement and the substrate's class name is MyElementSomethingSubstrate, the key would be "something".
- Defined in src/mvc/mvc.ts:311

addSubstrate

addSubstrate(substrate: TurboSubstrate): void
Function
addSubstrate
Parameters
- substrate: TurboSubstrate
  The substrate to add.
Returns void
Description
Adds the given substrate to the MVC structure.
- Defined in src/mvc/mvc.ts:320

generate

generate(
    properties?: MvcGenerationProperties<
        ViewType,
        DataType,
        ModelType,
        EmitterType,
    >,
): void
Function
generate
Parameters
- properties: MvcGenerationProperties<ViewType, DataType, ModelType, EmitterType> = {}
  The properties to use to generate the MVC structure.
Returns void
Description
Generates the MVC structure based on the provided properties. If no model or model constructor is defined, no model will be generated. The same applies for the view. If not defined, a default emitter will be created.
- Defined in src/mvc/mvc.ts:335

initialize

initialize(): void
Function
initialize

Returns void
Description
Initializes the MVC parts: the view, the controllers, the interactors, the tools, the substrates, and the model (in this order). The model is initialized last to allow for the view and controllers to set up their change callbacks.
- Defined in src/mvc/mvc.ts:353

`Protected`updateController

updateController(controller: TurboController): void
Parameters
- controller: TurboController
Returns void
- Defined in src/mvc/mvc.ts:362

`Protected`updateHandler

updateHandler(handler: TurboHandler): void
Parameters
- handler: TurboHandler
Returns void
- Defined in src/mvc/mvc.ts:368

`Protected`updateInteractor

updateInteractor(interactor: TurboInteractor): void
Parameters
- interactor: TurboInteractor
Returns void
- Defined in src/mvc/mvc.ts:372

`Protected`updateTool

updateTool(tool: TurboTool): void
Parameters
- tool: TurboTool
Returns void
- Defined in src/mvc/mvc.ts:378

`Protected`updateSubstrate

updateSubstrate(substrate: TurboSubstrate): void
Parameters
- substrate: TurboSubstrate
Returns void
- Defined in src/mvc/mvc.ts:384

`Protected`linkPieces

linkPieces(): void
Returns void
- Defined in src/mvc/mvc.ts:390

`Protected`extractClassEssenceName

extractClassEssenceName(
constructor: new (...args: any[]) => any,
type: string,
): string
Parameters
- constructor: new (...args: any[]) => any
- type: string
Returns string
- Defined in src/mvc/mvc.ts:441

Class Mvc<ElementType, ViewType, DataType, ModelType, EmitterType>

Description

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Mvc<ElementType, ViewType, DataType, ModelType, EmitterType>

Properties

Readonlyelement

Description

Accessors

view

Returns ViewType

Description

Parameters

Returns void

model

Returns ModelType

Description

Parameters

Returns void

emitter

Returns EmitterType

Description

Parameters

Returns void

controllers

Description

Parameters

Returns void

handlers

Returns TurboHandler< TurboModel< any, any, any, "map" | "array", TurboDataBlock<any, any, any, any, any>, >,>[]

Description

Parameters

Returns void

interactors

Description

Parameters

Returns void

tools

Description

Parameters

Returns void

substrates

Description

Parameters

Returns void

data

Returns DataType

Description

Parameters

Returns void

dataId

Returns string

Description

Parameters

Returns void

dataIndex

Returns number

Description

Parameters

Returns void

dataSize

Returns number

Description

Methods

getController

Parameters

Returns TurboController

Description

addController

Parameters

Returns void

Description

`Readonly`element

Returns TurboHandler<
TurboModel<
any,
any,
any,
"map"
| "array",
TurboDataBlock<any, any, any, any, any>,
>,
>[]

`Protected`updateController

`Protected`updateHandler

`Protected`updateInteractor

`Protected`updateTool

`Protected`updateSubstrate

`Protected`linkPieces

`Protected`extractClassEssenceName