Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layout

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected __acceptButtonPlaceholder

__acceptButtonPlaceholder: ByNameReferenceProperty<ILayoutParameter> = ...
internal

Protected __acceptPlaceholderName

__acceptPlaceholderName: PrimitiveProperty<string> = ...
internal

Protected __appearance

__appearance: PartProperty<Appearance> = ...
internal

Protected __cancelButtonPlaceholder

__cancelButtonPlaceholder: ByNameReferenceProperty<ILayoutParameter> = ...
internal

Protected __cancelPlaceholderName

__cancelPlaceholderName: PrimitiveProperty<string> = ...
internal

Protected __canvasHeight

__canvasHeight: PrimitiveProperty<number> = ...
internal

Protected __canvasWidth

__canvasWidth: PrimitiveProperty<number> = ...
internal

Protected __class

__class: PrimitiveProperty<string> = ...
internal

Protected __content

__content: PartProperty<LayoutContent> = ...
internal

Protected __documentation

__documentation: PrimitiveProperty<string> = ...
internal

Protected __excluded

__excluded: PrimitiveProperty<boolean> = ...
internal

Protected __exportLevel

__exportLevel: EnumProperty<ExportLevel> = ...
internal

Protected __layoutCall

__layoutCall: PartProperty<LayoutCall> = ...
internal

Protected __layoutType

__layoutType: EnumProperty<LayoutType> = ...
internal

Protected __mainPlaceholder

__mainPlaceholder: ByNameReferenceProperty<ILayoutParameter> = ...
internal

Protected __mainPlaceholderName

__mainPlaceholderName: PrimitiveProperty<string> = ...
internal

Protected __name

__name: PrimitiveProperty<string> = ...
internal

Protected __style

__style: PrimitiveProperty<string> = ...
internal

Protected __useMainPlaceholderForPopups

__useMainPlaceholderForPopups: PrimitiveProperty<boolean> = ...
internal

Protected __widget

__widget: PartProperty<pages.Widget> = ...
internal

Protected __widgets

__widgets: PartListProperty<pages.Widget> = ...
internal

_container

_container: null | IContainer
internal

_containmentName

_containmentName: string
internal

_declaredAsNamespace

_declaredAsNamespace: boolean = false
internal

Protected _isDoingDelete

_isDoingDelete: boolean = false
internal

_isLoadable

_isLoadable: boolean = true
internal

_isLoading

_isLoading: boolean = false
internal

_isPartial

_isPartial: boolean
internal

_isReadOnly

_isReadOnly: boolean = false
internal

_isReverting

_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

_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

_markLoaded

_markLoaded: () => void = AbstractUnit.prototype._markLoaded

Type declaration

    • (): void
    • internal

      Returns void

_markLoading

_markLoading: () => void = AbstractUnit.prototype._markLoading

Type declaration

    • (): void
    • internal

      Returns void

_markNotLoaded

_markNotLoaded: () => void = AbstractUnit.prototype._markNotLoaded

Type declaration

    • (): void
    • internal

      Returns void

_model

_model: AbstractModel
internal

_registerAfterLoadCallback

_registerAfterLoadCallback: (callback: ICallback<IAbstractUnit>) => void = AbstractUnit.prototype._registerAfterLoadCallback

Type declaration

_registeredQualifiedName

_registeredQualifiedName: null | string = null

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

internal

_state

_state: StructureState = "attached"

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

internal

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Pages$Layout"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

_isAttached

  • get _isAttached(): boolean

  • This structure is attached somewhere in the model. This is the "normal" state for an structure.

    internal

    Returns boolean

_isDeleted

  • get _isDeleted(): boolean

  • This structure has been deleted and should no longer be used.

    internal

    Returns boolean

_isDetached

  • get _isDetached(): boolean

  • This structure is detached, so that it can be attached somewhere else in the model.

    internal

    Returns boolean

_isNew

  • get _isNew(): boolean

  • This structure was just constructed and has not been added to the model yet.

    internal

    Returns boolean

acceptButtonPlaceholder

acceptButtonPlaceholderQualifiedName

  • get acceptButtonPlaceholderQualifiedName(): null | string

  • Returns null | string

acceptPlaceholderName

  • get acceptPlaceholderName(): string
  • set acceptPlaceholderName(newValue: string): void

  • In version 7.9.0: deleted In version 6.8.0: introduced

    Returns string

  • In version 7.9.0: deleted In version 6.8.0: introduced

    Parameters

    • newValue: string

    Returns void

appearance

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns void

cancelButtonPlaceholder

cancelButtonPlaceholderQualifiedName

  • get cancelButtonPlaceholderQualifiedName(): null | string

  • Returns null | string

cancelPlaceholderName

  • get cancelPlaceholderName(): string
  • set cancelPlaceholderName(newValue: string): void

  • In version 7.9.0: deleted In version 6.8.0: introduced

    Returns string

  • In version 7.9.0: deleted In version 6.8.0: introduced

    Parameters

    • newValue: string

    Returns void

canvasHeight

  • get canvasHeight(): number
  • set canvasHeight(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

canvasWidth

  • get canvasWidth(): number
  • set canvasWidth(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

class

  • 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

container

  • get container(): TContainer

  • The parent unit of this unit.

    Returns TContainer

containerAsFolderBase

containerAsModule

  • get containerAsModule(): Module

content

documentation

  • get documentation(): string
  • set documentation(newValue: string): void

  • In version 9.10.0: added public

    Returns string

  • In version 9.10.0: added public

    Parameters

    • newValue: string

    Returns void

excluded

  • get excluded(): boolean
  • set excluded(newValue: boolean): void

  • In version 9.11.0: added public

    Returns boolean

  • In version 9.11.0: added public

    Parameters

    • newValue: boolean

    Returns void

exportLevel

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    Returns void

isLoadable

  • get isLoadable(): boolean

  • Whether this unit and all of its children (recursively) can be loaded.

    Returns boolean

isLoaded

  • get isLoaded(): boolean

  • Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

  • Whether this unit and all of its children (recursively) are editable.

    Returns boolean

layoutCall

  • In version 8.0.0: deleted In version 7.17.0: added public In version 6.8.0: added optional

    Returns null | LayoutCall

  • In version 8.0.0: deleted In version 7.17.0: added public In version 6.8.0: added optional

    Parameters

    Returns void

layoutType

mainPlaceholder

mainPlaceholderName

  • get mainPlaceholderName(): string
  • set mainPlaceholderName(newValue: string): void

  • In version 7.9.0: deleted In version 6.8.0: introduced

    Returns string

  • In version 7.9.0: deleted In version 6.8.0: introduced

    Parameters

    • newValue: string

    Returns void

mainPlaceholderQualifiedName

  • get mainPlaceholderQualifiedName(): null | string

  • Returns null | string

model

  • get model(): TModel

  • Returns TModel

name

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

qualifiedName

  • get qualifiedName(): null | string

  • Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

    Returns null | string

style

  • 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

unit

  • get unit(): this

  • Unit that owns/contains this thing.

    Returns this

useMainPlaceholderForPopups

  • get useMainPlaceholderForPopups(): boolean
  • set useMainPlaceholderForPopups(newValue: boolean): void

  • In version 7.9.0: deleted

    Returns boolean

  • In version 7.9.0: deleted

    Parameters

    • newValue: boolean

    Returns void

versionInfo

widget

  • In version 7.15.0: deleted

    Returns null | pages.Widget

  • In version 7.15.0: deleted

    Parameters

    Returns void

widgets

  • In version 8.0.0: deleted In version 7.15.0: introduced

    Returns IList<pages.Widget>

Methods

_assertLoaded

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

    internal

    Parameters

    Returns void

_cacheElement

_childHandle

  • 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

_deleteChild

_deleteInternal

  • _deleteInternal(): void

_detachChild

_dispose

  • _dispose(): void

_getQualifiedName

  • _getQualifiedName(): null | string

_handleCreateSelf

  • _handleCreateSelf(): void

_initializeDefaultProperties

  • _initializeDefaultProperties(): void

_initializeNewInstance

  • _initializeNewInstance(): void

_isByNameReferrable

  • _isByNameReferrable(): boolean

_markCurrentValuesAsDefaults

  • _markCurrentValuesAsDefaults(): void

_processLocalNameChange

  • _processLocalNameChange(previousName: null | string): void

  • Update local-by-name references to this structure.

    internal

    Parameters

    • previousName: null | string

    Returns void

_processNameChange

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

  • _registerProperty(prop: AbstractProperty<any, any>, declaredOn: IStructureClass): void

_resolveLocalName

  • _resolveLocalName(elementTypeName: string, name: null | string): null | IAbstractElement

  • Given the type and name of an element, returns the element in this model unit with the specified type and name if there is exactly one matching element, otherwise null.

    internal

    Parameters

    • elementTypeName: string
    • name: null | string

    Returns null | IAbstractElement

_scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: Delta): void

_sendChangeDelta

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

  • _sendDeleteDelta(): void

  • Sends the delete in case that we were removed from the model.

    internal

    Returns void

_startUsingElementsCache

  • _startUsingElementsCache(): void

_stopUsingElementsCache

  • _stopUsingElementsCache(): void

Protected _updateElementsContainer

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

    internal

    Parameters

    Returns void

_updateWithJson

_updateWithJsonImpl

allProperties

asLoaded

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

delete

  • delete(): void

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: (elem: Layout) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Layout>

  • 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

    • callback: (elem: Layout) => void
    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Layout>

loadedProperties

publicProperties

resolveByIdReferences

  • resolveByIdReferences(): void

toJSON

  • 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

  • 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

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): void

Static createIn

  • Creates a new Layout unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns Layout

Generated using TypeDoc