Class TurboSubstrate<ElementType, ViewType, ModelType, EmitterType>

TurboSubstrate

Description

Class representing a substrate 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>
- TurboSubstrate

Index

Constructors

constructor

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

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

Description

The name of the substrate.

`Readonly`solverKeys

solverKeys: string[] = []

Description

The property keys of the substrate solvers defined in the instance.

Accessors

objectList

get objectList(): Set<object>
Returns Set<object>
Description
The list of objects constrained by the substrate. Retrieving it will return a shallow copy as a Set. Use addObject and removeObject to manipulate the list.
- Defined in src/mvc/substrate/substrate.ts:48
set objectList(value: Set<object> | HTMLCollection | NodeList): void
Parameters
- value: Set<object> | HTMLCollection | NodeList
Returns void
- Defined in src/mvc/substrate/substrate.ts:52

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 makeSubstrate on this.element, sets it up, and attaches all the defined solvers.
Overrides TurboController.initialize
- Defined in src/mvc/substrate/substrate.ts:69

addObject

addObject(object: object): void
Function
addObject
Parameters
- object: object
  The object to add.
Returns void
Description
Adds the provided object to the substrate's list.
- Defined in src/mvc/substrate/substrate.ts:88

removeObject

removeObject(object: object): void
Function
removeObject
Parameters
- object: object
  The object to remove.
Returns void
Description
Removes the provided object from the substrate's list.
- Defined in src/mvc/substrate/substrate.ts:97

hasObject

hasObject(object: object): boolean
Function
hasObject
Parameters
- object: object
  The object to check.
Returns boolean
- Whether the object is present.
Description
Whether the provided object is included in the substrate's list.
- Defined in src/mvc/substrate/substrate.ts:107

isProcessed

isProcessed(object: object): boolean
Function
isProcessed
Parameters
- object: object
  The object to check.
Returns boolean
- Whether the object was processed.
Description
Whether the provided object is processed within the current resolving loop.
- Defined in src/mvc/substrate/substrate.ts:117

addSolver

addSolver(fn: SubstrateSolver): void
Function
addSolver
Parameters
- fn: SubstrateSolver
  The solver function to execute when calling resolve.
Returns void
Description
Add the given function as a solver in the substrate.
- Defined in src/mvc/substrate/substrate.ts:126

removeSolver

removeSolver(fn: SubstrateSolver): void
Function
removeSolver
Parameters
- fn: SubstrateSolver
  The solver function to remove.
Returns void
Description
Remove the given function from the substrate's list of solvers.
- Defined in src/mvc/substrate/substrate.ts:135

clearSolvers

clearSolvers(): void
Function
clearSolvers

Returns void
Description
Remove all solvers attached to the substrate.
- Defined in src/mvc/substrate/substrate.ts:143

resolve

resolve(properties?: SubstrateSolverProperties): void
Function
resolve
Parameters
- Optionalproperties: SubstrateSolverProperties = {}
  Optional properties to provide context to the resolving loop.
Returns void
Description
Resolve the substrate by calling all the solvers on each of the objects in the substrate's list.
- Defined in src/mvc/substrate/substrate.ts:152

onActivate

onActivate(): void
Function
onActivate

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

onDeactivate

onDeactivate(): void
Function
onDeactivate

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

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

element

Description

view

Description

model

Description

emitter

Description

keyName

Description

ReadonlysubstrateName

Description

ReadonlysolverKeys

Description

Accessors

objectList

Returns Set<object>

Description

Parameters

Returns void

Methods

ProtectedsetupChangedCallbacks

Returns void

Description

initialize

Returns void

Description

addObject

Parameters

Returns void

Description

removeObject

Parameters

Returns void

Description

hasObject

Parameters

Returns boolean

Description

isProcessed

Parameters

Returns boolean

Description

addSolver

Parameters

Returns void

Description

removeSolver

Parameters

Returns void

Description

clearSolvers

Returns void

Description

resolve

Parameters

Returns void

Description

onActivate

Returns void

Description

onDeactivate

Returns void

Description

Settings

`Readonly`substrateName

`Readonly`solverKeys

`Protected`setupChangedCallbacks