class sap.ui.layout.cssgrid.GridSettings

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/layout/cssgrid/GridSettings
Application Component: CA-UI5-CTR

Holds a set of CSS display:grid properties


Constructor

Constructor for a new GridSettings.

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.cssgrid.GridSettings(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
gridAutoColumns sap.ui.layout.cssgrid.CSSGridTrack empty string

Sets the value for the CSS display:grid property MDN web docs: grid-auto-columns

Visibility: public
gridAutoFlow sap.ui.layout.cssgrid.CSSGridAutoFlow Row

Sets the value for the CSS display:grid property MDN web docs: grid-auto-flow

Visibility: public
gridAutoRows sap.ui.layout.cssgrid.CSSGridTrack empty string

Sets the value for the CSS display:grid property MDN web docs: grid-auto-rows

Visibility: public
gridColumnGap sap.ui.core.CSSSize empty string

Sets the value for the CSS display:grid property MDN web docs: grid-column-gap

Visibility: public
gridGap sap.ui.layout.cssgrid.CSSGridGapShortHand empty string

Sets the value for the CSS display:grid property MDN web docs: grid-gap

Visibility: public
gridRowGap sap.ui.core.CSSSize empty string

Sets the value for the CSS display:grid property MDN web docs: grid-row-gap

Visibility: public
gridTemplateColumns sap.ui.layout.cssgrid.CSSGridTrack empty string

Sets the value for the CSS display:grid property MDN web docs: grid-template-columns

Visibility: public
gridTemplateRows sap.ui.layout.cssgrid.CSSGridTrack empty string

Sets the value for the CSS display:grid property MDN web docs: grid-template-rows

Visibility: public

Methods Overview

Method Description
sap.ui.layout.cssgrid.GridSettings.extend

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

getGridAutoColumns

Gets current value of property gridAutoColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-columns

Default value is empty string.

getGridAutoFlow

Gets current value of property gridAutoFlow.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-flow

Default value is "Row".

getGridAutoRows

Gets current value of property gridAutoRows.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-rows

Default value is empty string.

getGridColumnGap

Gets current value of property gridColumnGap.

Sets the value for the CSS display:grid property MDN web docs: grid-column-gap

Default value is empty string.

getGridGap

Gets current value of property gridGap.

Sets the value for the CSS display:grid property MDN web docs: grid-gap

Default value is empty string.

getGridRowGap

Gets current value of property gridRowGap.

Sets the value for the CSS display:grid property MDN web docs: grid-row-gap

Default value is empty string.

getGridTemplateColumns

Gets current value of property gridTemplateColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-template-columns

Default value is empty string.

getGridTemplateRows

Gets current value of property gridTemplateRows.

Sets the value for the CSS display:grid property MDN web docs: grid-template-rows

Default value is empty string.

sap.ui.layout.cssgrid.GridSettings.getMetadata

Returns a metadata object for class sap.ui.layout.cssgrid.GridSettings.

setGridAutoColumns

Sets a new value for property gridAutoColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-columns

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

Default value is empty string.

setGridAutoFlow

Sets a new value for property gridAutoFlow.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-flow

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

Default value is "Row".

setGridAutoRows

Sets a new value for property gridAutoRows.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-rows

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

Default value is empty string.

setGridColumnGap

Sets a new value for property gridColumnGap.

Sets the value for the CSS display:grid property MDN web docs: grid-column-gap

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

Default value is empty string.

setGridGap

Sets a new value for property gridGap.

Sets the value for the CSS display:grid property MDN web docs: grid-gap

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

Default value is empty string.

setGridRowGap

Sets a new value for property gridRowGap.

Sets the value for the CSS display:grid property MDN web docs: grid-row-gap

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

Default value is empty string.

setGridTemplateColumns

Sets a new value for property gridTemplateColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-template-columns

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

Default value is empty string.

setGridTemplateRows

Sets a new value for property gridTemplateRows.

Sets the value for the CSS display:grid property MDN web docs: grid-template-rows

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

Default value is empty string.

sap.ui.layout.cssgrid.GridSettings.extend

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

getGridAutoColumns

Gets current value of property gridAutoColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-columns

Default value is empty string.

getGridAutoFlow

Gets current value of property gridAutoFlow.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-flow

Default value is "Row".

getGridAutoRows

Gets current value of property gridAutoRows.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-rows

Default value is empty string.

getGridColumnGap

Gets current value of property gridColumnGap.

Sets the value for the CSS display:grid property MDN web docs: grid-column-gap

Default value is empty string.

getGridGap

Gets current value of property gridGap.

Sets the value for the CSS display:grid property MDN web docs: grid-gap

Default value is empty string.

getGridRowGap

Gets current value of property gridRowGap.

Sets the value for the CSS display:grid property MDN web docs: grid-row-gap

Default value is empty string.

getGridTemplateColumns

Gets current value of property gridTemplateColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-template-columns

Default value is empty string.

getGridTemplateRows

Gets current value of property gridTemplateRows.

Sets the value for the CSS display:grid property MDN web docs: grid-template-rows

Default value is empty string.

sap.ui.layout.cssgrid.GridSettings.getMetadata

Returns a metadata object for class sap.ui.layout.cssgrid.GridSettings.

setGridAutoColumns

Sets a new value for property gridAutoColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-columns

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

Default value is empty string.

Param Type DefaultValue Description
sGridAutoColumns sap.ui.layout.cssgrid.CSSGridTrack ""

New value for property gridAutoColumns

setGridAutoFlow

Sets a new value for property gridAutoFlow.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-flow

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

Default value is "Row".

Param Type DefaultValue Description
sGridAutoFlow sap.ui.layout.cssgrid.CSSGridAutoFlow "Row"

New value for property gridAutoFlow

setGridAutoRows

Sets a new value for property gridAutoRows.

Sets the value for the CSS display:grid property MDN web docs: grid-auto-rows

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

Default value is empty string.

Param Type DefaultValue Description
sGridAutoRows sap.ui.layout.cssgrid.CSSGridTrack ""

New value for property gridAutoRows

setGridColumnGap

Sets a new value for property gridColumnGap.

Sets the value for the CSS display:grid property MDN web docs: grid-column-gap

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

Default value is empty string.

Param Type DefaultValue Description
sGridColumnGap sap.ui.core.CSSSize ""

New value for property gridColumnGap

setGridGap

Sets a new value for property gridGap.

Sets the value for the CSS display:grid property MDN web docs: grid-gap

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

Default value is empty string.

Param Type DefaultValue Description
sGridGap sap.ui.layout.cssgrid.CSSGridGapShortHand ""

New value for property gridGap

setGridRowGap

Sets a new value for property gridRowGap.

Sets the value for the CSS display:grid property MDN web docs: grid-row-gap

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

Default value is empty string.

Param Type DefaultValue Description
sGridRowGap sap.ui.core.CSSSize ""

New value for property gridRowGap

setGridTemplateColumns

Sets a new value for property gridTemplateColumns.

Sets the value for the CSS display:grid property MDN web docs: grid-template-columns

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

Default value is empty string.

Param Type DefaultValue Description
sGridTemplateColumns sap.ui.layout.cssgrid.CSSGridTrack ""

New value for property gridTemplateColumns

setGridTemplateRows

Sets a new value for property gridTemplateRows.

Sets the value for the CSS display:grid property MDN web docs: grid-template-rows

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

Default value is empty string.

Param Type DefaultValue Description
sGridTemplateRows sap.ui.layout.cssgrid.CSSGridTrack ""

New value for property gridTemplateRows