Class sap.ui.layout.GridDataModule: sap/ui/layout/GridData
Grid layout data
Since: 1.15.0.
sClassName
and enriches it with the information contained in oClassInfo
. 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
- span : sap.ui.layout.GridSpan
- spanXL : int
- spanL : int
- spanM : int
- spanS : int
- indent : sap.ui.layout.GridIndent
- indentXL : int
- indentL : int
- indentM : int
- indentS : int
- visibleXL : boolean (default: true)
- visibleL : boolean (default: true)
- visibleM : boolean (default: true)
- visibleS : boolean (default: true)
- moveBackwards : sap.ui.layout.GridIndent
- moveForward : sap.ui.layout.GridIndent
- linebreak : boolean (default: false)
- linebreakXL : boolean (default: false)
- linebreakL : boolean (default: false)
- linebreakM : boolean (default: false)
- linebreakS : boolean (default: false)
- spanLarge : int
- spanMedium : int
- spanSmall : int
- indentLarge : int
- indentMedium : int
- indentSmall : int
- visibleOnLarge : boolean (default: true)
- visibleOnMedium : boolean (default: true)
- visibleOnSmall : boolean (default: true)
In addition, all settings applicable to the base type sap.ui.core.LayoutData can be used as well.
{string} | sId? | id for the new control, generated automatically if no id is given |
{object} | mSettings? | initial settings for the new control |
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.
{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 |
{function} | Created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
indent
. A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
{sap.ui.layout.GridIndent} | Value of property indent |
indentL
. Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
{int} | Value of property indentL |
indentM
. Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
{int} | Value of property indentM |
indentS
. Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
{int} | Value of property indentS |
indentXL
. Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "indent".
{int} | Value of property indentXL |
linebreak
. Optional. If this property is set to true, the control on all-size screens causes a line break within the Grid and becomes the first within the next line.
Default value is false
.
{boolean} | Value of property linebreak |
linebreakL
. Optional. If this property is set to true, the control on large screens causes a line break within the Grid and becomes the first within the next line.
Default value is false
.
{boolean} | Value of property linebreakL |
linebreakM
. Optional. If this property is set to true, the control on medium sized screens causes a line break within the Grid and becomes the first within the next line.
Default value is false
.
{boolean} | Value of property linebreakM |
linebreakS
. Optional. If this property is set to true, the control on small screens causes a line break within the Grid and becomes the first within the next line.
Default value is false
.
{boolean} | Value of property linebreakS |
linebreakXL
. Optional. If this property is set to true, the control on extra large screens causes a line break within the Grid and becomes the first within the next line.
Default value is false
.
{boolean} | Value of property linebreakXL |
moveBackwards
. Optional. Moves a cell backwards so many columns as specified.
{sap.ui.layout.GridIndent} | Value of property moveBackwards |
moveForward
. Optional. Moves a cell forwards so many columns as specified.
{sap.ui.layout.GridIndent} | Value of property moveForward |
span
. A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
{sap.ui.layout.GridSpan} | Value of property span |
spanL
. Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
{int} | Value of property spanL |
spanM
. Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
{int} | Value of property spanM |
spanS
. Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
{int} | Value of property spanS |
spanXL
. Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "span".
{int} | Value of property spanXL |
visibleL
. Defines if this Control is visible on Large screens.
Default value is true
.
{boolean} | Value of property visibleL |
visibleM
. Defines if this Control is visible on Medium size screens.
Default value is true
.
{boolean} | Value of property visibleM |
visibleS
. Defines if this Control is visible on small screens.
Default value is true
.
{boolean} | Value of property visibleS |
visibleXL
. Defines if this Control is visible on XL - extra Large screens.
Default value is true
.
{boolean} | Value of property visibleXL |
indent
. A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.layout.GridIndent} | sIndent | New value for property indent |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
indentL
. Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iIndentL | New value for property indentL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
indentM
. Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iIndentM | New value for property indentM |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
indentS
. Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iIndentS | New value for property indentS |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
indentXL
. Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "indent".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iIndentXL | New value for property indentXL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
linebreak
. Optional. If this property is set to true, the control on all-size screens causes a line break within the Grid and becomes the first within the next line.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
{boolean} | bLinebreak | New value for property linebreak |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
linebreakL
. Optional. If this property is set to true, the control on large screens causes a line break within the Grid and becomes the first within the next line.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
{boolean} | bLinebreakL | New value for property linebreakL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
linebreakM
. Optional. If this property is set to true, the control on medium sized screens causes a line break within the Grid and becomes the first within the next line.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
{boolean} | bLinebreakM | New value for property linebreakM |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
linebreakS
. Optional. If this property is set to true, the control on small screens causes a line break within the Grid and becomes the first within the next line.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
{boolean} | bLinebreakS | New value for property linebreakS |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
linebreakXL
. Optional. If this property is set to true, the control on extra large screens causes a line break within the Grid and becomes the first within the next line.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
{boolean} | bLinebreakXL | New value for property linebreakXL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
moveBackwards
. Optional. Moves a cell backwards so many columns as specified.
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.layout.GridIndent} | sMoveBackwards | New value for property moveBackwards |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
moveForward
. Optional. Moves a cell forwards so many columns as specified.
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.layout.GridIndent} | sMoveForward | New value for property moveForward |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
span
. A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.layout.GridSpan} | sSpan | New value for property span |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
spanL
. Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iSpanL | New value for property spanL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
spanM
. Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iSpanM | New value for property spanM |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
spanS
. Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iSpanS | New value for property spanS |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
spanXL
. Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "span".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iSpanXL | New value for property spanXL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
visibleL
. Defines if this Control is visible on Large screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bVisibleL | New value for property visibleL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
visibleM
. Defines if this Control is visible on Medium size screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bVisibleM | New value for property visibleM |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
visibleS
. Defines if this Control is visible on small screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bVisibleS | New value for property visibleS |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
visibleXL
. Defines if this Control is visible on XL - extra Large screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bVisibleXL | New value for property visibleXL |
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
indentLarge
. Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
- Deprecated:
- Since version 1.17.1. Use indentL instead.
{int} | Value of property indentLarge |
indentMedium
. Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
- Deprecated:
- Since version 1.17.1. Use indentM instead.
{int} | Value of property indentMedium |
indentSmall
. Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
- Deprecated:
- Since version 1.17.1. Use indentS instead.
{int} | Value of property indentSmall |
spanLarge
. Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
- Deprecated:
- Since version 1.17.1. Use spanL instead.
{int} | Value of property spanLarge |
spanMedium
. Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
- Deprecated:
- Since version 1.17.1. Use spanM instead.
{int} | Value of property spanMedium |
spanSmall
. Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
- Deprecated:
- Since version 1.17.1. Use spanS instead.
{int} | Value of property spanSmall |
visibleOnLarge
. Deprecated. Defines if this Control is visible on Large screens.
Default value is true
.
- Deprecated:
- Since version 1.17.1. Use visibleL instead.
{boolean} | Value of property visibleOnLarge |
visibleOnMedium
. Deprecated. Defines if this Control is visible on Medium size screens.
Default value is true
.
- Deprecated:
- Since version 1.17.1. Use visibleM instead.
{boolean} | Value of property visibleOnMedium |
visibleOnSmall
. Deprecated. Defines if this Control is visible on small screens.
Default value is true
.
- Deprecated:
- Since version 1.17.1. Use visibleS instead.
{boolean} | Value of property visibleOnSmall |
indentLarge
. Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iIndentLarge | New value for property indentLarge |
- Deprecated:
- Since version 1.17.1. Use indentL instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
indentMedium
. Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iIndentMedium | New value for property indentMedium |
- Deprecated:
- Since version 1.17.1. Use indentM instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
indentSmall
. Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iIndentSmall | New value for property indentSmall |
- Deprecated:
- Since version 1.17.1. Use indentS instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
spanLarge
. Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iSpanLarge | New value for property spanLarge |
- Deprecated:
- Since version 1.17.1. Use spanL instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
spanMedium
. Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iSpanMedium | New value for property spanMedium |
- Deprecated:
- Since version 1.17.1. Use spanM instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
spanSmall
. Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
When called with a value of null
or undefined
, the default value of the property will be restored.
{int} | iSpanSmall | New value for property spanSmall |
- Deprecated:
- Since version 1.17.1. Use spanS instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
visibleOnLarge
. Deprecated. Defines if this Control is visible on Large screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bVisibleOnLarge | New value for property visibleOnLarge |
- Deprecated:
- Since version 1.17.1. Use visibleL instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
visibleOnMedium
. Deprecated. Defines if this Control is visible on Medium size screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bVisibleOnMedium | New value for property visibleOnMedium |
- Deprecated:
- Since version 1.17.1. Use visibleM instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |
visibleOnSmall
. Deprecated. Defines if this Control is visible on small screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bVisibleOnSmall | New value for property visibleOnSmall |
- Deprecated:
- Since version 1.17.1. Use visibleS instead.
{sap.ui.layout.GridData} | Reference to this in order to allow method chaining |