Class sap.m. ListBase Module: sap/m/ListBase

oItem

the item to add; if empty, nothing is inserted

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

attachDelete(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the delete event of this sap.m.ListBase.

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.m.ListBase itself.

Fires when delete icon is pressed by user.

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.m.ListBase` itself

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

attachItemPress(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the itemPress event of this sap.m.ListBase.

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.m.ListBase itself.

Fires when an item is pressed unless the item's type property is Inactive.

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.m.ListBase` itself

Since:: 1.20

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

attachSelectionChange(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the selectionChange event of this sap.m.ListBase.

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.m.ListBase itself.

Fires when selection is changed via user interaction inside the control.

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.m.ListBase` itself

Since:: 1.16

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

attachSwipe(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the swipe event of this sap.m.ListBase.

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.m.ListBase itself.

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.m.ListBase` itself

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

attachUpdateFinished(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the updateFinished event of this sap.m.ListBase.

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.m.ListBase itself.

Fires after items binding is updated and processed by the control.

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.m.ListBase` itself

Since:: 1.16.3

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

attachUpdateStarted(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the updateStarted event of this sap.m.ListBase.

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.m.ListBase itself.

Fires before items binding is updated (e.g. sorting, filtering)

Note: Event handler should not invalidate the control.

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.m.ListBase` itself

Since:: 1.16.3

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

bindItems(oBindingInfo): sap.m.ListBase

Binds aggregation items to model data.

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

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

destroyHeaderToolbar(): sap.m.ListBase

Destroys the headerToolbar in the aggregation headerToolbar.

Since:: 1.16

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

destroyInfoToolbar(): sap.m.ListBase

Destroys the infoToolbar in the aggregation infoToolbar.

Since:: 1.16

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

destroyItems(): sap.m.ListBase

Destroys all the items in the aggregation items.

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

destroySwipeContent(): sap.m.ListBase

Destroys the swipeContent in the aggregation swipeContent.

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

detachDelete(fnFunction, oListener): sap.m.ListBase

Detaches event handler fnFunction from the delete event of this sap.m.ListBase.

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.m.ListBase} Reference to this in order to allow method chaining

detachItemPress(fnFunction, oListener): sap.m.ListBase

Detaches event handler fnFunction from the itemPress event of this sap.m.ListBase.

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

Since:: 1.20

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

detachSelectionChange(fnFunction, oListener): sap.m.ListBase

Detaches event handler fnFunction from the selectionChange event of this sap.m.ListBase.

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

Since:: 1.16

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

detachSwipe(fnFunction, oListener): sap.m.ListBase

Detaches event handler fnFunction from the swipe event of this sap.m.ListBase.

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.m.ListBase} Reference to this in order to allow method chaining

detachUpdateFinished(fnFunction, oListener): sap.m.ListBase

Detaches event handler fnFunction from the updateFinished event of this sap.m.ListBase.

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

Since:: 1.16.3

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

detachUpdateStarted(fnFunction, oListener): sap.m.ListBase

Detaches event handler fnFunction from the updateStarted event of this sap.m.ListBase.

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

Since:: 1.16.3

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

fireDelete(mArguments?): sap.m.ListBase

Fires event delete to attached listeners.

Expects the following event parameters:

listItem of type sap.m.ListItemBaseThe item which fired the delete event.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

fireItemPress(mArguments?): sap.m.ListBase

Fires event itemPress to attached listeners.

Expects the following event parameters:

listItem of type sap.m.ListItemBaseThe item which fired the pressed event.
srcControl of type sap.ui.core.ControlThe control which caused the press event within the container.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.20

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

fireSelectionChange(mArguments?): sap.m.ListBase

Fires event selectionChange to attached listeners.

Expects the following event parameters:

listItem of type sap.m.ListItemBaseThe item whose selection has changed. In MultiSelect mode, only the up-most selected item is returned. This parameter can be used for single-selection modes.
listItems of type sap.m.ListItemBase[]Array of items whose selection has changed. This parameter can be used for MultiSelect mode.
selected of type booleanIndicates whether the listItem parameter is selected or not.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.16

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

fireSwipe(mArguments?): boolean

Fires event swipe to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

listItem of type sap.m.ListItemBaseThe item which fired the swipe.
swipeContent of type sap.ui.core.ControlAggregated swipeContent control that is shown on the right hand side of the item.
srcControl of type sap.ui.core.ControlHolds which control caused the swipe event within the item.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{boolean}

Whether or not to prevent the default action

fireUpdateFinished(mArguments?): sap.m.ListBase

Fires event updateFinished to attached listeners.

Expects the following event parameters:

reason of type stringThe reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.
actual of type intActual number of items.
total of type intThe total count of bound items. This can be used if the growing property is set to true.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.16.3

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

fireUpdateStarted(mArguments?): sap.m.ListBase

Fires event updateStarted to attached listeners.

Expects the following event parameters:

reason of type stringThe reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.
actual of type intActual number of items.
total of type intThe total count of bound items. This can be used if the growing property is set to true.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.16.3

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

getAriaLabelledBy(): sap.ui.core.Control[]

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

Since:: 1.28.0

Returns:

{sap.ui.core.Control[]}

getEnableBusyIndicator(): boolean

Gets current value of property enableBusyIndicator.

When this property is set to true, the control will automatically display a busy indicator when it detects that data is being loaded. This busy indicator blocks the interaction with the items until data loading is finished. By default, the busy indicator will be shown after one second. This behavior can be customized by setting the busyIndicatorDelay property.

Default value is true.

Since:: 1.20.2

Returns:

{boolean} Value of property enableBusyIndicator

getFooterText(): string

Gets current value of property footerText.

Defines the footer text that appears in the control.

Returns:

{string} Value of property footerText

getGrowing(): boolean

Gets current value of property growing.

If set to true, enables the growing feature of the control to load more items by requesting from the model. Note:: This feature only works when an items aggregation is bound. Growing must not be used together with two-way binding.

Default value is false.

Since:: 1.16.0

Returns:

{boolean} Value of property growing

getGrowingInfo(): object

Returns growing information as object with "actual" and "total" keys. Note: This function returns "null" if "growing" feature is disabled.

Since:: 1.16

Returns:

{object}

getGrowingScrollToLoad(): boolean

Gets current value of property growingScrollToLoad.

If set to true, the user can scroll down to load more items. Otherwise a growing button is displayed at the bottom of the control. Note: This property can only be used if the growing property is set to true and only if there is one instance of sap.m.List or sap.m.Table inside the scrollable scroll container (e.g sap.m.Page).

Default value is false.

Since:: 1.16.0

Returns:

{boolean} Value of property growingScrollToLoad

getGrowingThreshold(): int

Gets current value of property growingThreshold.

Defines the number of items to be requested from the model for each grow. This property can only be used if the growing property is set to true.

Default value is 20.

Since:: 1.16.0

Returns:

{int} Value of property growingThreshold

getGrowingTriggerText(): string

Gets current value of property growingTriggerText.

Defines the text displayed on the growing button. The default is a translated text ("More") coming from the message bundle. This property can only be used if the growing property is set to true.

Since:: 1.16.0

Returns:

{string} Value of property growingTriggerText

getHeaderText(): string

Gets current value of property headerText.

Defines the header text that appears in the control. Note: If headerToolbar aggregation is set, then this property is ignored.

Returns:

{string} Value of property headerText

getHeaderToolbar(): sap.m.Toolbar

Gets content of aggregation headerToolbar.

The header area can be used as a toolbar to add extra controls for user interactions. Note: When set, this overwrites the headerText property.

Since:: 1.16

Returns:

getIncludeItemInSelection(): boolean

Gets current value of property includeItemInSelection.

Defines whether the items are selectable by clicking on the item itself (true) rather than having to set the selection control first. Note: The SingleSelectMaster mode also provides this functionality by default.

Default value is false.

Returns:

{boolean} Value of property includeItemInSelection

getInfoToolbar(): sap.m.Toolbar

Gets content of aggregation infoToolbar.

A toolbar that is placed below the header to show extra information to the user.

Since:: 1.16

Returns:

getInset(): boolean

Gets current value of property inset.

Defines the indentation of the container. Setting it to true indents the list.

Default value is false.

Returns:

{boolean} Value of property inset

getItemNavigation(): sap.ui.core.delegate.ItemNavigation|undefined

Returns ItemNavigation for controls uses List

Since:: 1.16.5

Returns:

{sap.ui.core.delegate.ItemNavigation|undefined}

getItems(): sap.m.ListItemBase[]

Gets content of aggregation items.

Defines the items contained within this control.

Returns:

{sap.m.ListItemBase[]}

getKeyboardMode(): sap.m.ListKeyboardMode

Gets current value of property keyboardMode.

Defines keyboard handling behavior of the control.

Default value is Navigation.

Since:: 1.38.0

Returns:

{sap.m.ListKeyboardMode} Value of property keyboardMode

getLastMode()

Returns the last list mode, the mode that is rendered This can be used to detect mode changes during rendering

getMode(): sap.m.ListMode

Gets current value of property mode.

Defines the mode of the control (e.g. None, SingleSelect, MultiSelect, Delete).

Default value is None.

Returns:

{sap.m.ListMode} Value of property mode

getModeAnimationOn(): boolean

Gets current value of property modeAnimationOn.

Defines if animations will be shown while switching between modes.

Default value is true.

Returns:

{boolean} Value of property modeAnimationOn

getNoDataText(): string

Gets current value of property noDataText.

This text is displayed when the control contains no items.

Returns:

{string} Value of property noDataText

getRememberSelections(): boolean

Gets current value of property rememberSelections.

If set to true, this control remembers and retains the selection of the items after a binding update has been performed (e.g. sorting, filtering). Note: This feature works only if two-way binding for the selected property of the item is not used and needs to be turned off if the binding context of the item does not always point to the same entry in the model, for example, if the order of the data in the JSONModel is changed.

Default value is true.

Since:: 1.16.6

Returns:

{boolean} Value of property rememberSelections

getSelectedContexts(bAll): object[]

Returns the binding contexts of the selected items. Note: This method returns an empty array if no databinding is used.

Parameters:

{boolean}

bAll

Set true to include even invisible selected items(e.g. the selections from the previous filters). Note: In single selection modes, only the last selected item's binding context is returned in array.

Since:: 1.18.6

Returns:

{object[]}

getSelectedItem(): sap.m.ListItemBase

Returns selected list item. When no item is selected, "null" is returned. When "multi-selection" is enabled and multiple items are selected, only the up-most selected item is returned.

Returns:

getSelectedItems(): sap.m.ListItemBase[]

Returns an array containing the selected list items. If no items are selected, an empty array is returned.

Returns:

{sap.m.ListItemBase[]}

getShowNoData(): boolean

Gets current value of property showNoData.

Defines whether or not the text specified in the noDataText property is displayed.

Default value is true.

Returns:

{boolean} Value of property showNoData

getShowSeparators(): sap.m.ListSeparators

Gets current value of property showSeparators.

Defines which item separator style will be used.

Default value is All.

Returns:

{sap.m.ListSeparators} Value of property showSeparators

getShowUnread(): boolean

Gets current value of property showUnread.

Activates the unread indicator for all items, if set to true.

Default value is false.

Returns:

{boolean} Value of property showUnread

getSwipeContent(): sap.ui.core.Control

Gets content of aggregation swipeContent.

User can swipe to bring in this control on the right hand side of an item. Note: For non-touch devices, this functionality is ignored.

Returns:

{sap.ui.core.Control}

getSwipeDirection(): sap.m.SwipeDirection

Gets current value of property swipeDirection.

Defines the direction of the swipe movement (e.g LeftToRight, RightToLeft, Both) to display the control defined in the swipeContent aggregation.

Default value is Both.

Returns:

{sap.m.SwipeDirection} Value of property swipeDirection

getSwipedItem(): sap.m.ListItemBase

Returns swiped list item. When no item is swiped, "null" is returned.

Returns:

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Sets the width of the control.

Default value is 100%.

Returns:

{sap.ui.core.CSSSize} Value of property width

indexOfItem(oItem): int

Checks for the provided sap.m.ListItemBase in the aggregation items. and returns its index if found or -1 otherwise.

Parameters:

oItem

The item whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertItem(oItem, iIndex): sap.m.ListBase

Inserts a item into the aggregation items.

Parameters:

{sap.m.ListItemBase}	oItem	the item to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

removeAllAriaLabelledBy(): sap.ui.core.Control[]

Removes all the controls in the association named ariaLabelledBy.

Since:: 1.28.0

Returns:

{sap.ui.core.Control[]}

An array of the removed elements (might be empty)

removeAllItems(): sap.m.ListItemBase[]

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.m.ListItemBase[]}

An array of the removed elements (might be empty)

removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control

Removes an ariaLabelledBy from the association named ariaLabelledBy.

Parameters:

{int|string|sap.ui.core.Control}

vAriaLabelledBy

The ariaLabelledByto be removed or its index or ID

Since:: 1.28.0

Returns:

{sap.ui.core.Control} the removed ariaLabelledBy or null

removeItem(vItem): sap.m.ListItemBase

Removes a item from the aggregation items.

Parameters:

{int|string|sap.m.ListItemBase}

vItem

The itemto remove or its index or id

Returns:

{sap.m.ListItemBase} The removed item or null

removeSelections(bAll): sap.m.ListBase

Removes visible selections of the current selection mode.

Parameters:

{boolean}

bAll

Since version 1.16.3. This control keeps old selections after filter or sorting. Set this parameter "true" to remove all selections.

Returns:

selectAll(): sap.m.ListBase

Select all items in "MultiSelection" mode.

Since:: 1.16

Returns:

setEnableBusyIndicator(bEnableBusyIndicator): sap.m.ListBase

Sets a new value for property enableBusyIndicator.

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

Default value is true.

Parameters:

{boolean} bEnableBusyIndicator New value for property enableBusyIndicator

Since:: 1.20.2

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setFooterText(sFooterText): sap.m.ListBase

Sets a new value for property footerText.

Defines the footer text that appears in the control.

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

Parameters:

{string} sFooterText New value for property footerText

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setGrowing(bGrowing): sap.m.ListBase

Sets a new value for property growing.

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

Default value is false.

Parameters:

{boolean} bGrowing New value for property growing

Since:: 1.16.0

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setGrowingScrollToLoad(bGrowingScrollToLoad): sap.m.ListBase

Sets a new value for property growingScrollToLoad.

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

Default value is false.

Parameters:

{boolean} bGrowingScrollToLoad New value for property growingScrollToLoad

Since:: 1.16.0

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setGrowingThreshold(iGrowingThreshold): sap.m.ListBase

Sets a new value for property growingThreshold.

Defines the number of items to be requested from the model for each grow. This property can only be used if the growing property is set to true.

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

Default value is 20.

Parameters:

{int} iGrowingThreshold New value for property growingThreshold

Since:: 1.16.0

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setGrowingTriggerText(sGrowingTriggerText): sap.m.ListBase

Sets a new value for property growingTriggerText.

Defines the text displayed on the growing button. The default is a translated text ("More") coming from the message bundle. This property can only be used if the growing property is set to true.

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

Parameters:

{string} sGrowingTriggerText New value for property growingTriggerText

Since:: 1.16.0

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setHeaderText(sHeaderText): sap.m.ListBase

Sets a new value for property headerText.

Defines the header text that appears in the control. Note: If headerToolbar aggregation is set, then this property is ignored.

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

Parameters:

{string} sHeaderText New value for property headerText

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setHeaderToolbar(oHeaderToolbar): sap.m.ListBase

Sets the aggregated headerToolbar.

Parameters:

oHeaderToolbar

The headerToolbar to set

Since:: 1.16

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setIncludeItemInSelection(bIncludeItemInSelection): sap.m.ListBase

Sets a new value for property includeItemInSelection.

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

Default value is false.

Parameters:

{boolean} bIncludeItemInSelection New value for property includeItemInSelection

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setInfoToolbar(oInfoToolbar): sap.m.ListBase

Sets the aggregated infoToolbar.

Parameters:

oInfoToolbar

The infoToolbar to set

Since:: 1.16

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setInset(bInset): sap.m.ListBase

Sets a new value for property inset.

Defines the indentation of the container. Setting it to true indents the list.

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

Default value is false.

Parameters:

{boolean} bInset New value for property inset

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setKeyboardMode(sKeyboardMode): sap.m.ListBase

Sets a new value for property keyboardMode.

Defines keyboard handling behavior of the control.

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

Default value is Navigation.

Parameters:

{sap.m.ListKeyboardMode} sKeyboardMode New value for property keyboardMode

Since:: 1.38.0

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setMode(sMode): sap.m.ListBase

Sets a new value for property mode.

Defines the mode of the control (e.g. None, SingleSelect, MultiSelect, Delete).

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

Default value is None.

Parameters:

{sap.m.ListMode} sMode New value for property mode

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setModeAnimationOn(bModeAnimationOn): sap.m.ListBase

Sets a new value for property modeAnimationOn.

Defines if animations will be shown while switching between modes.

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

Default value is true.

Parameters:

{boolean} bModeAnimationOn New value for property modeAnimationOn

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setNoDataText(sNoDataText): sap.m.ListBase

Sets a new value for property noDataText.

This text is displayed when the control contains no items.

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

Parameters:

{string} sNoDataText New value for property noDataText

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setRememberSelections(bRememberSelections): sap.m.ListBase

Sets a new value for property rememberSelections.

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

Default value is true.

Parameters:

{boolean} bRememberSelections New value for property rememberSelections

Since:: 1.16.6

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setSelectedItem(oListItem, bSelect): sap.m.ListBase

Selects or deselects the given list item.

Parameters:

{sap.m.ListItemBase}	oListItem	The list item whose selection to be changed. This parameter is mandatory.
{boolean}	bSelect	Sets selected status of the list item. Default value is true.

Returns:

setSelectedItemById(sId, bSelect): sap.m.ListBase

Sets a list item to be selected by id. In single mode the method removes the previous selection.

Parameters:

{string}	sId	The id of the list item whose selection to be changed.
{boolean}	bSelect	Sets selected status of the list item. Default value is true.

Returns:

setShowNoData(bShowNoData): sap.m.ListBase

Sets a new value for property showNoData.

Defines whether or not the text specified in the noDataText property is displayed.

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

Default value is true.

Parameters:

{boolean} bShowNoData New value for property showNoData

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setShowSeparators(sShowSeparators): sap.m.ListBase

Sets a new value for property showSeparators.

Defines which item separator style will be used.

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

Default value is All.

Parameters:

{sap.m.ListSeparators} sShowSeparators New value for property showSeparators

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setShowUnread(bShowUnread): sap.m.ListBase

Sets a new value for property showUnread.

Activates the unread indicator for all items, if set to true.

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

Default value is false.

Parameters:

{boolean} bShowUnread New value for property showUnread

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setSwipeContent(oSwipeContent): sap.m.ListBase

Sets the aggregated swipeContent.

Parameters:

{sap.ui.core.Control}

oSwipeContent

The swipeContent to set

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setSwipeDirection(sSwipeDirection): sap.m.ListBase

Sets a new value for property swipeDirection.

Defines the direction of the swipe movement (e.g LeftToRight, RightToLeft, Both) to display the control defined in the swipeContent aggregation.

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

Default value is Both.

Parameters:

{sap.m.SwipeDirection} sSwipeDirection New value for property swipeDirection

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

setWidth(sWidth): sap.m.ListBase

Sets a new value for property width.

Sets the width of the control.

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

Default value is 100%.

Parameters:

{sap.ui.core.CSSSize} sWidth New value for property width

Returns:

{sap.m.ListBase} Reference to this in order to allow method chaining

swipeOut(oCallback): sap.m.ListBase

After swipeContent is shown, user can interact with this control(e.g Tap). After interaction is done, you can/should use this method to hide swipeContent from screen. Note: If users try to tap inside of the list but outside of the swipeContent then control hides automatically.

Parameters:

{any}

oCallback

This callback function is called with two parameters(swipedListItem and swipedContent) after swipe-out animation is finished.

Returns: