class sap.m.SlideTile

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

The control that displays multiple GenericTile controls as changing slides.


Constructor

Constructor for a new sap.m.SlideTile control.

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.SlideTile(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
displayTime int 5000

The time of the slide display in milliseconds.

Visibility: public
height sap.ui.core.CSSSize

Height of the control.

Since: 1.96.

Visibility: public
scope sap.m.GenericTileScope Display

Changes the visualization in order to enable additional actions with the SlideTile control.

Since: 1.46.0.

Visibility: public
sizeBehavior sap.m.TileSizeBehavior Responsive

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen. This property has to be set consistently for the SlideTile along with all its inner GenericTile elements, so that they match one another visually.

Visibility: public
transitionTime int 500

The time of the slide changing in milliseconds.

Visibility: public
width sap.ui.core.CSSSize

Width of the control.

Since: 1.72.

Visibility: public

Aggregations

Default Aggregation: tiles

Name Cardinality Type Description
_pausePlayIcon 0..1 sap.ui.core.Icon

The pause/play icon that is being used to display the pause/play state of the control.

tiles (default) 0..n sap.m.GenericTile

The set of Generic Tiles to be shown in the control.


Events Overview

Event Description
press

The event is fired when the user chooses the tile. The event is available only in Actions scope.

Since: 1.46.0.

press

The event is fired when the user chooses the tile. The event is available only in Actions scope.

Since: 1.46.0.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
scope sap.m.GenericTileScope

The current scope the SlideTile was in when the event occurred.

Since: 1.46.0.

action string

The action that was pressed on the tile. In the Actions scope, the available actions are Press and Remove.

Since: 1.46.0.

domRef any

The Element's DOM Element. In Actions scope the domRef points to the DOM Element of the remove button (if pressed) or the more icon.

Since: 1.46.0.


Methods Overview

Method Description
addTile

Adds some tile to the aggregation tiles.

attachPress

Attaches event handler fnFunction to the press event of this sap.m.SlideTile.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SlideTile itself.

The event is fired when the user chooses the tile. The event is available only in Actions scope.

bindTiles

Binds aggregation tiles to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

destroyTiles

Destroys all the tiles in the aggregation tiles.

detachPress

Detaches event handler fnFunction from the press event of this sap.m.SlideTile.

The passed function and listener object must match the ones used for event registration.

sap.m.SlideTile.extend

Creates a new subclass of class sap.m.SlideTile 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.

firePress

Fires event press to attached listeners.

getDisplayTime

Gets current value of property displayTime.

The time of the slide display in milliseconds.

Default value is 5000.

getHeight

Gets current value of property height.

Height of the control.

sap.m.SlideTile.getMetadata

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

getScope

Gets current value of property scope.

Changes the visualization in order to enable additional actions with the SlideTile control.

Default value is "Display".

getSizeBehavior

Gets current value of property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen. This property has to be set consistently for the SlideTile along with all its inner GenericTile elements, so that they match one another visually.

Default value is Responsive.

getTiles

Gets content of aggregation tiles.

The set of Generic Tiles to be shown in the control.

getTransitionTime

Gets current value of property transitionTime.

The time of the slide changing in milliseconds.

Default value is 500.

getWidth

Gets current value of property width.

Width of the control.

indexOfTile

Checks for the provided sap.m.GenericTile in the aggregation tiles. and returns its index if found or -1 otherwise.

insertTile

Inserts a tile into the aggregation tiles.

removeAllTiles

Removes all the controls from the aggregation tiles.

Additionally, it unregisters them from the hosting UIArea.

removeTile

Removes a tile from the aggregation tiles.

setDisplayTime

Sets a new value for property displayTime.

The time of the slide display in milliseconds.

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

Default value is 5000.

setHeight

Sets a new value for property height.

Height of the control.

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

setScope

Sets a new value for property scope.

Changes the visualization in order to enable additional actions with the SlideTile control.

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

Default value is "Display".

setSizeBehavior

Sets a new value for property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen. This property has to be set consistently for the SlideTile along with all its inner GenericTile elements, so that they match one another visually.

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

Default value is Responsive.

setTransitionTime

Sets a new value for property transitionTime.

The time of the slide changing in milliseconds.

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

Default value is 500.

setWidth

Sets a new value for property width.

Width of the control.

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

unbindTiles

Unbinds aggregation tiles from model data.

addTile

Adds some tile to the aggregation tiles.

Param Type DefaultValue Description
oTile sap.m.GenericTile

The tile to add; if empty, nothing is inserted

attachPress

Attaches event handler fnFunction to the press event of this sap.m.SlideTile.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SlideTile itself.

The event is fired when the user chooses the tile. The event is available only in Actions scope.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.SlideTile itself

bindTiles

Binds aggregation tiles to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyTiles

Destroys all the tiles in the aggregation tiles.

detachPress

Detaches event handler fnFunction from the press event of this sap.m.SlideTile.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.m.SlideTile.extend

Creates a new subclass of class sap.m.SlideTile 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

firePress

Fires event press to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

scope sap.m.GenericTileScope

The current scope the SlideTile was in when the event occurred.

action string

The action that was pressed on the tile. In the Actions scope, the available actions are Press and Remove.

domRef any

The Element's DOM Element. In Actions scope the domRef points to the DOM Element of the remove button (if pressed) or the more icon.

getDisplayTime

Gets current value of property displayTime.

The time of the slide display in milliseconds.

Default value is 5000.

getHeight

Gets current value of property height.

Height of the control.

sap.m.SlideTile.getMetadata

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

getScope

Gets current value of property scope.

Changes the visualization in order to enable additional actions with the SlideTile control.

Default value is "Display".

getSizeBehavior

Gets current value of property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen. This property has to be set consistently for the SlideTile along with all its inner GenericTile elements, so that they match one another visually.

Default value is Responsive.

getTiles

Gets content of aggregation tiles.

The set of Generic Tiles to be shown in the control.

getTransitionTime

Gets current value of property transitionTime.

The time of the slide changing in milliseconds.

Default value is 500.

getWidth

Gets current value of property width.

Width of the control.

indexOfTile

Checks for the provided sap.m.GenericTile in the aggregation tiles. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oTile sap.m.GenericTile

The tile whose index is looked for

insertTile

Inserts a tile into the aggregation tiles.

Param Type DefaultValue Description
oTile sap.m.GenericTile

The tile to insert; if empty, nothing is inserted

iIndex int

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

removeAllTiles

Removes all the controls from the aggregation tiles.

Additionally, it unregisters them from the hosting UIArea.

removeTile

Removes a tile from the aggregation tiles.

Param Type DefaultValue Description
vTile int string sap.m.GenericTile

The tile to remove or its index or id

setDisplayTime

Sets a new value for property displayTime.

The time of the slide display in milliseconds.

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

Default value is 5000.

Param Type DefaultValue Description
iDisplayTime int 5000

New value for property displayTime

setHeight

Sets a new value for property height.

Height of the control.

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

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize

New value for property height

setScope

Sets a new value for property scope.

Changes the visualization in order to enable additional actions with the SlideTile control.

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

Default value is "Display".

Param Type DefaultValue Description
sScope sap.m.GenericTileScope "Display"

New value for property scope

setSizeBehavior

Sets a new value for property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen. This property has to be set consistently for the SlideTile along with all its inner GenericTile elements, so that they match one another visually.

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

Default value is Responsive.

Param Type DefaultValue Description
sSizeBehavior sap.m.TileSizeBehavior Responsive

New value for property sizeBehavior

setTransitionTime

Sets a new value for property transitionTime.

The time of the slide changing in milliseconds.

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

Default value is 500.

Param Type DefaultValue Description
iTransitionTime int 500

New value for property transitionTime

setWidth

Sets a new value for property width.

Width of the control.

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

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize

New value for property width

unbindTiles

Unbinds aggregation tiles from model data.