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

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

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(mArguments?)Fires event actionItemSelected to attached listeners.

fireCommentAdded(mArguments?)Fires event commentAdded to attached listeners.

fireDeleted(mArguments?)Fires event deleted to attached listeners.

fireInspect(mArguments?)Fires event inspect to attached listeners.

fireReferenceClicked(mArguments?)Fires event referenceClicked to attached listeners.

fireSenderClicked(mArguments?)Fires event senderClicked to attached listeners.

fireToggleFavorite(mArguments?)Fires event toggleFavorite to attached listeners.

fireToggleFlagged(mArguments?)Fires event toggleFlagged to attached listeners.

fireToggleShared(mArguments?)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.

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.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
- thumbnailSrc : sap.ui.core.URI
- text : string
- sender : string
- timestamp : string
- deletionAllowed : boolean (default: false)
- commentChunk : boolean (default: false)
- feederThumbnailSrc : sap.ui.core.URI
- feederSender : string
- flagged : boolean (default: false)
- favorite : boolean
- shared : boolean (default: false)
- enableFlag : boolean (default: true)
- enableShare : boolean (default: true)
- enableComment : boolean (default: true)
- enableInspect : boolean (default: true)
- enableFavorite : boolean (default: true)
Aggregations
- comments : sap.ui.ux3.FeedChunk[]
- actionMenuItems : sap.ui.commons.MenuItem[]
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:

{string}	sId?	id for the new control, generated automatically if no id is given
{object}	mSettings?	initial settings for the new control

Deprecated:
Since version 1.38. Instead, use the sap.m.FeedListItem control.

Event Detail

actionItemSelected(oControlEvent)

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

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{string}	oControlEvent.getParameters.itemId	The Id of the selected item
{sap.ui.unified.MenuItemBase}	oControlEvent.getParameters.item	The 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.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{sap.ui.ux3.FeedChunk}	oControlEvent.getParameters.comment	New comment chunk

deleted(oControlEvent)

Event is fired when the deletion button is pressed.

Parameters:

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

inspect(oControlEvent)

Event is fired when the inspect button was pressed

Parameters:

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

referenceClicked(oControlEvent)

Click on a @-reference

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{string}	oControlEvent.getParameters.text	Text of the @-reference

senderClicked(oControlEvent)

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

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.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.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{boolean}	oControlEvent.getParameters.favorite	Current 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.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{boolean}	oControlEvent.getParameters.flagged	Current 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.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{boolean}	oControlEvent.getParameters.shareed	Current 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:

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

Returns a metadata object for class sap.ui.ux3.FeedChunk.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addActionMenuItem(oActionMenuItem): sap.ui.ux3.FeedChunk

Adds some actionMenuItem to the aggregation actionMenuItems.

Parameters:

{sap.ui.commons.MenuItem}

oActionMenuItem

the actionMenuItem to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.FeedChunk} Reference 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.FeedChunk}

oComment

the comment to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

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

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{object}

oBindingInfo

The binding information

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{object}

oBindingInfo

The binding information

Returns:

{sap.ui.ux3.FeedChunk} Reference 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.FeedChunk} Reference 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.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference 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:

{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.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireActionItemSelected(mArguments?): sap.ui.ux3.FeedChunk

Fires event actionItemSelected to attached listeners.

Expects the following event parameters:

itemId of type stringThe Id of the selected item
item of type sap.ui.unified.MenuItemBaseThe selected item

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireCommentAdded(mArguments?): sap.ui.ux3.FeedChunk

Fires event commentAdded to attached listeners.

Expects the following event parameters:

comment of type sap.ui.ux3.FeedChunkNew comment chunk

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireDeleted(mArguments?): sap.ui.ux3.FeedChunk

Fires event deleted to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireInspect(mArguments?): sap.ui.ux3.FeedChunk

Fires event inspect to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireReferenceClicked(mArguments?): sap.ui.ux3.FeedChunk

Fires event referenceClicked to attached listeners.

Expects the following event parameters:

text of type stringText of the @-reference

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireSenderClicked(mArguments?): sap.ui.ux3.FeedChunk

Fires event senderClicked to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireToggleFavorite(mArguments?): sap.ui.ux3.FeedChunk

Fires event toggleFavorite to attached listeners.

Expects the following event parameters:

favorite of type booleanCurrent favorite state

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireToggleFlagged(mArguments?): sap.ui.ux3.FeedChunk

Fires event toggleFlagged to attached listeners.

Expects the following event parameters:

flagged of type booleanCurrent flagged state

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

fireToggleShared(mArguments?): sap.ui.ux3.FeedChunk

Fires event toggleShared to attached listeners.

Expects the following event parameters:

shareed of type booleanCurrent shared state

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} Value of property deletionAllowed

getEnableComment(): boolean

Gets current value of property enableComment.

If true the comment action is enabled.

Default value is true.

Returns:

{boolean} Value of property enableComment

getEnableFavorite(): boolean

Gets current value of property enableFavorite.

If true the favorite action is enabled.

Default value is true.

Returns:

{boolean} Value of property enableFavorite

getEnableFlag(): boolean

Gets current value of property enableFlag.

If true the flag action is enabled.

Default value is true.

Returns:

{boolean} Value of property enableFlag

getEnableInspect(): boolean

Gets current value of property enableInspect.

If true the inspect action is enabled.

Default value is true.

Returns:

{boolean} Value of property enableInspect

getEnableShare(): boolean

Gets current value of property enableShare.

If true the share action is enabled.

Default value is true.

Returns:

{boolean} Value 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:

{boolean} Value 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:

{string} Value 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.URI} Value 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:

{boolean} Value of property flagged

getSender(): string

Gets current value of property sender.

Sender of the chunk

Returns:

{string} Value 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:

{boolean} Value of property shared

getText(): string

Gets current value of property text.

The FeedChunk text. @References are supported.

Returns:

{string} Value of property text

getThumbnailSrc(): sap.ui.core.URI

Gets current value of property thumbnailSrc.

URL to the thumbnail image.

Returns:

{sap.ui.core.URI} Value 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:

{string} Value 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.MenuItem}

oActionMenuItem

The actionMenuItem whose index is looked for

Returns:

{int}

The 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.FeedChunk}

oComment

The comment whose index is looked for

Returns:

{int}

The 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.MenuItem}	oActionMenuItem	the actionMenuItem to insert; if empty, nothing is inserted
{int}	iIndex	the `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.FeedChunk} Reference 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.FeedChunk}	oComment	the comment to insert; if empty, nothing is inserted
{int}	iIndex	the `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.FeedChunk} Reference 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.MenuItem}

vActionMenuItem

The actionMenuItemto remove or its index or id

Returns:

{sap.ui.commons.MenuItem} The 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.FeedChunk}

vComment

The commentto remove or its index or id

Returns:

{sap.ui.ux3.FeedChunk} The 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:

{boolean} bDeletionAllowed New value for property deletionAllowed

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bEnableComment New value for property enableComment

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bEnableFavorite New value for property enableFavorite

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bEnableFlag New value for property enableFlag

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bEnableInspect New value for property enableInspect

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bEnableShare New value for property enableShare

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bFavorite New value for property favorite

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

setFeederSender(sFeederSender): sap.ui.ux3.FeedChunk

Sets a new value for property feederSender.

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

Parameters:

{string} sFeederSender New value for property feederSender

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

setFeederThumbnailSrc(sFeederThumbnailSrc): sap.ui.ux3.FeedChunk

Sets a new value for property feederThumbnailSrc.

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

Parameters:

{sap.ui.core.URI} sFeederThumbnailSrc New value for property feederThumbnailSrc

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bFlagged New value for property flagged

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{string} sSender New value for property sender

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{boolean} bShared New value for property shared

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{string} sText New value for property text

Returns:

{sap.ui.ux3.FeedChunk} Reference 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.URI} sThumbnailSrc New value for property thumbnailSrc

Returns:

{sap.ui.ux3.FeedChunk} Reference 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:

{string} sTimestamp New value for property timestamp

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

unbindActionMenuItems(): sap.ui.ux3.FeedChunk

Unbinds aggregation actionMenuItems from model data.

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining

unbindComments(): sap.ui.ux3.FeedChunk

Unbinds aggregation comments from model data.

Returns:

{sap.ui.ux3.FeedChunk} Reference 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.

Deprecated:
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.

Returns:

{boolean} Value of property commentChunk

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:

{boolean} bCommentChunk New value for property commentChunk

Deprecated:
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.

Returns:

{sap.ui.ux3.FeedChunk} Reference to this in order to allow method chaining