Class sap.m.PullToRefreshModule: sap/m/PullToRefresh
PullToRefresh control. Put it as the first control in contents of a scroll container or a scrollable page. Do not place it into a page with disabled scrolling. On touch devices it gets hidden by default and when the user pulls down the page far enough, it gets visible and triggers the "refresh" event. In non-touch browsers where scrollbars are used for scrolling, it is always visible and triggers the "refresh" event when clicked.
Since: 1.9.2.
sClassName and enriches it with the information contained in oClassInfo.fnFunction to the refresh event of this sap.m.PullToRefresh.fnFunction from the refresh event of this sap.m.PullToRefresh. 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
- description : string
- showIcon : boolean (default: false)
- customIcon : sap.ui.core.URI
- iconDensityAware : boolean (default: true)
- Events
- refresh : 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.
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
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.
| {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 |
| {function} | Created class / constructor function |
| {sap.ui.base.Metadata} | Metadata object describing this class |
fnFunction to the refresh event of this sap.m.PullToRefresh. 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.PullToRefresh itself.
Event indicates that the user has requested new data
| {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.PullToRefresh itself |
| {sap.m.PullToRefresh} | Reference to this in order to allow method chaining |
fnFunction from the refresh event of this sap.m.PullToRefresh. The passed function and listener object must match the ones used for event registration.
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
| {sap.m.PullToRefresh} | Reference to this in order to allow method chaining |
refresh to attached listeners. | {Map} | mArguments? | The arguments to pass along with the event |
| {sap.m.PullToRefresh} | Reference to this in order to allow method chaining |
customIcon. Provide a URI to a custom icon image to replace the SAP logo. Large images are scaled down to max 50px height.
| {sap.ui.core.URI} | Value of property customIcon |
description. Optional description. May be used to inform a user, for example, when the list has been updated last time.
| {string} | Value of property description |
iconDensityAware. By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
If bandwidth is the key for the application, set this value to false.
Default value is true.
| {boolean} | Value of property iconDensityAware |
showIcon. Set to true to display an icon/logo. Icon must be set either in the customIcon property or in the CSS theme for the PullToRefresh control.
Default value is false.
| {boolean} | Value of property showIcon |
customIcon. Provide a URI to a custom icon image to replace the SAP logo. Large images are scaled down to max 50px height.
When called with a value of null or undefined, the default value of the property will be restored.
| {sap.ui.core.URI} | sCustomIcon | New value for property customIcon |
| {sap.m.PullToRefresh} | Reference to this in order to allow method chaining |
description. Optional description. May be used to inform a user, for example, when the list has been updated last time.
When called with a value of null or undefined, the default value of the property will be restored.
| {string} | sDescription | New value for property description |
| {sap.m.PullToRefresh} | Reference to this in order to allow method chaining |
iconDensityAware. By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
If bandwidth is the key for the application, set this value to false.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
| {boolean} | bIconDensityAware | New value for property iconDensityAware |
| {sap.m.PullToRefresh} | Reference to this in order to allow method chaining |
showIcon. Set to true to display an icon/logo. Icon must be set either in the customIcon property or in the CSS theme for the PullToRefresh control.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
| {boolean} | bShowIcon | New value for property showIcon |
| {sap.m.PullToRefresh} | Reference to this in order to allow method chaining |