Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ControlSystem

ControlSystem can register and manage keyboard shortcuts like Ctrl + C by modules (or maybe other systems).

collboard-system

Hierarchy

  • AbstractSystem
    • ControlSystem

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • systems: ISystemsExtended

    Returns ControlSystem

Properties

Readonly controls

controls: BehaviorSubject<IControl[]>

Private executeShortcutsToCurrentlyPressedKeys

executeShortcutsToCurrentlyPressedKeys: any

Readonly pressedKeys

pressedKeys: BehaviorSubject<IShortcut>

Readonly ready

ready: Promise<void>

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

Private registerListeners

registerListeners: any

Private registerOneShortcut

registerOneShortcut: any

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[]): ControlSystem

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

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns ControlSystem

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>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

registerControl

  • registerControl<TValue>(options: IRegisterControlOptions<TValue>): Registration

  • Type parameters

    • TValue

    Parameters

    • options: IRegisterControlOptions<TValue>

    Returns Registration

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable