class sap.m.CarouselLayout

Control sample: sap.m.CarouselLayout
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/CarouselLayout
Application Component: CA-UI5-CTR

Applies a sap.m.CarouselLayout to a provided DOM element or Control.


Constructor

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.m.CarouselLayout(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
visiblePagesCount int 1

Defines how many pages are displayed in the visible area of the Carousel control. Value should be a positive number.

Note: When this property is set to something different than the default value, the loop property of Carousel is ignored.

Visibility: public

Methods Overview

Method Description
sap.m.CarouselLayout.extend

Creates a new subclass of class sap.m.CarouselLayout 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.base.ManagedObject.extend.

sap.m.CarouselLayout.getMetadata

Returns a metadata object for class sap.m.CarouselLayout.

getVisiblePagesCount

Gets current value of property visiblePagesCount.

Defines how many pages are displayed in the visible area of the Carousel control. Value should be a positive number.

Note: When this property is set to something different than the default value, the loop property of Carousel is ignored.

Default value is 1.

setVisiblePagesCount

Sets a new value for property visiblePagesCount.

Defines how many pages are displayed in the visible area of the Carousel control. Value should be a positive number.

Note: When this property is set to something different than the default value, the loop property of Carousel is ignored.

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

Default value is 1.

sap.m.CarouselLayout.extend

Creates a new subclass of class sap.m.CarouselLayout 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.base.ManagedObject.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.m.CarouselLayout.getMetadata

Returns a metadata object for class sap.m.CarouselLayout.

getVisiblePagesCount

Gets current value of property visiblePagesCount.

Defines how many pages are displayed in the visible area of the Carousel control. Value should be a positive number.

Note: When this property is set to something different than the default value, the loop property of Carousel is ignored.

Default value is 1.

setVisiblePagesCount

Sets a new value for property visiblePagesCount.

Defines how many pages are displayed in the visible area of the Carousel control. Value should be a positive number.

Note: When this property is set to something different than the default value, the loop property of Carousel is ignored.

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

Default value is 1.

Param Type DefaultValue Description
iVisiblePagesCount int 1

New value for property visiblePagesCount