The StandardTile control is displayed in the tile container.
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 |
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 |
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). |
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
|
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 |
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 |
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 |
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 |
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 |
setIcon |
Sets a new value for property icon. Defines the icon of the StandardTile. When called with a value of |
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 Default value is |
setInfo |
Sets a new value for property info. Defines the description of the StandardTile. When called with a value of |
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 Default value is |
setNumber |
Sets a new value for property number. Defines the number field of the StandardTile. When called with a value of |
setNumberUnit |
Sets a new value for property numberUnit. Defines the number units qualifier of the StandardTile. When called with a value of |
setTitle |
Sets a new value for property title. Defines the title of the StandardTile. When called with a value of |
setType |
Sets a new value for property type. Defines the type of the StandardTile. When called with a value of Default value is |
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 |
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 |
Gets current value of property activeIcon.
Defines the active icon of the StandardTile.
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
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
.
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
.
Gets current value of property numberUnit.
Defines the number units qualifier of the StandardTile.
Gets current value of property type.
Defines the type of the StandardTile.
Default value is None
.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |