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.
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#constructor for a general description of the syntax of the settings object.
new sap.m.GrowingList(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
scrollToLoad | boolean | false | 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). |
threshold | int | 20 | Number of items requested from the server. To activate this you should set growing property to "true" |
triggerText | string | 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". |
Name | Type | Default Value | Description |
---|---|---|---|
backgroundDesign | sap.m.BackgroundDesign | Solid | Sets the background style of the list. Depending on the theme, you can change the state of the background from |
enableBusyIndicator | boolean | true | When this property is set to |
footerText | string | Defines the footer text that appears in the control. Visibility: public |
|
growing | boolean | false | If set to |
growingDirection | sap.m.ListGrowingDirection | Downwards | Defines the direction of the growing feature. If set to |
growingScrollToLoad | boolean | false | 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 |
growingThreshold | int | 20 | Defines the number of items to be requested from the model for each grow. This property can only be used if the |
growingTriggerText | string | 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 |
|
headerDesign | sap.m.ListHeaderDesign | Standard | Defines the header style of the control. Possible values are |
headerText | string | Defines the header text that appears in the control. Note: If |
|
includeItemInSelection | boolean | false | Defines whether the items are selectable by clicking on the item itself ( |
inset | boolean | false | Defines the indentation of the container. Setting it to |
keyboardMode | sap.m.ListKeyboardMode | Navigation | Defines keyboard handling behavior of the control. |
mode | sap.m.ListMode | None | Defines the mode of the control (e.g. |
modeAnimationOn | boolean | true | Defines if animations will be shown while switching between modes. Visibility: public |
multiSelectMode | sap.m.MultiSelectMode | Default | Defines the multi-selection mode for the control. If this property is set to the Note: This property must be used with the |
noDataText | string | This text is displayed when the control contains no items. Visibility: public |
|
rememberSelections | boolean | true | 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 |
showNoData | boolean | true | Defines whether or not the text specified in the |
showSeparators | sap.m.ListSeparators | All | Defines which item separator style will be used. Visibility: public |
showUnread | boolean | false | Activates the unread indicator for all items, if set to |
sticky | sap.m.Sticky[] | Defines the section of the control that remains fixed at the top of the page during vertical scrolling as long as the control is in the viewport. Note: Enabling sticky column headers in List controls will not have any effect. There are some known restrictions. A few are given below:
Since: 1.58.Visibility: public |
|
swipeDirection | sap.m.SwipeDirection | Both | Defines the direction of the swipe movement (e.g LeftToRight, RightToLeft, Both) to display the control defined in the |
width | sap.ui.core.CSSSize | 100% | Sets the width of the control. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
contextMenu | 0..1 | sap.ui.core.IContextMenu |
Defines the context menu of the items. |
headerToolbar | 0..1 | sap.m.Toolbar |
The header area can be used as a toolbar to add extra controls for user interactions. Note: When set, this overwrites the |
infoToolbar | 0..1 | sap.m.Toolbar |
A toolbar that is placed below the header to show extra information to the user. |
items | 0..n | sap.m.ListItemBase |
Defines the items contained within this control. |
swipeContent | 0..1 | sap.ui.core.Control |
User can swipe to bring in this control on the right hand side of an item. Note:
|
Method | Description |
---|---|
sap.m.GrowingList.extend |
Creates a new subclass of class sap.m.GrowingList with name
|
sap.m.GrowingList.getMetadata |
Returns a metadata object for class sap.m.GrowingList. |
getScrollToLoad |
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 |
getThreshold |
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 |
getTriggerText |
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". |
setScrollToLoad |
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 Default value is |
setThreshold |
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 Default value is |
setTriggerText |
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 |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
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
.
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
.
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".
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bScrollToLoad | boolean | false |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iThreshold | int | 20 |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTriggerText | string |
New value for property |