@sapui5/sap.fe.templates 1.141.1 → 1.142.0

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

@@ -9,6 +9,7 @@ import IntentBasedNavigation from "sap/fe/core/controllerextensions/IntentBasedN
 import InternalIntentBasedNavigation from "sap/fe/core/controllerextensions/InternalIntentBasedNavigation";
 import InternalRouting from "sap/fe/core/controllerextensions/InternalRouting";
 import KPIManagement from "sap/fe/core/controllerextensions/KPIManagement";
+import MessageHandler from "sap/fe/core/controllerextensions/MessageHandler";
 import Placeholder from "sap/fe/core/controllerextensions/Placeholder";
 import Share from "sap/fe/core/controllerextensions/Share";
 import SideEffects from "sap/fe/core/controllerextensions/SideEffects";
@@ -21,11 +22,13 @@ import { getResourceModel } from "sap/fe/core/helpers/ResourceModelHelper";
 import * as StableIdHelper from "sap/fe/core/helpers/StableIdHelper";
 import { generate } from "sap/fe/core/helpers/StableIdHelper";
 import CoreLibrary from "sap/fe/core/library";
+import type { TitleInformation } from "sap/fe/core/rootView/RootViewBaseController";
 import type Breadcrumbs from "sap/fe/macros/Breadcrumbs";
 import type ChartType from "sap/fe/macros/Chart";
 import type MacroAPI from "sap/fe/macros/MacroAPI";
 import type ChartDelegate from "sap/fe/macros/chart/ChartDelegate";
 import ChartUtils from "sap/fe/macros/chart/ChartUtils";
+import type ContentSwitcher from "sap/fe/macros/contentSwitcher/ContentSwitcher";
 import type FilterBar from "sap/fe/macros/controls/FilterBar";
 import FilterUtils from "sap/fe/macros/filter/FilterUtils";
 import type FilterBarAPI from "sap/fe/macros/filterBar/FilterBarAPI";
@@ -54,8 +57,10 @@ import StateUtil from "sap/ui/mdc/p13n/StateUtil";
 import type JSONModel from "sap/ui/model/json/JSONModel";
 import type Context from "sap/ui/model/odata/v4/Context";
 import hasher from "sap/ui/thirdparty/hasher";
+import type { TitleAdditionalInfo } from "sap/ushell/ui5service/ShellUIService";
 import * as ListReportTemplating from "./ListReportTemplating";
 import IntentBasedNavigationOverride from "./overrides/IntentBasedNavigation";
+import MessageHandlerOverride from "./overrides/MessageHandler";
 import ShareOverrides from "./overrides/Share";
 import ViewStateOverrides from "./overrides/ViewState";
 
@@ -105,6 +110,9 @@ class ListReportController extends PageController {
 	@usingExtension(Placeholder)
 	placeholder!: Placeholder;
 
+	@usingExtension(MessageHandler.override(MessageHandlerOverride))
+	messageHandler!: MessageHandler;
+
 	protected extensionAPI?: ExtensionAPI;
 
 	private filterBarConditions?: unknown;
@@ -129,7 +137,8 @@ class ListReportController extends PageController {
 
 	onInit(): void {
 		PageController.prototype.onInit.apply(this);
-		const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+		const oInternalModelContext = this.getOwnerComponent().getBindingContext("internal") as InternalModelContext;
+		const uiModelContext = this.getOwnerComponent().getBindingContext("ui") as InternalModelContext;
 		const filterBar = this._getFilterBarControl();
 		if (filterBar) {
 			this._storeFilterBarSelectionVariant(filterBar, oInternalModelContext);
@@ -160,11 +169,7 @@ class ListReportController extends PageController {
 
 		// Configure the initial load settings
 		this._setInitLoad();
-		const view = this.getView();
-		const uiModel = view.getModel("ui");
-		const path = `/${view.getId()}`;
-		uiModel.setProperty(path, { isEditable: false });
-		view.bindElement({ path, model: "ui" });
+		uiModelContext.setProperty("", { isEditable: false });
 	}
 
 	onBeforeRendering(): void {
@@ -185,7 +190,13 @@ class ListReportController extends PageController {
 		delete this.extensionAPI;
 	}
 
-	_onAfterBinding(): void {
+	async _onAfterBinding(): Promise<void> {
+		const internalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+		if (!internalModelContext.getProperty("initialVariantApplied")) {
+			this.pageReady.waitFor(this._applyAppState());
+			internalModelContext.setProperty("initialVariantApplied", true);
+		}
+		await CommonUtils.getAppComponent(this.getView()).isAppComponentBusy();
 		const aTables = this._getControls("table") as Table[];
 		let updateActions = true;
 		if (EditState.isEditStateDirty()) {
@@ -195,13 +206,11 @@ class ListReportController extends PageController {
 			if (oTableBinding) {
 				updateActions = false;
 				const tableAPI = table?.getParent() as TableAPI;
-
 				// Update the table content using side effects (listBinding.refresh doesn't keep expansion states in a TreeTable)
 				CommonUtils.getAppComponent(this.getView())
 					.getRoutingService()
 					.waitForBindingCleanup()
-					.then(async () => {
-						await CommonUtils.getAppComponent(this.getView()).isAppComponentBusy();
+					.then(() => {
 						oTableBinding.attachEventOnce("dataReceived", () => {
 							this._updateTableActions(aTables);
 						});
@@ -223,13 +232,6 @@ class ListReportController extends PageController {
 		if (updateActions) {
 			this._updateTableActions(aTables);
 		}
-
-		const internalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
-		if (!internalModelContext.getProperty("initialVariantApplied")) {
-			const viewId = this.getView().getId();
-			this.pageReady.waitFor(this._applyAppState(viewId));
-			internalModelContext.setProperty("initialVariantApplied", true);
-		}
 		const environmentCapabilities = CommonUtils.getAppComponent(this.getView()).getEnvironmentCapabilities();
 		environmentCapabilities
 			.isInsightsEnabled()
@@ -283,10 +285,10 @@ class ListReportController extends PageController {
 	 * This happens either when there is a change on the FilterBar and the search is triggered,
 	 * or when a tab with custom content is selected,
 	 * or when the view is forced to be refreshed through the Extension API for the list report's public method setTabContentToBeRefreshedOnNextOpening.
-	 * This method can be overwritten by the controller extension in case of customization.
-	 * @param mParameters Map containing the filter conditions of the FilterBar, the currentTabID
-	 * and the view refresh cause (tabChanged, search or forcedRefresh).
-	 * The map looks like this:
+	 * This method can be overwritten by the controller extension for customization.
+	 * @param mParameters Map containing the filter conditions of the FilterBar, the currentTabID,
+	 * and the view refresh cause such as tabChanged, search, or forcedRefresh.
+	 * See the following example of a map:
 	 * <code><pre>
 	 * 	{
 	 * 		filterConditions: {
@@ -315,9 +317,9 @@ class ListReportController extends PageController {
 
 	/**
 	 * Method called when a filter or search value has been changed in the FilterBar,
-	 * but has not been validated yet by the end user (with the 'Go' or 'Search' button).
+	 * but has not been validated yet by the end user with the 'Go' or 'Search' button.
 	 * Typically, the content of the current tab is greyed out until the filters are validated.
-	 * This method can be overwritten by the controller extension in case of customization.
+	 * This method can be overwritten by the controller extension for customization.
 	 * @public
 	 */
 	@publicExtension()
@@ -373,11 +375,43 @@ class ListReportController extends PageController {
 		filterField.focus(focusInfo);
 	}
 
+	/**
+	 * Sets the focus when the header is expanded.
+	 * The priorities are: (1) first empty mandatory filter field, (2) search field if focusable or first filter field, and (3) Go button.
+	 * @param filterBar The filter bar control.
+	 */
+	private _focusWhenHeaderExpanded(filterBar: FilterBar): void {
+		const firstEmptyMandatoryField = filterBar.getFilterItems().find(function (oFilterItem: FilterField) {
+			return oFilterItem.getRequired() && oFilterItem.getConditions().length === 0;
+		});
+		//Focusing on the first empty mandatory filter field, or on the first filter field if the table data is loaded
+		// Do a "silent" focus for FilterField, by adding the silent attribute. The silent attribute suppresses typeahead opening.
+		if (firstEmptyMandatoryField) {
+			if (firstEmptyMandatoryField.isA<FilterField>("sap.ui.mdc.FilterField")) {
+				this._focusSilent(firstEmptyMandatoryField);
+			} else {
+				(firstEmptyMandatoryField as Control).focus();
+			}
+		} else if (this._isInitLoadEnabled() && filterBar.getFilterItems().length > 0) {
+			// If there is no empty mandatory filter field, set silent focus on search field (if focusable), otherwise on first filter field
+			const basicSearchField = filterBar.getBasicSearchField();
+			const fieldToFocus = basicSearchField?.isFocusable() ? basicSearchField : filterBar.getFilterItems()[0];
+			if (fieldToFocus.isA<FilterField>("sap.ui.mdc.FilterField")) {
+				this._focusSilent(fieldToFocus);
+			} else {
+				(fieldToFocus as Control).focus();
+			}
+		} else {
+			//Focusing on the Go button
+			this.getView().byId(`${this._getFilterBarControlId()}-btnSearch`)?.focus();
+		}
+	}
+
 	/**
 	 * This method sets the initial focus in a list report based on the User Experience guidelines.
 	 *
 	 */
-	_setInitialFocus(): void {
+	async _setInitialFocus(): Promise<void> {
 		const dynamicPage = this._getDynamicListReportControl(),
 			isHeaderExpanded = dynamicPage.getHeaderExpanded(),
 			filterBar = this._getFilterBarControl() as FilterBar;
@@ -387,45 +421,39 @@ class ListReportController extends PageController {
 				filterBar.setShowMessages(true);
 			}
 			if (isHeaderExpanded) {
-				const firstEmptyMandatoryField = filterBar.getFilterItems().find(function (oFilterItem: FilterField) {
-					return oFilterItem.getRequired() && oFilterItem.getConditions().length === 0;
-				});
-				//Focusing on the first empty mandatory filter field, or on the first filter field if the table data is loaded
-				// Do a "silent" focus for FilterField, by adding the silent attribute. The silent attribute suppresses typeahead opening.
-				if (firstEmptyMandatoryField) {
-					if (firstEmptyMandatoryField.isA<FilterField>("sap.ui.mdc.FilterField")) {
-						this._focusSilent(firstEmptyMandatoryField);
-					} else {
-						(firstEmptyMandatoryField as Control).focus();
-					}
-				} else if (this._isInitLoadEnabled() && filterBar.getFilterItems().length > 0) {
-					// Add check for available filterItems
-					const fieldToFocus = filterBar.getFilterItems()[0];
-					if (fieldToFocus.isA<FilterField>("sap.ui.mdc.FilterField")) {
-						this._focusSilent(fieldToFocus);
-					} else {
-						(fieldToFocus as Control).focus();
-					}
-				} else {
-					//Focusing on the Go button
-					this.getView().byId(`${this._getFilterBarControlId()}-btnSearch`)?.focus();
-				}
+				this._focusWhenHeaderExpanded(filterBar);
 			} else if (this._isInitLoadEnabled()) {
-				this._getTable()
+				await this._getTable()
 					?.focusRow(0)
 					.catch(function (error: unknown) {
-						Log.error("Error while setting initial focus on the table ", error as string);
+						if (error) {
+							// if there is no error it can just be that there are no lines to focus
+							Log.info("Error while setting initial focus on the table ", error as string);
+						}
 					});
 			}
 		} else {
-			this._getTable()
+			await this._getTable()
 				?.focusRow(0)
 				.catch(function (error: unknown) {
-					Log.error("Error while setting initial focus on the table ", error as string);
+					if (error) {
+						// if there is no error it can just be that there are no lines to focus
+						Log.info("Error while setting initial focus on the table ", error as string);
+					}
 				});
 		}
 	}
 
+	/**
+	 * Override to get the browser title of the LR page.
+	 * @param _pageTitleInformation Present page title information
+	 * @returns Title information to be used by shell services for browser title
+	 */
+	async _getBrowserTitle(_pageTitleInformation: TitleInformation): Promise<TitleAdditionalInfo | undefined> {
+		// We shall fallback to defaul app title in case of list report.
+		return Promise.resolve(undefined);
+	}
+
 	async _getPageTitleInformation(): Promise<{ title?: string; subtitle: string; intent: string; icon: string }> {
 		const oManifestEntry = this.getAppComponent().getManifestEntry("sap.app");
 		return Promise.resolve({
@@ -451,8 +479,8 @@ class ListReportController extends PageController {
 		return adaptationFilterBar?.getParent() ? adaptationFilterBar : undefined;
 	}
 
-	async _applyAppState(viewId: string): Promise<void> {
-		await this.getAppComponent().getAppStateHandler().applyAppState(viewId, this.getView());
+	async _applyAppState(): Promise<void> {
+		await this.getAppComponent().getAppStateHandler().applyAppState(this.getView());
 		const oFilterBar = this._getFilterBarControl();
 		if (oFilterBar) {
 			oFilterBar.enableRequests(true);
@@ -755,6 +783,17 @@ class ListReportController extends PageController {
 	}
 
 	handlers = {
+		onFilterLayoutSwitch(this: ListReportController, oEvent: UI5Event<{}, ContentSwitcher>): void {
+			const currentKey = oEvent.getSource().selectedKey;
+			const variantManagement = this._getControlFromPageModelProperty("/variantManagement/pageId");
+			if (variantManagement) {
+				if (currentKey === "ai") {
+					variantManagement.setVisible(false);
+				} else {
+					variantManagement.setVisible(true);
+				}
+			}
+		},
 		onInlineEditSave(this: ListReportController): void {
 			this.inlineEditFlow.inlineEditSave();
 		},

package/src/sap/fe/templates/ListReport/manifest.json

@@ -5,7 +5,7 @@
 		"type": "component",
 		"i18n": "../messagebundle.properties",
 		"applicationVersion": {
-			"version": "1.141.1"
+			"version": "1.142.0"
 		},
 		"title": "List Report",
 		"tags": {

package/src/sap/fe/templates/ListReport/overrides/MessageHandler.js

@@ -0,0 +1,25 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+ *      (c) Copyright 2009-2025 SAP SE. All rights reserved
+ */
+sap.ui.define(["sap/fe/core/CommonUtils"], function (CommonUtils) {
+  "use strict";
+
+  // import type NavContainer from "sap/m/NavContainer";
+
+  const MessageHandlerLRExtension = {
+    getShowBoundMessagesInMessageDialog: function () {
+      // For List Report, determines whether bound messages should be shown in a dialog or not
+      const appComponent = this.base.getAppComponent();
+      const getCurrentPageView = CommonUtils.getCurrentPageView(appComponent);
+      const currentPageViewID = getCurrentPageView?.getId();
+      const baseViewID = this.base.getView()?.getId();
+      if (currentPageViewID !== baseViewID) {
+        return false;
+      }
+      return true;
+    }
+  };
+  return MessageHandlerLRExtension;
+}, false);
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJNZXNzYWdlSGFuZGxlckxSRXh0ZW5zaW9uIiwiZ2V0U2hvd0JvdW5kTWVzc2FnZXNJbk1lc3NhZ2VEaWFsb2ciLCJhcHBDb21wb25lbnQiLCJiYXNlIiwiZ2V0QXBwQ29tcG9uZW50IiwiZ2V0Q3VycmVudFBhZ2VWaWV3IiwiQ29tbW9uVXRpbHMiLCJjdXJyZW50UGFnZVZpZXdJRCIsImdldElkIiwiYmFzZVZpZXdJRCIsImdldFZpZXciXSwic291cmNlUm9vdCI6Ii4iLCJzb3VyY2VzIjpbIk1lc3NhZ2VIYW5kbGVyLnRzIl0sInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBDb21tb25VdGlscyBmcm9tIFwic2FwL2ZlL2NvcmUvQ29tbW9uVXRpbHNcIjtcbmltcG9ydCB0eXBlIE1lc3NhZ2VIYW5kbGVyIGZyb20gXCJzYXAvZmUvY29yZS9jb250cm9sbGVyZXh0ZW5zaW9ucy9NZXNzYWdlSGFuZGxlclwiO1xuLy8gaW1wb3J0IHR5cGUgTmF2Q29udGFpbmVyIGZyb20gXCJzYXAvbS9OYXZDb250YWluZXJcIjtcblxuY29uc3QgTWVzc2FnZUhhbmRsZXJMUkV4dGVuc2lvbiA9IHtcblx0Z2V0U2hvd0JvdW5kTWVzc2FnZXNJbk1lc3NhZ2VEaWFsb2c6IGZ1bmN0aW9uICh0aGlzOiBNZXNzYWdlSGFuZGxlcik6IGJvb2xlYW4ge1xuXHRcdC8vIEZvciBMaXN0IFJlcG9ydCwgZGV0ZXJtaW5lcyB3aGV0aGVyIGJvdW5kIG1lc3NhZ2VzIHNob3VsZCBiZSBzaG93biBpbiBhIGRpYWxvZyBvciBub3Rcblx0XHRjb25zdCBhcHBDb21wb25lbnQgPSB0aGlzLmJhc2UuZ2V0QXBwQ29tcG9uZW50KCk7XG5cdFx0Y29uc3QgZ2V0Q3VycmVudFBhZ2VWaWV3ID0gQ29tbW9uVXRpbHMuZ2V0Q3VycmVudFBhZ2VWaWV3KGFwcENvbXBvbmVudCk7XG5cdFx0Y29uc3QgY3VycmVudFBhZ2VWaWV3SUQgPSBnZXRDdXJyZW50UGFnZVZpZXc/LmdldElkKCk7XG5cdFx0Y29uc3QgYmFzZVZpZXdJRCA9IHRoaXMuYmFzZS5nZXRWaWV3KCk/LmdldElkKCk7XG5cblx0XHRpZiAoY3VycmVudFBhZ2VWaWV3SUQgIT09IGJhc2VWaWV3SUQpIHtcblx0XHRcdHJldHVybiBmYWxzZTtcblx0XHR9XG5cdFx0cmV0dXJuIHRydWU7XG5cdH1cbn07XG5cbmV4cG9ydCBkZWZhdWx0IE1lc3NhZ2VIYW5kbGVyTFJFeHRlbnNpb247XG4iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7RUFFQTs7RUFFQSxNQUFNQSx5QkFBeUIsR0FBRztJQUNqQ0MsbUNBQW1DLEVBQUUsU0FBQUEsQ0FBQSxFQUF5QztNQUM3RTtNQUNBLE1BQU1DLFlBQVksR0FBRyxJQUFJLENBQUNDLElBQUksQ0FBQ0MsZUFBZSxDQUFDLENBQUM7TUFDaEQsTUFBTUMsa0JBQWtCLEdBQUdDLFdBQVcsQ0FBQ0Qsa0JBQWtCLENBQUNILFlBQVksQ0FBQztNQUN2RSxNQUFNSyxpQkFBaUIsR0FBR0Ysa0JBQWtCLEVBQUVHLEtBQUssQ0FBQyxDQUFDO01BQ3JELE1BQU1DLFVBQVUsR0FBRyxJQUFJLENBQUNOLElBQUksQ0FBQ08sT0FBTyxDQUFDLENBQUMsRUFBRUYsS0FBSyxDQUFDLENBQUM7TUFFL0MsSUFBSUQsaUJBQWlCLEtBQUtFLFVBQVUsRUFBRTtRQUNyQyxPQUFPLEtBQUs7TUFDYjtNQUNBLE9BQU8sSUFBSTtJQUNaO0VBQ0QsQ0FBQztFQUFDLE9BRWFULHlCQUF5QjtBQUFBIiwiaWdub3JlTGlzdCI6W119

package/src/sap/fe/templates/ListReport/overrides/MessageHandler.ts

@@ -0,0 +1,20 @@
+import CommonUtils from "sap/fe/core/CommonUtils";
+import type MessageHandler from "sap/fe/core/controllerextensions/MessageHandler";
+// import type NavContainer from "sap/m/NavContainer";
+
+const MessageHandlerLRExtension = {
+	getShowBoundMessagesInMessageDialog: function (this: MessageHandler): boolean {
+		// For List Report, determines whether bound messages should be shown in a dialog or not
+		const appComponent = this.base.getAppComponent();
+		const getCurrentPageView = CommonUtils.getCurrentPageView(appComponent);
+		const currentPageViewID = getCurrentPageView?.getId();
+		const baseViewID = this.base.getView()?.getId();
+
+		if (currentPageViewID !== baseViewID) {
+			return false;
+		}
+		return true;
+	}
+};
+
+export default MessageHandlerLRExtension;