Class sap.ui.ux3.FeedChunkModule: sap/ui/ux3/FeedChunk

extends Control

The unit that is embedded - single-wise or in a multiple way - into a Feed control. The control provides a set of properties for text, sender information, time stamp, comments, and functions such as flagging the entry to be favorite, shared, or flagged.
Deprecated API:
Since version 1.38. Instead, use the sap.m.FeedListItem control.
Experimental API:
Since version 1.2. The whole Feed/Feeder API is still under discussion, significant changes are likely. Especially text presentation (e.g. @-references and formatted text) is not final. Also the Feed model topic is still open.
Constructor Summary
new sap.ui.ux3.FeedChunk(sId?, mSettings?)Constructor for a new FeedChunk.
Event Summary
actionItemSelected(oControlEvent)Event is fired when an item from the action menu button was selected.
commentAdded(oControlEvent)Event is raised when a comment is added to the entry.
deleted(oControlEvent)Event is fired when the deletion button is pressed.
inspect(oControlEvent)Event is fired when the inspect button was pressed
referenceClicked(oControlEvent)Click on a @-reference
senderClicked(oControlEvent)Event is fired when the thumbnail or the name of the sender is clicked.
toggleFavorite(oControlEvent)Event is raised when the user clicks to set the entry as favorite.
toggleFlagged(oControlEvent)Event is raised when the user clicks to flag the entry.
toggleShared(oControlEvent)Event is raised when the user clicks to share the entry.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.ux3.FeedChunk.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.FeedChunk with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.FeedChunk.getMetadata()Returns a metadata object for class sap.ui.ux3.FeedChunk.
addActionMenuItem(oActionMenuItem)Adds some actionMenuItem to the aggregation actionMenuItems.
addComment(oComment)Adds some comment to the aggregation comments.
attachActionItemSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the actionItemSelected event of this sap.ui.ux3.FeedChunk.
attachCommentAdded(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the commentAdded event of this sap.ui.ux3.FeedChunk.
attachDeleted(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the deleted event of this sap.ui.ux3.FeedChunk.
attachInspect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the inspect event of this sap.ui.ux3.FeedChunk.
attachReferenceClicked(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the referenceClicked event of this sap.ui.ux3.FeedChunk.
attachSenderClicked(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the senderClicked event of this sap.ui.ux3.FeedChunk.
attachToggleFavorite(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the toggleFavorite event of this sap.ui.ux3.FeedChunk.
attachToggleFlagged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the toggleFlagged event of this sap.ui.ux3.FeedChunk.
attachToggleShared(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the toggleShared event of this sap.ui.ux3.FeedChunk.
bindActionMenuItems(oBindingInfo)Binds aggregation actionMenuItems to model data.
bindComments(oBindingInfo)Binds aggregation comments to model data.
destroyActionMenuItems()Destroys all the actionMenuItems in the aggregation actionMenuItems.
destroyComments()Destroys all the comments in the aggregation comments.
detachActionItemSelected(fnFunction, oListener)Detaches event handler fnFunction from the actionItemSelected event of this sap.ui.ux3.FeedChunk.
detachCommentAdded(fnFunction, oListener)Detaches event handler fnFunction from the commentAdded event of this sap.ui.ux3.FeedChunk.
detachDeleted(fnFunction, oListener)Detaches event handler fnFunction from the deleted event of this sap.ui.ux3.FeedChunk.
detachInspect(fnFunction, oListener)Detaches event handler fnFunction from the inspect event of this sap.ui.ux3.FeedChunk.
detachReferenceClicked(fnFunction, oListener)Detaches event handler fnFunction from the referenceClicked event of this sap.ui.ux3.FeedChunk.
detachSenderClicked(fnFunction, oListener)Detaches event handler fnFunction from the senderClicked event of this sap.ui.ux3.FeedChunk.
detachToggleFavorite(fnFunction, oListener)Detaches event handler fnFunction from the toggleFavorite event of this sap.ui.ux3.FeedChunk.
detachToggleFlagged(fnFunction, oListener)Detaches event handler fnFunction from the toggleFlagged event of this sap.ui.ux3.FeedChunk.
detachToggleShared(fnFunction, oListener)Detaches event handler fnFunction from the toggleShared event of this sap.ui.ux3.FeedChunk.
fireActionItemSelected(mParameters?)Fires event actionItemSelected to attached listeners.
fireCommentAdded(mParameters?)Fires event commentAdded to attached listeners.
fireDeleted(mParameters?)Fires event deleted to attached listeners.
fireInspect(mParameters?)Fires event inspect to attached listeners.
fireReferenceClicked(mParameters?)Fires event referenceClicked to attached listeners.
fireSenderClicked(mParameters?)Fires event senderClicked to attached listeners.
fireToggleFavorite(mParameters?)Fires event toggleFavorite to attached listeners.
fireToggleFlagged(mParameters?)Fires event toggleFlagged to attached listeners.
fireToggleShared(mParameters?)Fires event toggleShared to attached listeners.
getActionMenuItems()Gets content of aggregation actionMenuItems.
getComments()Gets content of aggregation comments.
getDeletionAllowed()Gets current value of property deletionAllowed.
getEnableComment()Gets current value of property enableComment.
getEnableFavorite()Gets current value of property enableFavorite.
getEnableFlag()Gets current value of property enableFlag.
getEnableInspect()Gets current value of property enableInspect.
getEnableShare()Gets current value of property enableShare.
getFavorite()Gets current value of property favorite.
getFeederSender()Gets current value of property feederSender.
getFeederThumbnailSrc()Gets current value of property feederThumbnailSrc.
getFlagged()Gets current value of property flagged.
getSender()Gets current value of property sender.
getShared()Gets current value of property shared.
getText()Gets current value of property text.
getThumbnailSrc()Gets current value of property thumbnailSrc.
getTimestamp()Gets current value of property timestamp.
indexOfActionMenuItem(oActionMenuItem)Checks for the provided sap.ui.commons.MenuItem in the aggregation actionMenuItems.
indexOfComment(oComment)Checks for the provided sap.ui.ux3.FeedChunk in the aggregation comments.
insertActionMenuItem(oActionMenuItem, iIndex)Inserts a actionMenuItem into the aggregation actionMenuItems.
insertComment(oComment, iIndex)Inserts a comment into the aggregation comments.
removeActionMenuItem(vActionMenuItem)Removes a actionMenuItem from the aggregation actionMenuItems.
removeAllActionMenuItems()Removes all the controls from the aggregation actionMenuItems.
removeAllComments()Removes all the controls from the aggregation comments.
removeComment(vComment)Removes a comment from the aggregation comments.
setDeletionAllowed(bDeletionAllowed)Sets a new value for property deletionAllowed.
setEnableComment(bEnableComment)Sets a new value for property enableComment.
setEnableFavorite(bEnableFavorite)Sets a new value for property enableFavorite.
setEnableFlag(bEnableFlag)Sets a new value for property enableFlag.
setEnableInspect(bEnableInspect)Sets a new value for property enableInspect.
setEnableShare(bEnableShare)Sets a new value for property enableShare.
setFavorite(bFavorite)Sets a new value for property favorite.
setFeederSender(sFeederSender)Sets a new value for property feederSender.
setFeederThumbnailSrc(sFeederThumbnailSrc)Sets a new value for property feederThumbnailSrc.
setFlagged(bFlagged)Sets a new value for property flagged.
setSender(sSender)Sets a new value for property sender.
setShared(bShared)Sets a new value for property shared.
setText(sText)Sets a new value for property text.
setThumbnailSrc(sThumbnailSrc)Sets a new value for property thumbnailSrc.
setTimestamp(sTimestamp)Sets a new value for property timestamp.
unbindActionMenuItems()Unbinds aggregation actionMenuItems from model data.
unbindComments()Unbinds aggregation comments from model data.
getCommentChunk()Gets current value of property commentChunk.
setCommentChunk(bCommentChunk)Sets a new value for property commentChunk.
Constructor Detail
new sap.ui.ux3.FeedChunk(sId?, mSettings?)

Constructor for a new FeedChunk.

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

  • Events

    • deleted : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • commentAdded : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • toggleFlagged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • senderClicked : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • referenceClicked : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • toggleFavorite : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • inspect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • toggleShared : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • actionItemSelected : 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:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
actionItemSelected(oControlEvent)
Event is fired when an item from the action menu button was selected.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.itemIdThe Id of the selected item
sap.ui.unified.MenuItemBaseoControlEvent.getParameters.itemThe selected item
commentAdded(oControlEvent)
Event is raised when a comment is added to the entry. This event is not supported for comment chunks.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.ux3.FeedChunkoControlEvent.getParameters.commentNew comment chunk
deleted(oControlEvent)
Event is fired when the deletion button is pressed.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
inspect(oControlEvent)
Event is fired when the inspect button was pressed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
referenceClicked(oControlEvent)
Click on a @-reference
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.textText of the @-reference
senderClicked(oControlEvent)
Event is fired when the thumbnail or the name of the sender is clicked.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
toggleFavorite(oControlEvent)
Event is raised when the user clicks to set the entry as favorite. This event is not supported for comment chunks.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
booleanoControlEvent.getParameters.favoriteCurrent favorite state
toggleFlagged(oControlEvent)
Event is raised when the user clicks to flag the entry. This event is not supported for comment chunks.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
booleanoControlEvent.getParameters.flaggedCurrent flagged state
toggleShared(oControlEvent)
Event is raised when the user clicks to share the entry. This event is not supported for comment chunks.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
booleanoControlEvent.getParameters.shareedCurrent shared state
Method Detail
sap.ui.ux3.FeedChunk.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.ux3.FeedChunk 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.ui.ux3.FeedChunk.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.FeedChunk.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addActionMenuItem(oActionMenuItem): sap.ui.ux3.FeedChunk
Adds some actionMenuItem to the aggregation actionMenuItems.
Parameters:
sap.ui.commons.MenuItemoActionMenuItemthe actionMenuItem to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
addComment(oComment): sap.ui.ux3.FeedChunk
Adds some comment to the aggregation comments.
Parameters:
sap.ui.ux3.FeedChunkoCommentthe comment to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachActionItemSelected(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the actionItemSelected event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is fired when an item from the action menu button was selected.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachCommentAdded(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the commentAdded event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is raised when a comment is added to the entry. This event is not supported for comment chunks.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachDeleted(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the deleted event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is fired when the deletion button is pressed.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachInspect(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the inspect event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is fired when the inspect button was pressed

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachReferenceClicked(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the referenceClicked event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Click on a @-reference

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachSenderClicked(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the senderClicked event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is fired when the thumbnail or the name of the sender is clicked.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachToggleFavorite(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the toggleFavorite event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is raised when the user clicks to set the entry as favorite. This event is not supported for comment chunks.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachToggleFlagged(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the toggleFlagged event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is raised when the user clicks to flag the entry. This event is not supported for comment chunks.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
attachToggleShared(oData?, fnFunction, oListener?): sap.ui.ux3.FeedChunk

Attaches event handler fnFunction to the toggleShared event of this sap.ui.ux3.FeedChunk.

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.ui.ux3.FeedChunk itself.

Event is raised when the user clicks to share the entry. This event is not supported for comment chunks.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
bindActionMenuItems(oBindingInfo): sap.ui.ux3.FeedChunk

Binds aggregation actionMenuItems to model data.

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

Parameters:
objectoBindingInfoThe binding information
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
bindComments(oBindingInfo): sap.ui.ux3.FeedChunk

Binds aggregation comments to model data.

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

Parameters:
objectoBindingInfoThe binding information
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
destroyActionMenuItems(): sap.ui.ux3.FeedChunk
Destroys all the actionMenuItems in the aggregation actionMenuItems.
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
destroyComments(): sap.ui.ux3.FeedChunk
Destroys all the comments in the aggregation comments.
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachActionItemSelected(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the actionItemSelected event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachCommentAdded(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the commentAdded event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachDeleted(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the deleted event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachInspect(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the inspect event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachReferenceClicked(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the referenceClicked event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachSenderClicked(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the senderClicked event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachToggleFavorite(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the toggleFavorite event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachToggleFlagged(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the toggleFlagged event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
detachToggleShared(fnFunction, oListener): sap.ui.ux3.FeedChunk

Detaches event handler fnFunction from the toggleShared event of this sap.ui.ux3.FeedChunk.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireActionItemSelected(mParameters?): sap.ui.ux3.FeedChunk
Fires event actionItemSelected to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.itemId?The Id of the selected item
sap.ui.unified.MenuItemBasemParameters.item?The selected item
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireCommentAdded(mParameters?): sap.ui.ux3.FeedChunk
Fires event commentAdded to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.ux3.FeedChunkmParameters.comment?New comment chunk
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireDeleted(mParameters?): sap.ui.ux3.FeedChunk
Fires event deleted to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireInspect(mParameters?): sap.ui.ux3.FeedChunk
Fires event inspect to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireReferenceClicked(mParameters?): sap.ui.ux3.FeedChunk
Fires event referenceClicked to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.text?Text of the @-reference
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireSenderClicked(mParameters?): sap.ui.ux3.FeedChunk
Fires event senderClicked to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireToggleFavorite(mParameters?): sap.ui.ux3.FeedChunk
Fires event toggleFavorite to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
booleanmParameters.favorite?Current favorite state
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireToggleFlagged(mParameters?): sap.ui.ux3.FeedChunk
Fires event toggleFlagged to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
booleanmParameters.flagged?Current flagged state
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
fireToggleShared(mParameters?): sap.ui.ux3.FeedChunk
Fires event toggleShared to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
booleanmParameters.shareed?Current shared state
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
getActionMenuItems(): sap.ui.commons.MenuItem[]

Gets content of aggregation actionMenuItems.

MenuItems to open when there is a click on the action menu button

Returns:
sap.ui.commons.MenuItem[]
getComments(): sap.ui.ux3.FeedChunk[]

Gets content of aggregation comments.

Comments on this chunk

Returns:
sap.ui.ux3.FeedChunk[]
getDeletionAllowed(): boolean

Gets current value of property deletionAllowed.

Flag if the deletion of the chunk shall be allowed

Default value is false.

Returns:
booleanValue of property deletionAllowed
getEnableComment(): boolean

Gets current value of property enableComment.

If true the comment action is enabled.

Default value is true.

Returns:
booleanValue of property enableComment
getEnableFavorite(): boolean

Gets current value of property enableFavorite.

If true the favorite action is enabled.

Default value is true.

Returns:
booleanValue of property enableFavorite
getEnableFlag(): boolean

Gets current value of property enableFlag.

If true the flag action is enabled.

Default value is true.

Returns:
booleanValue of property enableFlag
getEnableInspect(): boolean

Gets current value of property enableInspect.

If true the inspect action is enabled.

Default value is true.

Returns:
booleanValue of property enableInspect
getEnableShare(): boolean

Gets current value of property enableShare.

If true the share action is enabled.

Default value is true.

Returns:
booleanValue of property enableShare
getFavorite(): boolean

Gets current value of property favorite.

Defines whether the entry shall be displayed as favorite. This property is not supported for comment chunks.

Returns:
booleanValue of property favorite
getFeederSender(): string

Gets current value of property feederSender.

Sender for the comment feeder This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.

Returns:
stringValue of property feederSender
getFeederThumbnailSrc(): sap.ui.core.URI

Gets current value of property feederThumbnailSrc.

URL to the thumbnail image for the comment feeder. This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.

Returns:
sap.ui.core.URIValue of property feederThumbnailSrc
getFlagged(): boolean

Gets current value of property flagged.

Defines whether the entry is flagged. This property is not supported for comment chunks.

Default value is false.

Returns:
booleanValue of property flagged
getSender(): string

Gets current value of property sender.

Sender of the chunk

Returns:
stringValue of property sender
getShared(): boolean

Gets current value of property shared.

Defines whether the entry shall be shared. This property is not supported for comment chunks.

Default value is false.

Returns:
booleanValue of property shared
getText(): string

Gets current value of property text.

The FeedChunk text. @References are supported.

Returns:
stringValue of property text
getThumbnailSrc(): sap.ui.core.URI

Gets current value of property thumbnailSrc.

URL to the thumbnail image.

Returns:
sap.ui.core.URIValue of property thumbnailSrc
getTimestamp(): string

Gets current value of property timestamp.

Format is ISO 8601 YYYY-MM-DDThh:mm:ss.sZ, Z meaning the time is in UTC time zone

Returns:
stringValue of property timestamp
indexOfActionMenuItem(oActionMenuItem): int
Checks for the provided sap.ui.commons.MenuItem in the aggregation actionMenuItems. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.commons.MenuItemoActionMenuItemThe actionMenuItem whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfComment(oComment): int
Checks for the provided sap.ui.ux3.FeedChunk in the aggregation comments. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.ux3.FeedChunkoCommentThe comment whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertActionMenuItem(oActionMenuItem, iIndex): sap.ui.ux3.FeedChunk
Inserts a actionMenuItem into the aggregation actionMenuItems.
Parameters:
sap.ui.commons.MenuItemoActionMenuItemthe actionMenuItem to insert; if empty, nothing is inserted
intiIndexthe 0-based index the actionMenuItem should be inserted at; for a negative value of iIndex, the actionMenuItem is inserted at position 0; for a value greater than the current size of the aggregation, the actionMenuItem is inserted at the last position
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
insertComment(oComment, iIndex): sap.ui.ux3.FeedChunk
Inserts a comment into the aggregation comments.
Parameters:
sap.ui.ux3.FeedChunkoCommentthe comment to insert; if empty, nothing is inserted
intiIndexthe 0-based index the comment should be inserted at; for a negative value of iIndex, the comment is inserted at position 0; for a value greater than the current size of the aggregation, the comment is inserted at the last position
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
removeActionMenuItem(vActionMenuItem): sap.ui.commons.MenuItem
Removes a actionMenuItem from the aggregation actionMenuItems.
Parameters:
int|string|sap.ui.commons.MenuItemvActionMenuItemThe actionMenuItem to remove or its index or id
Returns:
sap.ui.commons.MenuItemThe removed actionMenuItem or null
removeAllActionMenuItems(): sap.ui.commons.MenuItem[]

Removes all the controls from the aggregation actionMenuItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.commons.MenuItem[]An array of the removed elements (might be empty)
removeAllComments(): sap.ui.ux3.FeedChunk[]

Removes all the controls from the aggregation comments.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.ux3.FeedChunk[]An array of the removed elements (might be empty)
removeComment(vComment): sap.ui.ux3.FeedChunk
Removes a comment from the aggregation comments.
Parameters:
int|string|sap.ui.ux3.FeedChunkvCommentThe comment to remove or its index or id
Returns:
sap.ui.ux3.FeedChunkThe removed comment or null
setDeletionAllowed(bDeletionAllowed): sap.ui.ux3.FeedChunk

Sets a new value for property deletionAllowed.

Flag if the deletion of the chunk shall be allowed

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

Default value is false.

Parameters:
booleanbDeletionAllowedNew value for property deletionAllowed
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setEnableComment(bEnableComment): sap.ui.ux3.FeedChunk

Sets a new value for property enableComment.

If true the comment action is enabled.

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

Default value is true.

Parameters:
booleanbEnableCommentNew value for property enableComment
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setEnableFavorite(bEnableFavorite): sap.ui.ux3.FeedChunk

Sets a new value for property enableFavorite.

If true the favorite action is enabled.

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

Default value is true.

Parameters:
booleanbEnableFavoriteNew value for property enableFavorite
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setEnableFlag(bEnableFlag): sap.ui.ux3.FeedChunk

Sets a new value for property enableFlag.

If true the flag action is enabled.

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

Default value is true.

Parameters:
booleanbEnableFlagNew value for property enableFlag
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setEnableInspect(bEnableInspect): sap.ui.ux3.FeedChunk

Sets a new value for property enableInspect.

If true the inspect action is enabled.

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

Default value is true.

Parameters:
booleanbEnableInspectNew value for property enableInspect
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setEnableShare(bEnableShare): sap.ui.ux3.FeedChunk

Sets a new value for property enableShare.

If true the share action is enabled.

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

Default value is true.

Parameters:
booleanbEnableShareNew value for property enableShare
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setFavorite(bFavorite): sap.ui.ux3.FeedChunk

Sets a new value for property favorite.

Defines whether the entry shall be displayed as favorite. This property is not supported for comment chunks.

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

Parameters:
booleanbFavoriteNew value for property favorite
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setFeederSender(sFeederSender): sap.ui.ux3.FeedChunk

Sets a new value for property feederSender.

Sender for the comment feeder This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.

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

Parameters:
stringsFeederSenderNew value for property feederSender
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setFeederThumbnailSrc(sFeederThumbnailSrc): sap.ui.ux3.FeedChunk

Sets a new value for property feederThumbnailSrc.

URL to the thumbnail image for the comment feeder. This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.

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

Parameters:
sap.ui.core.URIsFeederThumbnailSrcNew value for property feederThumbnailSrc
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setFlagged(bFlagged): sap.ui.ux3.FeedChunk

Sets a new value for property flagged.

Defines whether the entry is flagged. This property is not supported for comment chunks.

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

Default value is false.

Parameters:
booleanbFlaggedNew value for property flagged
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setSender(sSender): sap.ui.ux3.FeedChunk

Sets a new value for property sender.

Sender of the chunk

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

Parameters:
stringsSenderNew value for property sender
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setShared(bShared): sap.ui.ux3.FeedChunk

Sets a new value for property shared.

Defines whether the entry shall be shared. This property is not supported for comment chunks.

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

Default value is false.

Parameters:
booleanbSharedNew value for property shared
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setText(sText): sap.ui.ux3.FeedChunk

Sets a new value for property text.

The FeedChunk text. @References are supported.

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

Parameters:
stringsTextNew value for property text
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setThumbnailSrc(sThumbnailSrc): sap.ui.ux3.FeedChunk

Sets a new value for property thumbnailSrc.

URL to the thumbnail image.

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

Parameters:
sap.ui.core.URIsThumbnailSrcNew value for property thumbnailSrc
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
setTimestamp(sTimestamp): sap.ui.ux3.FeedChunk

Sets a new value for property timestamp.

Format is ISO 8601 YYYY-MM-DDThh:mm:ss.sZ, Z meaning the time is in UTC time zone

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

Parameters:
stringsTimestampNew value for property timestamp
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
unbindActionMenuItems(): sap.ui.ux3.FeedChunk
Unbinds aggregation actionMenuItems from model data.
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
unbindComments(): sap.ui.ux3.FeedChunk
Unbinds aggregation comments from model data.
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
getCommentChunk(): boolean

Gets current value of property commentChunk.

This flag changes a FeedChunk into a CommentChunk. In this case, it can not have own comments, furthermore it must be assigned to a FeedChunk.

Default value is false.

Returns:
booleanValue of property commentChunk
Deprecated API:
Since version 1.4.0. Not longer used. If a chunk is a comment is determined from hierarchy. If the parent is a chunk it's automatically a comment.
setCommentChunk(bCommentChunk): sap.ui.ux3.FeedChunk

Sets a new value for property commentChunk.

This flag changes a FeedChunk into a CommentChunk. In this case, it can not have own comments, furthermore it must be assigned to a FeedChunk.

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

Default value is false.

Parameters:
booleanbCommentChunkNew value for property commentChunk
Returns:
sap.ui.ux3.FeedChunkReference to this in order to allow method chaining
Deprecated API:
Since version 1.4.0. Not longer used. If a chunk is a comment is determined from hierarchy. If the parent is a chunk it's automatically a comment.