Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetValueType

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___allowNonPersistableEntities

___allowNonPersistableEntities: any

Private ___attributeTypes

___attributeTypes: any

Private ___defaultValue

___defaultValue: any

Private ___entityProperty

___entityProperty: any

Private ___enumerationValues

___enumerationValues: any

Private ___isList

___isList: any

Private ___isPath

___isPath: any

Private ___multiline

___multiline: any

Private ___objectType

___objectType: any

Private ___parameterIsList

___parameterIsList: any

Private ___pathType

___pathType: any

Private ___required

___required: any

Private ___returnType

___returnType: any

Private ___translations

___translations: any

Private ___type

___type: any

allowNonPersistableEntities

allowNonPersistableEntities: boolean

attributeTypes

attributeTypes: IList<CustomWidgetAttributeType>

container

container: AbstractElement

containerAsWidgetPropertyType

containerAsWidgetPropertyType: WidgetPropertyType

defaultValue

defaultValue: string

entityProperty

entityProperty: string

enumerationValues

enumerationValues: IList<WidgetEnumerationValue>

id

id: string

isList

isList: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

  • if false, a load is required to access these properties.

isPath

isPath: IsPath

model

model: IModel

multiline

multiline: boolean

objectType

objectType: WidgetObjectType

parameterIsList

parameterIsList: boolean

pathType

pathType: PathType

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

required

required: boolean

returnType

returnType: WidgetReturnType

translations

translations: IList<WidgetTranslation>

type

type: WidgetValueTypeEnum

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new WidgetValueType instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns WidgetValueType

Static createIn

  • Creates and returns a new WidgetValueType instance in the SDK and on the server. The new WidgetValueType will be automatically stored in the 'valueType' property of the parent WidgetPropertyType element passed as argument.

    Parameters

    Returns WidgetValueType

Generated using TypeDoc