Fiori elements 特性全集演示 · 通用特性

项目

内容

官方仓库

SAP-samples/fiori-elements-feature-showcase

业务场景

用一套可运行的应用演示 Fiori elements 的每一种表格、表单与页面特性

技术栈

SAP Fiori elements for OData V4、SAPUI5、注解(annotation)、灵活编程模型

对应课程

UX405、UX406、UX410、UX400

对应路径

第 3 条 开发 SAPUI5 应用

为什么值得做:Fiori elements 的能力边界靠文档很难建立直觉。 这个仓库把特性做成可点开的界面,点一下就知道某个注解会产生什么效果。

动手要点:

  • 把应用跑起来,逐个对照 annotations.cds —— 改一个注解,刷新看变化。

  • 这个「改注解看效果」的循环,是掌握 Fiori elements 最快的路径。

本页内容抓取自官方仓库 SAP-samples/fiori-elements-feature-showcase,共收录 1 篇官方文档(README 与 docs)。原仓库内容版权归 SAP SE,遵循其许可证。

General Features

灵活列布局(Flexible Column Layout)

灵活列布局(FCL)让应用可以在同一页面上把对象页(Object Page)、甚至再一个对象页显示在列表报表(List Report)旁边, 而不必跳转到下一页。 要启用灵活列布局,请使用 SAP Fiori tools 的 Application Modeler;该设置位于 Page Map 中的 Global Page Settings 下。

配置草稿(Draft)

搜索词:#Draft

注解 @odata.draft.enabled 为实体启用草稿模式。

annotate srv.RootEntities with @odata.draft.enabled;

替换标准 UI 文本

搜索词:"enhanceI18n"

如果需要,可以替换标准 UI 文本。 为此需要一个新的 i18n 文件(例如 customI18N.properties),然后在 manifest.json 文件中引用它。

"RootEntityListReport": {
    ...
    "options": {
        "settings": {
            ...
            "enhanceI18n": "i18n/customI18N.properties",
            ...
        }
    }
},

可以针对所有实体替换,也可以针对特定实体、或特定实体的特定操作替换。

  • C_COMMON_DIALOG_OK 是所有实体的键。

  • C_TRANSACTION_HELPER_OBJECT_PAGE_CONFIRM_DELETE_WITH_OBJECTTITLE_SINGULAR|RootEntities 是「RootEntities」实体的键。

  • C_OPERATIONS_ACTION_CONFIRM_MESSAGE|RootEntities|criticalAction 是「RootEntities」实体的「criticalAction」操作的键。

C_COMMON_ACTION_PARAMETER_DIALOG_CANCEL|RootEntities = Custom cancel text

关于替换标准 UI 文本以及哪些内容可被覆盖的更多信息,见 SAP Fiori elements 文档。

自定义操作(Custom Actions)

搜索词:CustomActions

借助扩展点,可以在 UI 的不同位置添加自定义前端操作。自定义操作添加到 manifest.json 文件; 添加位置取决于该操作要显示在 UI 的哪里。 一般来说,一个自定义操作由该操作的唯一限定名(qualifier)组成。属性 press 是 JavaScript 文件中事件处理器的路径。 enabled 与 visible 两个属性既接受静态值(true/false),也接受绑定路径(如示例所示),或另一个返回 true/false 的 JavaScript 函数路径。text 属性是按钮的标签。

"CustomActionSection" : {
    "press": "sap.fe.showcase.lrop.ext.CustomActions.messageBox",
    "enabled": "{= ${ui>/editMode} !== 'Editable'}",
    "visible" : true,
    "text": "{i18n>CustomActionSection}"
}

下面的代码片段是示例中的列表报表扩展控制器文件。enabled 与 enabledForSingleSelect 是 enabled 属性可用的函数。

...
export default class RootEntityLRExtension extends ControllerExtension<ExtensionAPI> {
  messageBox() {
      MessageBox.alert("Button pressed");
  }
  enabled() {
      return true;
  }
  enabledForSingleSelect(oBindingContext: ODataContextBinding, aSelectedContexts: [Context]) {
      if (aSelectedContexts && aSelectedContexts.length === 1) {
          return true;
      }
      return false;
  }
}

从自定义操作调用 CAP 操作

搜索词:#EditFlowAPI

也可以从 JavaScript 函数中,借助 SAP Fiori elements Edit-flow API 的 invokeAction 函数调用 CAP 操作。

...
export default class RootEntityOPExtension extends ControllerExtension<ExtensionAPI> {
    ...

    //Search-Term: #EditFlowAPI
    onChangeCriticality(oEvent: Button$PressEvent) {
        let sActionName = "LROPODataService.changeCriticality";
        this.base.getExtensionAPI().getEditFlow().invokeAction(sActionName, {
            contexts: oEvent.getSource().getBindingContext()! as Context,
            model: oEvent.getSource().getModel() as ODataModel,
            label: 'Confirm',
            invocationGrouping: "ChangeSet"
        }); //SAP Fiori elements EditFlow API
    }
}

默认排序与筛选

搜索词(以下关键词均可在官方仓库中搜索到示例):"defaultTemplateAnnotationPath"、#DefaultSortFilter

通过指定 @UI.SelectionPresentationVariant 并在 manifest 中引用它,可以应用高级的默认筛选与排序。只能引用 @UI.SelectionPresentationVariant。

"OrdersList": {
    ...
    "options": {
        "settings": {
            "contextPath": "/Orders",
            "defaultTemplateAnnotationPath": "com.sap.vocabularies.UI.v1.SelectionPresentationVariant#DefaultFilter",
            ...
        }
    }
}

当作用于工作清单(WorkList)时,SelectionVariant 部分会被忽略。

更多信息见 SAP UI5 文档。