Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EnumListProperty<T>

A property value that is a list of enum literals.

Type parameters

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

    Parameters

    Returns EnumListProperty<T>

Properties

Protected _skipOnChange

_skipOnChange: boolean = false
internal

declaredOn

declaredOn: IStructureClass

disposer

disposer: undefined | (() => void)

Protected enumType

enumType: new (key: string, lifeCycle: ILifeCycle) => AbstractEnum

Type declaration

Readonly isAvailable

isAvailable: boolean = false

Readonly isPublic

isPublic: boolean = false

Readonly isRequired

isRequired: boolean = false

name

name: string

observableValue

observableValue: IList<T>

parent

parent: Structure<IAbstractModel, null | IContainer>

Accessors

versionInfo

  • get versionInfo(): PropertyVersionInfo

  • Returns PropertyVersionInfo

Methods

_toJSON

  • _toJSON(): string[]

Protected assertReadable

  • assertReadable(): void

Protected assertWritable

  • assertWritable(): void

deepCopyInto

dispose

  • dispose(): void

get

Protected initialize

  • initialize(initialItems: T[], primitiveType: PrimitiveTypeEnum): { observableValue: IObservableArray<T> }

  • 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.

    Parameters

    • initialItems: T[]
    • primitiveType: PrimitiveTypeEnum

    Returns { observableValue: IObservableArray<T> }

    • observableValue: IObservableArray<T>

reportAvailabilityIssues

  • reportAvailabilityIssues(): void

Protected shouldHandleChange

  • shouldHandleChange(): boolean

toRawChangeValue

  • toRawChangeValue(value: T): any

updateWithRawValue

  • updateWithRawValue(value: any[]): void

Generated using TypeDoc