abstract class sap.m.TablePersoProvider

Control sample: sap.m.TablePersoProvider
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/TablePersoProvider
Application Component: CA-UI5-CTR

Table Personalization Provider


Constructor

This is an abstract TablePersoProvider, describing the interface for a real TablePersoProvider.

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.

This class does not have its own settings, but all settings applicable to the base type sap.ui.base.ManagedObject can be used.

new sap.m.TablePersoProvider()

Methods Overview

Method Description
delPersData

Removes the personalization bundle.
This must return a jQuery promise .

sap.m.TablePersoProvider.extend

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.

getCaption

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 an sap.m.Label (has 'text' property) or an 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.

getGroup

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.

sap.m.TablePersoProvider.getMetadata

Returns a metadata object for class sap.m.TablePersoProvider.

getPersData

Retrieves the personalization bundle.
This must return a jQuery Promise , which resolves in the desired table state.

getResetPersData

Retrieves the desired reset state. This getter is used by the TablePersoController if the resetAllMode is ServiceReset.

This must return a jQuery promise .

init

Initializes the TablePersoProvider instance after creation.

resetPersData

Resets user’s personalization for a given table so that ‘getPersData’ will deliver its initial state. If no table is specified, all personalizations of the currently logged on user are reset.

This must return a jQuery promise .

setPersData

Stores the personalization bundle, overwriting any previous bundle completely.
This must return a jQuery promise .

delPersData

Removes the personalization bundle.
This must return a jQuery promise .

sap.m.TablePersoProvider.extend

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.

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

getCaption

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 an sap.m.Label (has 'text' property) or an 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.

Param Type DefaultValue Description
oColumn sap.m.Column

column whose caption shall be determined

getGroup

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.

Param Type DefaultValue Description
oColumn sap.m.Column

column whose group shall be determined

sap.m.TablePersoProvider.getMetadata

Returns a metadata object for class sap.m.TablePersoProvider.

getPersData

Retrieves the personalization bundle.
This must return a jQuery Promise , which resolves in the desired table state.

getResetPersData

Retrieves the desired reset state. This getter is used by the TablePersoController if the resetAllMode is ServiceReset.

This must return a jQuery promise .

init

Initializes the TablePersoProvider instance after creation.

resetPersData

Resets user’s personalization for a given table so that ‘getPersData’ will deliver its initial state. If no table is specified, all personalizations of the currently logged on user are reset.

This must return a jQuery promise .

setPersData

Stores the personalization bundle, overwriting any previous bundle completely.
This must return a jQuery promise .

Param Type DefaultValue Description
oBundle object