Class sap.ui.layout.ResponsiveFlowLayoutModule: sap/ui/layout/ResponsiveFlowLayout

extends Control
known direct subclasses: ResponsiveFlowLayout

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.


Since: 1.16.0.
Constructor Summary
new sap.ui.layout.ResponsiveFlowLayout(sId?, mSettings?)Constructor for a new ResponsiveFlowLayout.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.layout.ResponsiveFlowLayout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.ResponsiveFlowLayout with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.ResponsiveFlowLayout.getMetadata()Returns a metadata object for class sap.ui.layout.ResponsiveFlowLayout.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addContent(oContent)Adds content.
destroyContent()Destroys all the content in the aggregation content.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getContent()Gets content of aggregation content.
getResponsive()Gets current value of property responsive.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts content.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllContent()Removes all the controls from the aggregation content.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeContent(oContent)Removes content.
setResponsive(bResponsive)Sets a new value for property responsive.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.layout.ResponsiveFlowLayout(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
  • Aggregations
    • content : sap.ui.core.Control[] (default)

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Method Detail
sap.ui.layout.ResponsiveFlowLayout.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.layout.ResponsiveFlowLayout.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.ResponsiveFlowLayout.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAriaLabelledBy(vAriaLabelledBy): sap.ui.layout.ResponsiveFlowLayout
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
{string|sap.ui.core.Control}vAriaLabelledBy the ariaLabelledBy to add; if empty, nothing is inserted
Since:
1.38.32
Returns:
{sap.ui.layout.ResponsiveFlowLayout} Reference to this in order to allow method chaining
addContent(oContent)
Adds content. This function needs to be overridden to prevent any rendering while some content is still being added.
Parameters:
{sap.ui.core.Control}oContent The content that should be added to the layout
destroyContent(): sap.ui.layout.ResponsiveFlowLayout
Destroys all the content in the aggregation content.
Returns:
{sap.ui.layout.ResponsiveFlowLayout} Reference to this in order to allow method chaining
getAriaLabelledBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Since:
1.38.32
Returns:
{sap.ui.core.Control[]}
getContent(): sap.ui.core.Control[]
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.

Returns:
{sap.ui.core.Control[]}
getResponsive(): boolean
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.

Returns:
{boolean} Value of property responsive
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex)
Inserts content. This function needs to be overridden to prevent any rendering while some content is still being added.
Parameters:
{sap.ui.core.Control}oContent The content that should be inserted to the layout
{int}iIndex The index where the content should be inserted into
removeAllAriaLabelledBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaLabelledBy.
Since:
1.38.32
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
{int|string|sap.ui.core.Control}vAriaLabelledBy The ariaLabelledByto be removed or its index or ID
Since:
1.38.32
Returns:
{sap.ui.core.Control} the removed ariaLabelledBy or null
removeContent(oContent): sap.ui.core.Control
Removes content. This function needs to be overridden to prevent any rendering while some content is still being added.
Parameters:
{int|string|sap.ui.core.Control}oContent The content that should be removed from the layout
Returns:
{sap.ui.core.Control} The this pointer for chaining
setResponsive(bResponsive): sap.ui.layout.ResponsiveFlowLayout
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.

Parameters:
{boolean}bResponsive New value for property responsive
Returns:
{sap.ui.layout.ResponsiveFlowLayout} Reference to this in order to allow method chaining