Class sap.m.TablePersoDialogModule: sap/m/TablePersoDialog

extends ManagedObject

Table Personalization Dialog

Constructor Summary
new sap.m.TablePersoDialog(sId?, mSettings?)The TablePersoDialog can be used to display and allow modification of personalization settings relating to a Table.
Event Summary
cancel(oControlEvent)
confirm(oControlEvent)
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.TablePersoDialog.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.TablePersoDialog with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.TablePersoDialog.getMetadata()Returns a metadata object for class sap.m.TablePersoDialog.
attachCancel(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cancel event of this sap.m.TablePersoDialog.
attachConfirm(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the confirm event of this sap.m.TablePersoDialog.
detachCancel(fnFunction, oListener)Detaches event handler fnFunction from the cancel event of this sap.m.TablePersoDialog.
detachConfirm(fnFunction, oListener)Detaches event handler fnFunction from the confirm event of this sap.m.TablePersoDialog.
fireCancel(mArguments?)Fires event cancel to attached listeners.
fireConfirm(mArguments?)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.
getPersoDialogFor()ID of the element which is the current target of the association persoDialogFor, or null.
getPersoMap()Gets current value of property persoMap.
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.
setColumnInfoCallback(oColumnInfoCallback)Sets a new value for property columnInfoCallback.
setContentHeight(sContentHeight)Sets a new value for property contentHeight.
setContentWidth(sContentWidth)Sets a new value for property contentWidth.
setHasGrouping(bHasGrouping)Setter to turn on/ switch off TablePersoDialog's grouping mode.
setInitialColumnState(oInitialColumnState)Sets a new value for property initialColumnState.
setPersoDialogFor(oPersoDialogFor)Sets the associated persoDialogFor.
setPersoMap(oPersoMap)Sets a new value for property persoMap.
setShowResetAll(bShowResetAll)Setter to show/hide TablePersoDialog's 'Undo Personalization' button.
setShowSelectAll(bShowSelectAll)Setter to show/hide TablePersoDialog's 'selectAll' checkbox.
destroyPersoService()Destroys the persoService in the aggregation persoService.
getPersoService()Gets content of aggregation persoService.
setPersoService(oPersoService)Sets the aggregated persoService.
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
attachEvent, attachEventOnce, detachEvent, fireEvent, hasListeners
Methods borrowed from class sap.ui.base.Object
getInterface
Constructor Detail
new sap.m.TablePersoDialog(sId?, mSettings?)
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
  • The result of calling sap.m.TablePersoProvider's 'getCaption' callback if it is implemented and delivers a non-null value for a column
  • the column header control's 'text' property if no caption property is available
  • the column header control's 'title' property if neither 'text' nor 'caption' property are available
  • the column id is displayed as last fallback, if none of the above is at hand. In that case, a warning is logged.

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:

In addition, all settings applicable to the base type sap.ui.base.ManagedObject can be used as well.

Parameters:
{string}sId? 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!
{object}mSettings? optional map/JSON-object with initial settings for the new component instance
Event Detail
cancel(oControlEvent)
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
confirm(oControlEvent)
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.m.TablePersoDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.TablePersoDialog.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.TablePersoDialog.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachCancel(oData?, fnFunction, oListener?): sap.m.TablePersoDialog
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.

Parameters:
{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.TablePersoDialog itself
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
attachConfirm(oData?, fnFunction, oListener?): sap.m.TablePersoDialog
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.

Parameters:
{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.TablePersoDialog itself
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
detachCancel(fnFunction, oListener): sap.m.TablePersoDialog
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
detachConfirm(fnFunction, oListener): sap.m.TablePersoDialog
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
fireCancel(mArguments?): sap.m.TablePersoDialog
Fires event cancel to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
fireConfirm(mArguments?): sap.m.TablePersoDialog
Fires event confirm to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
getColumnInfoCallback(): object
Gets current value of property columnInfoCallback.
Returns:
{object} Value of property columnInfoCallback
getContentHeight(): sap.ui.core.CSSSize
Gets current value of property contentHeight.
Returns:
{sap.ui.core.CSSSize} Value of property contentHeight
getContentWidth(): sap.ui.core.CSSSize
Gets current value of property contentWidth.
Returns:
{sap.ui.core.CSSSize} Value of property contentWidth
getHasGrouping(): boolean
Gets current value of property hasGrouping.
Returns:
{boolean} Value of property hasGrouping
getInitialColumnState(): object
Gets current value of property initialColumnState.
Returns:
{object} Value of property initialColumnState
getPersoDialogFor(): sap.m.Table
ID of the element which is the current target of the association persoDialogFor, or null.
Returns:
{sap.m.Table}
getPersoMap(): object
Gets current value of property persoMap.
Returns:
{object} Value of property persoMap
getShowResetAll(): boolean
Gets current value of property showResetAll.
Returns:
{boolean} Value of property showResetAll
getShowSelectAll(): boolean
Gets current value of property showSelectAll.
Returns:
{boolean} 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(): object
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).
Returns:
{object} the personalization data
setColumnInfoCallback(oColumnInfoCallback): sap.m.TablePersoDialog
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.

Parameters:
{object}oColumnInfoCallback New value for property columnInfoCallback
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
setContentHeight(sContentHeight): sap.m.TablePersoDialog
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.

Parameters:
{sap.ui.core.CSSSize}sContentHeight New value for property contentHeight
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
setContentWidth(sContentWidth): sap.m.TablePersoDialog
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.

Parameters:
{sap.ui.core.CSSSize}sContentWidth New value for property contentWidth
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
setHasGrouping(bHasGrouping): TablePersoDialog
Setter to turn on/ switch off TablePersoDialog's grouping mode.
Parameters:
{boolean}bHasGrouping groping mode on or off.
Returns:
{TablePersoDialog} the TablePersoDialog instance.
setInitialColumnState(oInitialColumnState): sap.m.TablePersoDialog
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.

Parameters:
{object}oInitialColumnState New value for property initialColumnState
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
setPersoDialogFor(oPersoDialogFor): sap.m.TablePersoDialog
Sets the associated persoDialogFor.
Parameters:
{sap.m.Table}oPersoDialogFor Id of an element which becomes the new target of this persoDialogFor association; alternatively, an element instance may be given
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
setPersoMap(oPersoMap): sap.m.TablePersoDialog
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.

Parameters:
{object}oPersoMap New value for property persoMap
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
setShowResetAll(bShowResetAll): TablePersoDialog
Setter to show/hide TablePersoDialog's 'Undo Personalization' button.
Parameters:
{boolean}bShowResetAll 'undo Personalization' button visible or not.
Returns:
{TablePersoDialog} the TablePersoDialog instance.
setShowSelectAll(bShowSelectAll): TablePersoDialog
Setter to show/hide TablePersoDialog's 'selectAll' checkbox.
Parameters:
{boolean}bShowSelectAll selectAll checkbox visible or not.
Returns:
{TablePersoDialog} the TablePersoDialog instance.
destroyPersoService(): sap.m.TablePersoDialog
Destroys the persoService in the aggregation persoService.
Deprecated:
Since version 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining
getPersoService(): Object
Gets content of aggregation persoService.

Refers to the service for reading and writing the personalization.

Deprecated:
Since version 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference
Returns:
{Object}
setPersoService(oPersoService): sap.m.TablePersoDialog
Sets the aggregated persoService.
Parameters:
{Object}oPersoService The persoService to set
Deprecated:
Since version 1.30.1 This aggregate is no longer used. It collided with the TablePersoController's persoService reference
Returns:
{sap.m.TablePersoDialog} Reference to this in order to allow method chaining