Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FocusSystem

FocusSystem can register and manage unique focuses and icons which there are.

collboard-system

Hierarchy

  • AbstractSystem
    • FocusSystem

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new FocusSystem(systems: ISystemsExtended): FocusSystem

  • Parameters

    • systems: ISystemsExtended

    Returns FocusSystem

Properties

Private focusScopes

focusScopes: any

Readonly ready

ready: Promise<void>

Promise which is resolved when the system is initialized and ready to use.

Protected Readonly systems

systems: ISystemsExtended

Accessors

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

isReady

  • get isReady(): boolean

  • Checks if the system is initialized and ready to use.

    Returns boolean

Methods

addSubdestroyable

  • addSubdestroyable(...subdestroyable: ITeardownLogic[]): FocusSystem

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns FocusSystem

Protected checkIsReady

  • checkIsReady(): void

  • Checks if the system is initialized and ready to use. If not, throws an error. If it is, do nothing.

    Returns void

Protected checkWhetherNotDestroyed

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void

  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void

        • Returns void

    Returns void

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

getAllFocusScopes

  • getAllFocusScopes<TIdentification>(): Record<FocusScopeName, FocusScope<TIdentification>>

  • Type parameters

    • TIdentification

    Returns Record<FocusScopeName, FocusScope<TIdentification>>

getFocus

  • getFocus<TIdentification>(focusName: string): FocusScope<TIdentification>

  • Type parameters

    • TIdentification

    Parameters

    • focusName: string

    Returns FocusScope<TIdentification>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable