Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractReference<T>

Abstract base class for both {@link ReferenceByName by-name} and {@link ReferenceById by-id} references to elements of type T, which are observed.

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructs and returns a new reference instance, that is owned (by a property of) an abstract element.

    Parameters

    Returns AbstractReference

Properties

Protected isResolved

isResolved: boolean

Protected isResolving

isResolving: boolean

owner

owner: AbstractElement

Protected referenceId

referenceId: string

Protected target

target: IObservableValue<T>

Methods

dispose

  • dispose(): void

  • Returns void

get

  • get(): T

  • Returns the value of the wrapped reference.

    Returns T

observe

  • observe(callback: function, fireImmediately?: boolean): IVoidCallback

  • Registers an observer in the form of a callback with this references and fires that callback immediately if the reference is already resolved. Used by properties to observe this reference, so that storage and logical updates can be applied.

    Parameters

    • callback: function
        • (newValue: T, oldValue: T): void

        • Parameters

          • newValue: T
          • oldValue: T

          Returns void

    • Optional fireImmediately: boolean

    Returns IVoidCallback

Protected registerRef

  • registerRef(): void

  • Returns void

resolve

  • resolve(): boolean

  • Returns boolean

set

  • set(newValue: T): void

  • Sets the value of the wrapped reference, taking care of resolution and life cycle.

    Parameters

    • newValue: T

    Returns void

Protected unregisterRef

  • unregisterRef(): void

  • Returns void

updateWithRawValue

  • updateWithRawValue(value: string): void

  • Sets only the raw target id, without trying to resolve that.

    Parameters

    • value: string

    Returns void

Generated using TypeDoc