Class TurboSubstrate<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>
- TurboSubstrate

Index

Constructors

constructor

new TurboSubstrate<
    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: TurboSubstrateProperties<
        ElementType,
        ViewType,
        ModelType,
        EmitterType,
    >,
): TurboSubstrate<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: TurboSubstrateProperties<ElementType, ViewType, ModelType, EmitterType>
Returns TurboSubstrate<ElementType, ViewType, ModelType, EmitterType>
Overrides TurboController.constructor
- Defined in src/mvc/substrate/substrate.ts:34

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 substrate. Used to retrieve it in the main component. If not set, if the element's class name is MyElement and the substrate's class name is MyElementSomethingSubstrate, the key would default to "something".

`Readonly`substrateName

substrateName: string

`Readonly`solverKeys

solverKeys: string[] = []

Accessors

objectList

get objectList(): Set<object>
Returns Set<object>
- Defined in src/mvc/substrate/substrate.ts:26
set objectList(value: Set<object> | HTMLCollection | NodeList): void
Parameters
- value: Set<object> | HTMLCollection | NodeList
Returns void
- Defined in src/mvc/substrate/substrate.ts:30

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/substrate/substrate.ts:39

addObject

addObject(object: object): void
Parameters
- object: object
Returns void
- Defined in src/mvc/substrate/substrate.ts:53

removeObject

removeObject(object: object): Turbo<Node>
Parameters
- object: object
Returns Turbo<Node>
- Defined in src/mvc/substrate/substrate.ts:57

hasObject

hasObject(object: object): boolean
Parameters
- object: object
Returns boolean
- Defined in src/mvc/substrate/substrate.ts:61

isProcessed

isProcessed(object: object): boolean
Parameters
- object: object
Returns boolean
- Defined in src/mvc/substrate/substrate.ts:65

resolve

resolve(properties?: SubstrateSolverProperties): void
Parameters
- properties: SubstrateSolverProperties = {}
Returns void
- Defined in src/mvc/substrate/substrate.ts:69

addSolver

addSolver(callback: (...args: any[]) => any): void
Parameters
- callback: (...args: any[]) => any
Returns void
- Defined in src/mvc/substrate/substrate.ts:73

removeSolver

removeSolver(callback: (...args: any[]) => any): void
Parameters
- callback: (...args: any[]) => any
Returns void
- Defined in src/mvc/substrate/substrate.ts:77

clearSolvers

clearSolvers(): void
Returns void
- Defined in src/mvc/substrate/substrate.ts:81

onActivate

onActivate(): void
Returns void
- Defined in src/mvc/substrate/substrate.types.ts:17

onDeactivate

onDeactivate(): void
Returns void
- Defined in src/mvc/substrate/substrate.types.ts:18

Class TurboSubstrate<ElementType, ViewType, ModelType, EmitterType>

Description

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TurboSubstrate<ElementType, ViewType, ModelType, EmitterType>

Properties

Protectedelement

Description

Protected Optionalview

Description

Protected Optionalmodel

Description

Protected Optionalemitter

Description

keyName

Description

ReadonlysubstrateName

ReadonlysolverKeys

Accessors

objectList

Returns Set<object>

Parameters

Returns void

Methods

ProtectedsetupChangedCallbacks

Returns void

Description

initialize

Returns void

Description

addObject

Parameters

Returns void

removeObject

Parameters

Returns Turbo<Node>

hasObject

Parameters

Returns boolean

isProcessed

Parameters

Returns boolean

resolve

Parameters

Returns void

addSolver

Parameters

Returns void

removeSolver

Parameters

Returns void

clearSolvers

Returns void

onActivate

Returns void

onDeactivate

Returns void

Settings

On This Page

`Protected`element

`Protected` `Optional`view

`Protected` `Optional`model

`Protected` `Optional`emitter

`Readonly`substrateName

`Readonly`solverKeys

`Protected`setupChangedCallbacks