Class sap.ui.commons.HorizontalDividerModule: sap/ui/commons/HorizontalDivider

extends Control

Divides the screen in visual areas.
Deprecated API:
Since version 1.38.
Constructor Summary
new sap.ui.commons.HorizontalDivider(sId?, mSettings?)Constructor for a new HorizontalDivider.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.HorizontalDivider.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.HorizontalDivider with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.HorizontalDivider.getMetadata()Returns a metadata object for class sap.ui.commons.HorizontalDivider.
getHeight()Gets current value of property height.
getType()Gets current value of property type.
getWidth()Gets current value of property width.
setHeight(sHeight)Sets a new value for property height.
setType(sType)Sets a new value for property type.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.ui.commons.HorizontalDivider(sId?, mSettings?)

Constructor for a new HorizontalDivider.

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

    • width : sap.ui.core.CSSSize (default: 100%)
    • type : sap.ui.commons.HorizontalDividerType (default: Area)
    • height : sap.ui.commons.HorizontalDividerHeight (default: Medium)

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

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.ui.commons.HorizontalDivider.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.HorizontalDivider 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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.commons.HorizontalDivider.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.HorizontalDivider.
Returns:
sap.ui.base.MetadataMetadata object describing this class

Gets current value of property height.

Defines the height of the divider.

Default value is Medium.

Returns:
sap.ui.commons.HorizontalDividerHeightValue of property height

Gets current value of property type.

Defines the type of the divider.

Default value is Area.

Returns:
sap.ui.commons.HorizontalDividerTypeValue of property type
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Defines the width of the divider.

Default value is 100%.

Returns:
sap.ui.core.CSSSizeValue of property width

Sets a new value for property height.

Defines the height of the divider.

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

Default value is Medium.

Parameters:
sap.ui.commons.HorizontalDividerHeightsHeightNew value for property height
Returns:
sap.ui.commons.HorizontalDividerReference to this in order to allow method chaining

Sets a new value for property type.

Defines the type of the divider.

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

Default value is Area.

Parameters:
sap.ui.commons.HorizontalDividerTypesTypeNew value for property type
Returns:
sap.ui.commons.HorizontalDividerReference to this in order to allow method chaining

Sets a new value for property width.

Defines the width of the divider.

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

Default value is 100%.

Parameters:
sap.ui.core.CSSSizesWidthNew value for property width
Returns:
sap.ui.commons.HorizontalDividerReference to this in order to allow method chaining