class sap.ui.layout.cssgrid.GridBoxLayout

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

Applies a sap.ui.layout.cssgrid.GridSettings to a provided DOM element or Control.


Constructor

Constructor for a new GridBoxLayout.

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.GridBoxLayout(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
boxMinWidth sap.ui.core.CSSSize empty string

Defines the minimum width of the Boxes

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

Defines the width of the Boxes

Visibility: public
boxesPerRowConfig sap.ui.layout.BoxesPerRowConfig XL7 L6 M4 S2

A string type that defines number of Boxes per row for extra large, large, medium and small screens

Note: When the property boxMinWidth or boxWidth is set this property has no effect.

Visibility: public

Methods Overview

Method Description
_getTemplateColumns

Returns a gridTemplateColumns value based on boxWidth and boxMinWidth properties

sap.ui.layout.cssgrid.GridBoxLayout.extend

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

getBoxesPerRowConfig

Gets current value of property boxesPerRowConfig.

A string type that defines number of Boxes per row for extra large, large, medium and small screens

Note: When the property boxMinWidth or boxWidth is set this property has no effect.

Default value is "XL7 L6 M4 S2".

getBoxMinWidth

Gets current value of property boxMinWidth.

Defines the minimum width of the Boxes

Default value is empty string.

getBoxWidth

Gets current value of property boxWidth.

Defines the width of the Boxes

Default value is empty string.

sap.ui.layout.cssgrid.GridBoxLayout.getMetadata

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

isResponsive
setBoxesPerRowConfig

Sets a new value for property boxesPerRowConfig.

A string type that defines number of Boxes per row for extra large, large, medium and small screens

Note: When the property boxMinWidth or boxWidth is set this property has no effect.

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

Default value is "XL7 L6 M4 S2".

setBoxMinWidth

Sets a new value for property boxMinWidth.

Defines the minimum width of the Boxes

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

Default value is empty string.

setBoxWidth

Sets a new value for property boxWidth.

Defines the width of the Boxes

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

Default value is empty string.

_getTemplateColumns

Returns a gridTemplateColumns value based on boxWidth and boxMinWidth properties

sap.ui.layout.cssgrid.GridBoxLayout.extend

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

getBoxesPerRowConfig

Gets current value of property boxesPerRowConfig.

A string type that defines number of Boxes per row for extra large, large, medium and small screens

Note: When the property boxMinWidth or boxWidth is set this property has no effect.

Default value is "XL7 L6 M4 S2".

getBoxMinWidth

Gets current value of property boxMinWidth.

Defines the minimum width of the Boxes

Default value is empty string.

getBoxWidth

Gets current value of property boxWidth.

Defines the width of the Boxes

Default value is empty string.

sap.ui.layout.cssgrid.GridBoxLayout.getMetadata

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

isResponsive

setBoxesPerRowConfig

Sets a new value for property boxesPerRowConfig.

A string type that defines number of Boxes per row for extra large, large, medium and small screens

Note: When the property boxMinWidth or boxWidth is set this property has no effect.

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

Default value is "XL7 L6 M4 S2".

Param Type DefaultValue Description
sBoxesPerRowConfig sap.ui.layout.BoxesPerRowConfig "XL7 L6 M4 S2"

New value for property boxesPerRowConfig

setBoxMinWidth

Sets a new value for property boxMinWidth.

Defines the minimum width of the Boxes

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
sBoxMinWidth sap.ui.core.CSSSize ""

New value for property boxMinWidth

setBoxWidth

Sets a new value for property boxWidth.

Defines the width of the Boxes

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
sBoxWidth sap.ui.core.CSSSize ""

New value for property boxWidth