Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageSettings

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private ___formTitle

___formTitle: any

Private ___location

___location: any

Private ___page

___page: any

container

container: AbstractElement

containerAsAssociationWidget

containerAsAssociationWidget: AssociationWidget

containerAsDataGridAddButton

containerAsDataGridAddButton: DataGridAddButton

containerAsGridEditButton

containerAsGridEditButton: GridEditButton

containerAsGridNewButton

containerAsGridNewButton: GridNewButton

containerAsNewButton

containerAsNewButton: NewButton

containerAsPageClientAction

containerAsPageClientAction: PageClientAction

containerAsPageForSpecialization

containerAsPageForSpecialization: PageForSpecialization

containerAsReferenceSelector

containerAsReferenceSelector: ReferenceSelector

containerAsShowPageAction

containerAsShowPageAction: ShowPageAction

formTitle

formTitle: Text

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

location

location: FormLocation

model

model: IModel

page

page: IPage

pageQualifiedName

pageQualifiedName: string

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

Static typeName

typeName: string

Static versionInfo

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

Static createInAssociationWidgetUnderSelectPageSettings

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

    Parameters

    Returns PageSettings

Static createInDataGridAddButtonUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInGridEditButtonUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInGridNewButtonUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInNewButtonUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInPageClientActionUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInPageForSpecializationUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInReferenceSelectorUnderGotoPageSettings

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

    Parameters

    Returns PageSettings

Static createInShowPageActionUnderPageSettings

  • Creates and returns a new PageSettings instance in the SDK and on the server. The new PageSettings will be automatically stored in the 'pageSettings' property of the parent microflows.ShowPageAction element passed as argument.

    Parameters

    Returns PageSettings

Generated using TypeDoc