Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AttributesSystem

AttributesSystem manages shared art attributes and modules capable of selecting from them. It auto-installs / uninstalls attribute modules.

collboard-system

Hierarchy

  • AbstractSystem
    • AttributesSystem

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • systems: ISystemsExtended

    Returns AttributesSystem

Properties

Private attributesRules

attributesRules: any

Private attributesValue

attributesValue: any

Private getAttributeValueDefined

getAttributeValueDefined: any

Private inputRenderDefined

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

registeredAttributeNames

  • get registeredAttributeNames(): string[]

  • Returns string[]

Methods

addSubdestroyable

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

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns AttributesSystem

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>

getAttributeValue

  • getAttributeValue(attributeName: string, valueScope?: string): BehaviorSubject<attribute_value>

  • Parameters

    • attributeName: string
    • Optional valueScope: string

    Returns BehaviorSubject<attribute_value>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

inputRender

  • inputRender(attributeName: string, options?: { overrideValue?: attribute_value; valueScope?: string; additionaOnChange?: any }): null | Element

  • Note: this is not async because when it need to do some async stuff it will return AsyncContentComponent immediatelly and load in in the fly TODO: Is it a good solution?

    Parameters

    • attributeName: string
    • Optional options: { overrideValue?: attribute_value; valueScope?: string; additionaOnChange?: any }
      • Optional overrideValue?: attribute_value
      • Optional valueScope?: string
      • additionaOnChange?:function
        • additionaOnChange(value: attribute_value): void

        • Parameters

          • value: attribute_value

          Returns void

    Returns null | Element

registerAttributeRule

  • registerAttributeRule(rule: IAttributeRule<attribute_value>): Registration

  • Parameters

    • rule: IAttributeRule<attribute_value>

    Returns Registration

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable