Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupBox

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___caption

___caption: any

Private ___collapsible

___collapsible: any

Private ___widget

___widget: any

caption

caption: ClientTemplate

class

class: string

collapsible

collapsible: GroupBoxCollapsible

conditionalVisibilitySettings

conditionalVisibilitySettings: ConditionalVisibilitySettings

container

container: AbstractElement

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

containerAsNavigationListItem

containerAsNavigationListItem: NavigationListItem

containerAsReportPane

containerAsReportPane: ReportPane

containerAsScrollContainerRegion

containerAsScrollContainerRegion: ScrollContainerRegion

containerAsSnippet

containerAsSnippet: Snippet

containerAsSplitPane

containerAsSplitPane: SplitPane

containerAsTabPage

containerAsTabPage: TabPage

containerAsTableCell

containerAsTableCell: TableCell

containerAsTemplateGridContents

containerAsTemplateGridContents: TemplateGridContents

containerAsVerticalFlow

containerAsVerticalFlow: VerticalFlow

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

style

style: string

tabIndex

tabIndex: number

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

widget

widget: Widget

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

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

Static createInDataViewUnderFooterWidget

  • Creates and returns a new GroupBox instance in the SDK and on the server. The new GroupBox 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: [6.7.0, 6.8.0, 6.9.0, 6.10.0]

    Parameters

    Returns GroupBox

Static createInDataViewUnderWidget

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

    Parameters

    Returns GroupBox

Static createInDivContainerUnderWidget

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

    Parameters

    Returns GroupBox

Static createInGroupBoxUnderWidget

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

    Parameters

    Returns GroupBox

Static createInHeaderUnderLeftWidget

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

    Parameters

    Returns GroupBox

Static createInHeaderUnderRightWidget

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

    Parameters

    Returns GroupBox

Static createInLayoutCallArgumentUnderWidget

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

    Parameters

    Returns GroupBox

Static createInLayoutGridColumnUnderWidget

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

    Parameters

    Returns GroupBox

Static createInLayoutUnderWidget

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

    Parameters

    Returns GroupBox

Static createInListViewTemplateUnderWidget

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

    Parameters

    Returns GroupBox

Static createInListViewUnderWidget

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

    Parameters

    Returns GroupBox

Static createInNavigationListItemUnderWidget

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

    Parameters

    Returns GroupBox

Static createInReportPaneUnderParameterWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: [6.0.0, 6.0.1, 6.1.0, 6.2.0, 6.3.0, 6.4.0, 6.4.1, 6.5.0, 6.6.0, 6.7.0, 6.8.0, 6.9.0]

    Parameters

    Returns GroupBox

Static createInReportPaneUnderReportWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: [6.0.0, 6.0.1, 6.1.0, 6.2.0, 6.3.0, 6.4.0, 6.4.1, 6.5.0, 6.6.0, 6.7.0, 6.8.0, 6.9.0]

    Parameters

    Returns GroupBox

Static createInScrollContainerRegionUnderWidget

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

    Parameters

    Returns GroupBox

Static createInSnippetUnderWidget

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

    Parameters

    Returns GroupBox

Static createInSplitPaneUnderFirstWidget

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

    Parameters

    Returns GroupBox

Static createInSplitPaneUnderSecondWidget

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

    Parameters

    Returns GroupBox

Static createInTabPageUnderWidget

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

    Parameters

    Returns GroupBox

Static createInTableCellUnderWidget

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

    Parameters

    Returns GroupBox

Static createInTemplateGridContentsUnderWidget

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

    Parameters

    Returns GroupBox

Static createInVerticalFlowUnderWidgets

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

    Parameters

    Returns GroupBox

Generated using TypeDoc