class sap.m.FeedContent

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

Displays a tile containing the text of the feed, a subheader, and a numeric value.


Constructor

Constructor for a new sap.m.FeedContent 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.FeedContent(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
contentText string

The content text.

Visibility: public
size sap.m.Size Auto

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

Visibility: public
subheader string

The subheader.

Visibility: public
truncateValueTo int 4

The number of characters to display for the value property.

Visibility: public
value string

The actual value.

Visibility: public
valueColor sap.m.ValueColor

The semantic color of the value.

Visibility: public

Aggregations

Default Aggregation: _contentTextAgr

Name Cardinality Type Description
_contentTextAgr (default) 0..1 sap.m.Text

The hidden aggregation for the content text.


Events Overview

Event Description
press

The event is triggered when the feed content is pressed.

press

The event is triggered when the feed content is pressed.

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

Methods Overview

Method Description
attachPress

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

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

The event is triggered when the feed content is pressed.

detachPress

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

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

sap.m.FeedContent.extend

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

getContentText

Gets current value of property contentText.

The content text.

sap.m.FeedContent.getMetadata

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

getSize

Gets current value of property size.

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

Default value is Auto.

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

Gets current value of property subheader.

The subheader.

getTruncateValueTo

Gets current value of property truncateValueTo.

The number of characters to display for the value property.

Default value is 4.

getValue

Gets current value of property value.

The actual value.

getValueColor

Gets current value of property valueColor.

The semantic color of the value.

setContentText

Sets a new value for property contentText.

The content text.

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

setSize

Sets a new value for property size.

Updates the size of the chart. If 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.

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

Sets a new value for property subheader.

The subheader.

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

setTruncateValueTo

Sets a new value for property truncateValueTo.

The number of characters to display for the value property.

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

Default value is 4.

setValue

Sets a new value for property value.

The actual value.

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.

attachPress

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

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

The event is triggered when the feed content is pressed.

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

detachPress

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

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

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

getContentText

Gets current value of property contentText.

The content text.

sap.m.FeedContent.getMetadata

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

getSize

Gets current value of property size.

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

Default value is Auto.

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

getSubheader

Gets current value of property subheader.

The subheader.

getTruncateValueTo

Gets current value of property truncateValueTo.

The number of characters to display for the value property.

Default value is 4.

getValue

Gets current value of property value.

The actual value.

getValueColor

Gets current value of property valueColor.

The semantic color of the value.

setContentText

Sets a new value for property contentText.

The content text.

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

Param Type DefaultValue Description
sContentText string

New value for property contentText

setSize

Sets a new value for property size.

Updates the size of the chart. If 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.

Since 1.38.0 The FeedContent 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

setSubheader

Sets a new value for property subheader.

The subheader.

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

setTruncateValueTo

Sets a new value for property truncateValueTo.

The number of characters to display for the value property.

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

Default value is 4.

Param Type DefaultValue Description
iTruncateValueTo int 4

New value for property truncateValueTo

setValue

Sets a new value for property value.

The actual value.

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

Param Type DefaultValue Description
sValue string

New value for property value

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.

Param Type DefaultValue Description
sValueColor sap.m.ValueColor

New value for property valueColor