Class sap.ui.layout.form.GridContainerDataModule: sap/ui/layout/form/GridContainerData

extends LayoutData
known direct subclasses: GridContainerData

GridLayout-specific properties for FormContainers.


Since: 1.16.0.
Constructor Summary
new sap.ui.layout.form.GridContainerData(sId?, mSettings?)Constructor for a new sap.ui.layout.form.GridContainerData.
Method Summary
sap.ui.layout.form.GridContainerData.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.form.GridContainerData with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.form.GridContainerData.getMetadata()Returns a metadata object for class sap.ui.layout.form.GridContainerData.
getHalfGrid()Gets current value of property halfGrid.
setHalfGrid(bHalfGrid)Sets a new value for property halfGrid.
Constructor Detail
new sap.ui.layout.form.GridContainerData(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

In addition, all settings applicable to the base type sap.ui.core.LayoutData can be used as well.

Parameters:
{string}sId? Id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.ui.layout.form.GridContainerData.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.layout.form.GridContainerData.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.form.GridContainerData.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getHalfGrid(): boolean
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.

Returns:
{boolean} Value of property halfGrid
setHalfGrid(bHalfGrid): sap.ui.layout.form.GridContainerData
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.

Parameters:
{boolean}bHalfGrid New value for property halfGrid
Returns:
{sap.ui.layout.form.GridContainerData} Reference to this in order to allow method chaining