class sap.ui.ux3.FeedChunk

Control sample: sap.ui.ux3.FeedChunk
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/ux3/FeedChunk
Application Component: CA-UI5-CTR

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.


Constructor

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

new sap.ui.ux3.FeedChunk(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
commentChunk boolean false

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.

Visibility: public
deletionAllowed boolean false

Flag if the deletion of the chunk shall be allowed

Visibility: public
enableComment boolean true

If true the comment action is enabled.

Visibility: public
enableFavorite boolean true

If true the favorite action is enabled.

Visibility: public
enableFlag boolean true

If true the flag action is enabled.

Visibility: public
enableInspect boolean true

If true the inspect action is enabled.

Visibility: public
enableShare boolean true

If true the share action is enabled.

Visibility: public
favorite boolean

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

Visibility: public
feederSender string

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.

Visibility: public
feederThumbnailSrc sap.ui.core.URI

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.

Visibility: public
flagged boolean false

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

Visibility: public
sender string

Sender of the chunk

Visibility: public
shared boolean false

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

Visibility: public
text string

The FeedChunk text. @References are supported.

Visibility: public
thumbnailSrc sap.ui.core.URI

URL to the thumbnail image.

Visibility: public
timestamp string

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

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
actionMenuItems 0..n sap.ui.commons.MenuItem

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

comments 0..n sap.ui.ux3.FeedChunk

Comments on this chunk


Events Overview

Event Description
actionItemSelected

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

commentAdded

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

deleted

Event is fired when the deletion button is pressed.

inspect

Event is fired when the inspect button was pressed

referenceClicked

Click on a @-reference

senderClicked

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

toggleFavorite

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

toggleFlagged

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

toggleShared

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

actionItemSelected

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

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

The Id of the selected item

item sap.ui.unified.MenuItemBase

The selected item

commentAdded

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

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

New comment chunk

deleted

Event is fired when the deletion button is pressed.

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

inspect

Event is fired when the inspect button was pressed

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

referenceClicked

Click on a @-reference

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

Text of the @-reference

senderClicked

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

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

toggleFavorite

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

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

Current favorite state

toggleFlagged

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

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

Current flagged state

toggleShared

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

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

Current shared state


Methods Overview

Method Description
addActionMenuItem

Adds some actionMenuItem to the aggregation actionMenuItems.

addComment

Adds some comment to the aggregation comments.

attachActionItemSelected

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.

attachCommentAdded

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.

attachDeleted

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.

attachInspect

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

attachReferenceClicked

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

attachSenderClicked

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.

attachToggleFavorite

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.

attachToggleFlagged

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.

attachToggleShared

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.

bindActionMenuItems

Binds aggregation actionMenuItems to model data.

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

bindComments

Binds aggregation comments to model data.

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

destroyActionMenuItems

Destroys all the actionMenuItems in the aggregation actionMenuItems.

destroyComments

Destroys all the comments in the aggregation comments.

detachActionItemSelected

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.

detachCommentAdded

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.

detachDeleted

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.

detachInspect

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.

detachReferenceClicked

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.

detachSenderClicked

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.

detachToggleFavorite

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.

detachToggleFlagged

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.

detachToggleShared

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.

sap.ui.ux3.FeedChunk.extend

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.

fireActionItemSelected

Fires event actionItemSelected to attached listeners.

fireCommentAdded

Fires event commentAdded to attached listeners.

fireDeleted

Fires event deleted to attached listeners.

fireInspect

Fires event inspect to attached listeners.

fireReferenceClicked

Fires event referenceClicked to attached listeners.

fireSenderClicked

Fires event senderClicked to attached listeners.

fireToggleFavorite

Fires event toggleFavorite to attached listeners.

fireToggleFlagged

Fires event toggleFlagged to attached listeners.

fireToggleShared

Fires event toggleShared to attached listeners.

getActionMenuItems

Gets content of aggregation actionMenuItems.

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

getCommentChunk

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.

Since 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.
getComments

Gets content of aggregation comments.

Comments on this chunk

getDeletionAllowed

Gets current value of property deletionAllowed.

Flag if the deletion of the chunk shall be allowed

Default value is false.

getEnableComment

Gets current value of property enableComment.

If true the comment action is enabled.

Default value is true.

getEnableFavorite

Gets current value of property enableFavorite.

If true the favorite action is enabled.

Default value is true.

getEnableFlag

Gets current value of property enableFlag.

If true the flag action is enabled.

Default value is true.

getEnableInspect

Gets current value of property enableInspect.

If true the inspect action is enabled.

Default value is true.

getEnableShare

Gets current value of property enableShare.

If true the share action is enabled.

Default value is true.

getFavorite

Gets current value of property favorite.

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

getFeederSender

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.

getFeederThumbnailSrc

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.

getFlagged

Gets current value of property flagged.

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

Default value is false.

sap.ui.ux3.FeedChunk.getMetadata

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

getSender

Gets current value of property sender.

Sender of the chunk

getShared

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.

getText

Gets current value of property text.

The FeedChunk text. @References are supported.

getThumbnailSrc

Gets current value of property thumbnailSrc.

URL to the thumbnail image.

getTimestamp

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

indexOfActionMenuItem

Checks for the provided sap.ui.commons.MenuItem in the aggregation actionMenuItems. and returns its index if found or -1 otherwise.

indexOfComment

Checks for the provided sap.ui.ux3.FeedChunk in the aggregation comments. and returns its index if found or -1 otherwise.

insertActionMenuItem

Inserts a actionMenuItem into the aggregation actionMenuItems.

insertComment

Inserts a comment into the aggregation comments.

removeActionMenuItem

Removes a actionMenuItem from the aggregation actionMenuItems.

removeAllActionMenuItems

Removes all the controls from the aggregation actionMenuItems.

Additionally, it unregisters them from the hosting UIArea.

removeAllComments

Removes all the controls from the aggregation comments.

Additionally, it unregisters them from the hosting UIArea.

removeComment

Removes a comment from the aggregation comments.

setCommentChunk

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.

Since 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.
setDeletionAllowed

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.

setEnableComment

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.

setEnableFavorite

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.

setEnableFlag

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.

setEnableInspect

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.

setEnableShare

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.

setFavorite

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.

setFeederSender

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.

setFeederThumbnailSrc

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.

setFlagged

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.

setSender

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.

setShared

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.

setText

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.

setThumbnailSrc

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.

setTimestamp

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.

unbindActionMenuItems

Unbinds aggregation actionMenuItems from model data.

unbindComments

Unbinds aggregation comments from model data.

addActionMenuItem

Adds some actionMenuItem to the aggregation actionMenuItems.

Param Type DefaultValue Description
oActionMenuItem sap.ui.commons.MenuItem

The actionMenuItem to add; if empty, nothing is inserted

addComment

Adds some comment to the aggregation comments.

Param Type DefaultValue Description
oComment sap.ui.ux3.FeedChunk

The comment to add; if empty, nothing is inserted

attachActionItemSelected

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachCommentAdded

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachDeleted

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachInspect

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

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachReferenceClicked

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

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachSenderClicked

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachToggleFavorite

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachToggleFlagged

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

attachToggleShared

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk itself

bindActionMenuItems

Binds aggregation actionMenuItems to model data.

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

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

bindComments

Binds aggregation comments to model data.

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

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyActionMenuItems

Destroys all the actionMenuItems in the aggregation actionMenuItems.

destroyComments

Destroys all the comments in the aggregation comments.

detachActionItemSelected

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachCommentAdded

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachDeleted

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachInspect

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachReferenceClicked

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSenderClicked

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachToggleFavorite

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachToggleFlagged

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachToggleShared

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.ux3.FeedChunk.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireActionItemSelected

Fires event actionItemSelected to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

itemId string

The Id of the selected item

item sap.ui.unified.MenuItemBase

The selected item

fireCommentAdded

Fires event commentAdded to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

comment sap.ui.ux3.FeedChunk

New comment chunk

fireDeleted

Fires event deleted to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireInspect

Fires event inspect to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireReferenceClicked

Fires event referenceClicked to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

text string

Text of the @-reference

fireSenderClicked

Fires event senderClicked to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireToggleFavorite

Fires event toggleFavorite to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

favorite boolean

Current favorite state

fireToggleFlagged

Fires event toggleFlagged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

flagged boolean

Current flagged state

fireToggleShared

Fires event toggleShared to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

shareed boolean

Current shared state

getActionMenuItems

Gets content of aggregation actionMenuItems.

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

getCommentChunk

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.

Since 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.

getComments

Gets content of aggregation comments.

Comments on this chunk

getDeletionAllowed

Gets current value of property deletionAllowed.

Flag if the deletion of the chunk shall be allowed

Default value is false.

getEnableComment

Gets current value of property enableComment.

If true the comment action is enabled.

Default value is true.

getEnableFavorite

Gets current value of property enableFavorite.

If true the favorite action is enabled.

Default value is true.

getEnableFlag

Gets current value of property enableFlag.

If true the flag action is enabled.

Default value is true.

getEnableInspect

Gets current value of property enableInspect.

If true the inspect action is enabled.

Default value is true.

getEnableShare

Gets current value of property enableShare.

If true the share action is enabled.

Default value is true.

getFavorite

Gets current value of property favorite.

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

getFeederSender

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.

getFeederThumbnailSrc

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.

getFlagged

Gets current value of property flagged.

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

Default value is false.

sap.ui.ux3.FeedChunk.getMetadata

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

getSender

Gets current value of property sender.

Sender of the chunk

getShared

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.

getText

Gets current value of property text.

The FeedChunk text. @References are supported.

getThumbnailSrc

Gets current value of property thumbnailSrc.

URL to the thumbnail image.

getTimestamp

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

indexOfActionMenuItem

Checks for the provided sap.ui.commons.MenuItem in the aggregation actionMenuItems. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oActionMenuItem sap.ui.commons.MenuItem

The actionMenuItem whose index is looked for

indexOfComment

Checks for the provided sap.ui.ux3.FeedChunk in the aggregation comments. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oComment sap.ui.ux3.FeedChunk

The comment whose index is looked for

insertActionMenuItem

Inserts a actionMenuItem into the aggregation actionMenuItems.

Param Type DefaultValue Description
oActionMenuItem sap.ui.commons.MenuItem

The actionMenuItem to insert; if empty, nothing is inserted

iIndex int

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

insertComment

Inserts a comment into the aggregation comments.

Param Type DefaultValue Description
oComment sap.ui.ux3.FeedChunk

The comment to insert; if empty, nothing is inserted

iIndex int

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

removeActionMenuItem

Removes a actionMenuItem from the aggregation actionMenuItems.

Param Type DefaultValue Description
vActionMenuItem int string sap.ui.commons.MenuItem

The actionMenuItem to remove or its index or id

removeAllActionMenuItems

Removes all the controls from the aggregation actionMenuItems.

Additionally, it unregisters them from the hosting UIArea.

removeAllComments

Removes all the controls from the aggregation comments.

Additionally, it unregisters them from the hosting UIArea.

removeComment

Removes a comment from the aggregation comments.

Param Type DefaultValue Description
vComment int string sap.ui.ux3.FeedChunk

The comment to remove or its index or id

setCommentChunk

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.

Since 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.
Param Type DefaultValue Description
bCommentChunk boolean false

New value for property commentChunk

setDeletionAllowed

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.

Param Type DefaultValue Description
bDeletionAllowed boolean false

New value for property deletionAllowed

setEnableComment

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.

Param Type DefaultValue Description
bEnableComment boolean true

New value for property enableComment

setEnableFavorite

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.

Param Type DefaultValue Description
bEnableFavorite boolean true

New value for property enableFavorite

setEnableFlag

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.

Param Type DefaultValue Description
bEnableFlag boolean true

New value for property enableFlag

setEnableInspect

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.

Param Type DefaultValue Description
bEnableInspect boolean true

New value for property enableInspect

setEnableShare

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.

Param Type DefaultValue Description
bEnableShare boolean true

New value for property enableShare

setFavorite

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.

Param Type DefaultValue Description
bFavorite boolean

New value for property favorite

setFeederSender

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.

Param Type DefaultValue Description
sFeederSender string

New value for property feederSender

setFeederThumbnailSrc

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.

Param Type DefaultValue Description
sFeederThumbnailSrc sap.ui.core.URI

New value for property feederThumbnailSrc

setFlagged

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.

Param Type DefaultValue Description
bFlagged boolean false

New value for property flagged

setSender

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.

Param Type DefaultValue Description
sSender string

New value for property sender

setShared

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.

Param Type DefaultValue Description
bShared boolean false

New value for property shared

setText

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.

Param Type DefaultValue Description
sText string

New value for property text

setThumbnailSrc

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.

Param Type DefaultValue Description
sThumbnailSrc sap.ui.core.URI

New value for property thumbnailSrc

setTimestamp

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.

Param Type DefaultValue Description
sTimestamp string

New value for property timestamp

unbindActionMenuItems

Unbinds aggregation actionMenuItems from model data.

unbindComments

Unbinds aggregation comments from model data.