Class sap.m.TileContentModule: sap/m/TileContent

extends Control

This control is used within the GenericTile control.
Since: 1.34.
Constructor Summary
new sap.m.TileContent(sId?, mSettings?)Constructor for a new sap.m.TileContent control.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.TileContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.TileContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.TileContent.getMetadata()Returns a metadata object for class sap.m.TileContent.
bindContent(oBindingInfo)Binds aggregation content to model data.
destroyContent()Destroys the content in the aggregation content.
getContent()Gets content of aggregation content.
getDisabled()Gets current value of property disabled.
getFooter()Gets current value of property footer.
getFooterColor()Gets current value of property footerColor.
getFrameType()Gets current value of property frameType.
getUnit()Gets current value of property unit.
setContent(oContent)Sets the aggregated content.
setDisabled(bDisabled)Sets a new value for property disabled.
setFooter(sFooter)Sets a new value for property footer.
setFooterColor(sFooterColor)Sets a new value for property footerColor.
setFrameType(sFrameType)Sets a new value for property frameType.
setRenderContent(value)Setter for protected property to enable or disable content rendering.
setRenderFooter(value)Setter for protected property to enable or disable footer rendering.
setUnit(sUnit)Sets a new value for property unit.
unbindContent()Unbinds aggregation content from model data.
getSize()Gets current value of property size.
setSize(sSize)Sets a new value for property size.
Constructor Detail
new sap.m.TileContent(sId?, mSettings?)

Constructor for a new sap.m.TileContent 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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

    • content : sap.ui.core.Control (default)

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.m.TileContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.TileContent.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.TileContent.
Returns:
sap.ui.base.MetadataMetadata object describing this class
bindContent(oBindingInfo): sap.m.TileContent

Binds aggregation content to model data.

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

Parameters:
objectoBindingInfoThe binding information
Returns:
sap.m.TileContentReference to this in order to allow method chaining
destroyContent(): sap.m.TileContent
Destroys the content in the aggregation content.
Returns:
sap.m.TileContentReference to this in order to allow method chaining
getContent(): sap.ui.core.Control

Gets content of aggregation content.

The switchable view that depends on the tile type.

Returns:
sap.ui.core.Control
getDisabled(): boolean

Gets current value of property disabled.

Disables control if true.

Default value is false.

Returns:
booleanValue of property disabled
getFooter(): string

Gets current value of property footer.

The footer text of the tile.

Returns:
stringValue of property footer
getFooterColor(): sap.m.ValueColor

Gets current value of property footerColor.

The semantic color of the footer.

Default value is Neutral.

Returns:
sap.m.ValueColorValue of property footerColor
Since:
1.44
getFrameType(): sap.m.FrameType

Gets current value of property frameType.

The frame type: 1x1 or 2x1.

Default value is Auto.

Returns:
sap.m.FrameTypeValue of property frameType
getUnit(): string

Gets current value of property unit.

The percent sign, the currency symbol, or the unit of measure.

Returns:
stringValue of property unit
setContent(oContent): sap.m.TileContent
Sets the aggregated content.
Parameters:
sap.ui.core.ControloContentThe content to set
Returns:
sap.m.TileContentReference to this in order to allow method chaining
setDisabled(bDisabled): sap.m.TileContent

Sets a new value for property disabled.

Disables control if true.

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

Default value is false.

Parameters:
booleanbDisabledNew value for property disabled
Returns:
sap.m.TileContentReference to this in order to allow method chaining
setFooter(sFooter): sap.m.TileContent

Sets a new value for property footer.

The footer text of the tile.

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

Parameters:
stringsFooterNew value for property footer
Returns:
sap.m.TileContentReference to this in order to allow method chaining
setFooterColor(sFooterColor): sap.m.TileContent

Sets a new value for property footerColor.

The semantic color of the footer.

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

Default value is Neutral.

Parameters:
sap.m.ValueColorsFooterColorNew value for property footerColor
Returns:
sap.m.TileContentReference to this in order to allow method chaining
Since:
1.44
setFrameType(sFrameType): sap.m.TileContent

Sets a new value for property frameType.

The frame type: 1x1 or 2x1.

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

Default value is Auto.

Parameters:
sap.m.FrameTypesFrameTypeNew value for property frameType
Returns:
sap.m.TileContentReference to this in order to allow method chaining
setRenderContent(value): sap.m.TileContent
Setter for protected property to enable or disable content rendering. This function does not invalidate the control.
Parameters:
booleanvalueDetermines whether the control's content is rendered or not
Returns:
sap.m.TileContentthis To allow method chaining
setRenderFooter(value): sap.m.TileContent
Setter for protected property to enable or disable footer rendering. This function does not invalidate the control.
Parameters:
booleanvalueDetermines whether the control's footer is rendered or not
Returns:
sap.m.TileContentthis to allow method chaining
setUnit(sUnit): sap.m.TileContent

Sets a new value for property unit.

The percent sign, the currency symbol, or the unit of measure.

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

Parameters:
stringsUnitNew value for property unit
Returns:
sap.m.TileContentReference to this in order to allow method chaining
unbindContent(): sap.m.TileContent
Unbinds aggregation content from model data.
Returns:
sap.m.TileContentReference to this in order to allow method chaining
getSize(): sap.m.Size

Gets current value of property size.

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

Default value is Auto.

Returns:
sap.m.SizeValue of property size
Deprecated API:
Since version 1.38.0. The TileContent control has now a fixed size, depending on the used media (desktop, tablet or phone).
setSize(sSize): sap.m.TileContent

Sets a new value for property size.

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

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

Default value is Auto.

Parameters:
sap.m.SizesSizeNew value for property size
Returns:
sap.m.TileContentReference to this in order to allow method chaining
Deprecated API:
Since version 1.38.0. The TileContent control has now a fixed size, depending on the used media (desktop, tablet or phone).