class sap.m.TablePersoDialog

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

Table Personalization Dialog


Constructor

The TablePersoDialog can be used to display and allow modification of personalization settings relating to a Table. It displays the columns of the table that it refers to by using

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.TablePersoDialog(sId?, mSettings?)
Param Type Default Value Description
sId? string

optional id for the new control; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings will be given or not!

mSettings? object

optional map/JSON-object with initial settings for the new component instance


Properties

Name Type Default Value Description
columnInfoCallback object Visibility: public
contentHeight sap.ui.core.CSSSize Visibility: public
contentWidth sap.ui.core.CSSSize Visibility: public
hasGrouping boolean Visibility: public
initialColumnState object Visibility: public
persoMap object Visibility: public
showResetAll boolean Visibility: public
showSelectAll boolean Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
persoService 0..1 Object

Refers to the service for reading and writing the personalization.
Deprecated as of version 1.30.1. This aggregate is no longer used. It collided with the TablePersoController's persoService reference


Associations

Name Cardinality Type Description
persoDialogFor 0..1 sap.m.Table

The table which shall be personalized.


Events Overview

Event Description
cancel
confirm

cancel

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

confirm

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachCancel

Attaches event handler fnFunction to the cancel event of this sap.m.TablePersoDialog.

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.TablePersoDialog itself.

attachConfirm

Attaches event handler fnFunction to the confirm event of this sap.m.TablePersoDialog.

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.TablePersoDialog itself.

destroyPersoService

Destroys the persoService in the aggregation persoService.

Since 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference
detachCancel

Detaches event handler fnFunction from the cancel event of this sap.m.TablePersoDialog.

The passed function and listener object must match the ones used for event registration.

detachConfirm

Detaches event handler fnFunction from the confirm event of this sap.m.TablePersoDialog.

The passed function and listener object must match the ones used for event registration.

sap.m.TablePersoDialog.extend

Creates a new subclass of class sap.m.TablePersoDialog 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.

fireCancel

Fires event cancel to attached listeners.

fireConfirm

Fires event confirm to attached listeners.

getColumnInfoCallback

Gets current value of property columnInfoCallback.

getContentHeight

Gets current value of property contentHeight.

getContentWidth

Gets current value of property contentWidth.

getHasGrouping

Gets current value of property hasGrouping.

getInitialColumnState

Gets current value of property initialColumnState.

sap.m.TablePersoDialog.getMetadata

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

getPersoDialogFor

ID of the element which is the current target of the association persoDialogFor, or null.

getPersoMap

Gets current value of property persoMap.

getPersoService

Gets content of aggregation persoService.

Refers to the service for reading and writing the personalization.

Since 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference
getShowResetAll

Gets current value of property showResetAll.

getShowSelectAll

Gets current value of property showSelectAll.

init

Initializes the TablePersoDialog instance after creation.

open

Sets the content of the dialog, being list items representing the associated table's column settings, and opens the dialog

retrievePersonalizations

Returns the personalizations made. Currently supports a 'columns' property which holds an array of settings, one element per column in the associated table. The element contains column-specific information as follows: id: column id; order: new order; text: the column's header text that was displayed in the dialog; visible: visibility (true or false).

setColumnInfoCallback

Sets a new value for property columnInfoCallback.

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

setContentHeight

Sets a new value for property contentHeight.

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

setContentWidth

Sets a new value for property contentWidth.

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

setHasGrouping

Setter to turn on/ switch off TablePersoDialog's grouping mode.

setInitialColumnState

Sets a new value for property initialColumnState.

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

setPersoDialogFor

Sets the associated persoDialogFor.

setPersoMap

Sets a new value for property persoMap.

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

setPersoService

Sets the aggregated persoService.

Since 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference
setShowResetAll

Setter to show/hide TablePersoDialog's 'Undo Personalization' button.

setShowSelectAll

Setter to show/hide TablePersoDialog's 'selectAll' checkbox.

attachCancel

Attaches event handler fnFunction to the cancel event of this sap.m.TablePersoDialog.

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.TablePersoDialog itself.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.TablePersoDialog itself

attachConfirm

Attaches event handler fnFunction to the confirm event of this sap.m.TablePersoDialog.

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.TablePersoDialog itself.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.TablePersoDialog itself

destroyPersoService

Destroys the persoService in the aggregation persoService.

Since 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference

detachCancel

Detaches event handler fnFunction from the cancel event of this sap.m.TablePersoDialog.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachConfirm

Detaches event handler fnFunction from the confirm event of this sap.m.TablePersoDialog.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.m.TablePersoDialog.extend

Creates a new subclass of class sap.m.TablePersoDialog 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

fireCancel

Fires event cancel to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireConfirm

Fires event confirm to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getColumnInfoCallback

Gets current value of property columnInfoCallback.

getContentHeight

Gets current value of property contentHeight.

getContentWidth

Gets current value of property contentWidth.

getHasGrouping

Gets current value of property hasGrouping.

getInitialColumnState

Gets current value of property initialColumnState.

sap.m.TablePersoDialog.getMetadata

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

getPersoDialogFor

ID of the element which is the current target of the association persoDialogFor, or null.

getPersoMap

Gets current value of property persoMap.

getPersoService

Gets content of aggregation persoService.

Refers to the service for reading and writing the personalization.

Since 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference

getShowResetAll

Gets current value of property showResetAll.

getShowSelectAll

Gets current value of property showSelectAll.

init

Initializes the TablePersoDialog instance after creation.

open

Sets the content of the dialog, being list items representing the associated table's column settings, and opens the dialog

retrievePersonalizations

Returns the personalizations made. Currently supports a 'columns' property which holds an array of settings, one element per column in the associated table. The element contains column-specific information as follows: id: column id; order: new order; text: the column's header text that was displayed in the dialog; visible: visibility (true or false).

setColumnInfoCallback

Sets a new value for property columnInfoCallback.

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

Param Type DefaultValue Description
oColumnInfoCallback object

New value for property columnInfoCallback

setContentHeight

Sets a new value for property contentHeight.

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

Param Type DefaultValue Description
sContentHeight sap.ui.core.CSSSize

New value for property contentHeight

setContentWidth

Sets a new value for property contentWidth.

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

Param Type DefaultValue Description
sContentWidth sap.ui.core.CSSSize

New value for property contentWidth

setHasGrouping

Setter to turn on/ switch off TablePersoDialog's grouping mode.

Param Type DefaultValue Description
bHasGrouping boolean

groping mode on or off.

setInitialColumnState

Sets a new value for property initialColumnState.

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

Param Type DefaultValue Description
oInitialColumnState object

New value for property initialColumnState

setPersoDialogFor

Sets the associated persoDialogFor.

Param Type DefaultValue Description
oPersoDialogFor sap.ui.core.ID sap.m.Table

ID of an element which becomes the new target of this persoDialogFor association; alternatively, an element instance may be given

setPersoMap

Sets a new value for property persoMap.

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

Param Type DefaultValue Description
oPersoMap object

New value for property persoMap

setPersoService

Sets the aggregated persoService.

Since 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference
Param Type DefaultValue Description
oPersoService Object

The persoService to set

setShowResetAll

Setter to show/hide TablePersoDialog's 'Undo Personalization' button.

Param Type DefaultValue Description
bShowResetAll boolean

'undo Personalization' button visible or not.

setShowSelectAll

Setter to show/hide TablePersoDialog's 'selectAll' checkbox.

Param Type DefaultValue Description
bShowSelectAll boolean

selectAll checkbox visible or not.