Class sap.ui.layout.ResponsiveFlowLayoutDataModule: sap/ui/layout/ResponsiveFlowLayoutData

extends LayoutData
known direct subclasses: ResponsiveFlowLayoutData

This is a LayoutData element that can be added to a control if this control is used within a ResponsiveFlowLayout.


Since: 1.16.0.
Constructor Summary
new sap.ui.layout.ResponsiveFlowLayoutData(sId?, mSettings?)Constructor for a new ResponsiveFlowLayoutData.
Method Summary
sap.ui.layout.ResponsiveFlowLayoutData.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.ResponsiveFlowLayoutData with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.ResponsiveFlowLayoutData.getMetadata()Returns a metadata object for class sap.ui.layout.ResponsiveFlowLayoutData.
getLinebreak()Gets current value of property linebreak.
getLinebreakable()Gets current value of property linebreakable.
getMargin()Gets current value of property margin.
getMinWidth()Gets current value of property minWidth.
getWeight()Gets current value of property weight.
setLinebreak(bLinebreak)Sets a new value for property linebreak.
setLinebreakable(bLinebreakable)Sets a new value for property linebreakable.
setMargin(bMargin)Sets a new value for property margin.
setMinWidth(iMinWidth)Sets a new value for property minWidth.
setWeight(iWeight)Sets a new value for property weight.
Constructor Detail
new sap.ui.layout.ResponsiveFlowLayoutData(sId?, mSettings?)
Constructor for a new ResponsiveFlowLayoutData.

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:

In addition, all settings applicable to the base type sap.ui.core.LayoutData 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.ResponsiveFlowLayoutData.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.layout.ResponsiveFlowLayoutData 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.LayoutData.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.ResponsiveFlowLayoutData.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.ResponsiveFlowLayoutData.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getLinebreak(): boolean
Gets current value of property linebreak.

If this property is set, the control in which the LayoutData is added, will always cause a line break within the ResponsiveFlowLayout.

Default value is false.

Returns:
{boolean} Value of property linebreak
getLinebreakable(): boolean
Gets current value of property linebreakable.

Shows if an element can be wrapped into a new row. If this value is set to false, the min-width will be set to 0 and the wrapping is up to the previous element.

Default value is true.

Returns:
{boolean} Value of property linebreakable
getMargin(): boolean
Gets current value of property margin.

Prevents any margin of the element if set to false.

Default value is true.

Returns:
{boolean} Value of property margin
getMinWidth(): int
Gets current value of property minWidth.

Defines the minimal size in px of an ResponsiveFlowLayout element. The element will be shrunk down to this value.

Default value is 100.

Returns:
{int} Value of property minWidth
getWeight(): int
Gets current value of property weight.

Defines the weight of the element, that influences the resulting width. If there are several elements within a row of the ResponsiveFlowLayout, each element could have another weight. The bigger the weight of a single element, the wider it will be stretched, i.e. a bigger weight results in a larger width.

Default value is 1.

Returns:
{int} Value of property weight
setLinebreak(bLinebreak): sap.ui.layout.ResponsiveFlowLayoutData
Sets a new value for property linebreak.

If this property is set, the control in which the LayoutData is added, will always cause a line break within the ResponsiveFlowLayout.

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

Default value is false.

Parameters:
{boolean}bLinebreak New value for property linebreak
Returns:
{sap.ui.layout.ResponsiveFlowLayoutData} Reference to this in order to allow method chaining
setLinebreakable(bLinebreakable): sap.ui.layout.ResponsiveFlowLayoutData
Sets a new value for property linebreakable.

Shows if an element can be wrapped into a new row. If this value is set to false, the min-width will be set to 0 and the wrapping is up to the previous element.

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

Default value is true.

Parameters:
{boolean}bLinebreakable New value for property linebreakable
Returns:
{sap.ui.layout.ResponsiveFlowLayoutData} Reference to this in order to allow method chaining
Sets a new value for property margin.

Prevents any margin of the element if set to false.

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

Default value is true.

Parameters:
{boolean}bMargin New value for property margin
Returns:
{sap.ui.layout.ResponsiveFlowLayoutData} Reference to this in order to allow method chaining
Sets a new value for property minWidth.

Defines the minimal size in px of an ResponsiveFlowLayout element. The element will be shrunk down to this value.

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

Default value is 100.

Parameters:
{int}iMinWidth New value for property minWidth
Returns:
{sap.ui.layout.ResponsiveFlowLayoutData} Reference to this in order to allow method chaining
Sets a new value for property weight.

Defines the weight of the element, that influences the resulting width. If there are several elements within a row of the ResponsiveFlowLayout, each element could have another weight. The bigger the weight of a single element, the wider it will be stretched, i.e. a bigger weight results in a larger width.

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

Default value is 1.

Parameters:
{int}iWeight New value for property weight
Returns:
{sap.ui.layout.ResponsiveFlowLayoutData} Reference to this in order to allow method chaining