class sap.ui.layout.GridData

Control sample: sap.ui.layout.GridData
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/layout/GridData
Application Component: CA-UI5-CTR

Defines layout data for the sap.ui.layout.Grid.

Note: When GridData is used for controls inside a form, the linebreak property has to be set to true if the next form element has to be displayed on a new line. Otherwise the GridData overrides the layout provided by the Form.

Documentation links:


Constructor

Constructor for a new GridData.

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.GridData(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
indent sap.ui.layout.GridIndent

A string type that represents the indent values of the Grid 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 11 that the container has to take, for example, L2 M4 S6, M11, s10 or l4 m4.

Note: The parameters must be provided in the order .

Visibility: public
indentL int

Optional. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

Visibility: public
indentLarge int

Deprecated. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

Visibility: public
indentM int

Optional. Defines an indent value for medium size screens. This value overwrites the value for medium screens defined in the indent property.

Visibility: public
indentMedium int

Deprecated. Defines an indent value for medium screens. This value overwrites the value for medium screens defined in the indent property.

Visibility: public
indentS int

Optional. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

Visibility: public
indentSmall int

Deprecated. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

Visibility: public
indentXL int

Optional. Defines an indent value for extra large screens. This value overwrites the value for extra large screens defined in the indent property.

Visibility: public
linebreak boolean false

Optional. If set to true, the control causes a line break on all-size screens within the Grid and becomes the first within the next line.

Visibility: public
linebreakL boolean false

Optional. If set to true, the control causes a line break on large screens within the Grid and becomes the first within the next line.

Visibility: public
linebreakM boolean false

Optional. If set to true, the control causes a line break on medium screens within the Grid and becomes the first within the next line.

Visibility: public
linebreakS boolean false

Optional. If set to true, the control causes a line break on small screens within the Grid and becomes the first within the next line.

Visibility: public
linebreakXL boolean false

Optional. If set to true, the control causes a line break on extra large screens within the Grid and becomes the first within the next line.

Visibility: public
moveBackwards sap.ui.layout.GridIndent

Optional. Moves a cell backwards with as many columns as specified.

Visibility: public
moveForward sap.ui.layout.GridIndent

Optional. Moves a cell forwards with as many columns as specified.

Visibility: public
span sap.ui.layout.GridSpan

A string type that represents the span values of the Grid 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: The parameters must be provided in the order .

Visibility: public
spanL int

Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

Visibility: public
spanLarge int

Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

Visibility: public
spanM int

Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the span property.

Visibility: public
spanMedium int

Deprecated. Defines a span value for medium screens. This value overwrites the value for medium screens defined in the span property.

Visibility: public
spanS int

Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

Visibility: public
spanSmall int

Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

Visibility: public
spanXL int

Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the span property.

Visibility: public
visibleL boolean true

Defines if this control is visible on large screens.

Visibility: public
visibleM boolean true

Defines if this control is visible on medium screens.

Visibility: public
visibleOnLarge boolean true

Deprecated. Defines if this control is visible on large screens.

Visibility: public
visibleOnMedium boolean true

Deprecated. Defines if this control is visible on medium screens.

Visibility: public
visibleOnSmall boolean true

Deprecated. Defines if this control is visible on small screens.

Visibility: public
visibleS boolean true

Defines if this control is visible on small screens.

Visibility: public
visibleXL boolean true

Defines if this control is visible on extra Large screens.

Visibility: public

Methods Overview

Method Description
sap.ui.layout.GridData.extend

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

getIndent

Gets current value of property indent.

A string type that represents the indent values of the Grid 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 11 that the container has to take, for example, L2 M4 S6, M11, s10 or l4 m4.

Note: The parameters must be provided in the order .

getIndentL

Gets current value of property indentL.

Optional. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

getIndentLarge

Gets current value of property indentLarge.

Deprecated. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

Since 1.17.1 Use the <code>indentL</code> property instead.
getIndentM

Gets current value of property indentM.

Optional. Defines an indent value for medium size screens. This value overwrites the value for medium screens defined in the indent property.

getIndentMedium

Gets current value of property indentMedium.

Deprecated. Defines an indent value for medium screens. This value overwrites the value for medium screens defined in the indent property.

Since 1.17.1 Use the <code>indentM</code> property instead.
getIndentS

Gets current value of property indentS.

Optional. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

getIndentSmall

Gets current value of property indentSmall.

Deprecated. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

Since 1.17.1 Use <code>indentS</code> property instead.
getIndentXL

Gets current value of property indentXL.

Optional. Defines an indent value for extra large screens. This value overwrites the value for extra large screens defined in the indent property.

getLinebreak

Gets current value of property linebreak.

Optional. If set to true, the control causes a line break on all-size screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakL

Gets current value of property linebreakL.

Optional. If set to true, the control causes a line break on large screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakM

Gets current value of property linebreakM.

Optional. If set to true, the control causes a line break on medium screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakS

Gets current value of property linebreakS.

Optional. If set to true, the control causes a line break on small screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakXL

Gets current value of property linebreakXL.

Optional. If set to true, the control causes a line break on extra large screens within the Grid and becomes the first within the next line.

Default value is false.

sap.ui.layout.GridData.getMetadata

Returns a metadata object for class sap.ui.layout.GridData.

getMoveBackwards

Gets current value of property moveBackwards.

Optional. Moves a cell backwards with as many columns as specified.

getMoveForward

Gets current value of property moveForward.

Optional. Moves a cell forwards with as many columns as specified.

getSpan

Gets current value of property span.

A string type that represents the span values of the Grid 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: The parameters must be provided in the order .

getSpanL

Gets current value of property spanL.

Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

getSpanLarge

Gets current value of property spanLarge.

Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

Since 1.17.1 Use the <code>spanL</code> property instead.
getSpanM

Gets current value of property spanM.

Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the span property.

getSpanMedium

Gets current value of property spanMedium.

Deprecated. Defines a span value for medium screens. This value overwrites the value for medium screens defined in the span property.

Since 1.17.1 Use the <code>spanM</code> property instead.
getSpanS

Gets current value of property spanS.

Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

getSpanSmall

Gets current value of property spanSmall.

Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

Since 1.17.1 Use the <code>spanS</code> property instead.
getSpanXL

Gets current value of property spanXL.

Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the span property.

getVisibleL

Gets current value of property visibleL.

Defines if this control is visible on large screens.

Default value is true.

getVisibleM

Gets current value of property visibleM.

Defines if this control is visible on medium screens.

Default value is true.

getVisibleOnLarge

Gets current value of property visibleOnLarge.

Deprecated. Defines if this control is visible on large screens.

Default value is true.

Since 1.17.1 Use the <code>visibleL</code> property instead.
getVisibleOnMedium

Gets current value of property visibleOnMedium.

Deprecated. Defines if this control is visible on medium screens.

Default value is true.

Since 1.17.1 Use the <code>visibleM</code> property instead.
getVisibleOnSmall

Gets current value of property visibleOnSmall.

Deprecated. Defines if this control is visible on small screens.

Default value is true.

Since 1.17.1 Use the <code>visibleS</code> property instead.
getVisibleS

Gets current value of property visibleS.

Defines if this control is visible on small screens.

Default value is true.

getVisibleXL

Gets current value of property visibleXL.

Defines if this control is visible on extra Large screens.

Default value is true.

setIndent

Sets a new value for property indent.

A string type that represents the indent values of the Grid 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 11 that the container has to take, for example, L2 M4 S6, M11, s10 or l4 m4.

Note: The parameters must be provided in the order .

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

setIndentL

Sets a new value for property indentL.

Optional. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

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

setIndentLarge

Sets a new value for property indentLarge.

Deprecated. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

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

Since 1.17.1 Use the <code>indentL</code> property instead.
setIndentM

Sets a new value for property indentM.

Optional. Defines an indent value for medium size screens. This value overwrites the value for medium screens defined in the indent property.

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

setIndentMedium

Sets a new value for property indentMedium.

Deprecated. Defines an indent value for medium screens. This value overwrites the value for medium screens defined in the indent property.

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

Since 1.17.1 Use the <code>indentM</code> property instead.
setIndentS

Sets a new value for property indentS.

Optional. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

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

setIndentSmall

Sets a new value for property indentSmall.

Deprecated. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

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

Since 1.17.1 Use <code>indentS</code> property instead.
setIndentXL

Sets a new value for property indentXL.

Optional. Defines an indent value for extra large screens. This value overwrites the value for extra large screens defined in the indent property.

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

setLinebreak

Sets a new value for property linebreak.

Optional. If set to true, the control causes a line break on all-size screens 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.

setLinebreakL

Sets a new value for property linebreakL.

Optional. If set to true, the control causes a line break on large screens 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.

setLinebreakM

Sets a new value for property linebreakM.

Optional. If set to true, the control causes a line break on medium screens 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.

setLinebreakS

Sets a new value for property linebreakS.

Optional. If set to true, the control causes a line break on small screens 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.

setLinebreakXL

Sets a new value for property linebreakXL.

Optional. If set to true, the control causes a line break on extra large screens 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.

setMoveBackwards

Sets a new value for property moveBackwards.

Optional. Moves a cell backwards with as many columns as specified.

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

setMoveForward

Sets a new value for property moveForward.

Optional. Moves a cell forwards with as many columns as specified.

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

setSpan

Sets a new value for property span.

A string type that represents the span values of the Grid 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: The parameters must be provided in the order .

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

setSpanL

Sets a new value for property spanL.

Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

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

setSpanLarge

Sets a new value for property spanLarge.

Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

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

Since 1.17.1 Use the <code>spanL</code> property instead.
setSpanM

Sets a new value for property spanM.

Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the span property.

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

setSpanMedium

Sets a new value for property spanMedium.

Deprecated. Defines a span value for medium screens. This value overwrites the value for medium screens defined in the span property.

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

Since 1.17.1 Use the <code>spanM</code> property instead.
setSpanS

Sets a new value for property spanS.

Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

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

setSpanSmall

Sets a new value for property spanSmall.

Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

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

Since 1.17.1 Use the <code>spanS</code> property instead.
setSpanXL

Sets a new value for property spanXL.

Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the span property.

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

setVisibleL

Sets a new value for property 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.

setVisibleM

Sets a new value for property visibleM.

Defines if this control is visible on medium screens.

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

Default value is true.

setVisibleOnLarge

Sets a new value for property 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.

Since 1.17.1 Use the <code>visibleL</code> property instead.
setVisibleOnMedium

Sets a new value for property visibleOnMedium.

Deprecated. Defines if this control is visible on medium screens.

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

Default value is true.

Since 1.17.1 Use the <code>visibleM</code> property instead.
setVisibleOnSmall

Sets a new value for property 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.

Since 1.17.1 Use the <code>visibleS</code> property instead.
setVisibleS

Sets a new value for property 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.

setVisibleXL

Sets a new value for property visibleXL.

Defines if this control is visible on 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.

sap.ui.layout.GridData.extend

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

getIndent

Gets current value of property indent.

A string type that represents the indent values of the Grid 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 11 that the container has to take, for example, L2 M4 S6, M11, s10 or l4 m4.

Note: The parameters must be provided in the order .

getIndentL

Gets current value of property indentL.

Optional. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

getIndentLarge

Gets current value of property indentLarge.

Deprecated. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

Since 1.17.1 Use the <code>indentL</code> property instead.

getIndentM

Gets current value of property indentM.

Optional. Defines an indent value for medium size screens. This value overwrites the value for medium screens defined in the indent property.

getIndentMedium

Gets current value of property indentMedium.

Deprecated. Defines an indent value for medium screens. This value overwrites the value for medium screens defined in the indent property.

Since 1.17.1 Use the <code>indentM</code> property instead.

getIndentS

Gets current value of property indentS.

Optional. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

getIndentSmall

Gets current value of property indentSmall.

Deprecated. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

Since 1.17.1 Use <code>indentS</code> property instead.

getIndentXL

Gets current value of property indentXL.

Optional. Defines an indent value for extra large screens. This value overwrites the value for extra large screens defined in the indent property.

getLinebreak

Gets current value of property linebreak.

Optional. If set to true, the control causes a line break on all-size screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakL

Gets current value of property linebreakL.

Optional. If set to true, the control causes a line break on large screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakM

Gets current value of property linebreakM.

Optional. If set to true, the control causes a line break on medium screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakS

Gets current value of property linebreakS.

Optional. If set to true, the control causes a line break on small screens within the Grid and becomes the first within the next line.

Default value is false.

getLinebreakXL

Gets current value of property linebreakXL.

Optional. If set to true, the control causes a line break on extra large screens within the Grid and becomes the first within the next line.

Default value is false.

sap.ui.layout.GridData.getMetadata

Returns a metadata object for class sap.ui.layout.GridData.

getMoveBackwards

Gets current value of property moveBackwards.

Optional. Moves a cell backwards with as many columns as specified.

getMoveForward

Gets current value of property moveForward.

Optional. Moves a cell forwards with as many columns as specified.

getSpan

Gets current value of property span.

A string type that represents the span values of the Grid 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: The parameters must be provided in the order .

getSpanL

Gets current value of property spanL.

Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

getSpanLarge

Gets current value of property spanLarge.

Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

Since 1.17.1 Use the <code>spanL</code> property instead.

getSpanM

Gets current value of property spanM.

Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the span property.

getSpanMedium

Gets current value of property spanMedium.

Deprecated. Defines a span value for medium screens. This value overwrites the value for medium screens defined in the span property.

Since 1.17.1 Use the <code>spanM</code> property instead.

getSpanS

Gets current value of property spanS.

Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

getSpanSmall

Gets current value of property spanSmall.

Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

Since 1.17.1 Use the <code>spanS</code> property instead.

getSpanXL

Gets current value of property spanXL.

Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the span property.

getVisibleL

Gets current value of property visibleL.

Defines if this control is visible on large screens.

Default value is true.

getVisibleM

Gets current value of property visibleM.

Defines if this control is visible on medium screens.

Default value is true.

getVisibleOnLarge

Gets current value of property visibleOnLarge.

Deprecated. Defines if this control is visible on large screens.

Default value is true.

Since 1.17.1 Use the <code>visibleL</code> property instead.

getVisibleOnMedium

Gets current value of property visibleOnMedium.

Deprecated. Defines if this control is visible on medium screens.

Default value is true.

Since 1.17.1 Use the <code>visibleM</code> property instead.

getVisibleOnSmall

Gets current value of property visibleOnSmall.

Deprecated. Defines if this control is visible on small screens.

Default value is true.

Since 1.17.1 Use the <code>visibleS</code> property instead.

getVisibleS

Gets current value of property visibleS.

Defines if this control is visible on small screens.

Default value is true.

getVisibleXL

Gets current value of property visibleXL.

Defines if this control is visible on extra Large screens.

Default value is true.

setIndent

Sets a new value for property indent.

A string type that represents the indent values of the Grid 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 11 that the container has to take, for example, L2 M4 S6, M11, s10 or l4 m4.

Note: The parameters must be provided in the order .

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

Param Type DefaultValue Description
sIndent sap.ui.layout.GridIndent

New value for property indent

setIndentL

Sets a new value for property indentL.

Optional. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

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

Param Type DefaultValue Description
iIndentL int

New value for property indentL

setIndentLarge

Sets a new value for property indentLarge.

Deprecated. Defines an indent value for large screens. This value overwrites the value for large screens defined in the indent property.

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

Since 1.17.1 Use the <code>indentL</code> property instead.
Param Type DefaultValue Description
iIndentLarge int

New value for property indentLarge

setIndentM

Sets a new value for property indentM.

Optional. Defines an indent value for medium size screens. This value overwrites the value for medium screens defined in the indent property.

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

Param Type DefaultValue Description
iIndentM int

New value for property indentM

setIndentMedium

Sets a new value for property indentMedium.

Deprecated. Defines an indent value for medium screens. This value overwrites the value for medium screens defined in the indent property.

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

Since 1.17.1 Use the <code>indentM</code> property instead.
Param Type DefaultValue Description
iIndentMedium int

New value for property indentMedium

setIndentS

Sets a new value for property indentS.

Optional. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

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

Param Type DefaultValue Description
iIndentS int

New value for property indentS

setIndentSmall

Sets a new value for property indentSmall.

Deprecated. Defines an indent value for small screens. This value overwrites the value for small screens defined in the indent property.

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

Since 1.17.1 Use <code>indentS</code> property instead.
Param Type DefaultValue Description
iIndentSmall int

New value for property indentSmall

setIndentXL

Sets a new value for property indentXL.

Optional. Defines an indent value for extra large screens. This value overwrites the value for extra large screens defined in the indent property.

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

Param Type DefaultValue Description
iIndentXL int

New value for property indentXL

setLinebreak

Sets a new value for property linebreak.

Optional. If set to true, the control causes a line break on all-size screens 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.

Param Type DefaultValue Description
bLinebreak boolean false

New value for property linebreak

setLinebreakL

Sets a new value for property linebreakL.

Optional. If set to true, the control causes a line break on large screens 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.

Param Type DefaultValue Description
bLinebreakL boolean false

New value for property linebreakL

setLinebreakM

Sets a new value for property linebreakM.

Optional. If set to true, the control causes a line break on medium screens 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.

Param Type DefaultValue Description
bLinebreakM boolean false

New value for property linebreakM

setLinebreakS

Sets a new value for property linebreakS.

Optional. If set to true, the control causes a line break on small screens 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.

Param Type DefaultValue Description
bLinebreakS boolean false

New value for property linebreakS

setLinebreakXL

Sets a new value for property linebreakXL.

Optional. If set to true, the control causes a line break on extra large screens 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.

Param Type DefaultValue Description
bLinebreakXL boolean false

New value for property linebreakXL

setMoveBackwards

Sets a new value for property moveBackwards.

Optional. Moves a cell backwards with as many columns as specified.

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

Param Type DefaultValue Description
sMoveBackwards sap.ui.layout.GridIndent

New value for property moveBackwards

setMoveForward

Sets a new value for property moveForward.

Optional. Moves a cell forwards with as many columns as specified.

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

Param Type DefaultValue Description
sMoveForward sap.ui.layout.GridIndent

New value for property moveForward

setSpan

Sets a new value for property span.

A string type that represents the span values of the Grid 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: The parameters must be provided in the order .

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

Param Type DefaultValue Description
sSpan sap.ui.layout.GridSpan

New value for property span

setSpanL

Sets a new value for property spanL.

Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

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

Param Type DefaultValue Description
iSpanL int

New value for property spanL

setSpanLarge

Sets a new value for property spanLarge.

Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the span property.

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

Since 1.17.1 Use the <code>spanL</code> property instead.
Param Type DefaultValue Description
iSpanLarge int

New value for property spanLarge

setSpanM

Sets a new value for property spanM.

Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the span property.

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

Param Type DefaultValue Description
iSpanM int

New value for property spanM

setSpanMedium

Sets a new value for property spanMedium.

Deprecated. Defines a span value for medium screens. This value overwrites the value for medium screens defined in the span property.

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

Since 1.17.1 Use the <code>spanM</code> property instead.
Param Type DefaultValue Description
iSpanMedium int

New value for property spanMedium

setSpanS

Sets a new value for property spanS.

Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

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

Param Type DefaultValue Description
iSpanS int

New value for property spanS

setSpanSmall

Sets a new value for property spanSmall.

Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the span property.

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

Since 1.17.1 Use the <code>spanS</code> property instead.
Param Type DefaultValue Description
iSpanSmall int

New value for property spanSmall

setSpanXL

Sets a new value for property spanXL.

Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the span property.

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

Param Type DefaultValue Description
iSpanXL int

New value for property spanXL

setVisibleL

Sets a new value for property 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.

Param Type DefaultValue Description
bVisibleL boolean true

New value for property visibleL

setVisibleM

Sets a new value for property visibleM.

Defines if this control is visible on medium screens.

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

Default value is true.

Param Type DefaultValue Description
bVisibleM boolean true

New value for property visibleM

setVisibleOnLarge

Sets a new value for property 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.

Since 1.17.1 Use the <code>visibleL</code> property instead.
Param Type DefaultValue Description
bVisibleOnLarge boolean true

New value for property visibleOnLarge

setVisibleOnMedium

Sets a new value for property visibleOnMedium.

Deprecated. Defines if this control is visible on medium screens.

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

Default value is true.

Since 1.17.1 Use the <code>visibleM</code> property instead.
Param Type DefaultValue Description
bVisibleOnMedium boolean true

New value for property visibleOnMedium

setVisibleOnSmall

Sets a new value for property 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.

Since 1.17.1 Use the <code>visibleS</code> property instead.
Param Type DefaultValue Description
bVisibleOnSmall boolean true

New value for property visibleOnSmall

setVisibleS

Sets a new value for property 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.

Param Type DefaultValue Description
bVisibleS boolean true

New value for property visibleS

setVisibleXL

Sets a new value for property visibleXL.

Defines if this control is visible on 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.

Param Type DefaultValue Description
bVisibleXL boolean true

New value for property visibleXL