Class sap.ui.ux3.FeedModule: sap/ui/ux3/Feed

extends Control

A container control representing a full feed page, including feeder and updates.

Deprecated API:Since version 1.38. Instead, use anysap.ui.layout container 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.Feed(sId?, mSettings?)Constructor for a new Feed.
Event Summary
chunkAdded(oControlEvent)Event is fired when a new chunk is added
filterChange(oControlEvent)Event is fired when the filter is changed
search(oControlEvent)Event is fired when the search function on SearchField is triggered
toggleLive(oControlEvent)Event is fired when the live mode has changed
toolsItemSelected(oControlEvent)Event is fired when an item from the tools MenuButton was selected
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.Feed.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.Feed with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.Feed.getMetadata()Returns a metadata object for class sap.ui.ux3.Feed.
addChunk(oChunk)Adds some chunk to the aggregation chunks.
addFilterItem(oFilterItem)Adds some filterItem to the aggregation filterItems.
addToolsMenuItem(oToolsMenuItem)Adds some toolsMenuItem to the aggregation toolsMenuItems.
attachChunkAdded(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the chunkAdded event of this sap.ui.ux3.Feed.
attachFilterChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the filterChange event of this sap.ui.ux3.Feed.
attachSearch(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the search event of this sap.ui.ux3.Feed.
attachToggleLive(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the toggleLive event of this sap.ui.ux3.Feed.
attachToolsItemSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the toolsItemSelected event of this sap.ui.ux3.Feed.
bindChunks(oBindingInfo)Binds aggregation chunks to model data.
bindFilterItems(oBindingInfo)Binds aggregation filterItems to model data.
bindToolsMenuItems(oBindingInfo)Binds aggregation toolsMenuItems to model data.
destroyChunks()Destroys all the chunks in the aggregation chunks.
destroyFilterItems()Destroys all the filterItems in the aggregation filterItems.
destroyToolsMenuItems()Destroys all the toolsMenuItems in the aggregation toolsMenuItems.
detachChunkAdded(fnFunction, oListener)Detaches event handler fnFunction from the chunkAdded event of this sap.ui.ux3.Feed.
detachFilterChange(fnFunction, oListener)Detaches event handler fnFunction from the filterChange event of this sap.ui.ux3.Feed.
detachSearch(fnFunction, oListener)Detaches event handler fnFunction from the search event of this sap.ui.ux3.Feed.
detachToggleLive(fnFunction, oListener)Detaches event handler fnFunction from the toggleLive event of this sap.ui.ux3.Feed.
detachToolsItemSelected(fnFunction, oListener)Detaches event handler fnFunction from the toolsItemSelected event of this sap.ui.ux3.Feed.
fireChunkAdded(mArguments?)Fires event chunkAdded to attached listeners.
fireFilterChange(mArguments?)Fires event filterChange to attached listeners.
fireSearch(mArguments?)Fires event search to attached listeners.
fireToggleLive(mArguments?)Fires event toggleLive to attached listeners.
fireToolsItemSelected(mArguments?)Fires event toolsItemSelected to attached listeners.
getChunks()Gets content of aggregation chunks.
getFeederSender()Gets current value of property feederSender.
getFeederThumbnailSrc()Gets current value of property feederThumbnailSrc.
getFilterItems()Gets content of aggregation filterItems.
getLive()Gets current value of property live.
getTitle()Gets current value of property title.
getToolsMenuItems()Gets content of aggregation toolsMenuItems.
indexOfChunk(oChunk)Checks for the provided sap.ui.ux3.FeedChunk in the aggregation chunks.
indexOfFilterItem(oFilterItem)Checks for the provided sap.ui.core.ListItem in the aggregation filterItems.
indexOfToolsMenuItem(oToolsMenuItem)Checks for the provided sap.ui.commons.MenuItem in the aggregation toolsMenuItems.
insertChunk(oChunk, iIndex)Inserts a chunk into the aggregation chunks.
insertFilterItem(oFilterItem, iIndex)Inserts a filterItem into the aggregation filterItems.
insertToolsMenuItem(oToolsMenuItem, iIndex)Inserts a toolsMenuItem into the aggregation toolsMenuItems.
removeAllChunks()Removes all the controls from the aggregation chunks.
removeAllFilterItems()Removes all the controls from the aggregation filterItems.
removeAllToolsMenuItems()Removes all the controls from the aggregation toolsMenuItems.
removeChunk(vChunk)Removes a chunk from the aggregation chunks.
removeFilterItem(vFilterItem)Removes a filterItem from the aggregation filterItems.
removeToolsMenuItem(vToolsMenuItem)Removes a toolsMenuItem from the aggregation toolsMenuItems.
setFeederSender(sFeederSender)Sets a new value for property feederSender.
setFeederThumbnailSrc(sFeederThumbnailSrc)Sets a new value for property feederThumbnailSrc.
setLive(bLive)Sets a new value for property live.
setTitle(sTitle)Sets a new value for property title.
unbindChunks()Unbinds aggregation chunks from model data.
unbindFilterItems()Unbinds aggregation filterItems from model data.
unbindToolsMenuItems()Unbinds aggregation toolsMenuItems from model data.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
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.Feed(sId?, mSettings?)
Constructor for a new Feed.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
  • Aggregations
  • Events
    • filterChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • search : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • chunkAdded : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • toolsItemSelected : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • toggleLive : 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 anysap.ui.layout container control.
Event Detail
chunkAdded(oControlEvent)
Event is fired when a new chunk is added
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.ux3.FeedChunk}oControlEvent.getParameters.chunk New chunk
filterChange(oControlEvent)
Event is fired when the filter is changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.newValue The new/changed value of the filter
search(oControlEvent)
Event is fired when the search function on SearchField is triggered
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.query The search query
toggleLive(oControlEvent)
Event is fired when the live mode has changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{boolean}oControlEvent.getParameters.live Current live indicator
toolsItemSelected(oControlEvent)
Event is fired when an item from the tools MenuButton 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
Method Detail
sap.ui.ux3.Feed.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.Feed 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.Feed.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.Feed.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addChunk(oChunk): sap.ui.ux3.Feed
Adds some chunk to the aggregation chunks.
Parameters:
{sap.ui.ux3.FeedChunk}oChunk the chunk to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
addFilterItem(oFilterItem): sap.ui.ux3.Feed
Adds some filterItem to the aggregation filterItems.
Parameters:
{sap.ui.core.ListItem}oFilterItem the filterItem to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
addToolsMenuItem(oToolsMenuItem): sap.ui.ux3.Feed
Adds some toolsMenuItem to the aggregation toolsMenuItems.
Parameters:
{sap.ui.commons.MenuItem}oToolsMenuItem the toolsMenuItem to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
attachChunkAdded(oData?, fnFunction, oListener?): sap.ui.ux3.Feed
Attaches event handler fnFunction to the chunkAdded event of this sap.ui.ux3.Feed.

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

Event is fired when a new chunk is added

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.Feed itself
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
attachFilterChange(oData?, fnFunction, oListener?): sap.ui.ux3.Feed
Attaches event handler fnFunction to the filterChange event of this sap.ui.ux3.Feed.

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

Event is fired when the filter is changed

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.Feed itself
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
attachSearch(oData?, fnFunction, oListener?): sap.ui.ux3.Feed
Attaches event handler fnFunction to the search event of this sap.ui.ux3.Feed.

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

Event is fired when the search function on SearchField is triggered

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.Feed itself
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
attachToggleLive(oData?, fnFunction, oListener?): sap.ui.ux3.Feed
Attaches event handler fnFunction to the toggleLive event of this sap.ui.ux3.Feed.

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

Event is fired when the live mode has changed

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.Feed itself
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
attachToolsItemSelected(oData?, fnFunction, oListener?): sap.ui.ux3.Feed
Attaches event handler fnFunction to the toolsItemSelected event of this sap.ui.ux3.Feed.

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

Event is fired when an item from the tools MenuButton 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.Feed itself
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
bindChunks(oBindingInfo): sap.ui.ux3.Feed
Binds aggregation chunks 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.Feed} Reference to this in order to allow method chaining
bindFilterItems(oBindingInfo): sap.ui.ux3.Feed
Binds aggregation filterItems 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.Feed} Reference to this in order to allow method chaining
bindToolsMenuItems(oBindingInfo): sap.ui.ux3.Feed
Binds aggregation toolsMenuItems 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.Feed} Reference to this in order to allow method chaining
destroyChunks(): sap.ui.ux3.Feed
Destroys all the chunks in the aggregation chunks.
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
destroyFilterItems(): sap.ui.ux3.Feed
Destroys all the filterItems in the aggregation filterItems.
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
destroyToolsMenuItems(): sap.ui.ux3.Feed
Destroys all the toolsMenuItems in the aggregation toolsMenuItems.
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
detachChunkAdded(fnFunction, oListener): sap.ui.ux3.Feed
Detaches event handler fnFunction from the chunkAdded event of this sap.ui.ux3.Feed.

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.Feed} Reference to this in order to allow method chaining
detachFilterChange(fnFunction, oListener): sap.ui.ux3.Feed
Detaches event handler fnFunction from the filterChange event of this sap.ui.ux3.Feed.

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.Feed} Reference to this in order to allow method chaining
detachSearch(fnFunction, oListener): sap.ui.ux3.Feed
Detaches event handler fnFunction from the search event of this sap.ui.ux3.Feed.

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.Feed} Reference to this in order to allow method chaining
detachToggleLive(fnFunction, oListener): sap.ui.ux3.Feed
Detaches event handler fnFunction from the toggleLive event of this sap.ui.ux3.Feed.

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.Feed} Reference to this in order to allow method chaining
detachToolsItemSelected(fnFunction, oListener): sap.ui.ux3.Feed
Detaches event handler fnFunction from the toolsItemSelected event of this sap.ui.ux3.Feed.

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.Feed} Reference to this in order to allow method chaining
fireChunkAdded(mArguments?): sap.ui.ux3.Feed
Fires event chunkAdded to attached listeners.

Expects the following event parameters:

  • chunk of type sap.ui.ux3.FeedChunkNew chunk
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
fireFilterChange(mArguments?): sap.ui.ux3.Feed
Fires event filterChange to attached listeners.

Expects the following event parameters:

  • newValue of type stringThe new/changed value of the filter
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
fireSearch(mArguments?): sap.ui.ux3.Feed
Fires event search to attached listeners.

Expects the following event parameters:

  • query of type stringThe search query
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
fireToggleLive(mArguments?): sap.ui.ux3.Feed
Fires event toggleLive to attached listeners.

Expects the following event parameters:

  • live of type booleanCurrent live indicator
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
fireToolsItemSelected(mArguments?): sap.ui.ux3.Feed
Fires event toolsItemSelected 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.Feed} Reference to this in order to allow method chaining
getChunks(): sap.ui.ux3.FeedChunk[]
Gets content of aggregation chunks.

The chunks

Returns:
{sap.ui.ux3.FeedChunk[]}
getFeederSender(): string
Gets current value of property feederSender.

The sender of the feeder

Returns:
{string} Value of property feederSender
getFeederThumbnailSrc(): sap.ui.core.URI
Gets current value of property feederThumbnailSrc.

The path to the thumbnail image used for the feeder

Returns:
{sap.ui.core.URI} Value of property feederThumbnailSrc
getFilterItems(): sap.ui.core.ListItem[]
Gets content of aggregation filterItems.

Items of the filter

Returns:
{sap.ui.core.ListItem[]}
getLive(): boolean
Gets current value of property live.

Specifies whether the feed shall be in live mode

Default value is true.

Returns:
{boolean} Value of property live
getTitle(): string
Gets current value of property title.

Title text of the Feed. If no text is entered "FEED" is displayed.

Returns:
{string} Value of property title
getToolsMenuItems(): sap.ui.commons.MenuItem[]
Gets content of aggregation toolsMenuItems.

MenuItems to open when the tool button is clicked by the user

Returns:
{sap.ui.commons.MenuItem[]}
indexOfChunk(oChunk): int
Checks for the provided sap.ui.ux3.FeedChunk in the aggregation chunks. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.ux3.FeedChunk}oChunk The chunk whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfFilterItem(oFilterItem): int
Checks for the provided sap.ui.core.ListItem in the aggregation filterItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.ListItem}oFilterItem The filterItem whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfToolsMenuItem(oToolsMenuItem): int
Checks for the provided sap.ui.commons.MenuItem in the aggregation toolsMenuItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.commons.MenuItem}oToolsMenuItem The toolsMenuItem whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertChunk(oChunk, iIndex): sap.ui.ux3.Feed
Inserts a chunk into the aggregation chunks.
Parameters:
{sap.ui.ux3.FeedChunk}oChunk the chunk to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the chunk should be inserted at; for a negative value of iIndex, the chunk is inserted at position 0; for a value greater than the current size of the aggregation, the chunk is inserted at the last position
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
insertFilterItem(oFilterItem, iIndex): sap.ui.ux3.Feed
Inserts a filterItem into the aggregation filterItems.
Parameters:
{sap.ui.core.ListItem}oFilterItem the filterItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the filterItem should be inserted at; for a negative value of iIndex, the filterItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem is inserted at the last position
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
insertToolsMenuItem(oToolsMenuItem, iIndex): sap.ui.ux3.Feed
Inserts a toolsMenuItem into the aggregation toolsMenuItems.
Parameters:
{sap.ui.commons.MenuItem}oToolsMenuItem the toolsMenuItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the toolsMenuItem should be inserted at; for a negative value of iIndex, the toolsMenuItem is inserted at position 0; for a value greater than the current size of the aggregation, the toolsMenuItem is inserted at the last position
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
removeAllChunks(): sap.ui.ux3.FeedChunk[]
Removes all the controls from the aggregation chunks.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.ux3.FeedChunk[]} An array of the removed elements (might be empty)
removeAllFilterItems(): sap.ui.core.ListItem[]
Removes all the controls from the aggregation filterItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.ListItem[]} An array of the removed elements (might be empty)
removeAllToolsMenuItems(): sap.ui.commons.MenuItem[]
Removes all the controls from the aggregation toolsMenuItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.commons.MenuItem[]} An array of the removed elements (might be empty)
removeChunk(vChunk): sap.ui.ux3.FeedChunk
Removes a chunk from the aggregation chunks.
Parameters:
{int|string|sap.ui.ux3.FeedChunk}vChunk The chunkto remove or its index or id
Returns:
{sap.ui.ux3.FeedChunk} The removed chunk or null
removeFilterItem(vFilterItem): sap.ui.core.ListItem
Removes a filterItem from the aggregation filterItems.
Parameters:
{int|string|sap.ui.core.ListItem}vFilterItem The filterItemto remove or its index or id
Returns:
{sap.ui.core.ListItem} The removed filterItem or null
removeToolsMenuItem(vToolsMenuItem): sap.ui.commons.MenuItem
Removes a toolsMenuItem from the aggregation toolsMenuItems.
Parameters:
{int|string|sap.ui.commons.MenuItem}vToolsMenuItem The toolsMenuItemto remove or its index or id
Returns:
{sap.ui.commons.MenuItem} The removed toolsMenuItem or null
setFeederSender(sFeederSender): sap.ui.ux3.Feed
Sets a new value for property feederSender.

The sender of the feeder

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.Feed} Reference to this in order to allow method chaining
setFeederThumbnailSrc(sFeederThumbnailSrc): sap.ui.ux3.Feed
Sets a new value for property feederThumbnailSrc.

The path to the thumbnail image used for the feeder

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.Feed} Reference to this in order to allow method chaining
setLive(bLive): sap.ui.ux3.Feed
Sets a new value for property live.

Specifies whether the feed shall be in live mode

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

Default value is true.

Parameters:
{boolean}bLive New value for property live
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
setTitle(sTitle): sap.ui.ux3.Feed
Sets a new value for property title.

Title text of the Feed. If no text is entered "FEED" is displayed.

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

Parameters:
{string}sTitle New value for property title
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
unbindChunks(): sap.ui.ux3.Feed
Unbinds aggregation chunks from model data.
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
unbindFilterItems(): sap.ui.ux3.Feed
Unbinds aggregation filterItems from model data.
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining
unbindToolsMenuItems(): sap.ui.ux3.Feed
Unbinds aggregation toolsMenuItems from model data.
Returns:
{sap.ui.ux3.Feed} Reference to this in order to allow method chaining