Class sap.m.TileModule: sap/m/Tile

extends Control
known direct subclasses: CustomTile, OverviewTile, StandardTile

A tile to be displayed in the tile container. Use this tile as the base class for specialized tile implementations. Use the renderer _addOuterClass methods to add a style class to the main surface of the Tile. In this class set the background color, gradients or background images. Instead of implementing the default render method in the renderer, implement your content HTML in the _renderContent method of the specialized tile.


Since: 1.12.
Constructor Summary
new sap.m.Tile(sId?, mSettings?)Constructor for a new Tile.
Event Summary
press(oControlEvent)Tap event is raised if the user taps or clicks the 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.Tile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.Tile with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.Tile.getMetadata()Returns a metadata object for class sap.m.Tile.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.m.Tile.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.m.Tile.
firePress(mArguments?)Fires event press to attached listeners.
getRemovable()Gets current value of property removable.
setRemovable(bRemovable)Sets a new value for property removable.
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, onBeforeRendering, 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, exit, 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.Tile(sId?, mSettings?)
Constructor for a new Tile.

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
  • 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:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Event Detail
press(oControlEvent)
Tap event is raised if the user taps or clicks the control.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.m.Tile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.Tile 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.Tile.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.Tile.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachPress(oData?, fnFunction, oListener?): sap.m.Tile
Attaches event handler fnFunction to the press event of this sap.m.Tile.

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.Tile itself.

Tap event is raised if the user taps or clicks the control.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.Tile itself
Returns:
{sap.m.Tile} Reference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.m.Tile
Detaches event handler fnFunction from the press event of this sap.m.Tile.

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

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.m.Tile} Reference to this in order to allow method chaining
firePress(mArguments?): sap.m.Tile
Fires event press to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.Tile} Reference to this in order to allow method chaining
getRemovable(): boolean
Gets current value of property removable.

Determines whether the tile is movable within the surrounding tile container. The remove event is fired by the tile container.

Default value is true.

Returns:
{boolean} Value of property removable
setRemovable(bRemovable): sap.m.Tile
Sets a new value for property removable.

Determines whether the tile is movable within the surrounding tile container. The remove event is fired by the tile container.

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

Default value is true.

Parameters:
{boolean}bRemovable New value for property removable
Returns:
{sap.m.Tile} Reference to this in order to allow method chaining