class sap.ui.layout.form.GridElementData

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

The GridLayout-specific layout data for FormElement fields.


Constructor

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

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.GridElementData(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
hCells sap.ui.layout.form.GridElementCells auto

Number of cells in horizontal direction.

If set to auto, the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.

If set to full, only one field is allowed within the FormElement. It gets the full width of the row and the label is displayed above.

Note: For labels, the full size setting has no effect.

Visibility: public
vCells int 1

Number of cells in vertical direction.

Note: This property has no effect on labels.

Visibility: public

Methods Overview

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

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

getHCells

Gets current value of property hCells.

Number of cells in horizontal direction.

If set to auto, the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.

If set to full, only one field is allowed within the FormElement. It gets the full width of the row and the label is displayed above.

Note: For labels, the full size setting has no effect.

Default value is 'auto'.

sap.ui.layout.form.GridElementData.getMetadata

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

getVCells

Gets current value of property vCells.

Number of cells in vertical direction.

Note: This property has no effect on labels.

Default value is 1.

setHCells

Sets a new value for property hCells.

Number of cells in horizontal direction.

If set to auto, the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.

If set to full, only one field is allowed within the FormElement. It gets the full width of the row and the label is displayed above.

Note: For labels, the full size setting has no effect.

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

Default value is 'auto'.

setVCells

Sets a new value for property vCells.

Number of cells in vertical direction.

Note: This property has no effect on labels.

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

Default value is 1.

sap.ui.layout.form.GridElementData.extend

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

getHCells

Gets current value of property hCells.

Number of cells in horizontal direction.

If set to auto, the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.

If set to full, only one field is allowed within the FormElement. It gets the full width of the row and the label is displayed above.

Note: For labels, the full size setting has no effect.

Default value is 'auto'.

sap.ui.layout.form.GridElementData.getMetadata

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

getVCells

Gets current value of property vCells.

Number of cells in vertical direction.

Note: This property has no effect on labels.

Default value is 1.

setHCells

Sets a new value for property hCells.

Number of cells in horizontal direction.

If set to auto, the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.

If set to full, only one field is allowed within the FormElement. It gets the full width of the row and the label is displayed above.

Note: For labels, the full size setting has no effect.

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

Default value is 'auto'.

Param Type DefaultValue Description
sHCells sap.ui.layout.form.GridElementCells 'auto'

New value for property hCells

setVCells

Sets a new value for property vCells.

Number of cells in vertical direction.

Note: This property has no effect on labels.

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
iVCells int 1

New value for property vCells