Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractProperty<T, P>

Abstract base wrapper for property values/settings. All values/settings of ModelElement-s are wrapped in the appropriate way. This is particularly important for reference values which require additional magic.

Type parameters

  • T

  • P

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • parent is the structure that the value of this property attaches to, so e.g. for all values item of Part(List)Property we (should) have the invariant: item.container === this.parent.

    initialValue is default value except parts and GUID-typed primitives. (by-id/name references do not have default values.)

    Type parameters

    • T

    • P

    Parameters

    Returns AbstractProperty<T, P>

Properties

Protected _skipOnChange

_skipOnChange: boolean = false
internal

declaredOn

declaredOn: IStructureClass

disposer

disposer: undefined | (() => void)

Readonly isAvailable

isAvailable: boolean = false

Readonly isPublic

isPublic: boolean = false

Readonly isRequired

isRequired: boolean = false

name

name: string

observableValue

observableValue: P

parent

parent: Structure<IAbstractModel, null | IContainer>

Accessors

versionInfo

  • get versionInfo(): PropertyVersionInfo

  • Returns PropertyVersionInfo

Methods

Abstract _toJSON

  • _toJSON(): any
  • internal

    Returns any

Protected assertReadable

  • assertReadable(): void
  • internal

    Returns void

Protected assertWritable

  • assertWritable(): void
  • internal

    Returns void

Abstract deepCopyInto

dispose

  • dispose(): void

  • Returns void

Abstract get

  • get(): T

  • Returns T

Protected Abstract initialize

  • initialize(value: T, ...moreConstructorArgs: any[]): IInitializeResult<P>

  • Initialize should return something that is observable. The property will observe this internal structure and make sure changes are pushed to the server whenever needed, in its onChange event.

    internal

    Parameters

    • value: T
    • Rest ...moreConstructorArgs: any[]

    Returns IInitializeResult<P>

reportAvailabilityIssues

  • reportAvailabilityIssues(): void

  • Returns void

Protected shouldHandleChange

  • shouldHandleChange(): boolean
  • internal

    Returns boolean

Abstract updateWithRawValue

  • updateWithRawValue(value: any): void

  • Parameters

    • value: any

    Returns void

Generated using TypeDoc