class sap.ui.layout.SplitterLayoutData

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

Holds layout data for the splitter contents. Allowed size values are numeric values ending in "px" and "%" and the special case "auto". (The CSS value "auto" is used internally to recalculate the size of the content dynamically and is not directly set as style property.)


Constructor

Constructor for a new SplitterLayoutData.

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.SplitterLayoutData(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
minSize int 0

Sets the minimum size of the splitter content in px.

Visibility: public
resizable boolean true

Determines whether the control in the splitter can be resized or not.

Visibility: public
size sap.ui.core.CSSSize auto

The size of the splitter content. This property is updated when the area is resized by the user.

Note: Resizing areas in the sap.ui.layout.Splitter sets this property to "px" values, while resizing areas in the sap.ui.layout.ResponsiveSplitter sets it to % values.

Visibility: public

Methods Overview

Method Description
sap.ui.layout.SplitterLayoutData.extend

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

sap.ui.layout.SplitterLayoutData.getMetadata

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

getMinSize

Gets current value of property minSize.

Sets the minimum size of the splitter content in px.

Default value is 0.

getResizable

Gets current value of property resizable.

Determines whether the control in the splitter can be resized or not.

Default value is true.

getSize

Gets current value of property size.

The size of the splitter content. This property is updated when the area is resized by the user.

Note: Resizing areas in the sap.ui.layout.Splitter sets this property to "px" values, while resizing areas in the sap.ui.layout.ResponsiveSplitter sets it to % values.

Default value is 'auto'.

setMinSize

Sets a new value for property minSize.

Sets the minimum size of the splitter content in px.

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

Default value is 0.

setResizable

Sets a new value for property resizable.

Determines whether the control in the splitter can be resized or not.

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

Default value is true.

setSize

Sets a new value for property size.

The size of the splitter content. This property is updated when the area is resized by the user.

Note: Resizing areas in the sap.ui.layout.Splitter sets this property to "px" values, while resizing areas in the sap.ui.layout.ResponsiveSplitter sets it to % values.

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

Default value is 'auto'.

sap.ui.layout.SplitterLayoutData.extend

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

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

sap.ui.layout.SplitterLayoutData.getMetadata

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

getMinSize

Gets current value of property minSize.

Sets the minimum size of the splitter content in px.

Default value is 0.

getResizable

Gets current value of property resizable.

Determines whether the control in the splitter can be resized or not.

Default value is true.

getSize

Gets current value of property size.

The size of the splitter content. This property is updated when the area is resized by the user.

Note: Resizing areas in the sap.ui.layout.Splitter sets this property to "px" values, while resizing areas in the sap.ui.layout.ResponsiveSplitter sets it to % values.

Default value is 'auto'.

setMinSize

Sets a new value for property minSize.

Sets the minimum size of the splitter content in px.

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

Default value is 0.

Param Type DefaultValue Description
iMinSize int 0

New value for property minSize

setResizable

Sets a new value for property resizable.

Determines whether the control in the splitter can be resized or not.

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

New value for property resizable

setSize

Sets a new value for property size.

The size of the splitter content. This property is updated when the area is resized by the user.

Note: Resizing areas in the sap.ui.layout.Splitter sets this property to "px" values, while resizing areas in the sap.ui.layout.ResponsiveSplitter sets it to % values.

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

Default value is 'auto'.

Param Type DefaultValue Description
sSize sap.ui.core.CSSSize 'auto'

New value for property size