class sap.ui.layout.form.GridContainerData

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

The GridLayout-specific layout data for FormContainers.


Constructor

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

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.GridContainerData(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
halfGrid boolean false

If set, the container takes half the width of the Form (8 cells), if not it takes the full width (16 cells). If the GridLayout is set to singleColumn, the full width of the grid is only 8 cells. So containers are rendered only once per row.

Visibility: public

Methods Overview

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

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

getHalfGrid

Gets current value of property halfGrid.

If set, the container takes half the width of the Form (8 cells), if not it takes the full width (16 cells). If the GridLayout is set to singleColumn, the full width of the grid is only 8 cells. So containers are rendered only once per row.

Default value is false.

sap.ui.layout.form.GridContainerData.getMetadata

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

setHalfGrid

Sets a new value for property halfGrid.

If set, the container takes half the width of the Form (8 cells), if not it takes the full width (16 cells). If the GridLayout is set to singleColumn, the full width of the grid is only 8 cells. So containers are rendered only once per row.

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

Default value is false.

sap.ui.layout.form.GridContainerData.extend

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

getHalfGrid

Gets current value of property halfGrid.

If set, the container takes half the width of the Form (8 cells), if not it takes the full width (16 cells). If the GridLayout is set to singleColumn, the full width of the grid is only 8 cells. So containers are rendered only once per row.

Default value is false.

sap.ui.layout.form.GridContainerData.getMetadata

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

setHalfGrid

Sets a new value for property halfGrid.

If set, the container takes half the width of the Form (8 cells), if not it takes the full width (16 cells). If the GridLayout is set to singleColumn, the full width of the grid is only 8 cells. So containers are rendered only once per row.

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

Default value is false.

Param Type DefaultValue Description
bHalfGrid boolean false

New value for property halfGrid