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 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 |
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, |
|
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 Note: Will not work in combination with |
|
minColumnSize | sap.ui.core.CSSSize | Sets the minimum width of the columns. Setting this together with Note: Will not work in combination with |
|
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 |
Method | Description |
---|---|
sap.f.GridContainerSettings.extend |
Creates a new subclass of class sap.f.GridContainerSettings with name
|
getColumns |
Gets current value of property columns. How many columns to have on a row. If not defined, |
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 |
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 |
getMaxColumnSize |
Gets current value of property maxColumnSize. Sets the maximum width of the columns. Setting this together with Note: Will not work in combination with |
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 Note: Will not work in combination with |
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 |
setColumns |
Sets a new value for property columns. How many columns to have on a row. If not defined, When called with a value of |
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 Default value is |
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 Default value is |
setMaxColumnSize |
Sets a new value for property maxColumnSize. Sets the maximum width of the columns. Setting this together with Note: Will not work in combination with When called with a value of |
setMinColumnSize |
Sets a new value for property minColumnSize. Sets the minimum width of the columns. Setting this together with Note: Will not work in combination with When called with a value of |
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 Default value is |
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 |
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.
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"
.
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"
.
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
.
Returns a metadata object for class sap.f.GridContainerSettings.
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
.
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"
.
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 |
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 |
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 |
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 |
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 |
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 |