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.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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.
bindTiles(oBindingInfo)Binds aggregation tiles to model data.
destroyTiles()Destroys all the tiles in the aggregation tiles.
getDisplayTime()Gets current value of property displayTime.
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.
setTransitionTime(iTransitionTime)Sets a new value for property transitionTime.
unbindTiles()Unbinds aggregation tiles from model data.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
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:

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

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
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:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.m.SlideTile.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.SlideTile.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addTile(oTile): sap.m.SlideTile
Adds some tile to the aggregation tiles.
Parameters:
{sap.m.GenericTile}oTile the tile to add; if empty, nothing is inserted
Returns:
{sap.m.SlideTile} Reference to this in order to allow method chaining
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:
{object}oBindingInfo The binding information
Returns:
{sap.m.SlideTile} Reference to this in order to allow method chaining
destroyTiles(): sap.m.SlideTile
Destroys all the tiles in the aggregation tiles.
Returns:
{sap.m.SlideTile} Reference to this in order to allow method chaining
getDisplayTime(): int
Gets current value of property displayTime.

The time of the slide display in milliseconds.

Default value is 5000.

Returns:
{int} Value of property displayTime
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:
{int} Value 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.GenericTile}oTile The tile whose index is looked for
Returns:
{int} The 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.GenericTile}oTile the tile to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.m.SlideTile} Reference 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.GenericTile}vTile The tileto remove or its index or id
Returns:
{sap.m.GenericTile} The 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:
{int}iDisplayTime New value for property displayTime
Returns:
{sap.m.SlideTile} Reference to this in order to allow method chaining
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:
{int}iTransitionTime New value for property transitionTime
Returns:
{sap.m.SlideTile} Reference to this in order to allow method chaining
unbindTiles(): sap.m.SlideTile
Unbinds aggregation tiles from model data.
Returns:
{sap.m.SlideTile} Reference to this in order to allow method chaining