Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

Properties

__appStoreGuid: PrimitiveProperty<string> = ...
internal
__appStorePackageId: PrimitiveProperty<number> = ...
internal
__appStoreVersion: PrimitiveProperty<string> = ...
internal
__appStoreVersionGuid: PrimitiveProperty<string> = ...
internal
internal
internal
__exportLevel: EnumProperty<ModuleExportLevel> = ...
internal
internal
__fromAppStore: PrimitiveProperty<boolean> = ...
internal
__isReusableComponent: PrimitiveProperty<boolean> = ...
internal
__isThemeModule: PrimitiveProperty<boolean> = ...
internal
__moduleSecurity: StructuralChildProperty<IModuleSecurity> = ...
internal
__moduleSettings: StructuralChildProperty<IModuleSettings> = ...
internal
__name: PrimitiveProperty<string> = ...
internal
__sortIndex: PrimitiveProperty<number> = ...
internal
_container: null | IContainer
internal
_containmentName: string
internal
_declaredAsNamespace: boolean = false
internal
_isDoingDelete: boolean = false
internal
_isLoadable: boolean = true
internal
_isLoading: boolean = false
internal
_isPartial: boolean
internal
_isReadOnly: boolean = false
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
id: string
structureTypeName: string
structureTypeName: string = "Projects$Module"
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 appStoreGuid(): string
  • set appStoreGuid(newValue: string): void
  • get appStorePackageId(): number
  • set appStorePackageId(newValue: number): void
  • get appStoreVersion(): string
  • set appStoreVersion(newValue: string): void
  • get appStoreVersionGuid(): string
  • set appStoreVersionGuid(newValue: string): void
  • get container(): TContainer
  • The parent unit of this unit.

    Returns TContainer

  • get fromAppStore(): boolean
  • set fromAppStore(newValue: boolean): void
  • get isLoadable(): boolean
  • Whether this unit and all of its children (recursively) can be loaded.

    Returns boolean

  • get isLoaded(): boolean
  • Checks whether all attributes are available at this instant; if false, a load is required to access these properties.

    Returns boolean

  • get isReadOnly(): boolean
  • Whether this unit and all of its children (recursively) are editable.

    Returns boolean

  • get isReusableComponent(): boolean
  • set isReusableComponent(newValue: boolean): void
  • get isThemeModule(): boolean
  • set isThemeModule(newValue: boolean): void
  • get model(): TModel
  • Returns TModel

  • get name(): string
  • set name(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get sortIndex(): number
  • set sortIndex(newValue: number): void
  • The index of where this Module appears in the project. This property is required, and of type double. Also, its value needs to be unique among its siblings (meaning, in code: containerAsProject.modules) in the project. In other words: containerAsProject.modules.map(m => m.sortedIndex) (TS syntax) needs to be a list with unique values.

    Returns number

  • The index of where this Module appears in the project. This property is required, and of type double. Also, its value needs to be unique among its siblings (meaning, in code: containerAsProject.modules) in the project. In other words: containerAsProject.modules.map(m => m.sortedIndex) (TS syntax) needs to be a list with unique values.

    Parameters

    • newValue: number

    Returns void

  • get unit(): this
  • Unit that owns/contains this thing.

    Returns this

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
  • _handleCreateSelf(): void
  • _initializeDefaultProperties(): void
  • _initializeNewInstance(): void
  • _markCurrentValuesAsDefaults(): void
  • _markLoaded(): void
  • _markLoading(): void
  • _markNotLoaded(): void
  • _processLocalNameChange(previousName: null | string): 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

  • _registerAfterLoadCallback(callback: (unit: IAbstractUnit) => void): 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

  • _sendDeleteDelta(): void
  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • resolveByIdReferences(): void
  • 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 IAbstractElementJson

  • 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
  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates a new Module unit in the SDK and on the server. Expects one argument, the IProject in which this unit is contained.

    Parameters

    Returns Module

Generated using TypeDoc