Abstract Class sap.m.TablePersoProviderModule: sap/m/TablePersoProvider
extends ManagedObject
Table Personalization Provider
Constructor Summary
new sap.m.TablePersoProvider()This is an abstract TablePersoProvider, describing the interface for a real TablePersoProvider.
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.m.TablePersoProvider.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.TablePersoProvider with name
sClassName and enriches it with the information contained in oClassInfo.delPersData()Removes the personalization bundle This must return a jQuery promise (see http://api.jquery.com/promise/)
getCaption(oColumn)Callback function which can be used to determine the title of a given column within the TablePersoDialog.
getGroup(oColumn)Callback function which can be used to determine the group of a given column within the TablePersoDialog.
resetPersData()Resets user’s personalization for a given table so that ‘getPersData’ will deliver its initial state.
setPersData(oBundle)Stores the personalization bundle, overwriting any previous bundle completely This must return a jQuery promise (see http://api.jquery.com/promise/)
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, clone, destroy, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getMetadata, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, toString, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
Methods borrowed from class sap.ui.base.Object
Constructor Detail
Method Detail
sap.m.TablePersoProvider.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.TablePersoProvider 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.base.ManagedObject.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.TablePersoProvider.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.TablePersoProvider.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
delPersData()
Removes the personalization bundle This must return a jQuery promise (see http://api.jquery.com/promise/)
getCaption(oColumn)
Callback function which can be used to determine the title of a given column within the TablePersoDialog. As a default, the column header controls are asked for their 'text' or 'title' property. This works in most cases, for example if the header control is a sap.m.Label (has 'text' property) or a sap.m.ObjectListItem (has 'title' property).
If the header control used in a column has neither 'text' nor 'title' property, or if you would like to display a modified column name for a certain column, this callback function can be used.
If the callback delivers null for a column (which is the default implementation), the default texts described above are displayed for that column in the TablePersoDialog.
In case neither the callback delivers null and neither 'text' nor ' title' property are at hand, the TablePersoDialog will display the column id and a warning message is logged.
Parameters:
| {sap.m.Column} | oColumn | column whose caption shall be determined |
getGroup(oColumn)
Callback function which can be used to determine the group of a given column within the TablePersoDialog. As a default, the columns are not assigned to a group.
This information is used to group the columns within the TablePersoDialog if the TablePersoController's 'group' flag is set, otherwise, the groups are ignored.
Parameters:
| {sap.m.Column} | oColumn | column whose group shall be determined |
getPersData()
Retrieves the personalization bundle. This must return a jQuery promise (see http://api.jquery.com/promise/)