class sap.m.StandardTile

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

The StandardTile control is displayed in the tile container.


Constructor

Constructor for a new StandardTile.

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.StandardTile(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
activeIcon sap.ui.core.URI

Defines the active icon of the StandardTile.

Visibility: public
icon sap.ui.core.URI

Defines the icon of the StandardTile.

Visibility: public
iconDensityAware boolean true

By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.

If bandwidth is key for the application, set this value to false.

Visibility: public
info string

Defines the description of the StandardTile.

Visibility: public
infoState sap.ui.core.ValueState None

Defines the color of the info text. Possible values are Error, Warning, Success and so on.

Visibility: public
number string

Defines the number field of the StandardTile.

Visibility: public
numberUnit string

Defines the number units qualifier of the StandardTile.

Visibility: public
title string

Defines the title of the StandardTile.

Visibility: public
type sap.m.StandardTileType None

Defines the type of the StandardTile.

Visibility: public

Borrowed 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

Associations

Name Cardinality Type Description
ariaDescribedBy 0..n sap.ui.core.Control

Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby).


Methods Overview

Method Description
addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

sap.m.StandardTile.extend

Creates a new subclass of class sap.m.StandardTile with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.Tile.extend.

getActiveIcon

Gets current value of property activeIcon.

Defines the active icon of the StandardTile.

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getIcon

Gets the icon of the StandardTile control.

getIconDensityAware

Gets current value of property iconDensityAware.

By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.

If bandwidth is key for the application, set this value to false.

Default value is true.

getInfo

Gets current value of property info.

Defines the description of the StandardTile.

getInfoState

Gets current value of property infoState.

Defines the color of the info text. Possible values are Error, Warning, Success and so on.

Default value is None.

sap.m.StandardTile.getMetadata

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

getNumber

Gets current value of property number.

Defines the number field of the StandardTile.

getNumberUnit

Gets current value of property numberUnit.

Defines the number units qualifier of the StandardTile.

getTitle

Gets current value of property title.

Defines the title of the StandardTile.

getType

Gets current value of property type.

Defines the type of the StandardTile.

Default value is None.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

setActiveIcon

Sets a new value for property activeIcon.

Defines the active icon of the StandardTile.

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

setIcon

Sets a new value for property icon.

Defines the icon of the StandardTile.

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

setIconDensityAware

Sets a new value for property iconDensityAware.

By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.

If bandwidth is key for the application, set this value to false.

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

Default value is true.

setInfo

Sets a new value for property info.

Defines the description of the StandardTile.

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

setInfoState

Sets a new value for property infoState.

Defines the color of the info text. Possible values are Error, Warning, Success and so on.

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

Default value is None.

setNumber

Sets a new value for property number.

Defines the number field of the StandardTile.

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

setNumberUnit

Sets a new value for property numberUnit.

Defines the number units qualifier of the StandardTile.

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

setTitle

Sets a new value for property title.

Defines the title of the StandardTile.

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

setType

Sets a new value for property type.

Defines the type of the StandardTile.

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

Default value is None.

addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to add; if empty, nothing is inserted

sap.m.StandardTile.extend

Creates a new subclass of class sap.m.StandardTile with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.Tile.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

getActiveIcon

Gets current value of property activeIcon.

Defines the active icon of the StandardTile.

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getIcon

Gets the icon of the StandardTile control.

getIconDensityAware

Gets current value of property iconDensityAware.

By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.

If bandwidth is key for the application, set this value to false.

Default value is true.

getInfo

Gets current value of property info.

Defines the description of the StandardTile.

getInfoState

Gets current value of property infoState.

Defines the color of the info text. Possible values are Error, Warning, Success and so on.

Default value is None.

sap.m.StandardTile.getMetadata

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

getNumber

Gets current value of property number.

Defines the number field of the StandardTile.

getNumberUnit

Gets current value of property numberUnit.

Defines the number units qualifier of the StandardTile.

getTitle

Gets current value of property title.

Defines the title of the StandardTile.

getType

Gets current value of property type.

Defines the type of the StandardTile.

Default value is None.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy int sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to be removed or its index or ID

setActiveIcon

Sets a new value for property activeIcon.

Defines the active icon of the StandardTile.

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

Param Type DefaultValue Description
sActiveIcon sap.ui.core.URI

New value for property activeIcon

setIcon

Sets a new value for property icon.

Defines the icon of the StandardTile.

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

Param Type DefaultValue Description
sIcon sap.ui.core.URI

New value for property icon

setIconDensityAware

Sets a new value for property iconDensityAware.

By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.

If bandwidth is key for the application, set this value to false.

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
bIconDensityAware boolean true

New value for property iconDensityAware

setInfo

Sets a new value for property info.

Defines the description of the StandardTile.

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

Param Type DefaultValue Description
sInfo string

New value for property info

setInfoState

Sets a new value for property infoState.

Defines the color of the info text. Possible values are Error, Warning, Success and so on.

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

Default value is None.

Param Type DefaultValue Description
sInfoState sap.ui.core.ValueState None

New value for property infoState

setNumber

Sets a new value for property number.

Defines the number field of the StandardTile.

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

Param Type DefaultValue Description
sNumber string

New value for property number

setNumberUnit

Sets a new value for property numberUnit.

Defines the number units qualifier of the StandardTile.

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

Param Type DefaultValue Description
sNumberUnit string

New value for property numberUnit

setTitle

Sets a new value for property title.

Defines the title of the StandardTile.

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

Param Type DefaultValue Description
sTitle string

New value for property title

setType

Sets a new value for property type.

Defines the type of the StandardTile.

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

Default value is None.

Param Type DefaultValue Description
sType sap.m.StandardTileType None

New value for property type