Class sap.m.GrowingListModule: sap/m/GrowingList

extends List

sap.m.GrowingList control is the container for all list items and inherits from sap.m.List control. Everything like the selection, deletion, unread states and inset style are also maintained here. In addition the control provides a loading mechanism to request data from the model and append the list items to the list. The request is started manually by tapping on the trigger at the end of the list.

Deprecated API:Since version 1.16. Instead use "List" or "Table" control with setting "growing" property to "true"

Constructor Summary
new sap.m.GrowingList(sId?, mSettings?)Constructor for a new GrowingList.
Events borrowed from class sap.m.ListBase
delete, growingFinished, growingStarted, itemPress, select, selectionChange, swipe, updateFinished, updateStarted
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.GrowingList.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.GrowingList with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.GrowingList.getMetadata()Returns a metadata object for class sap.m.GrowingList.
getScrollToLoad()Gets current value of property scrollToLoad.
getThreshold()Gets current value of property threshold.
getTriggerText()Gets current value of property triggerText.
setScrollToLoad(bScrollToLoad)Sets a new value for property scrollToLoad.
setThreshold(iThreshold)Sets a new value for property threshold.
setTriggerText(sTriggerText)Sets a new value for property triggerText.
Methods borrowed from class sap.m.List
addColumn, destroyColumns, getBackgroundDesign, getColumns, indexOfColumn, insertColumn, removeAllColumns, removeColumn, setBackgroundDesign
Methods borrowed from class sap.m.ListBase
addAriaLabelledBy, addItem, attachDelete, attachGrowingFinished, attachGrowingStarted, attachItemPress, attachSelect, attachSelectionChange, attachSwipe, attachUpdateFinished, attachUpdateStarted, bindItems, destroyHeaderToolbar, destroyInfoToolbar, destroyItems, destroySwipeContent, detachDelete, detachGrowingFinished, detachGrowingStarted, detachItemPress, detachSelect, detachSelectionChange, detachSwipe, detachUpdateFinished, detachUpdateStarted, fireDelete, fireGrowingFinished, fireGrowingStarted, fireItemPress, fireSelect, fireSelectionChange, fireSwipe, fireUpdateFinished, fireUpdateStarted, getAriaLabelledBy, getEnableBusyIndicator, getFooterText, getGrowing, getGrowingInfo, getGrowingScrollToLoad, getGrowingThreshold, getGrowingTriggerText, getHeaderDesign, getHeaderText, getHeaderToolbar, getIncludeItemInSelection, getInfoToolbar, getInset, getItemNavigation, getItems, getKeyboardMode, getLastMode, getMode, getModeAnimationOn, getNoDataText, getRememberSelections, getSelectedContexts, getSelectedItem, getSelectedItems, getShowNoData, getShowSeparators, getShowUnread, getSwipeContent, getSwipeDirection, getSwipedItem, getWidth, indexOfItem, insertItem, removeAllAriaLabelledBy, removeAllItems, removeAriaLabelledBy, removeItem, removeSelections, selectAll, setEnableBusyIndicator, setFooterText, setGrowing, setGrowingScrollToLoad, setGrowingThreshold, setGrowingTriggerText, setHeaderDesign, setHeaderText, setHeaderToolbar, setIncludeItemInSelection, setInfoToolbar, setInset, setKeyboardMode, setMode, setModeAnimationOn, setNoDataText, setRememberSelections, setSelectedItem, setSelectedItemById, setShowNoData, setShowSeparators, setShowUnread, setSwipeContent, setSwipeDirection, setWidth, swipeOut, unbindItems
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.GrowingList(sId?, mSettings?)
Constructor for a new GrowingList.

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:

In addition, all settings applicable to the base type sap.m.List can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.16. Instead use "List" or "Table" control with setting "growing" property to "true"
Method Detail
sap.m.GrowingList.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.GrowingList with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.List.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.m.GrowingList.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.GrowingList.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getScrollToLoad(): boolean
Gets current value of property scrollToLoad.

If you set this property to true then user needs to scroll end to trigger loading a new page. Default value is false which means user needs to scroll end and then click button to load new page. NOTE: This property can be set true, if growing property is set "true" and if you only have one instance of this control inside the scroll container(e.g Page).

Default value is false.

Since:
1.16
Returns:
{boolean} Value of property scrollToLoad
getThreshold(): int
Gets current value of property threshold.

Number of items requested from the server. To activate this you should set growing property to "true"

Default value is 20.

Since:
1.16
Returns:
{int} Value of property threshold
getTriggerText(): string
Gets current value of property triggerText.

Text which is displayed on the trigger at the end of the list. The default is a translated text ("Load More Data") coming from the messagebundle properties. This property can be used only if growing property is set "true" and scrollToLoad property is set "false".

Since:
1.16
Returns:
{string} Value of property triggerText
setScrollToLoad(bScrollToLoad): sap.m.GrowingList
Sets a new value for property scrollToLoad.

If you set this property to true then user needs to scroll end to trigger loading a new page. Default value is false which means user needs to scroll end and then click button to load new page. NOTE: This property can be set true, if growing property is set "true" and if you only have one instance of this control inside the scroll container(e.g Page).

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

Default value is false.

Parameters:
{boolean}bScrollToLoad New value for property scrollToLoad
Since:
1.16
Returns:
{sap.m.GrowingList} Reference to this in order to allow method chaining
setThreshold(iThreshold): sap.m.GrowingList
Sets a new value for property threshold.

Number of items requested from the server. To activate this you should set growing property 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}iThreshold New value for property threshold
Since:
1.16
Returns:
{sap.m.GrowingList} Reference to this in order to allow method chaining
setTriggerText(sTriggerText): sap.m.GrowingList
Sets a new value for property triggerText.

Text which is displayed on the trigger at the end of the list. The default is a translated text ("Load More Data") coming from the messagebundle properties. This property can be used only if growing property is set "true" and scrollToLoad property is set "false".

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

Parameters:
{string}sTriggerText New value for property triggerText
Since:
1.16
Returns:
{sap.m.GrowingList} Reference to this in order to allow method chaining