@sapui5/sap.fe.templates 1.103.0 → 1.104.1

package/src/sap/fe/templates/ListReport/ListReportController.controller.ts

@@ -23,7 +23,8 @@ import {
 	usingExtension
 } from "sap/fe/core/helpers/ClassSupport";
 import EditState from "sap/fe/core/helpers/EditState";
-import type { InternalModelContext } from "sap/fe/core/helpers/ModelHelper";
+import MessageStrip from "sap/fe/core/helpers/MessageStrip";
+import { InternalModelContext } from "sap/fe/core/helpers/ModelHelper";
 import CoreLibrary from "sap/fe/core/library";
 import PageController from "sap/fe/core/PageController";
 import ChartRuntime from "sap/fe/macros/chart/ChartRuntime";
@@ -31,14 +32,12 @@ import ChartUtils from "sap/fe/macros/chart/ChartUtils";
 import CommonHelper from "sap/fe/macros/CommonHelper";
 import DelegateUtil from "sap/fe/macros/DelegateUtil";
 import FilterUtils from "sap/fe/macros/filter/FilterUtils";
-import TableUtils from "sap/fe/macros/table/Utils";
+import MultipleModeControl from "sap/fe/templates/ListReport/controls/MultipleModeControl";
 import ExtensionAPI from "sap/fe/templates/ListReport/ExtensionAPI";
 import EditFlowOverrides from "sap/fe/templates/RootContainer/overrides/EditFlow";
 import TableScroller from "sap/fe/templates/TableScroller";
-import type IconTabBar from "sap/m/IconTabBar";
 import type SegmentedButton from "sap/m/SegmentedButton";
 import type Control from "sap/ui/core/Control";
-import Core from "sap/ui/core/Core";
 import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
 import { system } from "sap/ui/Device";
 import ControlPersonalizationWriteAPI from "sap/ui/fl/write/api/ControlPersonalizationWriteAPI";
@@ -115,21 +114,7 @@ class ListReportController extends PageController {
 
 	onInit() {
 		PageController.prototype.onInit.apply(this);
-		const aControls = this._getControls();
 		const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
-		if (this._isMultiMode()) {
-			const oMultiModeTab = this._getMultiModeControl();
-			oInternalModelContext.setProperty("tabs", {
-				selected: oMultiModeTab.getSelectedKey() || (oMultiModeTab.getItems()[0] as any).getKey()
-			});
-			aControls.forEach((oControl: any) => {
-				const oUpdateCounts = () => {
-					this._updateCounts();
-				};
-				CommonUtils.addEventToBindingInfo(oControl, "dataRequested", oUpdateCounts);
-			});
-		}
-		//TODO: This is only a temporary approach and will be removed once app state behaviour is finalized.
 
 		oInternalModelContext.setProperty("hasPendingFilters", true);
 		oInternalModelContext.setProperty("appliedFilters", "");
@@ -155,10 +140,6 @@ class ListReportController extends PageController {
 		// happen after the routeMatch event has been processed (otherwise the router gets broken)
 		this.getAppComponent().getRouterProxy().waitForRouteMatchBeforeNavigation();
 
-		if (this._isMultiMode()) {
-			this._updateMultiControlHiddenStatus();
-		}
-
 		// Configure the initial load settings
 		this._setInitLoad();
 	}
@@ -175,6 +156,8 @@ class ListReportController extends PageController {
 	_onAfterBinding() {
 		const aTables = this._getControls("table");
 		if (EditState.isEditStateDirty()) {
+			const oMultiModeControl = this._getMultiModeControl();
+			oMultiModeControl?.invalidateContent();
 			const oTableBinding = this._getTableBinding();
 			if (oTableBinding) {
 				if (CommonUtils.getAppComponent(this.getView())._isFclEnabled()) {
@@ -184,11 +167,6 @@ class ListReportController extends PageController {
 					if (!this.sUpdateTimer) {
 						this.sUpdateTimer = setTimeout(() => {
 							oTableBinding.refresh();
-							if (this._isMultiMode()) {
-								this._invalidateMultipleModeContent();
-								this._setCountsOutDated();
-								this._updateCounts();
-							}
 							delete this.sUpdateTimer;
 						}, 0);
 					}
@@ -403,7 +381,7 @@ class ListReportController extends PageController {
 	}
 
 	_getMultiModeControl() {
-		return this.getView().byId("fe::TabMultipleMode") as IconTabBar;
+		return this.getView().byId("fe::TabMultipleMode::Control") as MultipleModeControl;
 	}
 
 	_getTableControlId() {
@@ -412,7 +390,7 @@ class ListReportController extends PageController {
 
 	_getCurrentControl(): Control {
 		if (!this._oListReportControl) {
-			const oMultiModeTab = this._getMultiModeControl();
+			const oMultiModeTab = this._getMultiModeControl().content;
 			this._oListReportControl = this.getView().byId(
 				oMultiModeTab.getSelectedKey() || (oMultiModeTab.getItems()[0] as any).getKey()
 			) as Control;
@@ -440,7 +418,7 @@ class ListReportController extends PageController {
 	_getControls(sKey?: any) {
 		if (this._isMultiMode()) {
 			const aControls: any[] = [];
-			const oTabMultiMode = this._getMultiModeControl();
+			const oTabMultiMode = this._getMultiModeControl().content;
 			oTabMultiMode.getItems().forEach((oItem: any) => {
 				const oControl = this.getView().byId(oItem.getKey());
 				if (oControl && sKey) {
@@ -500,17 +478,6 @@ class ListReportController extends PageController {
 		return initLoadMode === InitialLoadMode.Enabled;
 	}
 
-	/**
-	 * Method to know if ListReport is configured with Multiple EntitySets.
-	 *
-	 * @function
-	 * @name _isMultiEntitySets
-	 * @returns Is Multiple EntitySets configuration?
-	 */
-	_isMultiEntitySets() {
-		return this.getView().getContent()[0].data("isMultiEntitySets") === "true";
-	}
-
 	_hasMultiVisualizations() {
 		return this.getView().getContent()[0].data("hasMultiVisualizations") === "true";
 	}
@@ -588,68 +555,6 @@ class ListReportController extends PageController {
 		oTemplatePrivateModel.setProperty("/listReport/share", oShareInfo);
 	}
 
-	/**
-	 * Hidden tables must be marked as hidden to avoid sending
-	 * requests when FilterBar is changed or LR is initialized
-	 * Best workflow would be to suspend table binding but
-	 * if the user switch quickly between tabs the batch response of previous
-	 * is received when previous tab is already disabled (binding is suspended) and
-	 * generates error.
-	 * A temporary solution (if we find better workflow) is to set a customData and don't trigger
-	 * rebindTable if this customData is set to true.
-	 */
-	_updateMultiControlHiddenStatus() {
-		const oDisplayedControl = this._getCurrentControl();
-		if (this._isMultiMode() && oDisplayedControl) {
-			const sDisplayControlId = oDisplayedControl.getId();
-			const aControls = this._getControls();
-			aControls.forEach(function (oControl: any) {
-				const sControlId = oControl.getId();
-				oControl.data("controlHidden", sControlId !== sDisplayControlId);
-			});
-		}
-	}
-
-	/**
-	 * Method to update the local UI model of the page with the fields that are not applicable to the filter bar (this is specific to the multiple table scenario).
-	 *
-	 * @param oInternalModelContext The internal model context
-	 * @param oFilterBar MDC filter bar
-	 */
-	_updateMultiTabNotApplicableFields(oInternalModelContext: InternalModelContext, oFilterBar: FilterBar) {
-		const mCache: any = {};
-		const ignoredFields: any = {},
-			ignoredFieldsTitle: any = {},
-			aTables = this._getControls("table"),
-			aCharts = this._getControls("Chart");
-		aTables.forEach((oTable: any) => {
-			const sTableEntityPath = oTable.data("targetCollectionPath"),
-				sTableEntitySet = sTableEntityPath.slice(1),
-				sTabId = oTable.getParent().getParent().getKey(),
-				sTabTitle = oTable.getParent().getParent().getText(),
-				sCacheKey = sTableEntitySet + (oTable.data("enableAnalytics") === "true" ? "Analytical" : "Regular");
-			if (!mCache[sCacheKey]) {
-				mCache[sCacheKey] = FilterUtils.getNotApplicableFilters(oFilterBar, oTable);
-			}
-			ignoredFields[sTabId] = mCache[sCacheKey];
-			ignoredFieldsTitle[sTabId] = this.formatters.setTabMessageStrip.call(this, mCache[sCacheKey], sTabTitle, "false", {});
-		});
-		aCharts.forEach((oChart: any) => {
-			const sChartEntityPath = oChart.data("targetCollectionPath"),
-				sChartEntitySet = sChartEntityPath.slice(1),
-				sTabId = oChart.getParent().getParent().getKey(),
-				sTabTitle = oChart.getParent().getParent().getText(),
-				sCacheKey = `${sChartEntitySet}Chart`;
-			if (!mCache[sCacheKey]) {
-				mCache[sCacheKey] = FilterUtils.getNotApplicableFilters(oFilterBar, oChart);
-			}
-			ignoredFields[sTabId] = mCache[sCacheKey];
-			ignoredFieldsTitle[sTabId] = this.formatters.setTabMessageStrip.call(this, mCache[sCacheKey], sTabTitle, "false", {});
-		});
-		oInternalModelContext.setProperty("tabs/ignoredFields", ignoredFields);
-		oInternalModelContext.setProperty("tabs/ignoredFieldsTitle", ignoredFieldsTitle);
-	}
-
 	/**
 	 * Method to update the local UI model of the page with the fields that are not applicable to the filter bar (this is specific to the ALP scenario).
 	 *
@@ -685,11 +590,6 @@ class ListReportController extends PageController {
 		this._oListReportControl = undefined;
 		this._getCurrentControl();
 	}
-
-	_updateCounts() {
-		this._updateMultiModeCounts();
-	}
-
 	/**
 	 * Method to determine if a tab from the list report is a custom tab.
 	 *
@@ -698,75 +598,7 @@ class ListReportController extends PageController {
 	 * @returns Determines if the tab is a custom tab.
 	 */
 	_isCustomTab() {
-		const oMultiModeControl = this._getMultiModeControl();
-		return oMultiModeControl && oMultiModeControl.getSelectedKey().indexOf("::CustomTab::") > -1;
-	}
-
-	_setCountsOutDated() {
-		const oMultiModeControl = this._getMultiModeControl();
-		if (oMultiModeControl && oMultiModeControl.data("showCounts") === "true") {
-			const aItems = oMultiModeControl.getItems();
-			aItems.forEach(function (oItem: any) {
-				if (oItem.getKey().indexOf("fe::Chart") === -1) {
-					oItem.data("outdatedCounts", true);
-				}
-			});
-		}
-	}
-	_invalidateMultipleModeContent() {
-		const aControls = this._getControls();
-		const sDisplayedControlId = this._getCurrentControl().getId();
-		aControls.forEach(function (oControl: any) {
-			oControl.data("outdatedRows", oControl.getId() !== sDisplayedControlId);
-		});
-	}
-
-	_updateMultiModeCounts() {
-		let aBindingPromises = [];
-		const oMultiModeControl = this._getMultiModeControl();
-		if (oMultiModeControl && oMultiModeControl.data("showCounts") === "true" && !this._isCustomTab()) {
-			const oDisplayedControl = this._getCurrentControl();
-			const sDisplayedControlId = oDisplayedControl.getId();
-			const aCompliantTabs: any[] = [];
-			const aItems = oMultiModeControl.getItems();
-			aItems.forEach((oItem: any) => {
-				if (oItem.getProperty("visible")) {
-					const oControl = this.getView().byId(oItem.getKey());
-					if (
-						oControl &&
-						!oControl.isA("sap.ui.mdc.Chart") &&
-						(oItem.data("outdatedCounts") || oControl.getId() === sDisplayedControlId)
-					) {
-						aCompliantTabs.push({
-							control: oControl,
-							item: oItem
-						});
-					}
-				}
-			});
-
-			aBindingPromises = aCompliantTabs.map((mTab: any) => {
-				mTab.item.setCount("...");
-				const oControl = mTab.control;
-				const oFilterInfos = TableUtils.getFiltersInfoForSV(oControl, mTab.item.data("selectionVariant")) as any;
-				return TableUtils.getListBindingForCount(oControl, this.getView().getBindingContext(), {
-					batchGroupId: oControl.getId() === sDisplayedControlId ? oControl.data("batchGroupId") : "$auto",
-					additionalFilters: oFilterInfos.filters
-				});
-			});
-
-			Promise.all(aBindingPromises)
-				.then(function (aCounts: any[]) {
-					for (const k in aCounts) {
-						const oItem = aCompliantTabs[k].item;
-						oItem.setCount(TableUtils.getCountFormatted(aCounts[k]));
-						oItem.data("outdatedCounts", false);
-					}
-				})
-				.catch(function (oError: any) {
-					Log.error("Error while retrieving the values for the icon tab bar", oError);
-				});
-		}
+		return this._getMultiModeControl()?.content.getSelectedKey().indexOf("::CustomTab::") > -1;
 	}
 
 	_isFilterBarHidden() {
@@ -813,46 +645,26 @@ class ListReportController extends PageController {
 
 	handlers = {
 		onTabMultiModeChange(this: ListReportController, oEvent: any) {
-			this._updateMultiModeSelectedControl();
-			this._updateMultiControlHiddenStatus();
-
-			const oFilterBar = this._getFilterBarControl();
-			const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
-			const oDisplayedControl = this._getCurrentControl() as any;
-			const oMultiModeControl = this._getMultiModeControl();
-			const sSelectedKey = oMultiModeControl.getSelectedKey();
 			const sPreviousSelectedKey = oEvent && oEvent.mParameters ? oEvent.mParameters.previousKey : undefined;
-
-			oInternalModelContext.setProperty("tabs/selected", sSelectedKey);
-			if (oInternalModelContext.getProperty("hasPendingFilters") !== true) {
-				// No pending filters into FilterBar
-				if (oFilterBar && this._isCustomTab()) {
-					const oFilterConditions = oFilterBar.getFilterConditions();
-					this.onViewNeedsRefresh({
-						filterConditions: oFilterConditions,
-						currentTabId: sSelectedKey,
-						refreshCause: "tabChanged"
-					});
-				} else if (
-					!oDisplayedControl.isA("sap.ui.mdc.Chart") &&
-					(!oDisplayedControl.getRowBinding() || // first time the tab/table is displayed
-						oDisplayedControl.data("outdatedRows") === true)
-				) {
-					// Search has been triggered on a different tab {}
-					oDisplayedControl.rebind();
-					oDisplayedControl.data("outdatedRows", false);
-				} else if (
-					oDisplayedControl.isA("sap.ui.mdc.Chart") &&
-					(!oDisplayedControl.getControlDelegate()._getChart(oDisplayedControl).getBinding("data") || // first time the tab/chart is displayed
-						oDisplayedControl.data("outdatedRows") === true)
-				) {
-					const oInnerChart = oDisplayedControl.getControlDelegate()._getChart(oDisplayedControl);
-					oDisplayedControl.getControlDelegate().rebind(oDisplayedControl, oInnerChart.getBindingInfo("data"));
-					oDisplayedControl.data("outdatedRows", false);
-				}
-			}
+			this._updateMultiModeSelectedControl();
 
 			if (oEvent && oEvent.mParameters && sPreviousSelectedKey !== oEvent.mParameters.selectedKey) {
+				const sSelectedKey = oEvent.mParameters.selectedKey;
+				const oFilterBar = this._getFilterBarControl();
+				const oMultiModeControl = this._getMultiModeControl();
+				const oInternalModelContext = this.getView().getBindingContext("internal");
+				if (oInternalModelContext) {
+					if (oFilterBar && oInternalModelContext.getProperty("hasPendingFilters") !== true) {
+						if (this._isCustomTab()) {
+							const oFilterConditions = oFilterBar.getFilterConditions();
+							this.onViewNeedsRefresh({
+								filterConditions: oFilterConditions,
+								currentTabId: sSelectedKey,
+								refreshCause: "tabChanged"
+							});
+						}
+					}
+				}
 				ControlPersonalizationWriteAPI.add({
 					changes: [
 						{
@@ -863,7 +675,7 @@ class ListReportController extends PageController {
 									previousSelectedKey: sPreviousSelectedKey
 								}
 							},
-							selectorElement: oMultiModeControl
+							selectorElement: oMultiModeControl.content
 						}
 					]
 				});
@@ -878,17 +690,19 @@ class ListReportController extends PageController {
 				this.onPendingFilters();
 				oInternalModelContext.setProperty("appliedFilters", oFilterBar.getAssignedFiltersText().filtersText);
 				if (oEvent.getParameter("conditionsBased")) {
+					this._getMultiModeControl()?.setFreezeContent(true);
 					oInternalModelContext.setProperty("hasPendingFilters", true);
 				}
 			}
 		},
 		onVariantSelected(this: ListReportController, oEvent: any) {
 			const oVM = oEvent.getSource();
+			const oMultiModeControl = this._getMultiModeControl();
+
+			oMultiModeControl?.invalidateContent();
+			oMultiModeControl?.setFreezeContent(true);
 			// setTimeout cause the variant needs to be applied before judging the auto search or updating the app state
 			setTimeout(() => {
-				if (this._isMultiMode()) {
-					(this.handlers as any).onTabMultiModeChange.apply(this, [oEvent]);
-				}
 				if (this._shouldAutoTriggerSearch(oVM)) {
 					// the app state will be updated via onSearch handler
 					return this._getFilterBarControl().triggerSearch();
@@ -912,18 +726,19 @@ class ListReportController extends PageController {
 			oInternalModelContext.setProperty("hideDraftInfo", bHideDraft);
 			if (this._isMultiMode()) {
 				const oMultiModeControl = this._getMultiModeControl();
-				this._setCountsOutDated();
+				oMultiModeControl.setCountsOutDated(true);
+				oMultiModeControl.setFreezeContent(false);
 				if (!this._isCustomTab()) {
-					this._updateMultiTabNotApplicableFields(oInternalModelContext, oFilterBar);
-					// This should be done outside the search event handler of the filter bar.
-					// The same logic is required when filter bar is hidden and multiple tables exist on the LR.
-					// This is currently done in ListReport/overrides/ViewState.js#onAfterStateApplied()
-					this._invalidateMultipleModeContent();
+					oMultiModeControl.updateMultiTabNotApplicableFields(
+						oFilterBar,
+						oFilterBar.data("entityType"),
+						this.oResourceBundle as ResourceBundle
+					);
 				} else {
 					const oFilterConditions = oFilterBar.getFilterConditions();
 					this.onViewNeedsRefresh({
 						filterConditions: oFilterConditions,
-						currentTabId: oMultiModeControl.getSelectedKey(),
+						currentTabId: oMultiModeControl.content.getSelectedKey(),
 						refreshCause: "search"
 					});
 				}
@@ -1061,50 +876,23 @@ class ListReportController extends PageController {
 		}
 	};
 	formatters = {
-		/**
-		 * Method to set the message text for the multiple entity sets when fields in the FilterBar need to be ignored.
-		 *
-		 * @param this
-		 * @param aIgnoredFields Array of ignored fields in the FilterBar for the current tab (multiple entity sets)
-		 * @param sTabTitle Tab title
-		 * @param bIsChart Flag that indicates whether the control is a chart or not
-		 * @param oApplySupported ApplySupported for the control
-		 * @returns Message text
-		 */
-		setTabMessageStrip(this: ListReportController, aIgnoredFields: any[], sTabTitle: string, bIsChart?: any, oApplySupported?: any) {
+		setALPControlMessageStrip(this: ListReportController, aIgnoredFields: any[], bIsChart: any, oApplySupported?: any) {
 			let sText = "";
 			bIsChart = bIsChart === "true" || bIsChart === true;
 			const oFilterBar = this._getFilterBarControl();
-			if (oFilterBar && Array.isArray(aIgnoredFields) && aIgnoredFields.length > 0 && (sTabTitle || bIsChart)) {
-				const sFilterBarEntityPath = oFilterBar.data("entityType"),
-					oMetaModel = this.getView().getModel().getMetaModel(),
-					oResourceBundle = Core.getLibraryResourceBundle("sap.fe.templates") as ResourceBundle,
-					aIgnoredLabels = aIgnoredFields.map(function (sProperty) {
-						const oMacroResourceBundle = Core.getLibraryResourceBundle("sap.fe.macros") as ResourceBundle;
-						if (sProperty === "$search") {
-							return oMacroResourceBundle ? oMacroResourceBundle.getText("M_FILTERBAR_SEARCH") : "";
-						}
-						if (sProperty === "$editState") {
-							return oMacroResourceBundle ? oMacroResourceBundle.getText("M_COMMON_FILTERBAR_EDITING_STATUS") : "";
-						}
-						const sLabel = oMetaModel.getObject(`${sFilterBarEntityPath + sProperty}@com.sap.vocabularies.Common.v1.Label`);
-						return DelegateUtil.getLocalizedText(sLabel, oFilterBar);
-					});
+			if (oFilterBar && Array.isArray(aIgnoredFields) && aIgnoredFields.length > 0 && bIsChart) {
+				const aIgnoredLabels = MessageStrip.getLabels(
+					aIgnoredFields,
+					oFilterBar.data("entityType"),
+					oFilterBar,
+					this.oResourceBundle as ResourceBundle
+				);
 				const bIsSearchIgnored = !oApplySupported.enableSearch;
-				if (oResourceBundle) {
-					sText = CommonUtils.getMessageStripText(
-						this.getView(),
-						aIgnoredLabels,
-						oFilterBar,
-						bIsChart,
-						bIsSearchIgnored,
-						sTabTitle,
-						oResourceBundle,
-						DelegateUtil.getLocalizedText
-					);
-				}
+				sText = bIsChart
+					? MessageStrip.getALPText(aIgnoredLabels, oFilterBar, bIsSearchIgnored)
+					: MessageStrip.getText(aIgnoredLabels, oFilterBar, "", DelegateUtil.getLocalizedText);
+				return sText;
 			}
-			return sText;
 		}
 	};
 }