class sap.ui.layout.form.ColumnContainerData

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/layout/form/ColumnContainerData
Application Component: CA-UI5-CMP

The ColumnLayout-specific layout data for the FormContainer element.

Depending on its size, the Form control is divided into 1, 2, 3 or 4 columns by the ColumnLayout control. Using ColumnContainerData, the size of the FormContainer element can be influenced.


Constructor

Constructor for a new sap.ui.layout.form.ColumnContainerData.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.layout.form.ColumnContainerData(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
columnsL sap.ui.layout.form.ColumnsL 2

Number of columns the FormContainer element uses if the Form control has large size.

The number of columns for large size must not be smaller than the number of columns for medium size.

Visibility: public
columnsM sap.ui.layout.form.ColumnsM 1

Number of columns the FormContainer element uses if the Form control has medium size.

Visibility: public
columnsXL sap.ui.layout.form.ColumnsXL 2

Number of columns the FormContainer element uses if the Form control has extra-large size.

The number of columns for extra-large size must not be smaller than the number of columns for large size.

Visibility: public

Methods Overview

Method Description
sap.ui.layout.form.ColumnContainerData.extend

Creates a new subclass of class sap.ui.layout.form.ColumnContainerData with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.LayoutData.extend.

getColumnsL

Gets current value of property columnsL.

Number of columns the FormContainer element uses if the Form control has large size.

The number of columns for large size must not be smaller than the number of columns for medium size.

Default value is 2.

getColumnsM

Gets current value of property columnsM.

Number of columns the FormContainer element uses if the Form control has medium size.

Default value is 1.

getColumnsXL

Gets current value of property columnsXL.

Number of columns the FormContainer element uses if the Form control has extra-large size.

The number of columns for extra-large size must not be smaller than the number of columns for large size.

Default value is 2.

sap.ui.layout.form.ColumnContainerData.getMetadata

Returns a metadata object for class sap.ui.layout.form.ColumnContainerData.

setColumnsL

Sets a new value for property columnsL.

Number of columns the FormContainer element uses if the Form control has large size.

The number of columns for large size must not be smaller than the number of columns for medium size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 2.

setColumnsM

Sets a new value for property columnsM.

Number of columns the FormContainer element uses if the Form control has medium size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

setColumnsXL

Sets a new value for property columnsXL.

Number of columns the FormContainer element uses if the Form control has extra-large size.

The number of columns for extra-large size must not be smaller than the number of columns for large size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 2.

sap.ui.layout.form.ColumnContainerData.extend

Creates a new subclass of class sap.ui.layout.form.ColumnContainerData with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.LayoutData.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getColumnsL

Gets current value of property columnsL.

Number of columns the FormContainer element uses if the Form control has large size.

The number of columns for large size must not be smaller than the number of columns for medium size.

Default value is 2.

getColumnsM

Gets current value of property columnsM.

Number of columns the FormContainer element uses if the Form control has medium size.

Default value is 1.

getColumnsXL

Gets current value of property columnsXL.

Number of columns the FormContainer element uses if the Form control has extra-large size.

The number of columns for extra-large size must not be smaller than the number of columns for large size.

Default value is 2.

sap.ui.layout.form.ColumnContainerData.getMetadata

Returns a metadata object for class sap.ui.layout.form.ColumnContainerData.

setColumnsL

Sets a new value for property columnsL.

Number of columns the FormContainer element uses if the Form control has large size.

The number of columns for large size must not be smaller than the number of columns for medium size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 2.

Param Type DefaultValue Description
sColumnsL sap.ui.layout.form.ColumnsL 2

New value for property columnsL

setColumnsM

Sets a new value for property columnsM.

Number of columns the FormContainer element uses if the Form control has medium size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

Param Type DefaultValue Description
sColumnsM sap.ui.layout.form.ColumnsM 1

New value for property columnsM

setColumnsXL

Sets a new value for property columnsXL.

Number of columns the FormContainer element uses if the Form control has extra-large size.

The number of columns for extra-large size must not be smaller than the number of columns for large size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 2.

Param Type DefaultValue Description
sColumnsXL sap.ui.layout.form.ColumnsXL 2

New value for property columnsXL