class sap.ui.layout.cssgrid.ResponsiveColumnLayout

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

Represents a layout which displays variable number of columns, depending on available screen size. With that it achieves flexible layouts and line breaks for large, medium, and small-sized screens, such as desktop, tablet, and mobile.

Grid row's height is dynamically determined by the height of the highest grid element on this row.


Constructor

Constructor for a new ResponsiveColumnLayout.

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.ResponsiveColumnLayout(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


Events Overview

Event Description
layoutChange

Fired when the currently active layout changes

layoutChange

Fired when the currently active layout changes

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
layout string

The name of the newly active layout - "S", "M", "ML", "L", "XL", "XXL" or "XXXL".


Methods Overview

Method Description
attachLayoutChange

Attaches event handler fnFunction to the layoutChange event of this sap.ui.layout.cssgrid.ResponsiveColumnLayout.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.layout.cssgrid.ResponsiveColumnLayout itself.

Fired when the currently active layout changes

detachLayoutChange

Detaches event handler fnFunction from the layoutChange event of this sap.ui.layout.cssgrid.ResponsiveColumnLayout.

The passed function and listener object must match the ones used for event registration.

sap.ui.layout.cssgrid.ResponsiveColumnLayout.extend

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

fireLayoutChange

Fires event layoutChange to attached listeners.

sap.ui.layout.cssgrid.ResponsiveColumnLayout.getMetadata

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

isResponsive

Returns if the Grid Layout is responsive.

attachLayoutChange

Attaches event handler fnFunction to the layoutChange event of this sap.ui.layout.cssgrid.ResponsiveColumnLayout.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.layout.cssgrid.ResponsiveColumnLayout itself.

Fired when the currently active layout changes

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.layout.cssgrid.ResponsiveColumnLayout itself

detachLayoutChange

Detaches event handler fnFunction from the layoutChange event of this sap.ui.layout.cssgrid.ResponsiveColumnLayout.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.layout.cssgrid.ResponsiveColumnLayout.extend

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

fireLayoutChange

Fires event layoutChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

layout string

The name of the newly active layout - "S", "M", "ML", "L", "XL", "XXL" or "XXXL".

sap.ui.layout.cssgrid.ResponsiveColumnLayout.getMetadata

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

isResponsive

Returns if the Grid Layout is responsive.