Class Layout

See: relevant section in reference guide

Hierarchy

FormBase
- Layout

Implements

ILayout

Constructors

constructor

new Layout(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, container: IFolderBase): Layout

Overrides FormBase.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- container: IFolderBase
Returns Layout

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Pages$Layout"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

acceptButtonPlaceholder

get acceptButtonPlaceholder(): null | ILayoutParameter
set acceptButtonPlaceholder(newValue: null | ILayoutParameter): void

In version 6.8.0: deleted

Returns null | ILayoutParameter
In version 6.8.0: deleted

Parameters
- newValue: null | ILayoutParameter
Returns void

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

get appearance(): Appearance
set appearance(newValue: Appearance): void

In version 8.0.0: introduced

Returns Appearance
In version 8.0.0: introduced

Parameters
- newValue: Appearance
Returns void

cancelButtonPlaceholder

get cancelButtonPlaceholder(): null | ILayoutParameter
set cancelButtonPlaceholder(newValue: null | ILayoutParameter): void

In version 6.8.0: deleted

Returns null | ILayoutParameter
In version 6.8.0: deleted

Parameters
- newValue: null | ILayoutParameter
Returns void

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

Inherited from FormBase.canvasHeight
Returns number
Inherited from FormBase.canvasHeight
Parameters
- newValue: number
Returns void

canvasWidth

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

Inherited from FormBase.canvasWidth
Returns number
Inherited from FormBase.canvasWidth
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

Implementation of ILayout.container
Inherited from FormBase.container

The parent unit of this unit.

Returns TContainer

containerAsFolderBase

get containerAsFolderBase(): FolderBase

Implementation of ILayout.containerAsFolderBase
Overrides FormBase.containerAsFolderBase
Returns FolderBase

containerAsModule

get containerAsModule(): Module

Implementation of ILayout.containerAsModule
Inherited from FormBase.containerAsModule
Returns Module

content

get content(): LayoutContent
set content(newValue: LayoutContent): void

Implementation of ILayout.content

In version 8.0.0: introduced

Returns LayoutContent
Implementation of ILayout.content

In version 8.0.0: introduced

Parameters
- newValue: LayoutContent
Returns void

documentation

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

Implementation of ILayout.documentation
Inherited from FormBase.documentation

In version 9.10.0: added public

Returns string
Implementation of ILayout.documentation
Inherited from FormBase.documentation

In version 9.10.0: added public

Parameters
- newValue: string
Returns void

excluded

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

Implementation of ILayout.excluded
Inherited from FormBase.excluded

In version 9.11.0: added public

Returns boolean
Implementation of ILayout.excluded
Inherited from FormBase.excluded

In version 9.11.0: added public

Parameters
- newValue: boolean
Returns void

exportLevel

get exportLevel(): ExportLevel
set exportLevel(newValue: ExportLevel): void

Inherited from FormBase.exportLevel

In version 9.3.0: introduced

Returns ExportLevel
Inherited from FormBase.exportLevel

In version 9.3.0: introduced

Parameters
- newValue: ExportLevel
Returns void

isLoadable

get isLoadable(): boolean

Implementation of ILayout.isLoadable
Inherited from FormBase.isLoadable

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

Returns boolean

isLoaded

get isLoaded(): boolean

Implementation of ILayout.isLoaded
Inherited from FormBase.isLoaded

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

Implementation of ILayout.isReadOnly
Inherited from FormBase.isReadOnly

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

Returns boolean

layoutCall

get layoutCall(): null | LayoutCall
set layoutCall(newValue: null | LayoutCall): void

Implementation of ILayout.layoutCall

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

Returns null | LayoutCall
Implementation of ILayout.layoutCall

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

Parameters
- newValue: null | LayoutCall
Returns void

layoutType

get layoutType(): LayoutType
set layoutType(newValue: LayoutType): void

Implementation of ILayout.layoutType

In version 8.0.0: deleted In version 6.8.0: added public

Returns LayoutType
Implementation of ILayout.layoutType

In version 8.0.0: deleted In version 6.8.0: added public

Parameters
- newValue: LayoutType
Returns void

mainPlaceholder

get mainPlaceholder(): null | ILayoutParameter
set mainPlaceholder(newValue: null | ILayoutParameter): void

In version 6.8.0: deleted

Returns null | ILayoutParameter
In version 6.8.0: deleted

Parameters
- newValue: null | ILayoutParameter
Returns void

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

Implementation of ILayout.model
Inherited from FormBase.model
Returns TModel

name

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

Implementation of ILayout.name
Inherited from FormBase.name
Returns string
Implementation of ILayout.name
Inherited from FormBase.name
Parameters
- newValue: string
Returns void

qualifiedName

get qualifiedName(): null | string

Implementation of ILayout.qualifiedName
Inherited from FormBase.qualifiedName

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

Implementation of ILayout.unit
Inherited from FormBase.unit

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

widget

get widget(): null | pages.Widget
set widget(newValue: null | pages.Widget): void

In version 7.15.0: deleted

Returns null | pages.Widget
In version 7.15.0: deleted

Parameters
- newValue: null | pages.Widget
Returns void

widgets

get widgets(): IList<pages.Widget>

In version 8.0.0: deleted In version 7.15.0: introduced

Returns IList<pages.Widget>

Methods

allProperties

allProperties(): AbstractProperty<any, any>[]

Implementation of ILayout.allProperties
Inherited from FormBase.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): Layout

Implementation of ILayout.asLoaded
Inherited from FormBase.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

Implementation of ILayout.delete
Inherited from FormBase.delete

Deletes this element from the model.

Returns void

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Implementation of ILayout.findElementById
Inherited from FormBase.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from FormBase.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

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

Implementation of ILayout.load
Inherited from FormBase.load
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
  - - (elem: Layout): void
    - Parameters
      - elem: Layout
      Returns void
- Optional forceRefresh: boolean
Returns void
Implementation of ILayout.load
Inherited from FormBase.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<Layout>

loadedProperties

loadedProperties(): AbstractProperty<any, any>[]

Implementation of ILayout.loadedProperties
Inherited from FormBase.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

publicProperties(): AbstractProperty<any, any>[]

Implementation of ILayout.publicProperties
Inherited from FormBase.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IAbstractElementJson

Implementation of ILayout.toJSON
Inherited from FormBase.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

Implementation of ILayout.traverse
Inherited from FormBase.traverse

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
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

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

Implementation of ILayout.traverseFind
Inherited from FormBase.traverseFind

Traverses this structure, returning immediately when visit returns something other than null.

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

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

Implementation of ILayout.traversePublicParts
Inherited from FormBase.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static createIn

createIn(container: IFolderBase): Layout

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
- container: IFolderBase
Returns Layout

Generated using TypeDoc