Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomWidgetType

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___description

___description: any

Private ___name

___name: any

Private ___needsEntityContext

___needsEntityContext: any

Private ___objectType

___objectType: any

Private ___offlineCapable

___offlineCapable: any

Private ___phoneGapEnabled

___phoneGapEnabled: any

Private ___widgetId

___widgetId: any

container

container: AbstractElement

containerAsCustomWidget

containerAsCustomWidget: CustomWidget

description

description: string

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

name

name: string

needsEntityContext

needsEntityContext: boolean

objectType

objectType: WidgetObjectType

offlineCapable

offlineCapable: boolean

phoneGapEnabled

phoneGapEnabled: boolean

qualifiedName

qualifiedName: string

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

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

widgetId

widgetId: string

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 CustomWidgetType 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 CustomWidgetType

Static createIn

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

    Parameters

    Returns CustomWidgetType

Generated using TypeDoc