Options
All
  • Public
  • Public/Protected
  • All
Menu

In version 8.4.0: introduced

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

internal
internal
internal
__useAllPages: PrimitiveProperty<boolean> = ...
internal
internal
_container: null | IContainer
internal
_declaredAsNamespace: boolean = false
internal
_isDoingDelete: boolean = false
internal
_isPartial: boolean
internal
_isReverting: boolean = false

Indicates that the internal data of this element is being reverted to its previous value, so some validation check could be skipped

internal
_isUpdating: boolean = true

Indicates that the internal data of this element is being updated, as a result of data received from the server, so no storage events should be send

internal
internal
_registeredQualifiedName: null | string = null

used by qualified names cache to determine old name after a rename

internal
_state: StructureState = "attached"

The current state of the structure: (new|attached|detached|deleted).

internal
internal
id: string
structureTypeName: string
structureTypeName: string = "Pages$PageVariable"
versionInfo: StructureVersionInfo = ...

Accessors

  • get _isAttached(): boolean
  • This structure is attached somewhere in the model. This is the "normal" state for an structure.

    internal

    Returns boolean

  • get _isDeleted(): boolean
  • This structure has been deleted and should no longer be used.

    internal

    Returns boolean

  • get _isDetached(): boolean
  • This structure is detached, so that it can be attached somewhere else in the model.

    internal

    Returns boolean

  • get _isNew(): boolean
  • This structure was just constructed and has not been added to the model yet.

    internal

    Returns boolean

  • get container(): TContainer
  • Returns TContainer

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

  • In version 10.17.0: introduced

    Returns null | LocalVariable

  • In version 10.17.0: introduced

    Parameters

    Returns void

  • get localVariableLocalName(): null | string
  • Returns null | string

  • get model(): TModel
  • Returns TModel

  • In version 9.5.0: introduced

    Returns null | PageParameter

  • In version 9.5.0: introduced

    Parameters

    Returns void

  • get pageParameterLocalName(): null | string
  • Returns null | string

  • get snippetParameterLocalName(): null | string
  • Returns null | string

  • get useAllPages(): boolean
  • set useAllPages(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get widgetLocalName(): null | string
  • Returns null | string

Methods

  • Asserts that the complete element is available, and not just its public part.

    internal

    Parameters

    Returns void

  • Finds the given child among the properties of this structure, returning a handle to detach it later when appropriate based on in which property is was found.

    internal

    Parameters

    Returns null | IChildHandle

  • _deleteInternal(): void
  • _dispose(): void
  • This model element is no longer part of the model, and can be cleaned up.

    internal

    Returns void

  • _getQualifiedName(): null | string
  • _initializeDefaultProperties(): void
  • _initializeNewInstance(): void
  • _isByNameReferrable(): boolean
  • Return true if this is an abstractElement that might be referred to by some other element. If true, this element is maintained in the qualifiedNamesCache

    internal

    Returns boolean

  • _markCurrentValuesAsDefaults(): void
  • _processLocalNameChange(previousName: null | string): void
  • Update local-by-name references to this structure.

    internal

    Parameters

    • previousName: null | string

    Returns void

  • _processNameChange(): void
  • If the name of a model element changes, this might effect currently broken references-by-name, so let's process those.

    internal

    Returns void

  • _registerProperty(prop: AbstractProperty<any, any>, declaredOn: IStructureClass): void
  • _scheduleDeltaAfterCreate(delta: Delta): void
  • _sendChangeDelta(propertyName: string, newValue: any, changeType?: "CHANGE" | "ADD" | "REMOVE", index?: number): void
  • Sends the change delta in case a simple property has changed.

    internal

    Parameters

    • propertyName: string
    • newValue: any
    • changeType: "CHANGE" | "ADD" | "REMOVE" = "CHANGE"
    • index: number = -1

    Returns void

  • Sends the appropriate create delta to the server, and also sends all pending deltas, after this element has been assigned to some parent.

    internal

    Parameters

    Returns void

  • _sendDeleteDelta(): void
  • Sends the delete in case that we were removed from the model.

    internal

    Returns void

  • _sendDetachDelta(): void
  • Update an existing (probably partial) interface with real contents received from the server.

    internal

    Parameters

    Returns void

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

    Returns PageVariable

  • delete(): void
  • Deletes this element from the model.

    Returns void

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns PageVariable

  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: PageVariable) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<PageVariable>
  • 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.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<PageVariable>

  • resolveByIdReferences(): void
  • Should be called after deserialization / remote updates, to make sure all references are bound to their actual value.

    internal

    Returns void

  • toJSON(): IStructureJSON
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new PageVariable 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

    • model: IModel

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 9.24.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 8.8.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 9.24.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 9.24.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 10.4.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 10.0.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 8.4.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 8.4.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 9.7.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 9.21.0 and higher

    Parameters

    Returns PageVariable

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

    Warning! Can only be used on models with the following Mendix meta model versions: 10.14.0 and higher

    Parameters

    Returns PageVariable

  • Creates and returns a new PageVariable instance in the SDK and on the server. The new PageVariable will be automatically stored in the 'sourceVariable' property of the parent customwidgets.WidgetValue element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 8.8.0 and higher

    Parameters

    Returns PageVariable

Generated using TypeDoc