class sap.f.GridContainerSettings

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/f/GridContainerSettings
Application Component: CA-UI5-CTR

Holds a set of settings that define the dimensions of sap.f.GridContainer.

Can be used to define the sizes of columns and rows for different screen sizes, by using the layout aggregations of sap.f.GridContainer.


Constructor

Constructor for a new sap.f.GridContainerSettings.

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.f.GridContainerSettings(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
columnSize sap.ui.core.CSSSize 80px

The width of the columns. Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Visibility: public
columns int

How many columns to have on a row.

If not defined, sap.f.GridContainer will position as many columns as they can fit in the container.

Visibility: public
gap sap.ui.core.CSSSize 16px

The size of the gap between columns and rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Visibility: public
maxColumnSize sap.ui.core.CSSSize

Sets the maximum width of the columns. Setting this together with minColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

Visibility: public
minColumnSize sap.ui.core.CSSSize

Sets the minimum width of the columns. Setting this together with maxColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

Visibility: public
rowSize sap.ui.core.CSSSize 80px

The height of the rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Visibility: public

Methods Overview

Method Description
sap.f.GridContainerSettings.extend

Creates a new subclass of class sap.f.GridContainerSettings 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.base.ManagedObject.extend.

getColumns

Gets current value of property columns.

How many columns to have on a row.

If not defined, sap.f.GridContainer will position as many columns as they can fit in the container.

getColumnSize

Gets current value of property columnSize.

The width of the columns. Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Default value is "80px".

getGap

Gets current value of property gap.

The size of the gap between columns and rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Default value is "16px".

getMaxColumnSize

Gets current value of property maxColumnSize.

Sets the maximum width of the columns. Setting this together with minColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

sap.f.GridContainerSettings.getMetadata

Returns a metadata object for class sap.f.GridContainerSettings.

getMinColumnSize

Gets current value of property minColumnSize.

Sets the minimum width of the columns. Setting this together with maxColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

getRowSize

Gets current value of property rowSize.

The height of the rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Default value is "80px".

setColumns

Sets a new value for property columns.

How many columns to have on a row.

If not defined, sap.f.GridContainer will position as many columns as they can fit in the container.

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

setColumnSize

Sets a new value for property columnSize.

The width of the columns. Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

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

Default value is "80px".

setGap

Sets a new value for property gap.

The size of the gap between columns and rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

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

Default value is "16px".

setMaxColumnSize

Sets a new value for property maxColumnSize.

Sets the maximum width of the columns. Setting this together with minColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

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

setMinColumnSize

Sets a new value for property minColumnSize.

Sets the minimum width of the columns. Setting this together with maxColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

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

setRowSize

Sets a new value for property rowSize.

The height of the rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

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

Default value is "80px".

sap.f.GridContainerSettings.extend

Creates a new subclass of class sap.f.GridContainerSettings 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.base.ManagedObject.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

getColumns

Gets current value of property columns.

How many columns to have on a row.

If not defined, sap.f.GridContainer will position as many columns as they can fit in the container.

getColumnSize

Gets current value of property columnSize.

The width of the columns. Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Default value is "80px".

getGap

Gets current value of property gap.

The size of the gap between columns and rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Default value is "16px".

getMaxColumnSize

Gets current value of property maxColumnSize.

Sets the maximum width of the columns. Setting this together with minColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

sap.f.GridContainerSettings.getMetadata

Returns a metadata object for class sap.f.GridContainerSettings.

getMinColumnSize

Gets current value of property minColumnSize.

Sets the minimum width of the columns. Setting this together with maxColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

getRowSize

Gets current value of property rowSize.

The height of the rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

Default value is "80px".

setColumns

Sets a new value for property columns.

How many columns to have on a row.

If not defined, sap.f.GridContainer will position as many columns as they can fit in the container.

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

Param Type DefaultValue Description
iColumns int

New value for property columns

setColumnSize

Sets a new value for property columnSize.

The width of the columns. Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

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

Default value is "80px".

Param Type DefaultValue Description
sColumnSize sap.ui.core.CSSSize "80px"

New value for property columnSize

setGap

Sets a new value for property gap.

The size of the gap between columns and rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

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

Default value is "16px".

Param Type DefaultValue Description
sGap sap.ui.core.CSSSize "16px"

New value for property gap

setMaxColumnSize

Sets a new value for property maxColumnSize.

Sets the maximum width of the columns. Setting this together with minColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

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

Param Type DefaultValue Description
sMaxColumnSize sap.ui.core.CSSSize

New value for property maxColumnSize

setMinColumnSize

Sets a new value for property minColumnSize.

Sets the minimum width of the columns. Setting this together with maxColumnSize will allow the columns to breath between those two values.

Note: Will not work in combination with columnSize.

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

Param Type DefaultValue Description
sMinColumnSize sap.ui.core.CSSSize

New value for property minColumnSize

setRowSize

Sets a new value for property rowSize.

The height of the rows.

Note: Use only 'px' or 'rem'. Some features may not work as expected otherwise.

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

Default value is "80px".

Param Type DefaultValue Description
sRowSize sap.ui.core.CSSSize "80px"

New value for property rowSize