sap.suite.ui.commons.TimelineItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.TimelineItem 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.TimelineItem.
Returns:
Adds some customAction oCustomAction
to the aggregation named customAction
.
Parameters:
Returns:
Adds some suggestionItem oSuggestionItem
to the aggregation named suggestionItems
.
Parameters:
Returns:
Attach event handler
fnFunction
to the 'customActionClicked' event of this
sap.suite.ui.commons.TimelineItem
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.TimelineItem
.
itself. fire when custom action link 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.TimelineItem . itself. |
Returns:
Attach event handler
fnFunction
to the 'replyListOpen' event of this
sap.suite.ui.commons.TimelineItem
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.TimelineItem
.
itself. fire when the reply link is clicked to open reply popover
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.TimelineItem . itself. |
Returns:
Attach event handler
fnFunction
to the 'replyPost' event of this
sap.suite.ui.commons.TimelineItem
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.TimelineItem
.
itself. fire when Reply 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.TimelineItem . itself. |
Returns:
Attach event handler
fnFunction
to the 'suggest' event of this
sap.suite.ui.commons.TimelineItem
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.TimelineItem
.
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.TimelineItem . itself. |
- Since:
- 1.28.1
Returns:
Attach event handler
fnFunction
to the 'suggestionItemSelected' event of this
sap.suite.ui.commons.TimelineItem
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.TimelineItem
.
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.TimelineItem . itself. |
- Since:
- 1.28.1
Returns:
Attach event handler
fnFunction
to the 'userNameClicked' event of this
sap.suite.ui.commons.TimelineItem
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.TimelineItem
.
itself. Fire when user name in the item header 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.TimelineItem . itself. |
Returns:
Destroys all the customAction in the aggregation named customAction
.
Returns:
Destroys the customReply in the aggregation named customReply
.
Returns:
Destroys the embeddedControl in the aggregation named embeddedControl
.
Returns:
Destroys the replyList in the aggregation named replyList
.
Returns:
Destroys all the suggestionItems in the aggregation named suggestionItems
.
Returns:
Detach event handler
fnFunction
from the 'customActionClicked' event of this
sap.suite.ui.commons.TimelineItem
.
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 'replyListOpen' event of this
sap.suite.ui.commons.TimelineItem
.
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 'replyPost' event of this
sap.suite.ui.commons.TimelineItem
.
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.TimelineItem
.
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.28.1
Returns:
Detach event handler
fnFunction
from the 'suggestionItemSelected' event of this
sap.suite.ui.commons.TimelineItem
.
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.28.1
Returns:
Detach event handler
fnFunction
from the 'userNameClicked' event of this
sap.suite.ui.commons.TimelineItem
.
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:
Fire event customActionClicked to attached listeners.
Expects following event parameters:
- 'value' of type
string
Value of the custom action - 'key' of type
string
Key of the custom action - 'linkObj' of type
sap.ui.core.Control
Control of the custom action
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event replyListOpen to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event replyPost to attached listeners.
Expects following event parameters:
- 'value' of type
string
content of reply post
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.28.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.28.1
Returns:
Fire event userNameClicked to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Getter for aggregation customAction
.
Custom actions to display as links on the social bar
Returns:
Getter for aggregation customReply
.
Customer reply for embedded reply action
Returns:
getDateTime(): any
Getter for property
dateTime
. Datetime value of Timeline item
Default value is empty/undefined
Returns:
{any} | the value of property dateTime |
Getter for aggregation embeddedControl
.
Embed other control in timeline item, such as a button or a check box, etc.
Returns:
getFilterValue(): string
Getter for property
filterValue
. Text for filter value
Default value is empty/undefined
Returns:
{string} | the value of property filterValue |
getIcon(): string
Getter for property
icon
. Icon for this item
Default value is empty/undefined
Returns:
{string} | the value of property icon |
getIconTooltip(): string
Getter for property
iconTooltip
. Icon Tooltip for Item
Default value is empty/undefined
Returns:
{string} | the value of property iconTooltip |
getMaxCharacters(): int
Getter for property
maxCharacters
. The expand and collapse feature is set by default and uses 300 characters on mobile devices and 500 characters on desktops as limits. Based on these values, the text of the timeline utem is collapsed once text reaches these limits. In this case, only the specified number of characters is displayed. By clicking on the text link More, the entire text can be displayed. The text link Less collapses the text. The application is able to set the value to its needs.
Default value is empty/undefined
Returns:
{int} | the value of property maxCharacters |
getReplyCount(): int
Getter for property
replyCount
. count of the replies to the post
Default value is empty/undefined
Returns:
{int} | the value of property replyCount |
Getter for aggregation replyList
.
Reply list related to the post
Returns:
Getter for aggregation suggestionItems
.
Items for suggestions
Returns:
getText(): string
Getter for property
text
. Text shown inside the item
Default value is empty/undefined
Returns:
{string} | the value of property text |
getTitle(): string
Getter for property
title
. Text shown in the title after user name
Default value is empty/undefined
Returns:
{string} | the value of property title |
getUserName(): string
Getter for property
userName
. User name shown in the title
Default value is empty/undefined
Returns:
{string} | the value of property userName |
getUserNameClickable(): boolean
Getter for property
userNameClickable
. Make user name as a clickable to raise userNameClicked event
Default value is false
Returns:
{boolean} | the value of property userNameClickable |
Getter for property
userPicture
. User Picture
Default value is empty/undefined
Returns:
indexOfCustomAction(oCustomAction): int
Checks for the provided sap.ui.core.CustomData
in the aggregation named customAction
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 customAction into the aggregation named customAction
.
Parameters:
{sap.ui.core.CustomData} | oCustomAction | the customAction to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the customAction should be inserted at; for a negative value of iIndex , the customAction is inserted at position 0; for a value greater than the current size of the aggregation, the customAction 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 customAction
.
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 customAction from the aggregation named customAction
.
Parameters:
Returns:
Removes an suggestionItem from the aggregation named suggestionItems
.
Parameters:
Returns:
setCustomMessage(sMsg): void
set custom message
Parameters:
{string} | sMsg | Message to be set |
Setter for the aggregated customReply
.
Parameters:
Returns:
Setter for property
dateTime
.
Default value is empty/undefined
Parameters:
{any} | oDateTime | new value for property dateTime |
Returns:
Setter for the aggregated embeddedControl
.
Parameters:
Returns:
Setter for property
filterValue
.
Default value is empty/undefined
Parameters:
{string} | sFilterValue | new value for property filterValue |
Returns:
Setter for property
icon
.
Default value is empty/undefined
Parameters:
{string} | sIcon | new value for property icon |
Returns:
Setter for property
iconTooltip
.
Default value is empty/undefined
Parameters:
{string} | sIconTooltip | new value for property iconTooltip |
Returns:
Setter for property
maxCharacters
.
Default value is empty/undefined
Parameters:
{int} | iMaxCharacters | new value for property maxCharacters |
Returns:
Setter for property
replyCount
.
Default value is empty/undefined
Parameters:
{int} | iReplyCount | new value for property replyCount |
Returns:
Setter for the aggregated replyList
.
Parameters:
Returns:
Setter for property
text
.
Default value is empty/undefined
Parameters:
{string} | sText | new value for property text |
Returns:
Setter for property
title
.
Default value is empty/undefined
Parameters:
{string} | sTitle | new value for property title |
Returns:
Setter for property
userName
.
Default value is empty/undefined
Parameters:
{string} | sUserName | new value for property userName |
Returns:
Setter for property
userNameClickable
.
Default value is false
Parameters:
{boolean} | bUserNameClickable | new value for property userNameClickable |
Returns:
Setter for property
userPicture
.
Default value is empty/undefined
Parameters:
Returns: