Class ByNameReferenceProperty<T>

Property value that references a (model) element by name.

Type parameters

T: IAbstractElement

Hierarchy

AbstractProperty<T | null, IObservableValue<string | null>>
- ByNameReferenceProperty

Index

Constructors

constructor

new ByNameReferenceProperty<T>(declaredOn: IStructureClass, parent: AbstractElement<IAbstractModel, Container>, name: string, initialValue: null | T, _targetType: string): ByNameReferenceProperty<T>

Overrides AbstractProperty.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: IAbstractElement
Parameters
- declaredOn: IStructureClass
- parent: AbstractElement<IAbstractModel, Container>
- name: string
- initialValue: null | T
- _targetType: string
Returns ByNameReferenceProperty<T>

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: IObservableValue<null | string>

parent

parent: AbstractElement<IAbstractModel, Container>

Accessors

targetType

get targetType(): string

Returns string

versionInfo

get versionInfo(): PropertyVersionInfo

Inherited from AbstractProperty.versionInfo
Returns PropertyVersionInfo

Methods

_toJSON

_toJSON(): null | string

Overrides AbstractProperty._toJSON
internal
Returns null | string

Protected assertReadable

assertReadable(): void

Inherited from AbstractProperty.assertReadable
internal
Returns void

Protected assertWritable

assertWritable(): void

Inherited from AbstractProperty.assertWritable
internal
Returns void

deepCopyInto

deepCopyInto(clone: Structure<IAbstractModel, null | IContainer>, idMap: IMap<Structure<IAbstractModel, null | IContainer>>, unresolvedIdentifierFixers: ((idMap: IMap<Structure<IAbstractModel, null | IContainer>>) => void)[]): void

Overrides AbstractProperty.deepCopyInto
Parameters
- clone: Structure<IAbstractModel, null | IContainer>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>
- unresolvedIdentifierFixers: ((idMap: IMap<Structure<IAbstractModel, null | IContainer>>) => void)[]
Returns void

dispose

dispose(): void

Inherited from AbstractProperty.dispose
Returns void

get

get(): null | T

Overrides AbstractProperty.get
Returns null | T

Protected initialize

initialize(value: T, _targetType: string): { observableValue: IObservableValue<null | string> }

Overrides AbstractProperty.initialize
internal
Parameters
- value: T
- _targetType: string
Returns { observableValue: IObservableValue<null | string> }
- observableValue: IObservableValue<null | string>

qualifiedName

qualifiedName(): null | string

Returns null | string

reportAvailabilityIssues

reportAvailabilityIssues(): void

Inherited from AbstractProperty.reportAvailabilityIssues
Returns void

set

set(newValue: null | T): void

Parameters
- newValue: null | T
Returns void

Protected shouldHandleChange

shouldHandleChange(): boolean

Inherited from AbstractProperty.shouldHandleChange
internal
Returns boolean

updateQualifiedNameForRename

updateQualifiedNameForRename(value: string): void

This method is used to update the qualified name as part of a rename. _skipOnChange is used to prevent sending deltas for this change, as the Model Server handles this itself.

internal
Parameters
- value: string
Returns void

updateWithRawValue

updateWithRawValue(value: string): void

Overrides AbstractProperty.updateWithRawValue
Parameters
- value: string
Returns void

Generated using TypeDoc