FIORI2.0-ViewSettingsDialog的应用

引言

ViewSettingsDialog帮助用户在(master)或者sapm . m中对数据进行排序、筛选或分组。或sap.m.Table列表。对话框由表工具栏中的图标按钮触发。每个按钮显示一个下拉列表图标。

---

Overview

ViewSettingsDialog是一个复合控件，由一个模态 sap.m.Popover 组成。弹出窗口和几个内部列表。在对话框中有三个不同的选项卡(排序、组、筛选)，它们可以通过填充相应的关联来激活。如果只填充了一个关联，那么其他选项卡将自动隐藏。所选选项可用于创建表的分类器和过滤器。

注意:如果应用程序不提供所有三种排序、过滤和分组功能，但只有其中一个(例如sort)，我们建议将图标按钮直接放置在工具栏中。不要在页脚工具栏中放置排序、过滤器或组按钮，如果它们引用了一个表。如果它们引用主列表，则在footer工具栏中放置组、排序和筛选按钮。

---

Usage

When to use?

如果您需要允许用户在可管理的列表或表中对行项进行排序(最多20列)
如果需要在可管理的列表或表中提供自定义筛选器设置(最多20列)
如果您需要允许用户将行项分组到可管理的列表或表中(最多20列)

When not to use?

如果您有复杂的表(超过20个列)
如果需要重新排列表中的列(使用sapm . m)。TablePersoDialog相反)
如果您需要非常特定的排序、过滤器或列排序选项在复杂的表中(使用sapm . m)。P13nDialog相反)

---

Constructor

new sap.m.ViewSettingsDialog(sId?, mSettings?)

ID为新控件，如果没有给出ID，则自动生成
mSettings 新控件的初始设置

---

Properties

title
sortDescending 确定排序顺序是下降还是上升(默认)。
groupDescending 确定组序是下行还是升序(默认)。
filterSearchOperator 提供一个字符串过滤器操作符，当用户在筛选器详细信息页面中搜索条目时使用。可能的操作符是:与之相关的，包含，StartsWith，等于。如果通过setFilterSearchCallback方法提供了自定义的回调，则该属性将被忽略

---

Aggregations（聚合）

sortItems 具有键值和值的项列表，可以进行排序(例如，表的列列表)。
groupItems 具有键值和值的项列表，可以进行排序(例如，表的列列表)。
filterItems 可以过滤的键和值的项列表(例如，表的列列表)。filterItem与一个或多个细节过滤器相关联。
presetFilterItems 允许选择更复杂或自定义过滤器的预设置筛选项列表。这些条目显示在filter选项卡的顶部。
customTabs 所有自定义选项卡的列表

---

Associations

selectedSortItem 选择的排序项。可以通过将键或项本身传递给函
数setSelectedSortItem来设置它。
selectedGroupItem
selectedPresetFilterItem

---

Events

summary

cancel 当按下取消按钮时调用。它可用于设置自定义筛选器控件的状态。
Param：（oControlEvent）
getSource
getParameters

confirm 指示用户已按下OK按钮，并将所选排序、组和筛选设置应用到该页面上的数据。
注意:自定义选项卡不会自动转换为事件参数。对于自定义选项卡，您必须在此事件的回调中读取控件的状态。
Param:(oControlEvent)
getSource
getParameters
sortItem 选择排序项
sortDescending 选择的排序顺序(true =下降，false =上行)。
groupItem 选择组项目
groupDescending
presetFilterItem 选择的预设过滤项
filterItems
filterKeys 所选的过滤项的对象表示法格式:{key:booler}。如果显示了自定义控制筛选器(例如，用户单击了过滤器项)，其密钥的值将设置为true，以表明已经与控件进行了交互。
filterCompoundKeys 在对象表示法中选择的筛选项:{parentKey:{key:boolean,key2:boolean，…},…}。如果显示了自定义控制筛选器(例如，用户单击了过滤器项)，其密钥的值将设置为true，以表明已经与控件进行了交互
filterString 所选的过滤项以字符串格式显示在控件的标题栏中，格式为:key(subkey1,subkey2,subkey3)。

filterDetailPageOpened 打开筛选器详细信息页面时触发。
Param（oControlEvent）
getSource
getParameters
parentFilterItem 打开详细信息的过滤项。

resetFilters 当按下复位过滤器按钮时调用。它可以用来清除自定义过滤器控件的状态。
Param（oControlEvent）
getSource
getParameters

---

Methods

• addCustomTab 覆盖聚集setter，以便将ID验证逻辑作为某些字符串保留到预定义选项卡中。

  addCustomTab(oCustomTab) : sap.m.ViewSettingsDialog
  oCustomTab 要添加的自定义选项卡

• addFilterItem 将一些filterItem添加到聚合过滤项
  addFilterItem(oFilterItem) : sap.m.ViewSettingsDialog
  oFilterItem filterItem添加;如果是空的，则不会插入任何内容

• addGroupItem
  添加一个组项，并设置关联以反映所选择的状态。

• addPresetFilterItem
  添加预设置筛选器项，并设置关联以反映所选择的状态。

• addSortItem 添加排序项并设置关联以反映所选择的状态。
  addSortItem(oItem) :sap.m.ViewSettingsDialog
  oItem 要添加到聚合中的项

• attachCancel 附加事件处理程序fnFunction sap.m.ViewSettingsDialog取消事件。
  调用时，事件处理程序的上下文(它的这个)将绑定到oListener(如果指定的话)，否则它将绑定到这个sap.m。ViewSettingsDialog本身。
  当按下取消按钮时调用。它可用于设置自定义筛选器控件的状态

• attachConfirm 附加事件处理程序fnFunction sap.m.ViewSettingsDialog证实事件。
  调用时，事件处理程序的上下文(它的这个)将绑定到oListener(如果指定的话)，否则它将绑定到这个sapm。ViewSettingsDialog本身。
  指示用户已按下OK按钮，并将所选排序、组和筛选设置应用到该页面上的数据。
  注意:自定义选项卡不会自动转换为事件参数。对于自定义选项卡，您必须在此事件的回调中读取控件的状态。

• attachFilterDetailPageOpened

• attachResetFilters

• bindCustomTabs 绑定聚合customTabs到模型数据。
  看到ManagedObject。关于oBindingInfo可能属性的详细描述的bindAggregation。

  bindCustomTabs(oBindingInfo) : sap.m.ViewSettingsDialog
  oBindingInfo 绑定信息

• bindFilterItems 绑定聚合过滤项到模型数据。
  看到ManagedObject。关于oBindingInfo可能属性的详细描述的bindAggregation。

• bindGroupItems

• bindPresetFilterItems

• bindSortItems 将聚合sortItems绑定到模型数据。
  看到ManagedObject。关于oBindingInfo可能属性的详细描述的bindAggregation。

  bindSortItems(oBindingInfo) : sap.m.ViewSettingsDialog
  oBindingInfo The binding information

• getCustomTabs 获取聚合定制选项卡的内容。 所有自定义选项卡的列表

• getGroupDescending 获取属性组下降的当前值。 确定组序是下行还是升序(默认)。 默认值是错误的。

• getSortItems 获取聚合sortItems的内容。 具有键值和值的项列表，可以进行排序(例如，表的列列表)。