Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MasterDetail

NOTE: This class is experimental and is subject to change in newer Model SDK versions.

In version 7.15.0: deleted In version 7.1.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

class

class: string

container

container: AbstractElement

containerAsBuildingBlock

containerAsBuildingBlock: BuildingBlock

containerAsDataView

containerAsDataView: DataView

containerAsDivContainer

containerAsDivContainer: DivContainer

containerAsGroupBox

containerAsGroupBox: GroupBox

containerAsHeader

containerAsHeader: Header

containerAsLayout

containerAsLayout: Layout

containerAsLayoutCallArgument

containerAsLayoutCallArgument: LayoutCallArgument

containerAsLayoutGridColumn

containerAsLayoutGridColumn: LayoutGridColumn

containerAsListView

containerAsListView: ListView

containerAsListViewTemplate

containerAsListViewTemplate: ListViewTemplate

containerAsMasterDetailRegion

containerAsMasterDetailRegion: MasterDetailRegion

containerAsNativeLayout

containerAsNativeLayout: NativeLayout

containerAsNativeLayoutCallArgument

containerAsNativeLayoutCallArgument: NativeLayoutCallArgument

containerAsNavigationListItem

containerAsNavigationListItem: NavigationListItem

containerAsNestedWidgetValue

containerAsNestedWidgetValue: NestedWidgetValue

containerAsPluginWidget

containerAsPluginWidget: PluginWidget

containerAsReportPane

containerAsReportPane: ReportPane

containerAsScrollContainerRegion

containerAsScrollContainerRegion: ScrollContainerRegion

containerAsSnippet

containerAsSnippet: Snippet

containerAsSplitPane

containerAsSplitPane: SplitPane

containerAsTabPage

containerAsTabPage: TabPage

containerAsTableCell

containerAsTableCell: TableCell

containerAsTemplateGridContents

containerAsTemplateGridContents: TemplateGridContents

containerAsTemplatedWidgetValue

containerAsTemplatedWidgetValue: TemplatedWidgetValue

containerAsVerticalFlow

containerAsVerticalFlow: VerticalFlow

detail

detail: MasterDetailDetailRegion

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

master

master: MasterDetailMasterRegion

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

model

model: IModel

name

name: string

structureTypeName

structureTypeName: string

style

style: string

tabIndex

tabIndex: number

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach()

  • Detaches this element from the model, so that it can be attached in a different place.

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise

  • 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: function
        • (elem: ): void

        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new MasterDetail 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 MasterDetail

Static createInBuildingBlockUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.7.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInDataViewUnderFooterWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInDataViewUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInDivContainerUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInGroupBoxUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInHeaderUnderLeftWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInHeaderUnderRightWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInLayoutCallArgumentUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInLayoutGridColumnUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInLayoutUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInListViewTemplateUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInListViewUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInMasterDetailRegionUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInNavigationListItemUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInScrollContainerRegionUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInSnippetUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInSplitPaneUnderFirstWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInSplitPaneUnderSecondWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInTabPageUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInTableCellUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInTemplateGridContentsUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Static createInVerticalFlowUnderWidgets

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns MasterDetail

Generated using TypeDoc