class sap.m.GenericTile

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

Displays header, subheader, and a customizable main area in a tile format. Since 1.44, also an in-line format which contains only header and subheader is supported.


Constructor

Constructor for a new sap.m.GenericTile control.

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.GenericTile(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
additionalTooltip string

Tooltip text which is added at the tooltip generated by the control.

Since: 1.82.

Visibility: public
appShortcut string

Application information such as ID/Shortcut

Since: 1.92.0.

Visibility: public
ariaLabel string

Additional description for aria-label. The aria-label is rendered before the standard aria-label.

Since: 1.50.0.

Visibility: public
ariaRole string

Additional description for aria-role.

Since: 1.83.

Visibility: public
ariaRoleDescription string

Additional description for aria-roledescription.

Since: 1.83.

Visibility: public
backgroundColor sap.ui.core.CSSColor

Background color of the GenericTile. Only applicable for IconMode.

Since: 1.96.

Visibility: public
backgroundImage sap.ui.core.URI

The URI of the background image.

Visibility: public
enableNavigationButton boolean false

Renders the given link as a button, enabling the option of opening the link in new tab/window functionality. Works only in ArticleMode.

Visibility: public
failedText string

The message that appears when the control is in the Failed state.

Visibility: public
frameType sap.m.FrameType OneByOne

The FrameType: OneByOne, TwoByOne, OneByHalf, or TwoByHalf. Default set to OneByOne if property is not defined or set to Auto by the app.

Visibility: public
header string

The header of the tile.

Visibility: public
headerImage sap.ui.core.URI

The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.

Visibility: public
imageDescription string

Description of a header image that is used in the tooltip.

Visibility: public
mode sap.m.GenericTileMode ContentMode

The mode of the GenericTile.

Visibility: public
navigationButtonText string

Text for navigate action button. Default Value is "Read More". Works only in ArticleMode.

Visibility: public
pressEnabled boolean true

Disables press event for the tile control.

Visibility: public
scope sap.m.GenericTileScope Display

Changes the visualization in order to enable additional actions with the Generic Tile.

Since: 1.46.0.

Visibility: public
size sap.m.Size Auto

The size of the tile. If not set, then the default size is applied based on the device.

Visibility: public
sizeBehavior sap.m.TileSizeBehavior Responsive

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen.

Visibility: public
state sap.m.LoadState Loaded

The load status.

Visibility: public
subheader string

The subheader of the tile.

Visibility: public
systemInfo string

Backend system context information

Since: 1.92.0.

Visibility: public
tileIcon sap.ui.core.URI

Icon of the GenericTile. Only applicable for IconMode.

Since: 1.96.

Visibility: public
url sap.ui.core.URI

Renders the given link as root element and therefore enables the open in new tab / window functionality

Since: 1.76.

Visibility: public
valueColor sap.m.ValueColor None

The semantic color of the value.

Since: 1.95.

Visibility: public
width sap.ui.core.CSSSize

Width of the control.

Since: 1.72.

Visibility: public
wrappingType sap.m.WrappingType Normal

Defines the type of text wrapping to be used (hyphenated or normal).

Since: 1.60.

Visibility: public

Aggregations

Default Aggregation: tileContent

Name Cardinality Type Description
_failedMessageText 0..1 sap.m.Text

The hidden aggregation for the message in the failed state.

_tileIcon 0..1 sap.ui.core.Icon

The hidden aggregation for the Tile Icon Works only in IconMode.

_tileIconImage 0..1 sap.m.Image

The hidden aggregation for the Tile Icon Image. Works only in IconMode.

_titleText 0..1 sap.m.Text

The hidden aggregation for the title.

actionButtons 0..n sap.m.Button

Action buttons added in ActionMode.

icon 0..1 sap.ui.core.Control

An icon or image to be displayed in the control. This aggregation is deprecated since version 1.36.0, to display an icon or image use sap.m.ImageContent control instead.
Deprecated as of version 1.36.0. This aggregation is deprecated, use sap.m.ImageContent control to display an icon instead.

tileContent (default) 0..n sap.m.TileContent

The content of the tile.


Events Overview

Event Description
press

The event is triggered when the user presses the tile.

press

The event is triggered when the user presses the tile.

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

The current scope the GenericTile was in when the event occurred.

Since: 1.46.0.

action string

The action that was pressed on the tile. In the Actions scope, the available actions are Press and Remove. In Display scope, the parameter value is only Press.

Since: 1.46.0.

domRef any

The pressed DOM Element pointing to the GenericTile's DOM Element in Display scope. In Actions scope it points to the more icon, when the tile is pressed, or to the DOM Element of the remove button, when the remove button is pressed.

Since: 1.46.0.


Methods Overview

Method Description
addActionButton

Adds some actionButton to the aggregation actionButtons.

addTileContent

Adds some tileContent to the aggregation tileContent.

attachPress

Attaches event handler fnFunction to the press event of this sap.m.GenericTile.

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

The event is triggered when the user presses the tile.

bindActionButtons

Binds aggregation actionButtons to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

bindTileContent

Binds aggregation tileContent to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

destroyActionButtons

Destroys all the actionButtons in the aggregation actionButtons.

destroyIcon

Destroys the icon in the aggregation icon.

Since 1.36.0 This aggregation is deprecated, use sap.m.ImageContent control to display an icon instead.
destroyTileContent

Destroys all the tileContent in the aggregation tileContent.

detachPress

Detaches event handler fnFunction from the press event of this sap.m.GenericTile.

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

sap.m.GenericTile.extend

Creates a new subclass of class sap.m.GenericTile 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.

getActionButtons

Gets content of aggregation actionButtons.

Action buttons added in ActionMode.

getAdditionalTooltip

Gets current value of property additionalTooltip.

Tooltip text which is added at the tooltip generated by the control.

getAppShortcut

Gets current value of property appShortcut.

Application information such as ID/Shortcut

getAriaLabel

Gets current value of property ariaLabel.

Additional description for aria-label. The aria-label is rendered before the standard aria-label.

getAriaRole

Gets current value of property ariaRole.

Additional description for aria-role.

getAriaRoleDescription

Gets current value of property ariaRoleDescription.

Additional description for aria-roledescription.

getBackgroundColor

Gets current value of property backgroundColor.

Background color of the GenericTile. Only applicable for IconMode.

getBackgroundImage

Gets current value of property backgroundImage.

The URI of the background image.

getBoundingRects

Provides an interface to the tile's layout information consistent in all modes and content densities.

getEnableNavigationButton

Gets current value of property enableNavigationButton.

Renders the given link as a button, enabling the option of opening the link in new tab/window functionality. Works only in ArticleMode.

Default value is false.

getFailedText

Gets current value of property failedText.

The message that appears when the control is in the Failed state.

getFrameType

Gets current value of property frameType.

The FrameType: OneByOne, TwoByOne, OneByHalf, or TwoByHalf. Default set to OneByOne if property is not defined or set to Auto by the app.

Default value is OneByOne.

getHeader

Gets current value of property header.

The header of the tile.

getHeaderImage

Gets current value of property headerImage.

The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.

getIcon

Gets content of aggregation icon.

An icon or image to be displayed in the control. This aggregation is deprecated since version 1.36.0, to display an icon or image use sap.m.ImageContent control instead.

Since 1.36.0 This aggregation is deprecated, use sap.m.ImageContent control to display an icon instead.
getImageDescription

Gets current value of property imageDescription.

Description of a header image that is used in the tooltip.

sap.m.GenericTile.getMetadata

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

getMode

Gets current value of property mode.

The mode of the GenericTile.

Default value is ContentMode.

getNavigationButtonText

Gets current value of property navigationButtonText.

Text for navigate action button. Default Value is "Read More". Works only in ArticleMode.

getPressEnabled

Gets current value of property pressEnabled.

Disables press event for the tile control.

Default value is true.

getScope

Gets current value of property scope.

Changes the visualization in order to enable additional actions with the Generic Tile.

Default value is Display.

getSize

Gets current value of property size.

The size of the tile. If not set, then the default size is applied based on the device.

Default value is Auto.

Since 1.38.0 The GenericTile control has now a fixed size, depending on the used media (desktop, tablet or phone).
getSizeBehavior

Gets current value of property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen.

Default value is Responsive.

getState

Gets current value of property state.

The load status.

Default value is Loaded.

getSubheader

Gets current value of property subheader.

The subheader of the tile.

getSystemInfo

Gets current value of property systemInfo.

Backend system context information

getTileContent

Gets content of aggregation tileContent.

The content of the tile.

getTileIcon

Gets current value of property tileIcon.

Icon of the GenericTile. Only applicable for IconMode.

getUrl

Gets current value of property url.

Renders the given link as root element and therefore enables the open in new tab / window functionality

getValueColor

Gets current value of property valueColor.

The semantic color of the value.

Default value is "None".

getWidth

Gets current value of property width.

Width of the control.

getWrappingType

Gets current value of property wrappingType.

Defines the type of text wrapping to be used (hyphenated or normal).

Default value is Normal.

indexOfActionButton

Checks for the provided sap.m.Button in the aggregation actionButtons. and returns its index if found or -1 otherwise.

indexOfTileContent

Checks for the provided sap.m.TileContent in the aggregation tileContent. and returns its index if found or -1 otherwise.

insertActionButton

Inserts a actionButton into the aggregation actionButtons.

insertTileContent

Inserts a tileContent into the aggregation tileContent.

removeActionButton

Removes a actionButton from the aggregation actionButtons.

removeAllActionButtons

Removes all the controls from the aggregation actionButtons.

Additionally, it unregisters them from the hosting UIArea.

removeAllTileContent

Removes all the controls from the aggregation tileContent.

Additionally, it unregisters them from the hosting UIArea.

removeTileContent

Removes a tileContent from the aggregation tileContent.

setAdditionalTooltip

Sets a new value for property additionalTooltip.

Tooltip text which is added at the tooltip generated by the control.

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

setAppShortcut

Sets a new value for property appShortcut.

Application information such as ID/Shortcut

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

setAriaLabel

Sets a new value for property ariaLabel.

Additional description for aria-label. The aria-label is rendered before the standard aria-label.

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

setAriaRole

Sets a new value for property ariaRole.

Additional description for aria-role.

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

setAriaRoleDescription

Sets a new value for property ariaRoleDescription.

Additional description for aria-roledescription.

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

setBackgroundColor

Sets a new value for property backgroundColor.

Background color of the GenericTile. Only applicable for IconMode.

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

setBackgroundImage

Sets a new value for property backgroundImage.

The URI of the background image.

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

setEnableNavigationButton

Sets a new value for property enableNavigationButton.

Renders the given link as a button, enabling the option of opening the link in new tab/window functionality. Works only in ArticleMode.

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

Default value is false.

setFailedText

Sets a new value for property failedText.

The message that appears when the control is in the Failed state.

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

setFrameType

Sets a new value for property frameType.

The FrameType: OneByOne, TwoByOne, OneByHalf, or TwoByHalf. Default set to OneByOne if property is not defined or set to Auto by the app.

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

Default value is OneByOne.

setHeader

Sets a new value for property header.

The header of the tile.

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

setHeaderImage

Sets a new value for property headerImage.

The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.

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

setIcon

Sets the aggregated icon.

Since 1.36.0 This aggregation is deprecated, use sap.m.ImageContent control to display an icon instead.
setImageDescription

Sets a new value for property imageDescription.

Description of a header image that is used in the tooltip.

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

setMode

Sets a new value for property mode.

The mode of the GenericTile.

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

Default value is ContentMode.

setNavigationButtonText

Sets a new value for property navigationButtonText.

Text for navigate action button. Default Value is "Read More". Works only in ArticleMode.

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

setPressEnabled

Provides an interface to switch on or off the tile's press event. Used in SlideTile for Actions scope.

setScope

Sets a new value for property scope.

Changes the visualization in order to enable additional actions with the Generic Tile.

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

Default value is Display.

setSize

Sets a new value for property size.

The size of the tile. If not set, then the default size is applied based on the device.

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

Default value is Auto.

Since 1.38.0 The GenericTile control has now a fixed size, depending on the used media (desktop, tablet or phone).
setSizeBehavior

Sets a new value for property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen.

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

Default value is Responsive.

setState

Sets a new value for property state.

The load status.

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

Default value is Loaded.

setSubheader

Sets a new value for property subheader.

The subheader of the tile.

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

setSystemInfo

Sets a new value for property systemInfo.

Backend system context information

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

setTileIcon

Sets a new value for property tileIcon.

Icon of the GenericTile. Only applicable for IconMode.

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

setUrl

Sets a new value for property url.

Renders the given link as root element and therefore enables the open in new tab / window functionality

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

setValueColor

Sets a new value for property valueColor.

The semantic color of the value.

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

Default value is "None".

setWidth

Sets a new value for property width.

Width of the control.

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

setWrappingType

Sets a new value for property wrappingType.

Defines the type of text wrapping to be used (hyphenated or normal).

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

Default value is Normal.

showActionsView

Shows the actions scope view of GenericTile without changing the scope. Used in SlideTile for Actions scope.

unbindActionButtons

Unbinds aggregation actionButtons from model data.

unbindTileContent

Unbinds aggregation tileContent from model data.

addActionButton

Adds some actionButton to the aggregation actionButtons.

Param Type DefaultValue Description
oActionButton sap.m.Button

The actionButton to add; if empty, nothing is inserted

addTileContent

Adds some tileContent to the aggregation tileContent.

Param Type DefaultValue Description
oTileContent sap.m.TileContent

The tileContent to add; if empty, nothing is inserted

attachPress

Attaches event handler fnFunction to the press event of this sap.m.GenericTile.

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

The event is triggered when the user presses the tile.

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

bindActionButtons

Binds aggregation actionButtons to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

bindTileContent

Binds aggregation tileContent to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyActionButtons

Destroys all the actionButtons in the aggregation actionButtons.

destroyIcon

Destroys the icon in the aggregation icon.

Since 1.36.0 This aggregation is deprecated, use sap.m.ImageContent control to display an icon instead.

destroyTileContent

Destroys all the tileContent in the aggregation tileContent.

detachPress

Detaches event handler fnFunction from the press event of this sap.m.GenericTile.

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

Creates a new subclass of class sap.m.GenericTile 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

scope sap.m.GenericTileScope

The current scope the GenericTile was in when the event occurred.

action string

The action that was pressed on the tile. In the Actions scope, the available actions are Press and Remove. In Display scope, the parameter value is only Press.

domRef any

The pressed DOM Element pointing to the GenericTile's DOM Element in Display scope. In Actions scope it points to the more icon, when the tile is pressed, or to the DOM Element of the remove button, when the remove button is pressed.

getActionButtons

Gets content of aggregation actionButtons.

Action buttons added in ActionMode.

getAdditionalTooltip

Gets current value of property additionalTooltip.

Tooltip text which is added at the tooltip generated by the control.

getAppShortcut

Gets current value of property appShortcut.

Application information such as ID/Shortcut

getAriaLabel

Gets current value of property ariaLabel.

Additional description for aria-label. The aria-label is rendered before the standard aria-label.

getAriaRole

Gets current value of property ariaRole.

Additional description for aria-role.

getAriaRoleDescription

Gets current value of property ariaRoleDescription.

Additional description for aria-roledescription.

getBackgroundColor

Gets current value of property backgroundColor.

Background color of the GenericTile. Only applicable for IconMode.

getBackgroundImage

Gets current value of property backgroundImage.

The URI of the background image.

getBoundingRects

Provides an interface to the tile's layout information consistent in all modes and content densities.

getEnableNavigationButton

Gets current value of property enableNavigationButton.

Renders the given link as a button, enabling the option of opening the link in new tab/window functionality. Works only in ArticleMode.

Default value is false.

getFailedText

Gets current value of property failedText.

The message that appears when the control is in the Failed state.

getFrameType

Gets current value of property frameType.

The FrameType: OneByOne, TwoByOne, OneByHalf, or TwoByHalf. Default set to OneByOne if property is not defined or set to Auto by the app.

Default value is OneByOne.

getHeader

Gets current value of property header.

The header of the tile.

getHeaderImage

Gets current value of property headerImage.

The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.

getIcon

Gets content of aggregation icon.

An icon or image to be displayed in the control. This aggregation is deprecated since version 1.36.0, to display an icon or image use sap.m.ImageContent control instead.

Since 1.36.0 This aggregation is deprecated, use sap.m.ImageContent control to display an icon instead.

getImageDescription

Gets current value of property imageDescription.

Description of a header image that is used in the tooltip.

sap.m.GenericTile.getMetadata

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

getMode

Gets current value of property mode.

The mode of the GenericTile.

Default value is ContentMode.

getNavigationButtonText

Gets current value of property navigationButtonText.

Text for navigate action button. Default Value is "Read More". Works only in ArticleMode.

getPressEnabled

Gets current value of property pressEnabled.

Disables press event for the tile control.

Default value is true.

getScope

Gets current value of property scope.

Changes the visualization in order to enable additional actions with the Generic Tile.

Default value is Display.

getSize

Gets current value of property size.

The size of the tile. If not set, then the default size is applied based on the device.

Default value is Auto.

Since 1.38.0 The GenericTile control has now a fixed size, depending on the used media (desktop, tablet or phone).

getSizeBehavior

Gets current value of property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen.

Default value is Responsive.

getState

Gets current value of property state.

The load status.

Default value is Loaded.

getSubheader

Gets current value of property subheader.

The subheader of the tile.

getSystemInfo

Gets current value of property systemInfo.

Backend system context information

getTileContent

Gets content of aggregation tileContent.

The content of the tile.

getTileIcon

Gets current value of property tileIcon.

Icon of the GenericTile. Only applicable for IconMode.

getUrl

Gets current value of property url.

Renders the given link as root element and therefore enables the open in new tab / window functionality

getValueColor

Gets current value of property valueColor.

The semantic color of the value.

Default value is "None".

getWidth

Gets current value of property width.

Width of the control.

getWrappingType

Gets current value of property wrappingType.

Defines the type of text wrapping to be used (hyphenated or normal).

Default value is Normal.

indexOfActionButton

Checks for the provided sap.m.Button in the aggregation actionButtons. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oActionButton sap.m.Button

The actionButton whose index is looked for

indexOfTileContent

Checks for the provided sap.m.TileContent in the aggregation tileContent. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oTileContent sap.m.TileContent

The tileContent whose index is looked for

insertActionButton

Inserts a actionButton into the aggregation actionButtons.

Param Type DefaultValue Description
oActionButton sap.m.Button

The actionButton to insert; if empty, nothing is inserted

iIndex int

The 0-based index the actionButton should be inserted at; for a negative value of iIndex, the actionButton is inserted at position 0; for a value greater than the current size of the aggregation, the actionButton is inserted at the last position

insertTileContent

Inserts a tileContent into the aggregation tileContent.

Param Type DefaultValue Description
oTileContent sap.m.TileContent

The tileContent to insert; if empty, nothing is inserted

iIndex int

The 0-based index the tileContent should be inserted at; for a negative value of iIndex, the tileContent is inserted at position 0; for a value greater than the current size of the aggregation, the tileContent is inserted at the last position

removeActionButton

Removes a actionButton from the aggregation actionButtons.

Param Type DefaultValue Description
vActionButton int string sap.m.Button

The actionButton to remove or its index or id

removeAllActionButtons

Removes all the controls from the aggregation actionButtons.

Additionally, it unregisters them from the hosting UIArea.

removeAllTileContent

Removes all the controls from the aggregation tileContent.

Additionally, it unregisters them from the hosting UIArea.

removeTileContent

Removes a tileContent from the aggregation tileContent.

Param Type DefaultValue Description
vTileContent int string sap.m.TileContent

The tileContent to remove or its index or id

setAdditionalTooltip

Sets a new value for property additionalTooltip.

Tooltip text which is added at the tooltip generated by the control.

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

Param Type DefaultValue Description
sAdditionalTooltip string

New value for property additionalTooltip

setAppShortcut

Sets a new value for property appShortcut.

Application information such as ID/Shortcut

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

Param Type DefaultValue Description
sAppShortcut string

New value for property appShortcut

setAriaLabel

Sets a new value for property ariaLabel.

Additional description for aria-label. The aria-label is rendered before the standard aria-label.

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

Param Type DefaultValue Description
sAriaLabel string

New value for property ariaLabel

setAriaRole

Sets a new value for property ariaRole.

Additional description for aria-role.

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

Param Type DefaultValue Description
sAriaRole string

New value for property ariaRole

setAriaRoleDescription

Sets a new value for property ariaRoleDescription.

Additional description for aria-roledescription.

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

Param Type DefaultValue Description
sAriaRoleDescription string

New value for property ariaRoleDescription

setBackgroundColor

Sets a new value for property backgroundColor.

Background color of the GenericTile. Only applicable for IconMode.

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

Param Type DefaultValue Description
sBackgroundColor sap.ui.core.CSSColor

New value for property backgroundColor

setBackgroundImage

Sets a new value for property backgroundImage.

The URI of the background image.

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

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

New value for property backgroundImage

setEnableNavigationButton

Sets a new value for property enableNavigationButton.

Renders the given link as a button, enabling the option of opening the link in new tab/window functionality. Works only in ArticleMode.

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

Default value is false.

Param Type DefaultValue Description
bEnableNavigationButton boolean false

New value for property enableNavigationButton

setFailedText

Sets a new value for property failedText.

The message that appears when the control is in the Failed state.

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

Param Type DefaultValue Description
sFailedText string

New value for property failedText

setFrameType

Sets a new value for property frameType.

The FrameType: OneByOne, TwoByOne, OneByHalf, or TwoByHalf. Default set to OneByOne if property is not defined or set to Auto by the app.

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

Default value is OneByOne.

Param Type DefaultValue Description
sFrameType sap.m.FrameType OneByOne

New value for property frameType

setHeader

Sets a new value for property header.

The header of the tile.

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

Param Type DefaultValue Description
sHeader string

New value for property header

setHeaderImage

Sets a new value for property headerImage.

The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.

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

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

New value for property headerImage

setIcon

Sets the aggregated icon.

Since 1.36.0 This aggregation is deprecated, use sap.m.ImageContent control to display an icon instead.
Param Type DefaultValue Description
oIcon sap.ui.core.Control

The icon to set

setImageDescription

Sets a new value for property imageDescription.

Description of a header image that is used in the tooltip.

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

Param Type DefaultValue Description
sImageDescription string

New value for property imageDescription

setMode

Sets a new value for property mode.

The mode of the GenericTile.

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

Default value is ContentMode.

Param Type DefaultValue Description
sMode sap.m.GenericTileMode ContentMode

New value for property mode

setNavigationButtonText

Sets a new value for property navigationButtonText.

Text for navigate action button. Default Value is "Read More". Works only in ArticleMode.

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

Param Type DefaultValue Description
sNavigationButtonText string

New value for property navigationButtonText

setPressEnabled

Provides an interface to switch on or off the tile's press event. Used in SlideTile for Actions scope.

Param Type DefaultValue Description
value boolean

If set to true, the press event of the tile is active.

setScope

Sets a new value for property scope.

Changes the visualization in order to enable additional actions with the Generic Tile.

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

Default value is Display.

Param Type DefaultValue Description
sScope sap.m.GenericTileScope Display

New value for property scope

setSize

Sets a new value for property size.

The size of the tile. If not set, then the default size is applied based on the device.

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

Default value is Auto.

Since 1.38.0 The GenericTile control has now a fixed size, depending on the used media (desktop, tablet or phone).
Param Type DefaultValue Description
sSize sap.m.Size Auto

New value for property size

setSizeBehavior

Sets a new value for property sizeBehavior.

If set to TileSizeBehavior.Small, the tile size is the same as it would be on a small-screened phone (374px wide and lower), regardless of the screen size of the actual device being used. If set to TileSizeBehavior.Responsive, the tile size adapts to the size of the screen.

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

Default value is Responsive.

Param Type DefaultValue Description
sSizeBehavior sap.m.TileSizeBehavior Responsive

New value for property sizeBehavior

setState

Sets a new value for property state.

The load status.

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

Default value is Loaded.

Param Type DefaultValue Description
sState sap.m.LoadState Loaded

New value for property state

setSubheader

Sets a new value for property subheader.

The subheader of the tile.

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

Param Type DefaultValue Description
sSubheader string

New value for property subheader

setSystemInfo

Sets a new value for property systemInfo.

Backend system context information

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

Param Type DefaultValue Description
sSystemInfo string

New value for property systemInfo

setTileIcon

Sets a new value for property tileIcon.

Icon of the GenericTile. Only applicable for IconMode.

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

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

New value for property tileIcon

setUrl

Sets a new value for property url.

Renders the given link as root element and therefore enables the open in new tab / window functionality

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

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

New value for property url

setValueColor

Sets a new value for property valueColor.

The semantic color of the value.

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
sValueColor sap.m.ValueColor "None"

New value for property valueColor

setWidth

Sets a new value for property width.

Width of the control.

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

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize

New value for property width

setWrappingType

Sets a new value for property wrappingType.

Defines the type of text wrapping to be used (hyphenated or normal).

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

Default value is Normal.

Param Type DefaultValue Description
sWrappingType sap.m.WrappingType Normal

New value for property wrappingType

showActionsView

Shows the actions scope view of GenericTile without changing the scope. Used in SlideTile for Actions scope.

Param Type DefaultValue Description
value boolean

If set to true, actions view is showed.

unbindActionButtons

Unbinds aggregation actionButtons from model data.

unbindTileContent

Unbinds aggregation tileContent from model data.