Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

__accessibilitySettings: PartProperty<AccessibilitySettings> = ...
internal
__appearance: PartProperty<Appearance> = ...
internal
__ariaRequired: PrimitiveProperty<boolean> = ...
internal
__attributePath: PrimitiveProperty<string> = ...
internal
__attributeRef: PartProperty<AttributeRef> = ...
internal
__autoFocus: PrimitiveProperty<boolean> = ...
internal
__class: PrimitiveProperty<string> = ...
internal
__conditionalEditabilitySettings: PartProperty<ConditionalEditabilitySettings> = ...
internal
__conditionalVisibilitySettings: PartProperty<ConditionalVisibilitySettings> = ...
internal
__editable: EnumProperty<EditableEnum> = ...
internal
__label: PartProperty<Text> = ...
internal
__labelTemplate: PartProperty<ClientTemplate> = ...
internal
__maxLengthCode: PrimitiveProperty<number> = ...
internal
__name: PrimitiveProperty<string> = ...
internal
__onChangeAction: PartProperty<ClientAction> = ...
internal
__onChangeMicroflowSettings: PartProperty<MicroflowSettings> = ...
internal
__onEnterAction: PartProperty<ClientAction> = ...
internal
__onEnterMicroflowSettings: PartProperty<MicroflowSettings> = ...
internal
__onLeaveAction: PartProperty<ClientAction> = ...
internal
__onLeaveMicroflowSettings: PartProperty<MicroflowSettings> = ...
internal
__placeholder: PartProperty<Text> = ...
internal
__placeholderTemplate: PartProperty<ClientTemplate> = ...
internal
__readOnlyStyle: EnumProperty<ReadOnlyStyle> = ...
internal
__required: PrimitiveProperty<boolean> = ...
internal
__requiredMessage: PartProperty<Text> = ...
internal
__screenReaderLabel: PartProperty<ClientTemplate> = ...
internal
__sourceVariable: PartProperty<PageVariable> = ...
internal
__style: PrimitiveProperty<string> = ...
internal
__tabIndex: PrimitiveProperty<number> = ...
internal
__validation: PartProperty<WidgetValidation> = ...
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$TextWidget"
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

  • In version 9.24.0: deleted In version 9.22.0: introduced

    Returns null | AccessibilitySettings

  • In version 9.24.0: deleted In version 9.22.0: introduced

    Parameters

    Returns void

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns void

  • get ariaRequired(): boolean
  • set ariaRequired(newValue: boolean): void
  • In version 9.2.0: introduced

    Returns boolean

  • In version 9.2.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get attributePath(): string
  • set attributePath(newValue: string): void
  • The value of this property is conceptually of type paths.LegacyAttributePath.

    In version 7.11.0: deleted

    Returns string

  • The value of this property is conceptually of type paths.LegacyAttributePath.

    In version 7.11.0: deleted

    Parameters

    • newValue: string

    Returns void

  • In version 7.11.0: introduced

    Returns null | AttributeRef

  • In version 7.11.0: introduced

    Parameters

    Returns void

  • get autoFocus(): boolean
  • set autoFocus(newValue: boolean): void
  • In version 9.15.0: introduced

    Returns boolean

  • In version 9.15.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get class(): string
  • set class(newValue: string): void
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns void

  • get container(): TContainer
  • Returns TContainer

  • Returns BuildingBlock

  • Returns pages.DataView

  • Returns DivContainer

  • Returns GroupBox

  • Returns pages.Header

  • get containerAsLayout(): Layout
  • Returns Layout

  • Returns LayoutCallArgument

  • Returns LayoutGridColumn

  • Returns ListView

  • Returns ListViewTemplate

  • get containerAsMasterDetailRegion(): MasterDetailRegion
  • Returns MasterDetailRegion

  • get containerAsNativeLayout(): NativeLayout
  • Returns NativeLayout

  • get containerAsNativeLayoutCallArgument(): NativeLayoutCallArgument
  • Returns NativeLayoutCallArgument

  • Returns NativeLayoutContent

  • Returns NavigationListItem

  • Returns ReportPane

  • Returns Snippet

  • Returns SplitPane

  • Returns TabPage

  • Returns pages.TableCell

  • Returns VerticalFlow

  • Returns WebLayoutContent

  • Returns WidgetValue

  • Returns EditableEnum

  • Parameters

    Returns void

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

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

    Returns boolean

  • get label(): null | Text
  • set label(newValue: null | Text): void
  • In version 7.18.0: deleted

    Returns null | Text

  • In version 7.18.0: deleted

    Parameters

    • newValue: null | Text

    Returns void

  • In version 7.18.0: introduced

    Returns null | ClientTemplate

  • In version 7.18.0: introduced

    Parameters

    Returns void

  • get maxLengthCode(): number
  • set maxLengthCode(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get model(): TModel
  • Returns TModel

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

  • Parameters

    • newValue: string

    Returns void

  • In version 7.13.0: introduced

    Returns ClientAction

  • In version 7.13.0: introduced

    Parameters

    Returns void

  • In version 7.13.0: deleted

    Returns MicroflowSettings

  • In version 7.13.0: deleted

    Parameters

    Returns void

  • In version 7.13.0: introduced

    Returns ClientAction

  • In version 7.13.0: introduced

    Parameters

    Returns void

  • In version 7.13.0: deleted

    Returns MicroflowSettings

  • In version 7.13.0: deleted

    Parameters

    Returns void

  • In version 7.13.0: introduced

    Returns ClientAction

  • In version 7.13.0: introduced

    Parameters

    Returns void

  • In version 7.13.0: deleted

    Returns MicroflowSettings

  • In version 7.13.0: deleted

    Parameters

    Returns void

  • get placeholder(): Text
  • set placeholder(newValue: Text): void
  • In version 10.11.0: deleted

    Returns Text

  • In version 10.11.0: deleted

    Parameters

    Returns void

  • In version 10.11.0: introduced

    Returns ClientTemplate

  • In version 10.11.0: introduced

    Parameters

    Returns void

  • In version 6.9.0: introduced

    Returns ReadOnlyStyle

  • In version 6.9.0: introduced

    Parameters

    Returns void

  • get required(): boolean
  • set required(newValue: boolean): void
  • In version 7.6.0: deleted

    Returns boolean

  • In version 7.6.0: deleted

    Parameters

    • newValue: boolean

    Returns void

  • get requiredMessage(): Text
  • set requiredMessage(newValue: Text): void
  • In version 7.6.0: deleted

    Returns Text

  • In version 7.6.0: deleted

    Parameters

    Returns void

  • In version 8.12.0: introduced

    Returns null | ClientTemplate

  • In version 8.12.0: introduced

    Parameters

    Returns void

  • In version 8.8.0: introduced

    Returns null | PageVariable

  • In version 8.8.0: introduced

    Parameters

    Returns void

  • get style(): string
  • set style(newValue: string): void
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns void

  • get tabIndex(): number
  • set tabIndex(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • In version 7.6.0: introduced

    Returns WidgetValidation

  • In version 7.6.0: introduced

    Parameters

    Returns void

Methods

  • _deleteInternal(): void
  • _dispose(): void
  • _getQualifiedName(): null | string
  • _initializeDefaultProperties(): void
  • _initializeNewInstance(): void
  • _isByNameReferrable(): boolean
  • _markCurrentValuesAsDefaults(): void
  • _processLocalNameChange(previousName: null | string): void
  • _processNameChange(): 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
  • _sendDetachDelta(): 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 TextWidget

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

  • resolveByIdReferences(): 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
  • traversePublicParts(visit: (structure: IStructure) => void): void

Generated using TypeDoc