StandardTile

extends Tile

The StandardTile control is displayed in the tile container.

Since: 1.12.

Constructor Summary

new sap.m.StandardTile(sId?, mSettings?)Constructor for a new StandardTile.

Events borrowed from class sap.m.Tile

press

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.StandardTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.StandardTile with name sClassName and enriches it with the information contained in oClassInfo.

sap.m.StandardTile.getMetadata()Returns a metadata object for class sap.m.StandardTile.

addAriaDescribedBy(vAriaDescribedBy)Adds some ariaDescribedBy into the association ariaDescribedBy.

getActiveIcon()Gets current value of property activeIcon.

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.

getInfo()Gets current value of property info.

getInfoState()Gets current value of property infoState.

getNumber()Gets current value of property number.

getNumberUnit()Gets current value of property numberUnit.

getTitle()Gets current value of property title.

getType()Gets current value of property type.

removeAllAriaDescribedBy()Removes all the controls in the association named ariaDescribedBy.

removeAriaDescribedBy(vAriaDescribedBy)Removes an ariaDescribedBy from the association named ariaDescribedBy.

setActiveIcon(sActiveIcon)Sets a new value for property activeIcon.

setIcon(sIcon)Sets a new value for property icon.

setIconDensityAware(bIconDensityAware)Sets a new value for property iconDensityAware.

setInfo(sInfo)Sets a new value for property info.

setInfoState(sInfoState)Sets a new value for property infoState.

setNumber(sNumber)Sets a new value for property number.

setNumberUnit(sNumberUnit)Sets a new value for property numberUnit.

setTitle(sTitle)Sets a new value for property title.

setType(sType)Sets a new value for property type.

Methods borrowed from class sap.m.Tile

attachPress, detachPress, firePress, getRemovable, setRemovable

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

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.StandardTile(sId?, mSettings?)

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

The supported settings are:

Properties
- title : string
- info : string
- icon : sap.ui.core.URI
- activeIcon : sap.ui.core.URI
- number : string
- numberUnit : string
- infoState : sap.ui.core.ValueState (default: None)
- type : sap.m.StandardTileType (default: None)
- iconDensityAware : boolean (default: true)

In addition, all settings applicable to the base type sap.m.Tile 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.StandardTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.StandardTile.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addAriaDescribedBy(vAriaDescribedBy): sap.m.StandardTile

Adds some ariaDescribedBy into the association ariaDescribedBy.

Parameters:

{string|sap.ui.core.Control}

vAriaDescribedBy

the ariaDescribedBy to add; if empty, nothing is inserted

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

getActiveIcon(): sap.ui.core.URI

Gets current value of property activeIcon.

Defines the active icon of the StandardTile.

Returns:

{sap.ui.core.URI} Value of property activeIcon

getAriaDescribedBy(): sap.ui.core.Control[]

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

Returns:

{sap.ui.core.Control[]}

getIcon()

Gets the icon of the StandardTile control.

getIconDensityAware(): boolean

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.

Returns:

{boolean} Value of property iconDensityAware

getInfo(): string

Gets current value of property info.

Defines the description of the StandardTile.

Returns:

{string} Value of property info

getInfoState(): sap.ui.core.ValueState

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.

Returns:

{sap.ui.core.ValueState} Value of property infoState

getNumber(): string

Gets current value of property number.

Defines the number field of the StandardTile.

Returns:

{string} Value of property number

getNumberUnit(): string

Gets current value of property numberUnit.

Defines the number units qualifier of the StandardTile.

Returns:

{string} Value of property numberUnit

getTitle(): string

Gets current value of property title.

Defines the title of the StandardTile.

Returns:

{string} Value of property title

getType(): sap.m.StandardTileType

Gets current value of property type.

Defines the type of the StandardTile.

Default value is None.

Returns:

{sap.m.StandardTileType} Value of property type

removeAllAriaDescribedBy(): sap.ui.core.Control[]

Removes all the controls in the association named ariaDescribedBy.

Returns:

{sap.ui.core.Control[]}

An array of the removed elements (might be empty)

removeAriaDescribedBy(vAriaDescribedBy): sap.ui.core.Control

Removes an ariaDescribedBy from the association named ariaDescribedBy.

Parameters:

{int|string|sap.ui.core.Control}

vAriaDescribedBy

The ariaDescribedByto be removed or its index or ID

Returns:

{sap.ui.core.Control} the removed ariaDescribedBy or null

setActiveIcon(sActiveIcon): sap.m.StandardTile

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.

Parameters:

{sap.ui.core.URI} sActiveIcon New value for property activeIcon

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setIcon(sIcon): sap.m.StandardTile

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.

Parameters:

{sap.ui.core.URI} sIcon New value for property icon

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setIconDensityAware(bIconDensityAware): sap.m.StandardTile

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.

Parameters:

{boolean} bIconDensityAware New value for property iconDensityAware

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setInfo(sInfo): sap.m.StandardTile

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.

Parameters:

{string} sInfo New value for property info

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setInfoState(sInfoState): sap.m.StandardTile

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.

Parameters:

{sap.ui.core.ValueState} sInfoState New value for property infoState

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setNumber(sNumber): sap.m.StandardTile

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.

Parameters:

{string} sNumber New value for property number

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setNumberUnit(sNumberUnit): sap.m.StandardTile

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.

Parameters:

{string} sNumberUnit New value for property numberUnit

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setTitle(sTitle): sap.m.StandardTile

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.

Parameters:

{string} sTitle New value for property title

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining

setType(sType): sap.m.StandardTile

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.

Parameters:

{sap.m.StandardTileType} sType New value for property type

Returns:

{sap.m.StandardTile} Reference to this in order to allow method chaining