class sap.ui.layout.form.ColumnElementData

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

The ColumnLayout-specific layout data for the FormElement content fields.

One FormElement element contains 12 cells and has two sizes, small and large. Using ColumnElementData, the default calculation of the cells used for a field or label can be overwritten.


Constructor

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

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.ColumnElementData(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
cellsLarge sap.ui.layout.form.ColumnCells 8

Number of cells used by a field if the FormElement element is large. The label is then beside the fields per default.

If set to 12, the full size of the FormElement element is used.

Visibility: public
cellsSmall sap.ui.layout.form.ColumnCells 12

Number of cells used by a field if the FormElement element is small. The label is then above the fields per default.

If set to 12, the full size of the FormElement is used.

Visibility: public

Methods Overview

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

Creates a new subclass of class sap.ui.layout.form.ColumnElementData 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.

getCellsLarge

Gets current value of property cellsLarge.

Number of cells used by a field if the FormElement element is large. The label is then beside the fields per default.

If set to 12, the full size of the FormElement element is used.

Default value is 8.

getCellsSmall

Gets current value of property cellsSmall.

Number of cells used by a field if the FormElement element is small. The label is then above the fields per default.

If set to 12, the full size of the FormElement is used.

Default value is 12.

sap.ui.layout.form.ColumnElementData.getMetadata

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

setCellsLarge

Sets a new value for property cellsLarge.

Number of cells used by a field if the FormElement element is large. The label is then beside the fields per default.

If set to 12, the full size of the FormElement element is used.

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

Default value is 8.

setCellsSmall

Sets a new value for property cellsSmall.

Number of cells used by a field if the FormElement element is small. The label is then above the fields per default.

If set to 12, the full size of the FormElement is used.

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

Default value is 12.

sap.ui.layout.form.ColumnElementData.extend

Creates a new subclass of class sap.ui.layout.form.ColumnElementData 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

getCellsLarge

Gets current value of property cellsLarge.

Number of cells used by a field if the FormElement element is large. The label is then beside the fields per default.

If set to 12, the full size of the FormElement element is used.

Default value is 8.

getCellsSmall

Gets current value of property cellsSmall.

Number of cells used by a field if the FormElement element is small. The label is then above the fields per default.

If set to 12, the full size of the FormElement is used.

Default value is 12.

sap.ui.layout.form.ColumnElementData.getMetadata

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

setCellsLarge

Sets a new value for property cellsLarge.

Number of cells used by a field if the FormElement element is large. The label is then beside the fields per default.

If set to 12, the full size of the FormElement element is used.

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

Default value is 8.

Param Type DefaultValue Description
sCellsLarge sap.ui.layout.form.ColumnCells 8

New value for property cellsLarge

setCellsSmall

Sets a new value for property cellsSmall.

Number of cells used by a field if the FormElement element is small. The label is then above the fields per default.

If set to 12, the full size of the FormElement is used.

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

Default value is 12.

Param Type DefaultValue Description
sCellsSmall sap.ui.layout.form.ColumnCells 12

New value for property cellsSmall