class sap.m.Tile

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

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.


Constructor

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

new sap.m.Tile(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
removable boolean true

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

Visibility: public

Events Overview

Event Description
press

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

press

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

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

Methods Overview

Method Description
attachPress

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.

detachPress

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.

sap.m.Tile.extend

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.

firePress

Fires event press to attached listeners.

sap.m.Tile.getMetadata

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

getRemovable

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.

setRemovable

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.

attachPress

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.

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

detachPress

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.

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

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.

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

sap.m.Tile.getMetadata

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

getRemovable

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.

setRemovable

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.

Param Type DefaultValue Description
bRemovable boolean true

New value for property removable