Class sap.m.ListBaseModule: sap/m/ListBase

extends Control
known direct subclasses: List, Table, Tree

The sap.m.ListBase control provides a base functionality of the sap.m.List and sap.m.Table controls. Selection, deletion, unread states and inset style are also maintained in sap.m.ListBase.

Note: The ListBase including all contained items may be completely re-rendered when the data of a bound model is changed. Due to the limited hardware resources of mobile devices this can lead to longer delays for lists that contain many items. As such the usage of a list is not recommended for these use cases.


Since: 1.16.
Constructor Summary
new sap.m.ListBase(sId?, mSettings?)Constructor for a new ListBase.
Event Summary
delete(oControlEvent)Fires when delete icon is pressed by user.
itemPress(oControlEvent)Fires when an item is pressed unless the item's type property is Inactive.
selectionChange(oControlEvent)Fires when selection is changed via user interaction inside the control.
swipe(oControlEvent)Fires after user's swipe action and before the swipeContent is shown.
updateFinished(oControlEvent)Fires after items binding is updated and processed by the control.
updateStarted(oControlEvent)Fires before items binding is updated (e.g.
growingFinished(oControlEvent)Fires after the new growing chunk has been fetched from the model and processed by the control.
growingStarted(oControlEvent)Fires before the new growing chunk is requested from the model.
select(oControlEvent)Fires when selection is changed via user interaction.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.ListBase.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ListBase with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ListBase.getMetadata()Returns a metadata object for class sap.m.ListBase.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addItem(oItem)Adds some item to the aggregation items.
attachDelete(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the delete event of this sap.m.ListBase.
attachItemPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the itemPress event of this sap.m.ListBase.
attachSelectionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selectionChange event of this sap.m.ListBase.
attachSwipe(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the swipe event of this sap.m.ListBase.
attachUpdateFinished(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the updateFinished event of this sap.m.ListBase.
attachUpdateStarted(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the updateStarted event of this sap.m.ListBase.
bindItems(oBindingInfo)Binds aggregation items to model data.
destroyHeaderToolbar()Destroys the headerToolbar in the aggregation headerToolbar.
destroyInfoToolbar()Destroys the infoToolbar in the aggregation infoToolbar.
destroyItems()Destroys all the items in the aggregation items.
destroySwipeContent()Destroys the swipeContent in the aggregation swipeContent.
detachDelete(fnFunction, oListener)Detaches event handler fnFunction from the delete event of this sap.m.ListBase.
detachItemPress(fnFunction, oListener)Detaches event handler fnFunction from the itemPress event of this sap.m.ListBase.
detachSelectionChange(fnFunction, oListener)Detaches event handler fnFunction from the selectionChange event of this sap.m.ListBase.
detachSwipe(fnFunction, oListener)Detaches event handler fnFunction from the swipe event of this sap.m.ListBase.
detachUpdateFinished(fnFunction, oListener)Detaches event handler fnFunction from the updateFinished event of this sap.m.ListBase.
detachUpdateStarted(fnFunction, oListener)Detaches event handler fnFunction from the updateStarted event of this sap.m.ListBase.
fireDelete(mParameters?)Fires event delete to attached listeners.
fireItemPress(mParameters?)Fires event itemPress to attached listeners.
fireSelectionChange(mParameters?)Fires event selectionChange to attached listeners.
fireSwipe(mParameters?)Fires event swipe to attached listeners.
fireUpdateFinished(mParameters?)Fires event updateFinished to attached listeners.
fireUpdateStarted(mParameters?)Fires event updateStarted to attached listeners.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getEnableBusyIndicator()Gets current value of property enableBusyIndicator.
getFooterText()Gets current value of property footerText.
getGrowing()Gets current value of property growing.
getGrowingDirection()Gets current value of property growingDirection.
getGrowingInfo()Returns growing information as object with "actual" and "total" keys.
getGrowingScrollToLoad()Gets current value of property growingScrollToLoad.
getGrowingThreshold()Gets current value of property growingThreshold.
getGrowingTriggerText()Gets current value of property growingTriggerText.
getHeaderText()Gets current value of property headerText.
getHeaderToolbar()Gets content of aggregation headerToolbar.
getIncludeItemInSelection()Gets current value of property includeItemInSelection.
getInfoToolbar()Gets content of aggregation infoToolbar.
getInset()Gets current value of property inset.
getItemNavigation()Returns ItemNavigation for controls uses List
getItems()Gets content of aggregation items.
getKeyboardMode()Gets current 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()Gets current value of property mode.
getModeAnimationOn()Gets current value of property modeAnimationOn.
getNoDataText()Gets current value of property noDataText.
getRememberSelections()Gets current value of property rememberSelections.
getSelectedContexts(bAll)Returns the binding contexts of the selected items.
getSelectedItem()Returns selected list item.
getSelectedItems()Returns an array containing the selected list items.
getShowNoData()Gets current value of property showNoData.
getShowSeparators()Gets current value of property showSeparators.
getShowUnread()Gets current value of property showUnread.
getSwipeContent()Gets content of aggregation swipeContent.
getSwipeDirection()Gets current value of property swipeDirection.
getSwipedItem()Returns swiped list item.
getWidth()Gets current value of property width.
indexOfItem(oItem)Checks for the provided sap.m.ListItemBase in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllItems()Removes all the controls from the aggregation items.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeItem(vItem)Removes a item from the aggregation items.
removeSelections(bAll)Removes visible selections of the current selection mode.
selectAll()Select all items in "MultiSelection" mode.
setEnableBusyIndicator(bEnableBusyIndicator)Sets a new value for property enableBusyIndicator.
setFooterText(sFooterText)Sets a new value for property footerText.
setGrowing(bGrowing)Sets a new value for property growing.
setGrowingDirection(sGrowingDirection)Sets a new value for property growingDirection.
setGrowingScrollToLoad(bGrowingScrollToLoad)Sets a new value for property growingScrollToLoad.
setGrowingThreshold(iGrowingThreshold)Sets a new value for property growingThreshold.
setGrowingTriggerText(sGrowingTriggerText)Sets a new value for property growingTriggerText.
setHeaderText(sHeaderText)Sets a new value for property headerText.
setHeaderToolbar(oHeaderToolbar)Sets the aggregated headerToolbar.
setIncludeItemInSelection(bIncludeItemInSelection)Sets a new value for property includeItemInSelection.
setInfoToolbar(oInfoToolbar)Sets the aggregated infoToolbar.
setInset(bInset)Sets a new value for property inset.
setKeyboardMode(sKeyboardMode)Sets a new value for property keyboardMode.
setMode(sMode)Sets a new value for property mode.
setModeAnimationOn(bModeAnimationOn)Sets a new value for property modeAnimationOn.
setNoDataText(sNoDataText)Sets a new value for property noDataText.
setRememberSelections(bRememberSelections)Sets a new value for property rememberSelections.
setSelectedItem(oListItem, bSelect)Selects or deselects the given list item.
setSelectedItemById(sId, bSelect)Sets a list item to be selected by id.
setShowNoData(bShowNoData)Sets a new value for property showNoData.
setShowSeparators(sShowSeparators)Sets a new value for property showSeparators.
setShowUnread(bShowUnread)Sets a new value for property showUnread.
setSwipeContent(oSwipeContent)Sets the aggregated swipeContent.
setSwipeDirection(sSwipeDirection)Sets a new value for property swipeDirection.
setWidth(sWidth)Sets a new value for property width.
swipeOut(oCallback)After swipeContent is shown, user can interact with this control(e.g Tap).
unbindItems()Unbinds aggregation items from model data.
attachGrowingFinished(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the growingFinished event of this sap.m.ListBase.
attachGrowingStarted(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the growingStarted event of this sap.m.ListBase.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.m.ListBase.
detachGrowingFinished(fnFunction, oListener)Detaches event handler fnFunction from the growingFinished event of this sap.m.ListBase.
detachGrowingStarted(fnFunction, oListener)Detaches event handler fnFunction from the growingStarted event of this sap.m.ListBase.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.m.ListBase.
fireGrowingFinished(mParameters?)Fires event growingFinished to attached listeners.
fireGrowingStarted(mParameters?)Fires event growingStarted to attached listeners.
fireSelect(mParameters?)Fires event select to attached listeners.
getHeaderDesign()Gets current value of property headerDesign.
setHeaderDesign(sHeaderDesign)Sets a new value for property headerDesign.
Constructor Detail
new sap.m.ListBase(sId?, mSettings?)

Constructor for a new ListBase.

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

  • Associations

  • Events

    • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • selectionChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • delete : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • swipe : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • growingStarted : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • growingFinished : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • updateStarted : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • updateFinished : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • itemPress : 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:
stringsId?Id for the new control, generated automatically if no id is given
objectmSettings?Initial settings for the new control
Event Detail
delete(oControlEvent)
Fires when delete icon is pressed by user.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.ListItemBaseoControlEvent.getParameters.listItemThe item which fired the delete event.
itemPress(oControlEvent)
Fires when an item is pressed unless the item's type property is Inactive.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.ListItemBaseoControlEvent.getParameters.listItemThe item which fired the pressed event.
sap.ui.core.ControloControlEvent.getParameters.srcControlThe control which caused the press event within the container.
Since:
1.20
selectionChange(oControlEvent)
Fires when selection is changed via user interaction inside the control.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.ListItemBaseoControlEvent.getParameters.listItemThe 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.
sap.m.ListItemBase[]oControlEvent.getParameters.listItemsArray of items whose selection has changed. This parameter can be used for MultiSelect mode.
booleanoControlEvent.getParameters.selectedIndicates whether the listItem parameter is selected or not.
booleanoControlEvent.getParameters.selectAllIndicates whether the select all action is triggered or not.
Since:
1.16
swipe(oControlEvent)
Fires after user's swipe action and before the swipeContent is shown. On the swipe event handler, swipeContent can be changed according to the swiped item. Calling the preventDefault method of the event cancels the swipe action.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.ListItemBaseoControlEvent.getParameters.listItemThe item which fired the swipe.
sap.ui.core.ControloControlEvent.getParameters.swipeContentAggregated swipeContent control that is shown on the right hand side of the item.
sap.ui.core.ControloControlEvent.getParameters.srcControlHolds which control caused the swipe event within the item.
updateFinished(oControlEvent)
Fires after items binding is updated and processed by the control.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.reasonThe reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.
intoControlEvent.getParameters.actualActual number of items.
intoControlEvent.getParameters.totalThe total count of bound items. This can be used if the growing property is set to true.
Since:
1.16.3
updateStarted(oControlEvent)

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

Note: Event handler should not invalidate the control.

Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.reasonThe reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.
intoControlEvent.getParameters.actualActual number of items.
intoControlEvent.getParameters.totalThe total count of bound items. This can be used if the growing property is set to true.
Since:
1.16.3
growingFinished(oControlEvent)
Fires after the new growing chunk has been fetched from the model and processed by the control.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
intoControlEvent.getParameters.actualActual number of items.
intoControlEvent.getParameters.totalTotal number of items.
Deprecated API:
Since version 1.16.3. Instead, use "updateFinished" event.
Since:
1.16
growingStarted(oControlEvent)
Fires before the new growing chunk is requested from the model.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
intoControlEvent.getParameters.actualActual number of items.
intoControlEvent.getParameters.totalTotal number of items.
Deprecated API:
Since version 1.16.3. Instead, use updateStarted event with listening changeReason.
Since:
1.16
select(oControlEvent)
Fires when selection is changed via user interaction. In MultiSelect mode, this event is also fired on deselection.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.ListItemBaseoControlEvent.getParameters.listItemThe item which fired the select event.
Deprecated API:
Since version 1.16. Use the selectionChange event instead.
Method Detail
sap.m.ListBase.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.ListBase 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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.ListBase.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ListBase.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAriaLabelledBy(vAriaLabelledBy): sap.m.ListBase
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledBythe ariaLabelledBy to add; if empty, nothing is inserted
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.28.0
addItem(oItem): sap.m.ListBase
Adds some item to the aggregation items.
Parameters:
sap.m.ListItemBaseoItemthe item to add; if empty, nothing is inserted
Returns:
sap.m.ListBaseReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.20
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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16
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.

Fires after user's swipe action and before the swipeContent is shown. On the swipe event handler, swipeContent can be changed according to the swiped item. Calling the preventDefault method of the event cancels the swipe action.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.3
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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.3
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:
objectoBindingInfoThe binding information
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
destroyHeaderToolbar(): sap.m.ListBase
Destroys the headerToolbar in the aggregation headerToolbar.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16
destroyInfoToolbar(): sap.m.ListBase
Destroys the infoToolbar in the aggregation infoToolbar.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16
destroyItems(): sap.m.ListBase
Destroys all the items in the aggregation items.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
destroySwipeContent(): sap.m.ListBase
Destroys the swipeContent in the aggregation swipeContent.
Returns:
sap.m.ListBaseReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.20
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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16
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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.3
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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.3
fireDelete(mParameters?): sap.m.ListBase
Fires event delete to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.ListItemBasemParameters.listItem?The item which fired the delete event.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
fireItemPress(mParameters?): sap.m.ListBase
Fires event itemPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.ListItemBasemParameters.listItem?The item which fired the pressed event.
sap.ui.core.ControlmParameters.srcControl?The control which caused the press event within the container.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.20
fireSelectionChange(mParameters?): sap.m.ListBase
Fires event selectionChange to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.ListItemBasemParameters.listItem?The 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.
sap.m.ListItemBase[]mParameters.listItems?Array of items whose selection has changed. This parameter can be used for MultiSelect mode.
booleanmParameters.selected?Indicates whether the listItem parameter is selected or not.
booleanmParameters.selectAll?Indicates whether the select all action is triggered or not.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16
fireSwipe(mParameters?): 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.

Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.ListItemBasemParameters.listItem?The item which fired the swipe.
sap.ui.core.ControlmParameters.swipeContent?Aggregated swipeContent control that is shown on the right hand side of the item.
sap.ui.core.ControlmParameters.srcControl?Holds which control caused the swipe event within the item.
Returns:
booleanWhether or not to prevent the default action
fireUpdateFinished(mParameters?): sap.m.ListBase
Fires event updateFinished to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.reason?The reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.
intmParameters.actual?Actual number of items.
intmParameters.total?The total count of bound items. This can be used if the growing property is set to true.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.3
fireUpdateStarted(mParameters?): sap.m.ListBase
Fires event updateStarted to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.reason?The reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.
intmParameters.actual?Actual number of items.
intmParameters.total?The total count of bound items. This can be used if the growing property is set to true.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.3
getAriaLabelledBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
sap.ui.core.ID[]
Since:
1.28.0
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.

Returns:
booleanValue of property enableBusyIndicator
Since:
1.20.2
getFooterText(): string

Gets current value of property footerText.

Defines the footer text that appears in the control.

Returns:
stringValue 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.

Returns:
booleanValue of property growing
Since:
1.16.0
getGrowingDirection(): sap.m.ListGrowingDirection

Gets current value of property growingDirection.

Defines the direction of the growing feature. If set to Downwards the user has to scroll down to load more items or the growing button is displayed at the bottom. If set to Upwards the user has to scroll up to load more items or the growing button is displayed at the top.

Default value is Downwards.

Returns:
sap.m.ListGrowingDirectionValue of property growingDirection
Since:
1.40.0
getGrowingInfo(): object
Returns growing information as object with "actual" and "total" keys. Note: This function returns "null" if "growing" feature is disabled.
Returns:
object
Since:
1.16
getGrowingScrollToLoad(): boolean

Gets current value of property growingScrollToLoad.

If set to true, the user can scroll down/up to load more items. Otherwise a growing button is displayed at the bottom/top 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.

Returns:
booleanValue of property growingScrollToLoad
Since:
1.16.0
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.

Returns:
intValue of property growingThreshold
Since:
1.16.0
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.

Returns:
stringValue of property growingTriggerText
Since:
1.16.0
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:
stringValue 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.

Returns:
sap.m.Toolbar
Since:
1.16
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:
booleanValue 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.

Returns:
sap.m.Toolbar
Since:
1.16
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:
booleanValue of property inset
getItemNavigation(): sap.ui.core.delegate.ItemNavigation|undefined
Returns ItemNavigation for controls uses List
Returns:
sap.ui.core.delegate.ItemNavigation|undefined
Since:
1.16.5
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.

Returns:
sap.m.ListKeyboardModeValue of property keyboardMode
Since:
1.38.0
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.ListModeValue 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:
booleanValue of property modeAnimationOn
getNoDataText(): string

Gets current value of property noDataText.

This text is displayed when the control contains no items.

Returns:
stringValue 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 data binding for the selected property of the item is not used. It also 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.

Returns:
booleanValue of property rememberSelections
Since:
1.16.6
getSelectedContexts(bAll): object[]
Returns the binding contexts of the selected items. Note: This method returns an empty array if no databinding is used.
Parameters:
booleanbAllSet 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.
Returns:
object[]
Since:
1.18.6
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:
sap.m.ListItemBase
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:
booleanValue 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.ListSeparatorsValue 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:
booleanValue 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.SwipeDirectionValue of property swipeDirection
getSwipedItem(): sap.m.ListItemBase
Returns swiped list item. When no item is swiped, "null" is returned.
Returns:
sap.m.ListItemBase
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.CSSSizeValue 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:
sap.m.ListItemBaseoItemThe item whose index is looked for
Returns:
intThe 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.ListItemBaseoItemthe item to insert; if empty, nothing is inserted
intiIndexthe 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.ListBaseReference to this in order to allow method chaining
removeAllAriaLabelledBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
Since:
1.28.0
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.ID
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledByThe ariaLabelledBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaLabelledBy or null
Since:
1.28.0
removeItem(vItem): sap.m.ListItemBase
Removes a item from the aggregation items.
Parameters:
int|string|sap.m.ListItemBasevItemThe item to remove or its index or id
Returns:
sap.m.ListItemBaseThe removed item or null
removeSelections(bAll): sap.m.ListBase
Removes visible selections of the current selection mode.
Parameters:
booleanbAllSince version 1.16.3. This control keeps old selections after filter or sorting. Set this parameter "true" to remove all selections.
Returns:
sap.m.ListBase
selectAll(): sap.m.ListBase
Select all items in "MultiSelection" mode.
Returns:
sap.m.ListBase
Since:
1.16
setEnableBusyIndicator(bEnableBusyIndicator): sap.m.ListBase

Sets a new value for 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.

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

Default value is true.

Parameters:
booleanbEnableBusyIndicatorNew value for property enableBusyIndicator
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.20.2
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:
stringsFooterTextNew value for property footerText
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
setGrowing(bGrowing): sap.m.ListBase

Sets a new value for 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.

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

Default value is false.

Parameters:
booleanbGrowingNew value for property growing
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.0
setGrowingDirection(sGrowingDirection): sap.m.ListBase

Sets a new value for property growingDirection.

Defines the direction of the growing feature. If set to Downwards the user has to scroll down to load more items or the growing button is displayed at the bottom. If set to Upwards the user has to scroll up to load more items or the growing button is displayed at the top.

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

Default value is Downwards.

Parameters:
sap.m.ListGrowingDirectionsGrowingDirectionNew value for property growingDirection
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.40.0
setGrowingScrollToLoad(bGrowingScrollToLoad): sap.m.ListBase

Sets a new value for property growingScrollToLoad.

If set to true, the user can scroll down/up to load more items. Otherwise a growing button is displayed at the bottom/top 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).

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

Default value is false.

Parameters:
booleanbGrowingScrollToLoadNew value for property growingScrollToLoad
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.0
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:
intiGrowingThresholdNew value for property growingThreshold
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.0
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:
stringsGrowingTriggerTextNew value for property growingTriggerText
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.0
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:
stringsHeaderTextNew value for property headerText
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
setHeaderToolbar(oHeaderToolbar): sap.m.ListBase
Sets the aggregated headerToolbar.
Parameters:
sap.m.ToolbaroHeaderToolbarThe headerToolbar to set
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16
setIncludeItemInSelection(bIncludeItemInSelection): sap.m.ListBase

Sets a new value for 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.

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

Default value is false.

Parameters:
booleanbIncludeItemInSelectionNew value for property includeItemInSelection
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
setInfoToolbar(oInfoToolbar): sap.m.ListBase
Sets the aggregated infoToolbar.
Parameters:
sap.m.ToolbaroInfoToolbarThe infoToolbar to set
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16
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:
booleanbInsetNew value for property inset
Returns:
sap.m.ListBaseReference 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.ListKeyboardModesKeyboardModeNew value for property keyboardMode
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.38.0
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.ListModesModeNew value for property mode
Returns:
sap.m.ListBaseReference 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:
booleanbModeAnimationOnNew value for property modeAnimationOn
Returns:
sap.m.ListBaseReference 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:
stringsNoDataTextNew value for property noDataText
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
setRememberSelections(bRememberSelections): sap.m.ListBase

Sets a new value for 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 data binding for the selected property of the item is not used. It also 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.

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

Default value is true.

Parameters:
booleanbRememberSelectionsNew value for property rememberSelections
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Since:
1.16.6
setSelectedItem(oListItem, bSelect): sap.m.ListBase
Selects or deselects the given list item.
Parameters:
sap.m.ListItemBaseoListItemThe list item whose selection to be changed. This parameter is mandatory.
booleanbSelectSets selected status of the list item. Default value is true.
Returns:
sap.m.ListBase
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:
stringsIdThe id of the list item whose selection to be changed.
booleanbSelectSets selected status of the list item. Default value is true.
Returns:
sap.m.ListBase
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:
booleanbShowNoDataNew value for property showNoData
Returns:
sap.m.ListBaseReference 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.ListSeparatorssShowSeparatorsNew value for property showSeparators
Returns:
sap.m.ListBaseReference 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:
booleanbShowUnreadNew value for property showUnread
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
setSwipeContent(oSwipeContent): sap.m.ListBase
Sets the aggregated swipeContent.
Parameters:
sap.ui.core.ControloSwipeContentThe swipeContent to set
Returns:
sap.m.ListBaseReference 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.SwipeDirectionsSwipeDirectionNew value for property swipeDirection
Returns:
sap.m.ListBaseReference 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.CSSSizesWidthNew value for property width
Returns:
sap.m.ListBaseReference 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:
anyoCallbackThis callback function is called with two parameters(swipedListItem and swipedContent) after swipe-out animation is finished.
Returns:
sap.m.ListBase
unbindItems(): sap.m.ListBase
Unbinds aggregation items from model data.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
attachGrowingFinished(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the growingFinished 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 the new growing chunk has been fetched from the model and processed by the control.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.3. Instead, use "updateFinished" event.
Since:
1.16
attachGrowingStarted(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the growingStarted 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 the new growing chunk is requested from the model.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.3. Instead, use updateStarted event with listening changeReason.
Since:
1.16
attachSelect(oData?, fnFunction, oListener?): sap.m.ListBase

Attaches event handler fnFunction to the select 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. In MultiSelect mode, this event is also fired on deselection.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.ListBase itself
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16. Use the selectionChange event instead.
detachGrowingFinished(fnFunction, oListener): sap.m.ListBase

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

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.3. Instead, use "updateFinished" event.
Since:
1.16
detachGrowingStarted(fnFunction, oListener): sap.m.ListBase

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

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.3. Instead, use updateStarted event with listening changeReason.
Since:
1.16
detachSelect(fnFunction, oListener): sap.m.ListBase

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

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16. Use the selectionChange event instead.
fireGrowingFinished(mParameters?): sap.m.ListBase
Fires event growingFinished to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
intmParameters.actual?Actual number of items.
intmParameters.total?Total number of items.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.3. Instead, use "updateFinished" event.
Since:
1.16
fireGrowingStarted(mParameters?): sap.m.ListBase
Fires event growingStarted to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
intmParameters.actual?Actual number of items.
intmParameters.total?Total number of items.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.3. Instead, use updateStarted event with listening changeReason.
Since:
1.16
fireSelect(mParameters?): sap.m.ListBase
Fires event select to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.ListItemBasemParameters.listItem?The item which fired the select event.
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16. Use the selectionChange event instead.
getHeaderDesign(): sap.m.ListHeaderDesign

Gets current value of property headerDesign.

Defines the header style of the control. Possible values are Standard and Plain.

Default value is Standard.

Returns:
sap.m.ListHeaderDesignValue of property headerDesign
Deprecated API:
Since version 1.16. No longer has any functionality.
Since:
1.14
setHeaderDesign(sHeaderDesign): sap.m.ListBase

Sets a new value for property headerDesign.

Defines the header style of the control. Possible values are Standard and Plain.

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

Default value is Standard.

Parameters:
sap.m.ListHeaderDesignsHeaderDesignNew value for property headerDesign
Returns:
sap.m.ListBaseReference to this in order to allow method chaining
Deprecated API:
Since version 1.16. No longer has any functionality.
Since:
1.14