sap.suite.ui.commons.Timeline.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.Timeline with name
sClassName
and enriches it with the information contained in
oClassInfo
.
oClassInfo
might contain the same kind of informations as described in Element.extend.
Parameters:
{string} | sClassName | name of the class to be created |
{object} | oClassInfo? | object literal with informations about the class |
{function} | FNMetaImpl? | constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata. |
Returns:
{function} | the created class / constructor function |
Returns a metadata object for class sap.suite.ui.commons.Timeline.
Returns:
Adds some content oContent
to the aggregation named content
.
Parameters:
Returns:
Adds some filterList oFilterList
to the aggregation named filterList
.
Parameters:
Returns:
Adds some suggestionItem oSuggestionItem
to the aggregation named suggestionItems
.
Parameters:
Returns:
adjustUI(): void
to allow for UI layout change (public)
Attach event handler
fnFunction
to the 'addPost' event of this
sap.suite.ui.commons.Timeline
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.Timeline
.
itself. Event fire when user add a new post
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.Timeline . itself. |
Returns:
Attach event handler
fnFunction
to the 'filterOpen' event of this
sap.suite.ui.commons.Timeline
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.Timeline
.
itself. event is fired when filter icon is clicked and filter open
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.Timeline . itself. |
Returns:
Attach event handler
fnFunction
to the 'filterSelectionChange' event of this
sap.suite.ui.commons.Timeline
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.Timeline
.
itself. This event is getting triggered after selecting an item from filter list.
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.Timeline . itself. |
Returns:
Attach event handler
fnFunction
to the 'grow' event of this
sap.suite.ui.commons.Timeline
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.Timeline
.
itself. this event is fired when "More" button is clicked.
Parameters:
{object} | oData? | An application specific payload object, that will be passed to the event handler along with the event object when firing the event. |
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.Timeline . itself. |
Returns:
Attach event handler
fnFunction
to the 'select' event of this
sap.suite.ui.commons.Timeline
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.Timeline
.
itself. Select Timeline Item
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.Timeline . itself. |
Returns:
Attach event handler
fnFunction
to the 'suggest' event of this
sap.suite.ui.commons.Timeline
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.Timeline
.
itself. This event is fired when user types in the input and showSuggestion is set to true. Changing the suggestItems aggregation will show the suggestions within a popup.
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.Timeline . itself. |
- Since:
- 1.26.1
Returns:
Attach event handler
fnFunction
to the 'suggestionItemSelected' event of this
sap.suite.ui.commons.Timeline
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.Timeline
.
itself. This event is fired when suggestionItem shown in suggestion popup are selected. This event is only fired when showSuggestion is set to true and there are suggestionItems shown in the suggestion popup.
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.Timeline . itself. |
- Since:
- 1.26.1
Returns:
Destroys all the content in the aggregation named content
.
Returns:
Destroys the customFilter in the aggregation named customFilter
.
Returns:
Destroys all the filterList in the aggregation named filterList
.
Returns:
Destroys all the suggestionItems in the aggregation named suggestionItems
.
Returns:
Detach event handler
fnFunction
from the 'addPost' event of this
sap.suite.ui.commons.Timeline
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'filterOpen' event of this
sap.suite.ui.commons.Timeline
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'filterSelectionChange' event of this
sap.suite.ui.commons.Timeline
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'grow' event of this
sap.suite.ui.commons.Timeline
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'select' event of this
sap.suite.ui.commons.Timeline
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'suggest' event of this
sap.suite.ui.commons.Timeline
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
- Since:
- 1.26.1
Returns:
Detach event handler
fnFunction
from the 'suggestionItemSelected' event of this
sap.suite.ui.commons.Timeline
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
- Since:
- 1.26.1
Returns:
Fire event addPost to attached listeners.
Expects following event parameters:
- 'value' of type
string
post message
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event filterOpen to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event filterSelectionChange to attached listeners.
Expects following event parameters:
- 'selectedItem' of type
sap.suite.ui.commons.TimelineFilterListItem
filterClose event returns selected key value from filterList
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event grow to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event select to attached listeners.
Expects following event parameters:
- 'selectedItem' of type
sap.suite.ui.commons.TimelineItem
Selected TimelineItem
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event suggest to attached listeners.
Expects following event parameters:
- 'suggestValue' of type
string
The current value which has been typed in the input.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
- Since:
- 1.26.1
Returns:
Fire event suggestionItemSelected to attached listeners.
Expects following event parameters:
- 'selectedItem' of type
sap.ui.core.Item
This is the item selected in the suggestion popup.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
- Since:
- 1.26.1
Returns:
Getter for property
alignment
. Timeline item alignment.
Default value is Right
Returns:
Getter for property
axisOrientation
. Timeline axis orientation.
Default value is Vertical
Returns:
Getter for aggregation content
.
List of Timeline Items.
Returns:
getCurrentFilter(): string
Get the current selected filter key
Returns:
Getter for aggregation customFilter
.
Provide Custom Filter here
Returns:
getData(): object
Getter for property
data
. Data for Timeline Control..
Default value is empty/undefined
Returns:
{object} | the value of property data |
getEnableAllInFilterItem(): boolean
Getter for property
enableAllInFilterItem
. This flag enables to add 'All' in the begining of filter list
Default value is true
Returns:
{boolean} | the value of property enableAllInFilterItem |
getEnableBackendFilter(): boolean
Getter for property
enableBackendFilter
. This flag enables to get data from backend instead of deriving filter values from front-end values(displayed list).
Default value is false
Returns:
{boolean} | the value of property enableBackendFilter |
getEnableBusyIndicator(): boolean
Getter for property
enableBusyIndicator
. When this property is set to "true", Timeline will display a busy indicator when data is being loaded.This BusyIndicator blocks the interaction with the items until data loading is finished.
Default value is true
Returns:
{boolean} | the value of property enableBusyIndicator |
getEnableDoubleSided(): boolean
Getter for property
enableDoubleSided
. If set to true, timeline items will render on both sides
Default value is false
Returns:
{boolean} | the value of property enableDoubleSided |
getEnableScroll(): boolean
Getter for property
enableScroll
. Enable scroll bar display
Default value is true
Returns:
{boolean} | the value of property enableScroll |
getEnableSocial(): boolean
Getter for property
enableSocial
. enable Jam Integration
Default value is false
Returns:
{boolean} | the value of property enableSocial |
Getter for aggregation filterList
.
sap.suite.ui.commons/TimelineFilterListItem
Returns:
getForceGrowing(): boolean
Getter for property
forceGrowing
. If set to true, the "More" button will always show.
Default value is false
Returns:
{boolean} | the value of property forceGrowing |
getGrowing(): boolean
Getter for property
growing
. Sets the growing(paging) feature of control. This feature only works with model binding for aggregation "content".
Default value is true
Returns:
{boolean} | the value of property growing |
getGrowingThreshold(): int
Getter for property
growingThreshold
. Number of items requested from the server. To activate this you should set "growing" property to "true".
Default value is 5
Returns:
{int} | the value of property growingThreshold |
get the header bar control to customerize
Returns:
Get messagestrip
Returns:
getNoDataText(): string
Getter for property
noDataText
. This text is displayed when the control has no data.
Default value is empty/undefined
Returns:
{string} | the value of property noDataText |
getShowFilterBar(): boolean
Getter for property
showFilterBar
. Set timeline filterbar visibility
Default value is true
Returns:
{boolean} | the value of property showFilterBar |
getShowHeaderBar(): boolean
Getter for property
showHeaderBar
. Show header tool bar
Default value is true
Returns:
{boolean} | the value of property showHeaderBar |
getShowIcons(): boolean
Getter for property
showIcons
. Show icon on each Timeline item.
Default value is true
Returns:
{boolean} | the value of property showIcons |
getShowSearch(): boolean
Getter for property
showSearch
. Set timeline search field visibility
Default value is true
Returns:
{boolean} | the value of property showSearch |
getShowSuggestion(): boolean
Getter for property
showSuggestion
. If this is set to true, suggest event is fired when user types in the input. Changing the suggestItems aggregation in suggest event listener will show suggestions within a popup.
Default value is true
- Since:
- 1.26.1
Returns:
{boolean} | the value of property showSuggestion |
getSort(): boolean
Getter for property
sort
. Allow only latest first sort when Sort is checked, otherwise display order in which data is received.
Default value is true
Returns:
{boolean} | the value of property sort |
getSortOldestFirst(): boolean
Getter for property
sortOldestFirst
. Whether the oldest item will be displayed first.
Default value is false
Returns:
{boolean} | the value of property sortOldestFirst |
Getter for aggregation suggestionItems
.
Items for suggestions
Returns:
getSuspendSocailFeature(): boolean
get the suspend social feature status
Returns:
getVisible(): boolean
Getter for property
visible
. Set Timeline control visibility
Default value is true
Returns:
{boolean} | the value of property visible |
Getter for property
width
. Sets the width of the Timeline.
Default value is 100%
Returns:
indexOfContent(oContent): int
Checks for the provided sap.suite.ui.commons.TimelineItem
in the aggregation named content
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
indexOfFilterList(oFilterList): int
Checks for the provided sap.suite.ui.commons.TimelineFilterListItem
in the aggregation named filterList
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
indexOfSuggestionItem(oSuggestionItem): int
Checks for the provided sap.m.StandardListItem
in the aggregation named suggestionItems
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a content into the aggregation named content
.
Parameters:
{sap.suite.ui.commons.TimelineItem} | oContent | the content to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the content should be inserted at; for a negative value of iIndex , the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position |
Returns:
Inserts a filterList into the aggregation named filterList
.
Parameters:
{sap.suite.ui.commons.TimelineFilterListItem} | oFilterList | the filterList to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the filterList should be inserted at; for a negative value of iIndex , the filterList is inserted at position 0; for a value greater than the current size of the aggregation, the filterList is inserted at the last position |
Returns:
Inserts a suggestionItem into the aggregation named suggestionItems
.
Parameters:
{sap.m.StandardListItem} | oSuggestionItem | the suggestionItem to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the suggestionItem should be inserted at; for a negative value of iIndex , the suggestionItem is inserted at position 0; for a value greater than the current size of the aggregation, the suggestionItem is inserted at the last position |
Returns:
Removes all the controls in the aggregation named content
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named filterList
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named suggestionItems
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes an content from the aggregation named content
.
Parameters:
Returns:
Removes an filterList from the aggregation named filterList
.
Parameters:
Returns:
Removes an suggestionItem from the aggregation named suggestionItems
.
Parameters:
Returns:
Setter for property
alignment
.
Default value is Right
Parameters:
Returns:
Setter for property
axisOrientation
.
Default value is Vertical
Parameters:
Returns:
setCurrentFilter(sSelectedItemKey): void
Set the current selected filter key
Parameters:
{string} | sSelectedItemKey | Returns the TinelineFilterListItem |
Setter for the aggregated customFilter
.
Parameters:
Returns:
setCustomMessage(sMsg): void
set custom message
Parameters:
{string} | sMsg | Message to be set |
Setter for property
data
.
Default value is empty/undefined
Parameters:
{object} | oData | new value for property data |
Returns:
Setter for property
enableAllInFilterItem
.
Default value is true
Parameters:
{boolean} | bEnableAllInFilterItem | new value for property enableAllInFilterItem |
Returns:
Setter for property
enableBackendFilter
.
Default value is false
Parameters:
{boolean} | bEnableBackendFilter | new value for property enableBackendFilter |
Returns:
Setter for property
enableBusyIndicator
.
Default value is true
Parameters:
{boolean} | bEnableBusyIndicator | new value for property enableBusyIndicator |
Returns:
Setter for property
enableDoubleSided
.
Default value is false
Parameters:
{boolean} | bEnableDoubleSided | new value for property enableDoubleSided |
Returns:
Setter for property
enableScroll
.
Default value is true
Parameters:
{boolean} | bEnableScroll | new value for property enableScroll |
Returns:
Setter for property
enableSocial
.
Default value is false
Parameters:
{boolean} | bEnableSocial | new value for property enableSocial |
Returns:
Setter for property
forceGrowing
.
Default value is false
Parameters:
{boolean} | bForceGrowing | new value for property forceGrowing |
Returns:
Setter for property
growing
.
Default value is true
Parameters:
{boolean} | bGrowing | new value for property growing |
Returns:
Setter for property
growingThreshold
.
Default value is 5
Parameters:
{int} | iGrowingThreshold | new value for property growingThreshold |
Returns:
Setter for property
noDataText
.
Default value is empty/undefined
Parameters:
{string} | sNoDataText | new value for property noDataText |
Returns:
Setter for property
showFilterBar
.
Default value is true
Parameters:
{boolean} | bShowFilterBar | new value for property showFilterBar |
Returns:
Setter for property
showHeaderBar
.
Default value is true
Parameters:
{boolean} | bShowHeaderBar | new value for property showHeaderBar |
Returns:
Setter for property
showIcons
.
Default value is true
Parameters:
{boolean} | bShowIcons | new value for property showIcons |
Returns:
Setter for property
showSearch
.
Default value is true
Parameters:
{boolean} | bShowSearch | new value for property showSearch |
Returns:
Setter for property
showSuggestion
.
Default value is true
Parameters:
{boolean} | bShowSuggestion | new value for property showSuggestion |
- Since:
- 1.26.1
Returns:
Setter for property
sort
.
Default value is true
Parameters:
{boolean} | bSort | new value for property sort |
Returns:
Setter for property
sortOldestFirst
.
Default value is false
Parameters:
{boolean} | bSortOldestFirst | new value for property sortOldestFirst |
Returns:
setSuspendSocialFeature(bBSuspend): void
when set to true, the Add Post and Reply feature will be grayed out .
Parameters:
{boolean} | bBSuspend | boolean value for suspend or not. |
Setter for property
visible
.
Default value is true
Parameters:
{boolean} | bVisible | new value for property visible |
Returns:
Setter for property
width
.
Default value is 100%
Parameters:
Returns: