abstract class sap.ui.layout.cssgrid.GridLayoutBase

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

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


Constructor

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.

This class does not have its own settings, but all settings applicable to the base type sap.ui.base.ManagedObject can be used.

new sap.ui.layout.cssgrid.GridLayoutBase(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


Methods Overview

Method Description
_removeGridLayout

Removes all display:grid styles from the provided HTML element

_setGridLayout

Sets all display:grid styles to the provided HTML element

addGridStyles

Add "display:grid" and configuration styles with RenderManager. If the layout is responsive, the configuration styles are not added, as they are added by "applyGridLayout" later.

applyGridLayout

Apply styles to the provided array of HTML elements or controls based on the currently active GridSettings

sap.ui.layout.cssgrid.GridLayoutBase.extend

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

getActiveGridSettings

Should return sap.ui.layout.cssgrid.GridSettings - The active GridSettings Must be implemented by child classes

sap.ui.layout.cssgrid.GridLayoutBase.getMetadata

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

isResponsive
onGridAfterRendering

Hook function for the Grid's onAfterRendering

onGridResize

Hook function for the Grid's resize. Will be called if the grid layout is responsive.

_removeGridLayout

Removes all display:grid styles from the provided HTML element

Param Type DefaultValue Description
oElement HTMLElement

The element from which to remove the grid styles

_setGridLayout

Sets all display:grid styles to the provided HTML element

Param Type DefaultValue Description
oElement HTMLElement

The element to which to apply the grid styles

oGridSettings sap.ui.layout.cssgrid.GridSettings

The grid settings to apply

addGridStyles

Add "display:grid" and configuration styles with RenderManager. If the layout is responsive, the configuration styles are not added, as they are added by "applyGridLayout" later.

Param Type DefaultValue Description
oRM sap.ui.core.RenderManager

The render manager of the Grid which wants to add the styles

applyGridLayout

Apply styles to the provided array of HTML elements or controls based on the currently active GridSettings

Param Type DefaultValue Description
aElements sap.ui.core.Control[] HTMLElement[]

The elements or controls on which to apply the display:grid styles

sap.ui.layout.cssgrid.GridLayoutBase.extend

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

getActiveGridSettings

Should return sap.ui.layout.cssgrid.GridSettings - The active GridSettings Must be implemented by child classes

sap.ui.layout.cssgrid.GridLayoutBase.getMetadata

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

isResponsive

onGridAfterRendering

Hook function for the Grid's onAfterRendering

Param Type DefaultValue Description
oGrid sap.ui.layout.cssgrid.IGridConfigurable

The grid

onGridResize

Hook function for the Grid's resize. Will be called if the grid layout is responsive.

Param Type DefaultValue Description
oEvent jQuery.Event

The event passed by the resize handler