class sap.ui.layout.ResponsiveFlowLayout

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

This is a layout where several controls can be added. These controls are blown up to fit in an entire row. If the window resizes, the controls are moved between the rows and resized again.


Constructor

Constructor for a new ResponsiveFlowLayout.

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.ResponsiveFlowLayout(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
responsive boolean true

If set to false, all added controls will keep their width, or otherwise, the controls will be stretched to the possible width of a row.

Visibility: public

Aggregations

Default Aggregation: content

Name Cardinality Type Description
content (default) 0..n sap.ui.core.Control

Added content that should be positioned. Every content item should have a ResponsiveFlowLayoutData attached, or otherwise, the default values are used.


Associations

Name Cardinality Type Description
ariaLabelledBy 0..n sap.ui.core.Control

Association to controls / IDs that label this control (see WAI-ARIA attribute aria-labelledby).

Since: 1.48.7.


Methods Overview

Method Description
addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

addContent

Adds content. This function needs to be overridden to prevent any rendering while some content is still being added.

destroyContent

Destroys all the content in the aggregation content.

sap.ui.layout.ResponsiveFlowLayout.extend

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

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getContent

Gets content of aggregation content.

Added content that should be positioned. Every content item should have a ResponsiveFlowLayoutData attached, or otherwise, the default values are used.

sap.ui.layout.ResponsiveFlowLayout.getMetadata

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

getResponsive

Gets current value of property responsive.

If set to false, all added controls will keep their width, or otherwise, the controls will be stretched to the possible width of a row.

Default value is true.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

insertContent

Inserts content. This function needs to be overridden to prevent any rendering while some content is still being added.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

removeContent

Removes content. This function needs to be overridden to prevent any rendering while some content is still being added.

setResponsive

Sets a new value for property responsive.

If set to false, all added controls will keep their width, or otherwise, the controls will be stretched to the possible width of a row.

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

Default value is true.

addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

Param Type DefaultValue Description
vAriaLabelledBy sap.ui.core.ID sap.ui.core.Control

The ariaLabelledBy to add; if empty, nothing is inserted

addContent

Adds content. This function needs to be overridden to prevent any rendering while some content is still being added.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content that should be added to the layout

destroyContent

Destroys all the content in the aggregation content.

sap.ui.layout.ResponsiveFlowLayout.extend

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

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getContent

Gets content of aggregation content.

Added content that should be positioned. Every content item should have a ResponsiveFlowLayoutData attached, or otherwise, the default values are used.

sap.ui.layout.ResponsiveFlowLayout.getMetadata

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

getResponsive

Gets current value of property responsive.

If set to false, all added controls will keep their width, or otherwise, the controls will be stretched to the possible width of a row.

Default value is true.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content whose index is looked for

insertContent

Inserts content. This function needs to be overridden to prevent any rendering while some content is still being added.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content that should be inserted to the layout

iIndex int

The index where the content should be inserted into

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

Param Type DefaultValue Description
vAriaLabelledBy int sap.ui.core.ID sap.ui.core.Control

The ariaLabelledBy to be removed or its index or ID

removeContent

Removes content. This function needs to be overridden to prevent any rendering while some content is still being added.

Param Type DefaultValue Description
oContent int string sap.ui.core.Control

The content that should be removed from the layout

setResponsive

Sets a new value for property responsive.

If set to false, all added controls will keep their width, or otherwise, the controls will be stretched to the possible width of a row.

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
bResponsive boolean true

New value for property responsive