A container control representing a full feed page, including feeder and updates.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.ux3.Feed(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 |
Name | Type | Default Value | Description |
---|---|---|---|
feederSender | string | The sender of the feeder Visibility: public |
|
feederThumbnailSrc | sap.ui.core.URI | The path to the thumbnail image used for the feeder Visibility: public |
|
live | boolean | true | Specifies whether the feed shall be in live mode Visibility: public |
title | string | Title text of the Feed. If no text is entered "FEED" is displayed. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
chunks | 0..n | sap.ui.ux3.FeedChunk |
The chunks |
filterItems | 0..n | sap.ui.core.ListItem |
Items of the filter |
toolsMenuItems | 0..n | sap.ui.commons.MenuItem |
MenuItems to open when the tool button is clicked by the user |
Event | Description |
---|---|
chunkAdded |
Event is fired when a new chunk is added |
filterChange |
Event is fired when the filter is changed |
search |
Event is fired when the search function on SearchField is triggered |
toggleLive |
Event is fired when the live mode has changed |
toolsItemSelected |
Event is fired when an item from the tools MenuButton was selected |
Event is fired when a new chunk is added
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
chunk | sap.ui.ux3.FeedChunk |
New chunk |
Event is fired when the filter is changed
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
newValue | string |
The new/changed value of the filter |
Event is fired when the search function on SearchField is triggered
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
query | string |
The search query |
Method | Description |
---|---|
addChunk |
Adds some chunk to the aggregation chunks. |
addFilterItem |
Adds some filterItem to the aggregation filterItems. |
addToolsMenuItem |
Adds some toolsMenuItem to the aggregation toolsMenuItems. |
attachChunkAdded |
Attaches event handler When called, the context of the event handler (its Event is fired when a new chunk is added |
attachFilterChange |
Attaches event handler When called, the context of the event handler (its Event is fired when the filter is changed |
attachSearch |
Attaches event handler When called, the context of the event handler (its Event is fired when the search function on SearchField is triggered |
attachToggleLive |
Attaches event handler When called, the context of the event handler (its Event is fired when the live mode has changed |
attachToolsItemSelected |
Attaches event handler When called, the context of the event handler (its Event is fired when an item from the tools MenuButton was selected |
bindChunks |
Binds aggregation chunks to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
bindFilterItems |
Binds aggregation filterItems to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
bindToolsMenuItems |
Binds aggregation toolsMenuItems to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
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 |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachFilterChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSearch |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachToggleLive |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachToolsItemSelected |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.ux3.Feed.extend |
Creates a new subclass of class sap.ui.ux3.Feed with name
|
fireChunkAdded |
Fires event chunkAdded to attached listeners. |
fireFilterChange |
Fires event filterChange to attached listeners. |
fireSearch |
Fires event search to attached listeners. |
fireToggleLive |
Fires event toggleLive to attached listeners. |
fireToolsItemSelected |
Fires event toolsItemSelected to attached listeners. |
getChunks |
Gets content of aggregation chunks. The chunks |
getFeederSender |
Gets current value of property feederSender. The sender of the feeder |
getFeederThumbnailSrc |
Gets current value of property feederThumbnailSrc. The path to the thumbnail image used for the feeder |
getFilterItems |
Gets content of aggregation filterItems. Items of the filter |
getLive |
Gets current value of property live. Specifies whether the feed shall be in live mode Default value is |
sap.ui.ux3.Feed.getMetadata |
Returns a metadata object for class sap.ui.ux3.Feed. |
getTitle |
Gets current value of property title. Title text of the Feed. If no text is entered "FEED" is displayed. |
getToolsMenuItems |
Gets content of aggregation toolsMenuItems. MenuItems to open when the tool button is clicked by the user |
indexOfChunk |
Checks for the provided |
indexOfFilterItem |
Checks for the provided |
indexOfToolsMenuItem |
Checks for the provided |
insertChunk |
Inserts a chunk into the aggregation chunks. |
insertFilterItem |
Inserts a filterItem into the aggregation filterItems. |
insertToolsMenuItem |
Inserts a toolsMenuItem into the aggregation toolsMenuItems. |
removeAllChunks |
Removes all the controls from the aggregation chunks. Additionally, it unregisters them from the hosting UIArea. |
removeAllFilterItems |
Removes all the controls from the aggregation filterItems. Additionally, it unregisters them from the hosting UIArea. |
removeAllToolsMenuItems |
Removes all the controls from the aggregation toolsMenuItems. Additionally, it unregisters them from the hosting UIArea. |
removeChunk |
Removes a chunk from the aggregation chunks. |
removeFilterItem |
Removes a filterItem from the aggregation filterItems. |
removeToolsMenuItem |
Removes a toolsMenuItem from the aggregation toolsMenuItems. |
setFeederSender |
Sets a new value for property feederSender. The sender of the feeder When called with a value of |
setFeederThumbnailSrc |
Sets a new value for property feederThumbnailSrc. The path to the thumbnail image used for the feeder When called with a value of |
setLive |
Sets a new value for property live. Specifies whether the feed shall be in live mode When called with a value of Default value is |
setTitle |
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 |
unbindChunks |
Unbinds aggregation chunks from model data. |
unbindFilterItems |
Unbinds aggregation filterItems from model data. |
unbindToolsMenuItems |
Unbinds aggregation toolsMenuItems from model data. |
Adds some chunk to the aggregation chunks.
Param | Type | DefaultValue | Description |
---|---|---|---|
oChunk | sap.ui.ux3.FeedChunk |
The chunk to add; if empty, nothing is inserted |
Adds some filterItem to the aggregation filterItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFilterItem | sap.ui.core.ListItem |
The filterItem to add; if empty, nothing is inserted |
Adds some toolsMenuItem to the aggregation toolsMenuItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oToolsMenuItem | sap.ui.commons.MenuItem |
The toolsMenuItem to add; if empty, nothing is inserted |
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
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 |
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
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 |
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
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 |
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
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 |
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
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 |
Binds aggregation chunks 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 |
Binds aggregation filterItems 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 |
Binds aggregation toolsMenuItems 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 |
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.
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 |
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.
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 |
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.
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 |
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.
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 |
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.
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 |
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.
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 |
Fires event chunkAdded to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
chunk | sap.ui.ux3.FeedChunk |
New chunk |
Fires event filterChange to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
newValue | string |
The new/changed value of the filter |
Fires event search to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
query | string |
The search query |
Fires event toggleLive to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
live | boolean |
Current live indicator |
Fires event toolsItemSelected 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 |
Gets current value of property feederThumbnailSrc.
The path to the thumbnail image used for the feeder
Gets current value of property live.
Specifies whether the feed shall be in live mode
Default value is true
.
Gets current value of property title.
Title text of the Feed. If no text is entered "FEED" is displayed.
Gets content of aggregation toolsMenuItems.
MenuItems to open when the tool button is clicked by the user
Checks for the provided sap.ui.ux3.FeedChunk
in the aggregation chunks. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oChunk | sap.ui.ux3.FeedChunk |
The chunk whose index is looked for |
Checks for the provided sap.ui.core.ListItem
in the aggregation filterItems. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFilterItem | sap.ui.core.ListItem |
The filterItem whose index is looked for |
Checks for the provided sap.ui.commons.MenuItem
in the aggregation toolsMenuItems. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oToolsMenuItem | sap.ui.commons.MenuItem |
The toolsMenuItem whose index is looked for |
Inserts a chunk into the aggregation chunks.
Param | Type | DefaultValue | Description |
---|---|---|---|
oChunk | sap.ui.ux3.FeedChunk |
The chunk to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a filterItem into the aggregation filterItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFilterItem | sap.ui.core.ListItem |
The filterItem to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a toolsMenuItem into the aggregation toolsMenuItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oToolsMenuItem | sap.ui.commons.MenuItem |
The toolsMenuItem to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation chunks.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation filterItems.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation toolsMenuItems.
Additionally, it unregisters them from the hosting UIArea.
Removes a chunk from the aggregation chunks.
Param | Type | DefaultValue | Description |
---|---|---|---|
vChunk | int string sap.ui.ux3.FeedChunk |
The chunk to remove or its index or id |
Removes a filterItem from the aggregation filterItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
vFilterItem | int string sap.ui.core.ListItem |
The filterItem to remove or its index or id |
Removes a toolsMenuItem from the aggregation toolsMenuItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
vToolsMenuItem | int string sap.ui.commons.MenuItem |
The toolsMenuItem to remove or its index or id |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFeederSender | string |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFeederThumbnailSrc | sap.ui.core.URI |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bLive | boolean | true |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
New value for property |