FeedContent

extends Control

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

Since: 1.34.

Constructor Summary

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

Event Summary

press(oControlEvent)The event is fired when the user chooses the feed content.

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

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

attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.m.FeedContent.

detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.m.FeedContent.

firePress(mArguments?)Fires event press to attached listeners.

getContentText()Gets current value of property contentText.

getSubheader()Gets current value of property subheader.

getTruncateValueTo()Gets current value of property truncateValueTo.

getValue()Gets current value of property value.

getValueColor()Gets current value of property valueColor.

setContentText(sContentText)Sets a new value for property contentText.

setSubheader(sSubheader)Sets a new value for property subheader.

setTruncateValueTo(iTruncateValueTo)Sets a new value for property truncateValueTo.

setValue(sValue)Sets a new value for property value.

setValueColor(sValueColor)Sets a new value for property valueColor.

getSize()Gets current value of property size.

setSize(sSize)Sets a new value for property size.

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

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

The supported settings are:

Properties
- size : sap.m.Size (default: Auto)
- contentText : string
- subheader : string
- value : string
- valueColor : sap.m.ValueColor
- truncateValueTo : int (default: 4)
Aggregations
Events
- press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control 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

Event Detail

press(oControlEvent)

The event is fired when the user chooses the feed content.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Method Detail

sap.m.FeedContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

attachPress(oData?, fnFunction, oListener?): sap.m.FeedContent

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 fired when the user chooses the feed content.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.FeedContent` itself

Returns:

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

detachPress(fnFunction, oListener): sap.m.FeedContent

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

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

firePress(mArguments?): sap.m.FeedContent

Fires event press to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

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

getContentText(): string

Gets current value of property contentText.

The content text.

Returns:

{string} Value of property contentText

getSubheader(): string

Gets current value of property subheader.

The subheader.

Returns:

{string} Value of property subheader

getTruncateValueTo(): int

Gets current value of property truncateValueTo.

The number of characters to display for the value property.

Default value is 4.

Returns:

{int} Value of property truncateValueTo

getValue(): string

Gets current value of property value.

The actual value.

Returns:

{string} Value of property value

getValueColor(): sap.m.ValueColor

Gets current value of property valueColor.

The semantic color of the value.

Returns:

{sap.m.ValueColor} Value of property valueColor

setContentText(sContentText): sap.m.FeedContent

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.

Parameters:

{string} sContentText New value for property contentText

Returns:

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

setSubheader(sSubheader): sap.m.FeedContent

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.

Parameters:

{string} sSubheader New value for property subheader

Returns:

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

setTruncateValueTo(iTruncateValueTo): sap.m.FeedContent

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.

Parameters:

{int} iTruncateValueTo New value for property truncateValueTo

Returns:

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

setValue(sValue): sap.m.FeedContent

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.

Parameters:

{string} sValue New value for property value

Returns:

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

setValueColor(sValueColor): sap.m.FeedContent

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.

Parameters:

{sap.m.ValueColor} sValueColor New value for property valueColor

Returns:

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

getSize(): sap.m.Size

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.

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

Returns:

{sap.m.Size} Value of property size

setSize(sSize): sap.m.FeedContent

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.

Parameters:

{sap.m.Size} sSize New value for property size

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

Returns:

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