@sap/ux-ui5-tooling 1.20.4 → 1.21.0

package/dist/preview-middleware/dist/client/adp/quick-actions/fe-v2/change-table-columns.js

@@ -0,0 +1,103 @@
+"use strict";
+
+sap.ui.define(["../../../utils/core", "../table-quick-action-base", "../dialog-enablement-validator", "../control-types"], function (_____utils_core, ___table_quick_action_base, ___dialog_enablement_validator, ___control_types) {
+  "use strict";
+
+  const getControlById = _____utils_core["getControlById"];
+  const isA = _____utils_core["isA"];
+  const TableQuickActionDefinitionBase = ___table_quick_action_base["TableQuickActionDefinitionBase"];
+  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
+  const M_TABLE_TYPE = ___control_types["M_TABLE_TYPE"];
+  const SMART_TABLE_TYPE = ___control_types["SMART_TABLE_TYPE"];
+  const CHANGE_TABLE_COLUMNS = 'change-table-columns';
+  const CONTROL_TYPES = [SMART_TABLE_TYPE];
+  class ChangeTableColumnsQuickAction extends TableQuickActionDefinitionBase {
+    constructor(context) {
+      super(CHANGE_TABLE_COLUMNS, CONTROL_TYPES, 'V2_QUICK_ACTION_CHANGE_TABLE_COLUMNS', context, {
+        includeServiceAction: true,
+        validatePageVariantManagement: true
+      }, [DIALOG_ENABLEMENT_VALIDATOR]);
+    }
+    async execute(path) {
+      const {
+        table,
+        iconTabBarFilterKey,
+        changeColumnActionId,
+        sectionInfo
+      } = this.tableMap[path];
+      if (!table) {
+        return [];
+      }
+      if (sectionInfo) {
+        const {
+          layout,
+          section,
+          subSection
+        } = sectionInfo;
+        layout?.setSelectedSection(section);
+        section.setSelectedSubSection(subSection);
+        this.selectOverlay(table);
+      } else {
+        getControlById(table.getId())?.getDomRef()?.scrollIntoView();
+        this.selectOverlay(table);
+      }
+      if (this.iconTabBar && iconTabBarFilterKey) {
+        this.iconTabBar.setSelectedKey(iconTabBarFilterKey);
+      }
+      if (changeColumnActionId) {
+        const executeAction = async () => await this.context.actionService.execute(table.getId(), changeColumnActionId);
+        if (isA(SMART_TABLE_TYPE, table)) {
+          await executeAction();
+        } else if (isA(M_TABLE_TYPE, table)) {
+          // if table is busy, i.e. lazy loading, then we subscribe to 'updateFinished' event and call action service when loading is done
+          // to avoid reopening the dialog after close
+          if (this.isTableLoaded(table)) {
+            await executeAction();
+          } else {
+            table.attachEventOnce('updateFinished', executeAction, this);
+          }
+        }
+      }
+      return [];
+    }
+    isAbsoluteAggregationBinding(element, aggregationName) {
+      const mBindingInfo = element.getBindingInfo(aggregationName);
+      const path = mBindingInfo?.path;
+      if (!path) {
+        return false;
+      }
+      return path.indexOf('/') === 0;
+    }
+
+    /**
+     * Checks if table is loaded and has binding context available.
+     * This is needed to properly render change columns dialog.
+     * Based on {@link https://github.com/SAP/openui5/blob/rel-1.127/src/sap.ui.fl/src/sap/ui/fl/write/_internal/delegates/ODataV2ReadDelegate.js#L269-L271| ODataV2ReadDelegate.getPropertyInfo}.
+     *
+     * @param element - Table control.
+     * @returns True if binding context is available.
+     */
+    isTableLoaded(element) {
+      const aggregationName = 'items';
+      if (this.isAbsoluteAggregationBinding(element, aggregationName)) {
+        const bindingInfo = element.getBindingInfo(aggregationName);
+        // check to be default model binding otherwise return undefined
+        if (typeof bindingInfo.model === 'string' && bindingInfo.model !== '') {
+          return false;
+        }
+        return bindingInfo.path !== undefined;
+      } else {
+        // here we explicitly request the default models binding context
+        const bindingContext = element.getBindingContext();
+        return !!bindingContext;
+      }
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.CHANGE_TABLE_COLUMNS = CHANGE_TABLE_COLUMNS;
+  __exports.ChangeTableColumnsQuickAction = ChangeTableColumnsQuickAction;
+  return __exports;
+});
+//# sourceMappingURL=change-table-columns.js.map

package/dist/preview-middleware/dist/client/adp/quick-actions/fe-v2/change-table-columns.ts

@@ -0,0 +1,105 @@
+import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
+import type Table from 'sap/m/Table';
+import type SmartTable from 'sap/ui/comp/smarttable/SmartTable';
+import type ManagedObject from 'sap/ui/base/ManagedObject';
+
+import type {
+    QuickActionContext,
+    NestedQuickActionDefinition
+} from '../../../cpe/quick-actions/quick-action-definition';
+import { getControlById, isA } from '../../../utils/core';
+import { TableQuickActionDefinitionBase } from '../table-quick-action-base';
+import { DIALOG_ENABLEMENT_VALIDATOR } from '../dialog-enablement-validator';
+import { M_TABLE_TYPE, SMART_TABLE_TYPE } from '../control-types';
+
+export const CHANGE_TABLE_COLUMNS = 'change-table-columns';
+const CONTROL_TYPES = [SMART_TABLE_TYPE];
+
+export class ChangeTableColumnsQuickAction
+    extends TableQuickActionDefinitionBase
+    implements NestedQuickActionDefinition
+{
+    constructor(context: QuickActionContext) {
+        super(
+            CHANGE_TABLE_COLUMNS,
+            CONTROL_TYPES,
+            'V2_QUICK_ACTION_CHANGE_TABLE_COLUMNS',
+            context,
+            {
+                includeServiceAction: true,
+                validatePageVariantManagement: true
+            },
+            [DIALOG_ENABLEMENT_VALIDATOR]
+        );
+    }
+    async execute(path: string): Promise<FlexCommand[]> {
+        const { table, iconTabBarFilterKey, changeColumnActionId, sectionInfo } = this.tableMap[path];
+        if (!table) {
+            return [];
+        }
+
+        if (sectionInfo) {
+            const { layout, section, subSection } = sectionInfo;
+            layout?.setSelectedSection(section);
+            section.setSelectedSubSection(subSection);
+            this.selectOverlay(table);
+        } else {
+            getControlById(table.getId())?.getDomRef()?.scrollIntoView();
+            this.selectOverlay(table);
+        }
+
+        if (this.iconTabBar && iconTabBarFilterKey) {
+            this.iconTabBar.setSelectedKey(iconTabBarFilterKey);
+        }
+        if (changeColumnActionId) {
+            const executeAction = async () =>
+                await this.context.actionService.execute(table.getId(), changeColumnActionId);
+            if (isA<SmartTable>(SMART_TABLE_TYPE, table)) {
+                await executeAction();
+            } else if (isA<Table>(M_TABLE_TYPE, table)) {
+                // if table is busy, i.e. lazy loading, then we subscribe to 'updateFinished' event and call action service when loading is done
+                // to avoid reopening the dialog after close
+                if (this.isTableLoaded(table)) {
+                    await executeAction();
+                } else {
+                    table.attachEventOnce('updateFinished', executeAction, this);
+                }
+            }
+        }
+
+        return [];
+    }
+
+    private isAbsoluteAggregationBinding(element: ManagedObject, aggregationName: string): boolean {
+        const mBindingInfo = element.getBindingInfo(aggregationName);
+        const path = mBindingInfo?.path;
+        if (!path) {
+            return false;
+        }
+        return path.indexOf('/') === 0;
+    }
+
+    /**
+     * Checks if table is loaded and has binding context available.
+     * This is needed to properly render change columns dialog.
+     * Based on {@link https://github.com/SAP/openui5/blob/rel-1.127/src/sap.ui.fl/src/sap/ui/fl/write/_internal/delegates/ODataV2ReadDelegate.js#L269-L271| ODataV2ReadDelegate.getPropertyInfo}.
+     *
+     * @param element - Table control.
+     * @returns True if binding context is available.
+     */
+    private isTableLoaded(element: ManagedObject): boolean {
+        const aggregationName = 'items';
+        if (this.isAbsoluteAggregationBinding(element, aggregationName)) {
+            const bindingInfo = element.getBindingInfo(aggregationName);
+            // check to be default model binding otherwise return undefined
+            if (typeof bindingInfo.model === 'string' && bindingInfo.model !== '') {
+                return false;
+            }
+            return bindingInfo.path !== undefined;
+        } else {
+            // here we explicitly request the default models binding context
+            const bindingContext = element.getBindingContext();
+            return !!bindingContext;
+        }
+    }
+}

package/dist/preview-middleware/dist/client/adp/quick-actions/fe-v2/create-table-action.js

@@ -0,0 +1,111 @@
+"use strict";
+
+sap.ui.define(["sap/ui/dt/OverlayRegistry", "../../../utils/core", "../../dialog-factory", "../table-quick-action-base", "../dialog-enablement-validator", "../control-types"], function (OverlayRegistry, _____utils_core, ____dialog_factory, ___table_quick_action_base, ___dialog_enablement_validator, ___control_types) {
+  "use strict";
+
+  const getControlById = _____utils_core["getControlById"];
+  const isA = _____utils_core["isA"];
+  const DialogFactory = ____dialog_factory["DialogFactory"];
+  const DialogNames = ____dialog_factory["DialogNames"];
+  const TableQuickActionDefinitionBase = ___table_quick_action_base["TableQuickActionDefinitionBase"];
+  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
+  const GRID_TABLE_TYPE = ___control_types["GRID_TABLE_TYPE"];
+  const M_TABLE_TYPE = ___control_types["M_TABLE_TYPE"];
+  const SMART_TABLE_TYPE = ___control_types["SMART_TABLE_TYPE"];
+  const TREE_TABLE_TYPE = ___control_types["TREE_TABLE_TYPE"];
+  const CREATE_TABLE_ACTION = 'create-table-action';
+  // maintain order if action id
+
+  const CONTROL_TYPES = [SMART_TABLE_TYPE, M_TABLE_TYPE, TREE_TABLE_TYPE, GRID_TABLE_TYPE];
+  class AddTableActionQuickAction extends TableQuickActionDefinitionBase {
+    constructor(context) {
+      super(CREATE_TABLE_ACTION, CONTROL_TYPES, 'QUICK_ACTION_ADD_CUSTOM_TABLE_ACTION', context, undefined, [DIALOG_ENABLEMENT_VALIDATOR]);
+    }
+    async initialize() {
+      const processChild = (child, mapKey) => {
+        const table = this.tableMap[mapKey]?.table;
+        if (table) {
+          const headerToolbar = this.getHeaderToolbar(table);
+          if (!headerToolbar) {
+            child.enabled = false;
+            child.tooltip = this.context.resourceBundle.getText('NO_TABLE_HEADER_TOOLBAR');
+          }
+        }
+        child.children.forEach((nestedChild, idx) => processChild(nestedChild, `${mapKey}/${idx.toFixed(0)}`));
+      };
+      await super.initialize();
+
+      // disable nested actions based on conditions
+      this.children.forEach((nestedChild, idx) => processChild(nestedChild, `${idx.toFixed(0)}`));
+    }
+    async execute(path) {
+      const {
+        table,
+        iconTabBarFilterKey,
+        sectionInfo
+      } = this.tableMap[path];
+      if (!table) {
+        return [];
+      }
+      if (sectionInfo) {
+        const {
+          layout,
+          section,
+          subSection
+        } = sectionInfo;
+        layout?.setSelectedSection(section);
+        section.setSelectedSubSection(subSection);
+        this.selectOverlay(table);
+      } else {
+        getControlById(table.getId())?.getDomRef()?.scrollIntoView();
+        this.selectOverlay(table);
+      }
+      if (this.iconTabBar && iconTabBarFilterKey) {
+        this.iconTabBar.setSelectedKey(iconTabBarFilterKey);
+      }
+      const headerToolbar = this.getHeaderToolbar(table);
+
+      // open dialogBox to add, and content is selected ByDefault
+      if (headerToolbar) {
+        const overlay = OverlayRegistry.getOverlay(headerToolbar) || [];
+        await DialogFactory.createDialog(overlay, this.context.rta, DialogNames.ADD_FRAGMENT, undefined, {
+          aggregation: 'content',
+          title: 'QUICK_ACTION_ADD_CUSTOM_TABLE_ACTION',
+          defaultAggregationArrayIndex: 1
+        }, {
+          actionName: this.type,
+          telemetryEventIdentifier: this.getTelemetryIdentifier()
+        });
+      }
+      return [];
+    }
+    getHeaderToolbar(table) {
+      let headerToolbar;
+      if (isA(SMART_TABLE_TYPE, table)) {
+        for (const item of table.getAggregation('items')) {
+          if (item.getAggregation('headerToolbar')) {
+            headerToolbar = item.getAggregation('headerToolbar');
+            break;
+          }
+          if (isA('sap.m.OverflowToolbar', item)) {
+            headerToolbar = item;
+            break;
+          }
+        }
+        if (!headerToolbar) {
+          headerToolbar = table.getToolbar();
+        }
+      } else if (isA(M_TABLE_TYPE, table)) {
+        headerToolbar = table.getAggregation('headerToolbar');
+      }
+      return headerToolbar;
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.CREATE_TABLE_ACTION = CREATE_TABLE_ACTION;
+  __exports.AddTableActionQuickAction = AddTableActionQuickAction;
+  return __exports;
+});
+//# sourceMappingURL=create-table-action.js.map

package/dist/preview-middleware/dist/client/adp/quick-actions/fe-v2/create-table-action.ts

@@ -0,0 +1,110 @@
+import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
+import type Table from 'sap/m/Table';
+import type SmartTable from 'sap/ui/comp/smarttable/SmartTable';
+import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
+import type ManagedObject from 'sap/ui/base/ManagedObject';
+import type UI5Element from 'sap/ui/core/Element';
+
+import { QuickActionContext, NestedQuickActionDefinition } from '../../../cpe/quick-actions/quick-action-definition';
+import { getControlById, isA } from '../../../utils/core';
+import { DialogFactory, DialogNames } from '../../dialog-factory';
+import { TableQuickActionDefinitionBase } from '../table-quick-action-base';
+import { DIALOG_ENABLEMENT_VALIDATOR } from '../dialog-enablement-validator';
+import type OverflowToolbar from 'sap/m/OverflowToolbar';
+import { NestedQuickActionChild } from '@sap-ux-private/control-property-editor-common';
+import { GRID_TABLE_TYPE, M_TABLE_TYPE, SMART_TABLE_TYPE, TREE_TABLE_TYPE } from '../control-types';
+
+export const CREATE_TABLE_ACTION = 'create-table-action';
+// maintain order if action id
+
+const CONTROL_TYPES = [SMART_TABLE_TYPE, M_TABLE_TYPE, TREE_TABLE_TYPE, GRID_TABLE_TYPE];
+
+export class AddTableActionQuickAction extends TableQuickActionDefinitionBase implements NestedQuickActionDefinition {
+    constructor(context: QuickActionContext) {
+        super(CREATE_TABLE_ACTION, CONTROL_TYPES, 'QUICK_ACTION_ADD_CUSTOM_TABLE_ACTION', context, undefined, [
+            DIALOG_ENABLEMENT_VALIDATOR
+        ]);
+    }
+
+    async initialize(): Promise<void> {
+        const processChild = (child: NestedQuickActionChild, mapKey: string) => {
+            const table = this.tableMap[mapKey]?.table;
+            if (table) {
+                const headerToolbar = this.getHeaderToolbar(table);
+                if (!headerToolbar) {
+                    child.enabled = false;
+                    child.tooltip = this.context.resourceBundle.getText('NO_TABLE_HEADER_TOOLBAR');
+                }
+            }
+
+            child.children.forEach((nestedChild, idx) => processChild(nestedChild, `${mapKey}/${idx.toFixed(0)}`));
+        };
+
+        await super.initialize();
+
+        // disable nested actions based on conditions
+        this.children.forEach((nestedChild, idx) => processChild(nestedChild, `${idx.toFixed(0)}`));
+    }
+    async execute(path: string): Promise<FlexCommand[]> {
+        const { table, iconTabBarFilterKey, sectionInfo } = this.tableMap[path];
+        if (!table) {
+            return [];
+        }
+
+        if (sectionInfo) {
+            const { layout, section, subSection } = sectionInfo;
+            layout?.setSelectedSection(section);
+            section.setSelectedSubSection(subSection);
+            this.selectOverlay(table);
+        } else {
+            getControlById(table.getId())?.getDomRef()?.scrollIntoView();
+            this.selectOverlay(table);
+        }
+
+        if (this.iconTabBar && iconTabBarFilterKey) {
+            this.iconTabBar.setSelectedKey(iconTabBarFilterKey);
+        }
+
+        const headerToolbar = this.getHeaderToolbar(table);
+
+        // open dialogBox to add, and content is selected ByDefault
+        if (headerToolbar) {
+            const overlay = OverlayRegistry.getOverlay(headerToolbar as UI5Element) || [];
+            await DialogFactory.createDialog(
+                overlay,
+                this.context.rta,
+                DialogNames.ADD_FRAGMENT,
+                undefined,
+                {
+                    aggregation: 'content',
+                    title: 'QUICK_ACTION_ADD_CUSTOM_TABLE_ACTION',
+                    defaultAggregationArrayIndex: 1
+                },
+                { actionName: this.type, telemetryEventIdentifier: this.getTelemetryIdentifier() }
+            );
+        }
+        return [];
+    }
+
+    getHeaderToolbar(table: UI5Element): ManagedObject | ManagedObject[] | OverflowToolbar | null | undefined {
+        let headerToolbar;
+        if (isA<SmartTable>(SMART_TABLE_TYPE, table)) {
+            for (const item of table.getAggregation('items') as ManagedObject[]) {
+                if (item.getAggregation('headerToolbar')) {
+                    headerToolbar = item.getAggregation('headerToolbar');
+                    break;
+                }
+                if (isA<OverflowToolbar>('sap.m.OverflowToolbar', item)) {
+                    headerToolbar = item;
+                    break;
+                }
+            }
+            if (!headerToolbar) {
+                headerToolbar = table.getToolbar();
+            }
+        } else if (isA<Table>(M_TABLE_TYPE, table)) {
+            headerToolbar = table.getAggregation('headerToolbar');
+        }
+        return headerToolbar;
+    }
+}

package/dist/preview-middleware/dist/client/adp/quick-actions/fe-v2/create-table-custom-column.js

@@ -0,0 +1,108 @@
+"use strict";
+
+sap.ui.define(["sap/ui/dt/OverlayRegistry", "../../../utils/core", "../../dialog-factory", "../control-types", "../table-quick-action-base", "../dialog-enablement-validator", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../../../utils/info-center-message"], function (OverlayRegistry, _____utils_core, ____dialog_factory, ___control_types, ___table_quick_action_base, ___dialog_enablement_validator, ___sap_ux_private_control_property_editor_common, _____utils_info_center_message) {
+  "use strict";
+
+  const getControlById = _____utils_core["getControlById"];
+  const isA = _____utils_core["isA"];
+  const DialogNames = ____dialog_factory["DialogNames"];
+  const DialogFactory = ____dialog_factory["DialogFactory"];
+  const ANALYTICAL_TABLE_TYPE = ___control_types["ANALYTICAL_TABLE_TYPE"];
+  const GRID_TABLE_TYPE = ___control_types["GRID_TABLE_TYPE"];
+  const M_TABLE_TYPE = ___control_types["M_TABLE_TYPE"];
+  const SMART_TABLE_TYPE = ___control_types["SMART_TABLE_TYPE"];
+  const TREE_TABLE_TYPE = ___control_types["TREE_TABLE_TYPE"];
+  const TableQuickActionDefinitionBase = ___table_quick_action_base["TableQuickActionDefinitionBase"];
+  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
+  const sendInfoCenterMessage = _____utils_info_center_message["sendInfoCenterMessage"];
+  const CREATE_TABLE_CUSTOM_COLUMN = 'create-table-custom-column';
+  const CONTROL_TYPES = [SMART_TABLE_TYPE, M_TABLE_TYPE, TREE_TABLE_TYPE, GRID_TABLE_TYPE];
+
+  /**
+   * Reusable function which performs some preparation steps before table action execution
+   *
+   * @param table - table element
+   * @param sectionInfo - section data
+   * @param iconTabBar - icon tab bar element
+   * @param iconTabBarFilterKey - tab bar key to select a tab
+   */
+  function preprocessActionExecution(table, sectionInfo, iconTabBar, iconTabBarFilterKey) {
+    if (sectionInfo) {
+      const {
+        layout,
+        section,
+        subSection
+      } = sectionInfo;
+      layout?.setSelectedSection(section);
+      section.setSelectedSubSection(subSection);
+    } else {
+      getControlById(table.getId())?.getDomRef()?.scrollIntoView();
+    }
+    if (iconTabBar && iconTabBarFilterKey) {
+      iconTabBar.setSelectedKey(iconTabBarFilterKey);
+    }
+  }
+  class AddTableCustomColumnQuickAction extends TableQuickActionDefinitionBase {
+    constructor(context) {
+      super(CREATE_TABLE_CUSTOM_COLUMN, CONTROL_TYPES, 'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN', context, {
+        areTableRowsRequired: true
+      }, [DIALOG_ENABLEMENT_VALIDATOR]);
+    }
+    async execute(path) {
+      const {
+        table,
+        iconTabBarFilterKey,
+        sectionInfo
+      } = this.tableMap[path];
+      if (!table) {
+        return [];
+      }
+      preprocessActionExecution(table, sectionInfo, this.iconTabBar, iconTabBarFilterKey);
+      this.selectOverlay(table);
+      let tableInternal = table;
+      if (isA(SMART_TABLE_TYPE, table)) {
+        const itemsAggregation = table.getAggregation('items');
+        tableInternal = itemsAggregation.find(item => {
+          return [M_TABLE_TYPE, TREE_TABLE_TYPE, ANALYTICAL_TABLE_TYPE, GRID_TABLE_TYPE].some(tType => isA(tType, item));
+        });
+        if (!tableInternal) {
+          return [];
+        }
+      }
+      const overlay = OverlayRegistry.getOverlay(tableInternal) || [];
+      if (!overlay) {
+        return [];
+      }
+      if (isA(M_TABLE_TYPE, tableInternal) && tableInternal.getAggregation('items').length === 0) {
+        await sendInfoCenterMessage({
+          title: {
+            key: 'ADP_CREATE_XML_FRAGMENT_TITLE'
+          },
+          description: {
+            key: 'TABLE_ROWS_NEEDED_TO_CREATE_CUSTOM_COLUMN'
+          },
+          type: MessageBarType.error
+        });
+        return [];
+      }
+      const dialog = [TREE_TABLE_TYPE, ANALYTICAL_TABLE_TYPE, GRID_TABLE_TYPE].some(type => isA(type, tableInternal)) ? DialogNames.ADD_FRAGMENT : DialogNames.ADD_TABLE_COLUMN_FRAGMENTS;
+      await DialogFactory.createDialog(overlay, this.context.rta, dialog, undefined, {
+        aggregation: 'columns',
+        title: 'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN'
+      }, {
+        actionName: this.type,
+        telemetryEventIdentifier: this.getTelemetryIdentifier()
+      });
+      return [];
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.CREATE_TABLE_CUSTOM_COLUMN = CREATE_TABLE_CUSTOM_COLUMN;
+  __exports.preprocessActionExecution = preprocessActionExecution;
+  __exports.AddTableCustomColumnQuickAction = AddTableCustomColumnQuickAction;
+  return __exports;
+});
+//# sourceMappingURL=create-table-custom-column.js.map

package/dist/preview-middleware/dist/client/adp/quick-actions/fe-v2/create-table-custom-column.ts

@@ -0,0 +1,141 @@
+import type ManagedObject from 'sap/ui/base/ManagedObject';
+import type UI5Element from 'sap/ui/core/Element';
+
+import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
+import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
+
+import type ObjectPageSection from 'sap/uxap/ObjectPageSection';
+import type ObjectPageSubSection from 'sap/uxap/ObjectPageSubSection';
+import type ObjectPageLayout from 'sap/uxap/ObjectPageLayout';
+
+import type IconTabBar from 'sap/m/IconTabBar';
+
+import type SmartTable from 'sap/ui/comp/smarttable/SmartTable';
+
+import { QuickActionContext, NestedQuickActionDefinition } from '../../../cpe/quick-actions/quick-action-definition';
+import { getControlById, isA } from '../../../utils/core';
+import { DialogNames, DialogFactory } from '../../dialog-factory';
+import {
+    ANALYTICAL_TABLE_TYPE,
+    GRID_TABLE_TYPE,
+    M_TABLE_TYPE,
+    SMART_TABLE_TYPE,
+    TREE_TABLE_TYPE
+} from '../control-types';
+import { TableQuickActionDefinitionBase } from '../table-quick-action-base';
+import { DIALOG_ENABLEMENT_VALIDATOR } from '../dialog-enablement-validator';
+import { MessageBarType } from '@sap-ux-private/control-property-editor-common';
+import { sendInfoCenterMessage } from '../../../utils/info-center-message';
+
+export const CREATE_TABLE_CUSTOM_COLUMN = 'create-table-custom-column';
+
+const CONTROL_TYPES = [SMART_TABLE_TYPE, M_TABLE_TYPE, TREE_TABLE_TYPE, GRID_TABLE_TYPE];
+
+/**
+ * Reusable function which performs some preparation steps before table action execution
+ *
+ * @param table - table element
+ * @param sectionInfo - section data
+ * @param iconTabBar - icon tab bar element
+ * @param iconTabBarFilterKey - tab bar key to select a tab
+ */
+export function preprocessActionExecution(
+    table: UI5Element,
+    sectionInfo:
+        | {
+              section: ObjectPageSection;
+              subSection: ObjectPageSubSection;
+              layout?: ObjectPageLayout;
+          }
+        | undefined,
+    iconTabBar: IconTabBar | undefined,
+    iconTabBarFilterKey: string | undefined
+) {
+    if (sectionInfo) {
+        const { layout, section, subSection } = sectionInfo;
+        layout?.setSelectedSection(section);
+        section.setSelectedSubSection(subSection);
+    } else {
+        getControlById(table.getId())?.getDomRef()?.scrollIntoView();
+    }
+
+    if (iconTabBar && iconTabBarFilterKey) {
+        iconTabBar.setSelectedKey(iconTabBarFilterKey);
+    }
+}
+
+export class AddTableCustomColumnQuickAction
+    extends TableQuickActionDefinitionBase
+    implements NestedQuickActionDefinition
+{
+    constructor(context: QuickActionContext) {
+        super(
+            CREATE_TABLE_CUSTOM_COLUMN,
+            CONTROL_TYPES,
+            'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN',
+            context,
+            {
+                areTableRowsRequired: true
+            },
+            [DIALOG_ENABLEMENT_VALIDATOR]
+        );
+    }
+
+    async execute(path: string): Promise<FlexCommand[]> {
+        const { table, iconTabBarFilterKey, sectionInfo } = this.tableMap[path];
+        if (!table) {
+            return [];
+        }
+
+        preprocessActionExecution(table, sectionInfo, this.iconTabBar, iconTabBarFilterKey);
+        this.selectOverlay(table);
+
+        let tableInternal: ManagedObject | undefined = table;
+        if (isA<SmartTable>(SMART_TABLE_TYPE, table)) {
+            const itemsAggregation = table.getAggregation('items') as ManagedObject[];
+            tableInternal = itemsAggregation.find((item) => {
+                return [M_TABLE_TYPE, TREE_TABLE_TYPE, ANALYTICAL_TABLE_TYPE, GRID_TABLE_TYPE].some((tType) =>
+                    isA(tType, item)
+                );
+            });
+            if (!tableInternal) {
+                return [];
+            }
+        }
+
+        const overlay = OverlayRegistry.getOverlay(tableInternal as UI5Element) || [];
+        if (!overlay) {
+            return [];
+        }
+
+        if (
+            isA(M_TABLE_TYPE, tableInternal) &&
+            (tableInternal.getAggregation('items') as ManagedObject[]).length === 0
+        ) {
+            await sendInfoCenterMessage({
+                title: { key: 'ADP_CREATE_XML_FRAGMENT_TITLE' },
+                description: { key: 'TABLE_ROWS_NEEDED_TO_CREATE_CUSTOM_COLUMN' },
+                type: MessageBarType.error
+            });
+            return [];
+        }
+        const dialog = [TREE_TABLE_TYPE, ANALYTICAL_TABLE_TYPE, GRID_TABLE_TYPE].some((type) =>
+            isA(type, tableInternal)
+        )
+            ? DialogNames.ADD_FRAGMENT
+            : DialogNames.ADD_TABLE_COLUMN_FRAGMENTS;
+        await DialogFactory.createDialog(
+            overlay,
+            this.context.rta,
+            dialog,
+            undefined,
+            {
+                aggregation: 'columns',
+                title: 'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN'
+            },
+            { actionName: this.type, telemetryEventIdentifier: this.getTelemetryIdentifier() }
+        );
+
+        return [];
+    }
+}