Class sap.m.SlideTileModule: sap/m/SlideTile

extends Control

The control that displays multiple GenericTile controls as changing slides.
Since: 1.34.
Constructor Summary
new sap.m.SlideTile(sId?, mSettings?)Constructor for a new sap.m.SlideTile control.
Event Summary
press(oControlEvent)The event is fired when the user chooses the tile.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.SlideTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.SlideTile with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.SlideTile.getMetadata()Returns a metadata object for class sap.m.SlideTile.
addTile(oTile)Adds some tile to the aggregation tiles.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.m.SlideTile.
bindTiles(oBindingInfo)Binds aggregation tiles to model data.
destroyTiles()Destroys all the tiles in the aggregation tiles.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.m.SlideTile.
firePress(mParameters?)Fires event press to attached listeners.
getDisplayTime()Gets current value of property displayTime.
getScope()Gets current value of property scope.
getTiles()Gets content of aggregation tiles.
getTransitionTime()Gets current value of property transitionTime.
indexOfTile(oTile)Checks for the provided sap.m.GenericTile in the aggregation tiles.
insertTile(oTile, iIndex)Inserts a tile into the aggregation tiles.
removeAllTiles()Removes all the controls from the aggregation tiles.
removeTile(vTile)Removes a tile from the aggregation tiles.
setDisplayTime(iDisplayTime)Sets a new value for property displayTime.
setScope(sScope)Sets a new value for property scope.
setTransitionTime(iTransitionTime)Sets a new value for property transitionTime.
unbindTiles()Unbinds aggregation tiles from model data.
Constructor Detail
new sap.m.SlideTile(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

    • tiles : sap.m.GenericTile[] (default)

  • Events

    • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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
Event Detail
press(oControlEvent)
The event is fired when the user chooses the tile. The event is available only in Actions scope.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.GenericTileScopeoControlEvent.getParameters.scopeThe current scope the SlideTile was in when the event occurred.
stringoControlEvent.getParameters.actionThe action that was pressed on the tile. In the Actions scope, the available actions are Press and Remove.
anyoControlEvent.getParameters.domRefThe 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
Method Detail
sap.m.SlideTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.m.SlideTile.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.SlideTile.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addTile(oTile): sap.m.SlideTile
Adds some tile to the aggregation tiles.
Parameters:
sap.m.GenericTileoTilethe tile to add; if empty, nothing is inserted
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
attachPress(oData?, fnFunction, oListener?): sap.m.SlideTile

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.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SlideTile itself
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
Since:
1.46.0
bindTiles(oBindingInfo): sap.m.SlideTile

Binds aggregation tiles to model data.

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

Parameters:
objectoBindingInfoThe binding information
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
destroyTiles(): sap.m.SlideTile
Destroys all the tiles in the aggregation tiles.
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.m.SlideTile

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
Since:
1.46.0
firePress(mParameters?): sap.m.SlideTile
Fires event press to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.GenericTileScopemParameters.scope?The current scope the SlideTile was in when the event occurred.
stringmParameters.action?The action that was pressed on the tile. In the Actions scope, the available actions are Press and Remove.
anymParameters.domRef?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.
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
Since:
1.46.0
getDisplayTime(): int

Gets current value of property displayTime.

The time of the slide display in milliseconds.

Default value is 5000.

Returns:
intValue of property displayTime

Gets current value of property scope.

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

Default value is Display.

Returns:
sap.m.GenericTileScopeValue of property scope
Since:
1.46.0
getTiles(): sap.m.GenericTile[]

Gets content of aggregation tiles.

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

Returns:
sap.m.GenericTile[]
getTransitionTime(): int

Gets current value of property transitionTime.

The time of the slide changing in milliseconds.

Default value is 500.

Returns:
intValue of property transitionTime
indexOfTile(oTile): int
Checks for the provided sap.m.GenericTile in the aggregation tiles. and returns its index if found or -1 otherwise.
Parameters:
sap.m.GenericTileoTileThe tile whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertTile(oTile, iIndex): sap.m.SlideTile
Inserts a tile into the aggregation tiles.
Parameters:
sap.m.GenericTileoTilethe tile to insert; if empty, nothing is inserted
intiIndexthe 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
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
removeAllTiles(): sap.m.GenericTile[]

Removes all the controls from the aggregation tiles.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.m.GenericTile[]An array of the removed elements (might be empty)
removeTile(vTile): sap.m.GenericTile
Removes a tile from the aggregation tiles.
Parameters:
int|string|sap.m.GenericTilevTileThe tile to remove or its index or id
Returns:
sap.m.GenericTileThe removed tile or null
setDisplayTime(iDisplayTime): sap.m.SlideTile

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.

Parameters:
intiDisplayTimeNew value for property displayTime
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
setScope(sScope): sap.m.SlideTile

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.

Parameters:
sap.m.GenericTileScopesScopeNew value for property scope
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
Since:
1.46.0
setTransitionTime(iTransitionTime): sap.m.SlideTile

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.

Parameters:
intiTransitionTimeNew value for property transitionTime
Returns:
sap.m.SlideTileReference to this in order to allow method chaining
unbindTiles(): sap.m.SlideTile
Unbinds aggregation tiles from model data.
Returns:
sap.m.SlideTileReference to this in order to allow method chaining