Class sap.m.ViewSettingsDialogModule: sap/m/ViewSettingsDialog

extends Control

The ViewSettingsDialog control provides functionality to easily select the options for sorting, grouping, and filtering data. It is a composite control, consisting of a modal popover and several internal lists. There are three different tabs (Sort, Group, Filter) in the dialog that can be activated by filling the respective associations. If only one association is filled, the other tabs are automatically hidden. The selected options can be used to create sorters and filters for the table.


Since: 1.16.
Constructor Summary
new sap.m.ViewSettingsDialog(sId?, mSettings?)Constructor for a new ViewSettingsDialog.
Event Summary
cancel(oControlEvent)Called when the Cancel button is pressed.
confirm(oControlEvent)Indicates that the user has pressed the OK button and the selected sort, group, and filter settings should be applied to the data on this page.
filterDetailPageOpened(oControlEvent)Fired when the filter detail page is opened.
resetFilters(oControlEvent)Called when the reset filters button is pressed.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.ViewSettingsDialog.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ViewSettingsDialog with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ViewSettingsDialog.getMetadata()Returns a metadata object for class sap.m.ViewSettingsDialog.
addCustomTab(oCustomTab)Overwrites the aggregation setter in order to have ID validation logic as some strings are reserved for the predefined tabs.
addFilterItem(oFilterItem)Adds some filterItem to the aggregation filterItems.
addGroupItem(oItem)Adds a group item and sets the association to reflect the selected state.
addPresetFilterItem(oItem)Adds a preset filter item and sets the association to reflect the selected state.
addSortItem(oItem)Adds a sort item and sets the association to reflect the selected state.
attachCancel(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cancel event of this sap.m.ViewSettingsDialog.
attachConfirm(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the confirm event of this sap.m.ViewSettingsDialog.
attachFilterDetailPageOpened(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the filterDetailPageOpened event of this sap.m.ViewSettingsDialog.
attachResetFilters(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the resetFilters event of this sap.m.ViewSettingsDialog.
bindCustomTabs(oBindingInfo)Binds aggregation customTabs to model data.
bindFilterItems(oBindingInfo)Binds aggregation filterItems to model data.
bindGroupItems(oBindingInfo)Binds aggregation groupItems to model data.
bindPresetFilterItems(oBindingInfo)Binds aggregation presetFilterItems to model data.
bindSortItems(oBindingInfo)Binds aggregation sortItems to model data.
destroyCustomTabs()Destroys all the customTabs in the aggregation customTabs.
destroyFilterItems()Destroys all the filterItems in the aggregation filterItems.
destroyGroupItems()Destroys all the groupItems in the aggregation groupItems.
destroyPresetFilterItems()Destroys all the presetFilterItems in the aggregation presetFilterItems.
destroySortItems()Destroys all the sortItems in the aggregation sortItems.
detachCancel(fnFunction, oListener)Detaches event handler fnFunction from the cancel event of this sap.m.ViewSettingsDialog.
detachConfirm(fnFunction, oListener)Detaches event handler fnFunction from the confirm event of this sap.m.ViewSettingsDialog.
detachFilterDetailPageOpened(fnFunction, oListener)Detaches event handler fnFunction from the filterDetailPageOpened event of this sap.m.ViewSettingsDialog.
detachResetFilters(fnFunction, oListener)Detaches event handler fnFunction from the resetFilters event of this sap.m.ViewSettingsDialog.
fireCancel(mArguments?)Fires event cancel to attached listeners.
fireConfirm(mArguments?)Fires event confirm to attached listeners.
fireFilterDetailPageOpened(mArguments?)Fires event filterDetailPageOpened to attached listeners.
fireResetFilters(mArguments?)Fires event resetFilters to attached listeners.
getCustomTabs()Gets content of aggregation customTabs.
getFilterItems()Gets content of aggregation filterItems.
getGroupDescending()Gets current value of property groupDescending.
getGroupItems()Gets content of aggregation groupItems.
getPresetFilterItems()Gets content of aggregation presetFilterItems.
getSelectedFilterItems()Returns the selected filters as an array of ViewSettingsItems.
getSelectedFilterKeys()Gets the selected filter object in format {key: boolean}.
getSelectedFilterString()Gets the filter string in format: "filter name (subfilter1 name, subfilter2 name, .
getSelectedGroupItem()ID of the element which is the current target of the association selectedGroupItem, or null.
getSelectedPresetFilterItem()ID of the element which is the current target of the association selectedPresetFilterItem, or null.
getSelectedSortItem()ID of the element which is the current target of the association selectedSortItem, or null.
getSortDescending()Gets current value of property sortDescending.
getSortItems()Gets content of aggregation sortItems.
getTitle()Gets current value of property title.
indexOfCustomTab(oCustomTab)Checks for the provided sap.m.ViewSettingsCustomTab in the aggregation customTabs.
indexOfFilterItem(oFilterItem)Checks for the provided sap.m.ViewSettingsItem in the aggregation filterItems.
indexOfGroupItem(oGroupItem)Checks for the provided sap.m.ViewSettingsItem in the aggregation groupItems.
indexOfPresetFilterItem(oPresetFilterItem)Checks for the provided sap.m.ViewSettingsItem in the aggregation presetFilterItems.
indexOfSortItem(oSortItem)Checks for the provided sap.m.ViewSettingsItem in the aggregation sortItems.
insertCustomTab(oCustomTab, iIndex)Inserts a customTab into the aggregation customTabs.
insertFilterItem(oFilterItem, iIndex)Inserts a filterItem into the aggregation filterItems.
insertGroupItem(oGroupItem, iIndex)Inserts a groupItem into the aggregation groupItems.
insertPresetFilterItem(oPresetFilterItem, iIndex)Inserts a presetFilterItem into the aggregation presetFilterItems.
insertSortItem(oSortItem, iIndex)Inserts a sortItem into the aggregation sortItems.
open(sPageId?)Opens the ViewSettingsDialog relative to the parent control.
removeAllCustomTabs()Removes all the controls from the aggregation customTabs.
removeAllFilterItems()Removes all filter Items and resets the remembered page if it was a filter detail page and all of its filter items are being removed.
removeAllGroupItems()Removes all the controls from the aggregation groupItems.
removeAllPresetFilterItems()Removes all the controls from the aggregation presetFilterItems.
removeAllSortItems()Removes all the controls from the aggregation sortItems.
removeCustomTab(vCustomTab)Removes a customTab from the aggregation customTabs.
removeFilterItem(vFilterItem)Removes a filter Item and resets the remembered page if it was the filter detail page of the removed filter.
removeGroupItem(vGroupItem)Removes a groupItem from the aggregation groupItems.
removePresetFilterItem(vPresetFilterItem)Removes a presetFilterItem from the aggregation presetFilterItems.
removeSortItem(vSortItem)Removes a sortItem from the aggregation sortItems.
setBusy(bBusy)Forward the busy state setting to the internal dialog instance.
setGroupDescending(bGroupDescending)Sets a new value for property groupDescending.
setSelectedFilterKeys(oSelectedFilterKeys)Sets the selected filter object in format {key: boolean}.
setSelectedGroupItem(vItemOrKey)Sets the selected group item (either by key or by item).
setSelectedPresetFilterItem(vItemOrKey)Sets the selected preset filter item.
setSelectedSortItem(vItemOrKey)Sets the selected sort item (either by key or by item).
setSortDescending(bSortDescending)Sets a new value for property sortDescending.
setTitle(sTitle)Sets the title of the internal dialog.
unbindCustomTabs()Unbinds aggregation customTabs from model data.
unbindFilterItems()Unbinds aggregation filterItems from model data.
unbindGroupItems()Unbinds aggregation groupItems from model data.
unbindPresetFilterItems()Unbinds aggregation presetFilterItems from model data.
unbindSortItems()Unbinds aggregation sortItems from model data.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.ViewSettingsDialog(sId?, mSettings?)
Constructor for a new ViewSettingsDialog.

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
  • Aggregations
  • Events
    • confirm : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • cancel : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • resetFilters : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • filterDetailPageOpened : 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.

Parameters:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Event Detail
cancel(oControlEvent)
Called when the Cancel button is pressed. It can be used to set the state of custom filter controls.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
confirm(oControlEvent)
Indicates that the user has pressed the OK button and the selected sort, group, and filter settings should be applied to the data on this page.

Note: Custom tabs are not converted to event parameters automatically. For custom tabs, you have to read the state of your controls inside the callback of this event.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.m.ViewSettingsItem}oControlEvent.getParameters.sortItem The selected sort item.
{boolean}oControlEvent.getParameters.sortDescending The selected sort order (true = descending, false = ascending).
{sap.m.ViewSettingsItem}oControlEvent.getParameters.groupItem The selected group item.
{boolean}oControlEvent.getParameters.groupDescending The selected group order (true = descending, false = ascending).
{sap.m.ViewSettingsItem}oControlEvent.getParameters.presetFilterItem The selected preset filter item.
{sap.m.ViewSettingsItem[]}oControlEvent.getParameters.filterItems The selected filters in an array of ViewSettingsItem.
{object}oControlEvent.getParameters.filterKeys The selected filter items in an object notation format: { key: boolean }. If a custom control filter was displayed (for example, the user clicked on the filter item), the value for its key is set to true to indicate that there has been an interaction with the control.
{string}oControlEvent.getParameters.filterString The selected filter items in a string format to display in the control's header bar in format "Filtered by: key (subkey1, subkey2, subkey3)".
filterDetailPageOpened(oControlEvent)
Fired when the filter detail page is opened.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.m.ViewSettingsFilterItem}oControlEvent.getParameters.parentFilterItem The filter item for which the details are opened.
resetFilters(oControlEvent)
Called when the reset filters button is pressed. It can be used to clear the state of custom filter controls.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.m.ViewSettingsDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.ViewSettingsDialog 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.core.Control.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.ViewSettingsDialog.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ViewSettingsDialog.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addCustomTab(oCustomTab): sap.m.ViewSettingsDialog
Overwrites the aggregation setter in order to have ID validation logic as some strings are reserved for the predefined tabs.
Parameters:
{object}oCustomTab The custom tab to be added
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
addFilterItem(oFilterItem): sap.m.ViewSettingsDialog
Adds some filterItem to the aggregation filterItems.
Parameters:
{sap.m.ViewSettingsItem}oFilterItem the filterItem to add; if empty, nothing is inserted
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
addGroupItem(oItem): sap.m.ViewSettingsDialog
Adds a group item and sets the association to reflect the selected state.
Parameters:
{sap.m.ViewSettingsItem}oItem The item to be added to the group items
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
addPresetFilterItem(oItem): sap.m.ViewSettingsDialog
Adds a preset filter item and sets the association to reflect the selected state.
Parameters:
{sap.m.ViewSettingsItem}oItem The selected item or a string with the key
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
addSortItem(oItem): sap.m.ViewSettingsDialog
Adds a sort item and sets the association to reflect the selected state.
Parameters:
{sap.m.ViewSettingsItem}oItem The item to be added to the aggregation
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
attachCancel(oData?, fnFunction, oListener?): sap.m.ViewSettingsDialog
Attaches event handler fnFunction to the cancel event of this sap.m.ViewSettingsDialog.

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

Called when the Cancel button is pressed. It can be used to set the state of custom filter controls.

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.ViewSettingsDialog itself
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
attachConfirm(oData?, fnFunction, oListener?): sap.m.ViewSettingsDialog
Attaches event handler fnFunction to the confirm event of this sap.m.ViewSettingsDialog.

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

Indicates that the user has pressed the OK button and the selected sort, group, and filter settings should be applied to the data on this page.

Note: Custom tabs are not converted to event parameters automatically. For custom tabs, you have to read the state of your controls inside the callback of this event.

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.ViewSettingsDialog itself
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
attachFilterDetailPageOpened(oData?, fnFunction, oListener?): sap.m.ViewSettingsDialog
Attaches event handler fnFunction to the filterDetailPageOpened event of this sap.m.ViewSettingsDialog.

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

Fired when the filter detail page is opened.

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.ViewSettingsDialog itself
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
attachResetFilters(oData?, fnFunction, oListener?): sap.m.ViewSettingsDialog
Attaches event handler fnFunction to the resetFilters event of this sap.m.ViewSettingsDialog.

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

Called when the reset filters button is pressed. It can be used to clear the state of custom filter controls.

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.ViewSettingsDialog itself
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
bindCustomTabs(oBindingInfo): sap.m.ViewSettingsDialog
Binds aggregation customTabs to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Since:
1.30
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
bindFilterItems(oBindingInfo): sap.m.ViewSettingsDialog
Binds aggregation filterItems to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
bindGroupItems(oBindingInfo): sap.m.ViewSettingsDialog
Binds aggregation groupItems to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
bindPresetFilterItems(oBindingInfo): sap.m.ViewSettingsDialog
Binds aggregation presetFilterItems to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
bindSortItems(oBindingInfo): sap.m.ViewSettingsDialog
Binds aggregation sortItems to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
destroyCustomTabs(): sap.m.ViewSettingsDialog
Destroys all the customTabs in the aggregation customTabs.
Since:
1.30
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
destroyFilterItems(): sap.m.ViewSettingsDialog
Destroys all the filterItems in the aggregation filterItems.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
destroyGroupItems(): sap.m.ViewSettingsDialog
Destroys all the groupItems in the aggregation groupItems.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
destroyPresetFilterItems(): sap.m.ViewSettingsDialog
Destroys all the presetFilterItems in the aggregation presetFilterItems.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
destroySortItems(): sap.m.ViewSettingsDialog
Destroys all the sortItems in the aggregation sortItems.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
detachCancel(fnFunction, oListener): sap.m.ViewSettingsDialog
Detaches event handler fnFunction from the cancel event of this sap.m.ViewSettingsDialog.

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.ViewSettingsDialog} Reference to this in order to allow method chaining
detachConfirm(fnFunction, oListener): sap.m.ViewSettingsDialog
Detaches event handler fnFunction from the confirm event of this sap.m.ViewSettingsDialog.

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.ViewSettingsDialog} Reference to this in order to allow method chaining
detachFilterDetailPageOpened(fnFunction, oListener): sap.m.ViewSettingsDialog
Detaches event handler fnFunction from the filterDetailPageOpened event of this sap.m.ViewSettingsDialog.

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.ViewSettingsDialog} Reference to this in order to allow method chaining
detachResetFilters(fnFunction, oListener): sap.m.ViewSettingsDialog
Detaches event handler fnFunction from the resetFilters event of this sap.m.ViewSettingsDialog.

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.ViewSettingsDialog} Reference to this in order to allow method chaining
fireCancel(mArguments?): sap.m.ViewSettingsDialog
Fires event cancel to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
fireConfirm(mArguments?): sap.m.ViewSettingsDialog
Fires event confirm to attached listeners.

Expects the following event parameters:

  • sortItem of type sap.m.ViewSettingsItemThe selected sort item.
  • sortDescending of type booleanThe selected sort order (true = descending, false = ascending).
  • groupItem of type sap.m.ViewSettingsItemThe selected group item.
  • groupDescending of type booleanThe selected group order (true = descending, false = ascending).
  • presetFilterItem of type sap.m.ViewSettingsItemThe selected preset filter item.
  • filterItems of type sap.m.ViewSettingsItem[]The selected filters in an array of ViewSettingsItem.
  • filterKeys of type objectThe selected filter items in an object notation format: { key: boolean }. If a custom control filter was displayed (for example, the user clicked on the filter item), the value for its key is set to true to indicate that there has been an interaction with the control.
  • filterString of type stringThe selected filter items in a string format to display in the control's header bar in format "Filtered by: key (subkey1, subkey2, subkey3)".
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
fireFilterDetailPageOpened(mArguments?): sap.m.ViewSettingsDialog
Fires event filterDetailPageOpened to attached listeners.

Expects the following event parameters:

  • parentFilterItem of type sap.m.ViewSettingsFilterItemThe filter item for which the details are opened.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
fireResetFilters(mArguments?): sap.m.ViewSettingsDialog
Fires event resetFilters to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
getCustomTabs(): sap.m.ViewSettingsCustomTab[]
Gets content of aggregation customTabs.

The list of all the custom tabs.

Since:
1.30
Returns:
{sap.m.ViewSettingsCustomTab[]}
getFilterItems(): sap.m.ViewSettingsItem[]
Gets content of aggregation filterItems.

The list of items with key and value that can be filtered on (for example, a list of columns for a table). A filterItem is associated with one or more detail filters.

Since:
1.16
Returns:
{sap.m.ViewSettingsItem[]}
getGroupDescending(): boolean
Gets current value of property groupDescending.

Determines whether the group order is descending or ascending (default).

Default value is false.

Returns:
{boolean} Value of property groupDescending
getGroupItems(): sap.m.ViewSettingsItem[]
Gets content of aggregation groupItems.

The list of items with key and value that can be grouped on (for example, a list of columns for a table).

Since:
1.16
Returns:
{sap.m.ViewSettingsItem[]}
getPresetFilterItems(): sap.m.ViewSettingsItem[]
Gets content of aggregation presetFilterItems.

The list of preset filter items with key and value that allows the selection of more complex or custom filters. These entries are displayed at the top of the filter tab.

Since:
1.16
Returns:
{sap.m.ViewSettingsItem[]}
getSelectedFilterItems(): sap.m.ViewSettingsItem[]
Returns the selected filters as an array of ViewSettingsItems.

It can be used to create matching sorters and filters to apply the selected settings to the data.

Returns:
{sap.m.ViewSettingsItem[]} An array of selected filter items
getSelectedFilterKeys(): object
Gets the selected filter object in format {key: boolean}.

It can be used to create matching sorters and filters to apply the selected settings to the data.

Returns:
{object} An object with item and subitem keys
getSelectedFilterString(): string
Gets the filter string in format: "filter name (subfilter1 name, subfilter2 name, ...), ...". For custom and preset filters it will only add the filter name to the resulting string.
Returns:
{string} The selected filter string
getSelectedGroupItem(): sap.m.ViewSettingsItem
ID of the element which is the current target of the association selectedGroupItem, or null.
Returns:
{sap.m.ViewSettingsItem}
getSelectedPresetFilterItem(): sap.m.ViewSettingsItem
ID of the element which is the current target of the association selectedPresetFilterItem, or null.
Returns:
{sap.m.ViewSettingsItem}
getSelectedSortItem(): sap.m.ViewSettingsItem
ID of the element which is the current target of the association selectedSortItem, or null.
Returns:
{sap.m.ViewSettingsItem}
getSortDescending(): boolean
Gets current value of property sortDescending.

Determines whether the sort order is descending or ascending (default).

Default value is false.

Returns:
{boolean} Value of property sortDescending
getSortItems(): sap.m.ViewSettingsItem[]
Gets content of aggregation sortItems.

The list of items with key and value that can be sorted over (for example, a list of columns for a table).

Since:
1.16
Returns:
{sap.m.ViewSettingsItem[]}
getTitle(): string
Gets current value of property title.

Defines the title of the dialog. If not set and there is only one active tab, the dialog uses the default "View" or "Sort", "Group", "Filter" respectively.

Returns:
{string} Value of property title
indexOfCustomTab(oCustomTab): int
Checks for the provided sap.m.ViewSettingsCustomTab in the aggregation customTabs. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.ViewSettingsCustomTab}oCustomTab The customTab whose index is looked for
Since:
1.30
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfFilterItem(oFilterItem): int
Checks for the provided sap.m.ViewSettingsItem in the aggregation filterItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.ViewSettingsItem}oFilterItem The filterItem whose index is looked for
Since:
1.16
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfGroupItem(oGroupItem): int
Checks for the provided sap.m.ViewSettingsItem in the aggregation groupItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.ViewSettingsItem}oGroupItem The groupItem whose index is looked for
Since:
1.16
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfPresetFilterItem(oPresetFilterItem): int
Checks for the provided sap.m.ViewSettingsItem in the aggregation presetFilterItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.ViewSettingsItem}oPresetFilterItem The presetFilterItem whose index is looked for
Since:
1.16
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfSortItem(oSortItem): int
Checks for the provided sap.m.ViewSettingsItem in the aggregation sortItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.ViewSettingsItem}oSortItem The sortItem whose index is looked for
Since:
1.16
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertCustomTab(oCustomTab, iIndex): sap.m.ViewSettingsDialog
Inserts a customTab into the aggregation customTabs.
Parameters:
{sap.m.ViewSettingsCustomTab}oCustomTab the customTab to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the customTab should be inserted at; for a negative value of iIndex, the customTab is inserted at position 0; for a value greater than the current size of the aggregation, the customTab is inserted at the last position
Since:
1.30
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
insertFilterItem(oFilterItem, iIndex): sap.m.ViewSettingsDialog
Inserts a filterItem into the aggregation filterItems.
Parameters:
{sap.m.ViewSettingsItem}oFilterItem the filterItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the filterItem should be inserted at; for a negative value of iIndex, the filterItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem is inserted at the last position
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
insertGroupItem(oGroupItem, iIndex): sap.m.ViewSettingsDialog
Inserts a groupItem into the aggregation groupItems.
Parameters:
{sap.m.ViewSettingsItem}oGroupItem the groupItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the groupItem should be inserted at; for a negative value of iIndex, the groupItem is inserted at position 0; for a value greater than the current size of the aggregation, the groupItem is inserted at the last position
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
insertPresetFilterItem(oPresetFilterItem, iIndex): sap.m.ViewSettingsDialog
Inserts a presetFilterItem into the aggregation presetFilterItems.
Parameters:
{sap.m.ViewSettingsItem}oPresetFilterItem the presetFilterItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the presetFilterItem should be inserted at; for a negative value of iIndex, the presetFilterItem is inserted at position 0; for a value greater than the current size of the aggregation, the presetFilterItem is inserted at the last position
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
insertSortItem(oSortItem, iIndex): sap.m.ViewSettingsDialog
Inserts a sortItem into the aggregation sortItems.
Parameters:
{sap.m.ViewSettingsItem}oSortItem the sortItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the sortItem should be inserted at; for a negative value of iIndex, the sortItem is inserted at position 0; for a value greater than the current size of the aggregation, the sortItem is inserted at the last position
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
open(sPageId?): sap.m.ViewSettingsDialog
Opens the ViewSettingsDialog relative to the parent control.
Parameters:
{string}sPageId? The ID of the initial page to be opened in the dialog. The available values are "sort", "group", "filter" or IDs of custom tabs.
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
removeAllCustomTabs(): sap.m.ViewSettingsCustomTab[]
Removes all the controls from the aggregation customTabs.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.30
Returns:
{sap.m.ViewSettingsCustomTab[]} An array of the removed elements (might be empty)
removeAllFilterItems(): sap.m.ViewSettingsDialog
Removes all filter Items and resets the remembered page if it was a filter detail page and all of its filter items are being removed.
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
removeAllGroupItems(): sap.m.ViewSettingsItem[]
Removes all the controls from the aggregation groupItems.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.16
Returns:
{sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
removeAllPresetFilterItems(): sap.m.ViewSettingsItem[]
Removes all the controls from the aggregation presetFilterItems.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.16
Returns:
{sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
removeAllSortItems(): sap.m.ViewSettingsItem[]
Removes all the controls from the aggregation sortItems.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.16
Returns:
{sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
removeCustomTab(vCustomTab): sap.m.ViewSettingsCustomTab
Removes a customTab from the aggregation customTabs.
Parameters:
{int|string|sap.m.ViewSettingsCustomTab}vCustomTab The customTabto remove or its index or id
Since:
1.30
Returns:
{sap.m.ViewSettingsCustomTab} The removed customTab or null
removeFilterItem(vFilterItem): sap.m.ViewSettingsDialog
Removes a filter Item and resets the remembered page if it was the filter detail page of the removed filter.
Parameters:
{int|sap.m.ViewSettingsFilterItem|string}vFilterItem The filter item's index, or the item itself, or its id
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
removeGroupItem(vGroupItem): sap.m.ViewSettingsItem
Removes a groupItem from the aggregation groupItems.
Parameters:
{int|string|sap.m.ViewSettingsItem}vGroupItem The groupItemto remove or its index or id
Since:
1.16
Returns:
{sap.m.ViewSettingsItem} The removed groupItem or null
removePresetFilterItem(vPresetFilterItem): sap.m.ViewSettingsItem
Removes a presetFilterItem from the aggregation presetFilterItems.
Parameters:
{int|string|sap.m.ViewSettingsItem}vPresetFilterItem The presetFilterItemto remove or its index or id
Since:
1.16
Returns:
{sap.m.ViewSettingsItem} The removed presetFilterItem or null
removeSortItem(vSortItem): sap.m.ViewSettingsItem
Removes a sortItem from the aggregation sortItems.
Parameters:
{int|string|sap.m.ViewSettingsItem}vSortItem The sortItemto remove or its index or id
Since:
1.16
Returns:
{sap.m.ViewSettingsItem} The removed sortItem or null
setBusy(bBusy): sap.m.ViewSettingsDialog
Forward the busy state setting to the internal dialog instance. Needed because of the not-bullet proof implementation of setBusy in sap.ui.core.Control
Parameters:
{boolean}bBusy The busy state flag
Returns:
{sap.m.ViewSettingsDialog} this Instance for chaining
setGroupDescending(bGroupDescending): sap.m.ViewSettingsDialog
Sets a new value for property groupDescending.

Determines whether the group order is descending or ascending (default).

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

Default value is false.

Parameters:
{boolean}bGroupDescending New value for property groupDescending
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
setSelectedFilterKeys(oSelectedFilterKeys): sap.m.ViewSettingsDialog
Sets the selected filter object in format {key: boolean}.
Parameters:
{object}oSelectedFilterKeys A configuration object with filter item and sub item keys in the format: { key: boolean }. Setting boolean to true will set the filter to true, false or omitting an entry will set the filter to false. It can be used to set the dialog state based on presets.
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
setSelectedGroupItem(vItemOrKey): sap.m.ViewSettingsDialog
Sets the selected group item (either by key or by item).
Parameters:
{sap.m.ViewSettingsItem|string}vItemOrKey The selected item or the item's key string
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
setSelectedPresetFilterItem(vItemOrKey): sap.m.ViewSettingsDialog
Sets the selected preset filter item.
Parameters:
{sap.m.ViewSettingsItem|string}vItemOrKey The selected item or the item's key string
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
setSelectedSortItem(vItemOrKey): sap.m.ViewSettingsDialog
Sets the selected sort item (either by key or by item).
Parameters:
{sap.m.ViewSettingsItem|string}vItemOrKey The selected item or the item's key string
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
setSortDescending(bSortDescending): sap.m.ViewSettingsDialog
Sets a new value for property sortDescending.

Determines whether the sort order is descending or ascending (default).

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

Default value is false.

Parameters:
{boolean}bSortDescending New value for property sortDescending
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
setTitle(sTitle): sap.m.ViewSettingsDialog
Sets the title of the internal dialog.
Parameters:
{string}sTitle The title text for the dialog
Returns:
{sap.m.ViewSettingsDialog} this pointer for chaining
unbindCustomTabs(): sap.m.ViewSettingsDialog
Unbinds aggregation customTabs from model data.
Since:
1.30
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
unbindFilterItems(): sap.m.ViewSettingsDialog
Unbinds aggregation filterItems from model data.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
unbindGroupItems(): sap.m.ViewSettingsDialog
Unbinds aggregation groupItems from model data.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
unbindPresetFilterItems(): sap.m.ViewSettingsDialog
Unbinds aggregation presetFilterItems from model data.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining
unbindSortItems(): sap.m.ViewSettingsDialog
Unbinds aggregation sortItems from model data.
Since:
1.16
Returns:
{sap.m.ViewSettingsDialog} Reference to this in order to allow method chaining