class sap.ui.layout.HorizontalLayout

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

A layout that provides support for horizontal alignment of controls

This control can be a drop target.

Constructor

Constructor for a new HorizontalLayout.

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.HorizontalLayout(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
allowWrapping boolean false

Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less horizontal space available than required.

Visibility: public

Aggregations

Default Aggregation: content

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

The controls inside this layout


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

destroyContent

Destroys all the content in the aggregation content.

sap.ui.layout.HorizontalLayout.extend

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

getAccessibilityInfo

References:

  • sap.ui.core.Control#getAccessibilityInfo

getAllowWrapping

Gets current value of property allowWrapping.

Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less horizontal space available than required.

Default value is false.

getContent

Gets content of aggregation content.

The controls inside this layout

sap.ui.layout.HorizontalLayout.getMetadata

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

indexOfContent

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

insertContent

Inserts a content into the aggregation content.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

setAllowWrapping

Sets a new value for property allowWrapping.

Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less horizontal space available than required.

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

Default value is false.

addContent

Adds some content to the aggregation content.

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

The content to add; if empty, nothing is inserted

destroyContent

Destroys all the content in the aggregation content.

sap.ui.layout.HorizontalLayout.extend

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

getAccessibilityInfo

References:

getAllowWrapping

Gets current value of property allowWrapping.

Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less horizontal space available than required.

Default value is false.

getContent

Gets content of aggregation content.

The controls inside this layout

sap.ui.layout.HorizontalLayout.getMetadata

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

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 a content into the aggregation content.

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

The content to insert; if empty, nothing is inserted

iIndex int

The 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

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

The content to remove or its index or id

setAllowWrapping

Sets a new value for property allowWrapping.

Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less horizontal space available than required.

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

Default value is false.

Param Type DefaultValue Description
bAllowWrapping boolean false

New value for property allowWrapping