@sapui5/sap.suite.ui.generic.template 1.122.2 → 1.123.0

package/src/sap/suite/ui/generic/template/lib/ContextMenuHandler.js

@@ -1,17 +1,48 @@
 sap.ui.define([
+	"sap/base/util/extend",
+	"sap/base/util/ObjectPath",
+	"sap/f/library",
+	"sap/m/MessageBox",
+	"sap/suite/ui/generic/template/genericUtilities/controlHelper",
+	"sap/suite/ui/generic/template/genericUtilities/FeLogger",
 	"sap/ui/base/Object",
 	"sap/ui/base/Event",
-	"sap/base/util/extend",
-	"sap/suite/ui/generic/template/genericUtilities/controlHelper"
-], function(BaseObject, Event, extend, controlHelper) {
+	"sap/ui/util/openWindow"
+], function (extend, ObjectPath, fioriLibrary, MessageBox, controlHelper, FeLogger, BaseObject, Event, openWindow) {
 	"use strict";
 
 	/* This class provides generic functionality for handling of the context menu for one smart control (oSourceControl).
 	 * Note that this is currently restricted to the case that oSourceControl is a table.
 	 * oConfiguration is an object which contains logic which is specific to the floorplan using this functionality.
      */
+	var oLogger = new FeLogger("lib.ContextMenuHandler").getLogger();
+	// shortcut for sap.f.LayoutType
+	var LayoutType = fioriLibrary.LayoutType;
+
+	// Constants
+	var MAX_RECORDS_OPEN_IN_NEW_TAB = 10;
+
 	function getMethods(oController, oTemplateUtils, oState, oSourceControl, oConfiguration) {
 
+		//Type definitions
+
+		/**
+		 * @typedef {Object} FocusInfo Information about the applicable records for the context menu
+		 * @property {sap.ui.model.Context} focussedBindingContext - Binding context of the currently focussed row
+		 * @property {Array<sap.ui.model.Context>} applicableContexts - Array of contexts applicable to the context menu
+		 * @property {boolean} doesApplicableEqualSelected - If the focussed row is part of selected rows
+		 */
+
+		/**
+		 * @typedef {Object} ContextMenuEntry Context menu entry
+		 * @property {string} text - Text
+		 * @property {string} icon - Icon
+		 * @property {string} key - Uniquely identifiable key
+		 * @property {boolean} enabled - Is the entry enabled
+		 * @property {Array<ContextMenuEntry>} children - Child entries
+		 * @property {Promise<Function|undefined>} handlerPromise - A promise which resolves the handler method for the current entry
+		 */
+
 		var oView = oController.getView();
 		var oTemplatePrivateModel = oView.getModel("_templPriv");
 		var oCommonUtils = oTemplateUtils.oCommonUtils;
@@ -33,21 +64,55 @@ sap.ui.define([
 		var mHandlers; // maps keys of context menu entries to handler functions for the corresponding entry
 		var iCreatedMenuItemsCounter = 0; // increased whenever a new MenuItem is being created In fnAddMenuItem). Used to generate a key for mHandlers.
 
-		// add meta data of a menu item to the list of items (aItems).
-		// sText and sIcon represent the text and the icon of the menu entry.
-		// bStartsSection is a boolean telling whether the entry starts a new section with the menu (will be ignored for the first entry of aItems).
-		// oHandlerPromise is optional. If faulty the corresponding menu item will never be resolved.
-		function fnAddMenuItem(sPathToItems, aItems, sText, sIcon, bStartsSection, oHandlerPromise){
+		/**
+		 * The method does the following
+		 *  - Adds an entry (menu item) to the context menu.
+		 *  - Waits for the handler promise to be resolved and 
+		 * 		- Enables the menu item only if it has the handler method
+		 * 		- Registers the press event handler to the "mHandlers"
+		 *  - If the current menu item contains child entries, it waits for all the children handler promises to be resolved and
+		 * 		- Enables the child menu items based on the availability of respective handlers
+		 * 		- Enables the current menu item if at least one child item is enabled.
+		 * 
+		 *  Note: When the current entry has children, please pass "oHandlerPromise" as null.
+		 * 
+		 * @param {string} sPathToItems Binding path for the items
+		 * @param {Array<ContextMenuEntry>} aItems Array which stores all context menu entries
+		 * @param {string} sText Text of the context menu item
+		 * @param {string} sIcon Icon for the context menu item
+		 * @param {boolean} bStartsSection Defines whether a visual separator should be rendered before the item
+		 * @param {Promise<Function|boolean>} oHandlerPromise Optional parameter. A promise which resolves the press handler method to the current menu item
+		 * @param {Array<ContextMenuEntry>} aChildren Child entries for the current menu item
+		 */
+		function fnAddMenuItem(sPathToItems, aItems, sText, sIcon, bStartsSection, oHandlerPromise, aChildren){
 			iCreatedMenuItemsCounter++;
 			var sKey = "ContextMenuKey" + iCreatedMenuItemsCounter;
+			var iPosition = aItems.length;
+			aChildren = aChildren || [];
 			if (oHandlerPromise){
-				var iPosition = aItems.length;
 				oHandlerPromise.then(function(fnHandler){ 
 					if (fnHandler){
 						mHandlers[sKey] = fnHandler;
 						oTemplatePrivateModel.setProperty(sPathToItems + "/" + iPosition + "/enabled", true);
 					}
 				});
+			} else if (aChildren.length > 0) {
+				var aHandlerPromisesForChildren = aChildren.map(function (oMenuItem){
+					return oMenuItem.handlerPromise;
+				});
+				Promise.all(aHandlerPromisesForChildren).then(function (aHandlersForChildren) {
+					var bParentEnabled = false;
+					// Enabling the child menu items
+					aHandlersForChildren.forEach(function (fnHandler, iIndex) {
+						if (fnHandler) {
+							oTemplatePrivateModel.setProperty(sPathToItems + "/" + iPosition + "/children/" + iIndex + "/enabled", true);
+							// Parent is enabled if at least one child is enabled
+							bParentEnabled = true;
+						}
+					});
+					// Enabling the parent
+					oTemplatePrivateModel.setProperty(sPathToItems + "/" + iPosition + "/enabled", bParentEnabled);					
+				});
 			}
 			bStartsSection = bStartsSection && aItems.length > 0;
 			aItems.push({
@@ -55,7 +120,9 @@ sap.ui.define([
 				icon: sIcon,
 				key: sKey,
 				enabled: false,
-				startsSection: bStartsSection
+				startsSection: bStartsSection,
+				children: aChildren,
+				handlerPromise: oHandlerPromise
 			});
 		}
 
@@ -90,11 +157,27 @@ sap.ui.define([
 
 		// Invokes the "press" event handler of breakout control
 		function fnExecuteCustomActionByPressEvent (oBreakoutControlData, oToolbarControl) {
+			// Get the press handler name from the "press" property of action from manifest
 			var sPressHandlerName = oBreakoutControlData.press;
+			var fnEventHandler = null;
+			// Case 1: If the extension controller extends "sap.ui.core.mvc.ControllerExtension",
+			//   the press handler name would be in ".extension.controller_extension_name." format.
+			//   Here, event handler function is derived using ObjectPath.
+			//
+			// Case 2: If the extension controller extends "sap.ui.core.mvc.Controller",
+			//   then the press property from manifest has the event handler name.
+			//   Here, event handler function can be directly obtained from oController.
+			if (sPressHandlerName.startsWith(".")) {
+				// Omit the leading "." to find out the press handler path
+				var sPressHandlerPath = sPressHandlerName.substring(1);
+				fnEventHandler = ObjectPath.create(sPressHandlerPath, oController);
+			} else {
+				fnEventHandler = oController[sPressHandlerName];
+			}
 			var oEventSource = oToolbarControl;
 			// Creating a custom event with toolbar control as source
 			var oPressEvent = new Event("press", oEventSource);
-			oController[sPressHandlerName].apply(oController, [oPressEvent]);
+			fnEventHandler && fnEventHandler.apply(oController, [oPressEvent]);
 		}
 
 		// Returns the handler for standard action
@@ -130,7 +213,9 @@ sap.ui.define([
 		}
 
 		function fnAddToolbarButtonToContextMenu(sPathToItems, oFocusInfo, oToolbarControlsData, aItems, oButton, bStartsNewSection){
-			var sButtonId = oView.getLocalId(oButton.getId());
+			// If button has the stable id, find local id using "oButton.getId()".
+			// Otherwise, if the button was created using design time adaption, use the custom data "originalButtonId" to find local id. 
+			var sButtonId = oView.getLocalId(oButton.getId()) || oView.getLocalId(oButton.data("originalButtonId"));
 			// In the multi table multi view scenario, the toolbar button id is suffixed with icon tab bar's current key.
 			var oMultipleViewsHandler = oState.oMultipleViewsHandler;
 			var sButtonIdSuffix = oMultipleViewsHandler.getMode && oMultipleViewsHandler.getMode() === "multi" ? oState.oMultipleViewsHandler.getSelectedKey() : "";
@@ -162,6 +247,28 @@ sap.ui.define([
 			return false;
 		}
 
+		// Adds the menu button to context menu and creates a sub-menu for the child entries 
+		function fnAddMenuButtonToContextMenu(sPathToItems, oFocusInfo, oToolbarControlsData, aItems, oMenuButton, bStartsNewSection) {
+			var aMenuItems = oMenuButton.getMenu().getItems();
+
+			var aChildContextMenuEntries = [];
+			aMenuItems.forEach(function (oMenuItem) {
+				var bStartsSectionOnSubMenu = oMenuItem.getStartsSection();
+				fnAddToolbarButtonToContextMenu(sItemsPath, oFocusInfo, oToolbarControlsData, aChildContextMenuEntries, oMenuItem, bStartsSectionOnSubMenu);
+			});
+
+			if (aChildContextMenuEntries.length > 0) {
+				fnAddMenuItem(sPathToItems, aItems, oMenuButton.getText(), oMenuButton.getIcon(), bStartsNewSection, null, aChildContextMenuEntries);				
+				return true;
+			}
+			return false;
+		}
+
+		/**
+		 * Adds the toolbar buttons and menu buttons to the context menu
+		 * @param {FocusInfo} oFocusInfo Focus info
+		 * @param {Array<ContextMenuEntry>} aItems Array of context menu items
+		 */
 		function fnAddToolbarButtonsToContextMenu(oFocusInfo, aItems){
 			var aStandardActions = oCommonUtils.getToolbarCustomData(oSourceControl);
 			var mBreakoutActions = oCommonUtils.getBreakoutActions(oSourceControl);
@@ -180,78 +287,168 @@ sap.ui.define([
 				}			
 				if (controlHelper.isButton(oToolbarEntry)){
 					bFirst = !fnAddToolbarButtonToContextMenu(sItemsPath, oFocusInfo, oToolbarControlsData, aItems, oToolbarEntry, bFirst) && bFirst;
+				} else if (controlHelper.isMenuButton(oToolbarEntry)){
+					bFirst = !fnAddMenuButtonToContextMenu(sItemsPath, oFocusInfo, oToolbarControlsData, aItems, oToolbarEntry, bFirst) && bFirst;
 				}
 			});
 		}
-/*
-		function fnAddInlineActionsToContextMenu(oFocusInfo, aItems){
-			if (oFocusInfo.applicableContexts.length !== 1){
-				return;
+
+		/********************************************************
+		 * Methods related to "Open in new tab" functionality
+		 ********************************************************/
+
+		// Currently the inactive contexts (inline creation rows which are untouched and missing required props) 
+		// are considered as non navigable contexts
+		function fnIsContextNavigable (oContext) {
+			var bIsEmptyRow = oContext.isInactive();
+			//TODO: add other conditions if necessary
+			return !bIsEmptyRow;
+		}
+
+		/**
+		 * Constructs the app specific route for the target to be opened on new tab. The target route consists of
+		 * 1. Deep path of the context
+		 * 2. URL parameters of the current app specific route.
+		 * 
+		 * Note: All the URL parameters from source are retained in the target except the "FCLLayout". 
+		 * The target "FCLLayout" is calculated by the below logic:
+		 * 
+		 * If the app supports FCL.
+		 * 	- If the current page is LR (iViewLevel = 0), the target layout is "MidColumnFullScreen"
+		 * 	- If the current page is OP (iViewLevel > 0), the target layout is "EndColumnFullScreen"
+		 * 	
+		 * @returns {string} target path
+		 */
+		function fnConstructTargetAppSpecificRoute (oContext, oAppComponent, sSrcAppSpecificRoute) {
+			var sUrlParams = sSrcAppSpecificRoute.includes("?") ? sSrcAppSpecificRoute.substring(sSrcAppSpecificRoute.indexOf("?")) : "";
+			var oUrlParams = new URLSearchParams(sUrlParams);
+			var sDeepPath = oContext.getDeepPath();
+			var sTargetPathPrefix = sDeepPath.startsWith("/") ? "&" : "&/";
+			// If the app supports FCL, the object page should be opened in full screen mode
+			if (oAppComponent.getFlexibleColumnLayout()) {
+				var iViewLevel = oTemplateUtils.oComponentUtils.getViewLevel();
+				var sTargetFCLLayout = iViewLevel === 0 ? LayoutType.MidColumnFullScreen : LayoutType.EndColumnFullScreen;
+				// Update "FCLLayout"
+				oUrlParams.set("FCLLayout", sTargetFCLLayout);
 			}
-			var oSelectedContext = oFocusInfo.applicableContexts[0];
-			var oTableRow = oPresentationControlHandler.getRowForContext(oSelectedContext);
-			if (oTableRow){
-				//var bIsFirst = true;
-				controlHelper.searchInTree(oTableRow, function(oRowEntry){
-					return false;
-					if (controlHelper.isButton(oRowEntry)){
-						oHandlerPromise = Promise.resolve(oRowEntry.getEnabled() && function(){
-						
-						});
-						fnAddMainMenuItem(aItems, oRowEntry.getText(), oRowEntry.getIcon(), bIsFirst, oHandlerPromise);
-						bIsFirst = false;
-						return false;
-					}
-				});			
+			return sTargetPathPrefix + sDeepPath + "?" + oUrlParams.toString();
+		}
+
+		// Opens the given context in a new tab
+		function fnOpenContextInNewTab (oContext, oUrlParser, sFLPUrl, oAppComponent) {
+			// Construct URL object from FLP URL
+			var oFLPUrl = new URL(sFLPUrl);
+			// Get the hash from URL object
+			var sHash = oFLPUrl.hash;
+			// Parse the hash and update "appSpecificRoute" with the calculated target path.
+			// Then, reconstruct the hash with updated value.
+			var oHash = oUrlParser.parseShellHash(sHash);
+			oHash.appSpecificRoute = fnConstructTargetAppSpecificRoute(oContext, oAppComponent, oHash.appSpecificRoute);
+			sHash = oUrlParser.constructShellHash(oHash);
+			// Update the hash on the FLP URL and reconstruct the URL
+			oFLPUrl.hash = sHash;
+			var sTargetUrl =  oFLPUrl.toString();
+			//Open the new window with the target URL
+			openWindow(sTargetUrl);
+		}
+
+		/**
+		 * Opens all the eligible contexts in new tab.
+		 * Also, validates the maximum allowed number of records to be opened.
+		 * @param {FocusInfo} oFocusInfo 
+		 * @param {Array<sap.ui.model.Context>} aNavigableContexts 
+		 * @returns 
+		 */
+		function fnOpenNavigableContextsInNewTab (oFocusInfo, aNavigableContexts) {
+			if (oFocusInfo.applicableContexts.length > MAX_RECORDS_OPEN_IN_NEW_TAB) {
+				var sWarningMessage = oTemplateUtils.oCommonUtils.getText("T_TABLE_NAVIGATION_TOO_MANY_ITEMS_SELECTED", [MAX_RECORDS_OPEN_IN_NEW_TAB]);
+				MessageBox.warning(sWarningMessage);
+				return;
 			}
 
-		} */
+			var oAppComponent = oController.getOwnerComponent().getAppComponent();
+			var UShellContainer = sap.ui.require("sap/ushell/Container");
+			var oUrlParsingPromise = UShellContainer.getServiceAsync("URLParsing");
+			var oFLPUrlPromise = UShellContainer.getFLPUrlAsync(true);
+			// If the table has any pending changes, synchronize the draft before navigation.
+			var oSynchronizeDraftPromise = oSourceControl.getModel().hasPendingChanges() ? oTemplateUtils.oServices.oApplicationController.synchronizeDraftAsync() : Promise.resolve();
 
-		// iExpadMode: 0 = no expad, 1 = in new tab, 2 = in new window
-		function fnNavigateToContext(oTargetContext, iExpadMode){
+			Promise.all([oUrlParsingPromise, oFLPUrlPromise, oSynchronizeDraftPromise]).then(function (aResults) {
+				var oUrlParser = aResults[0];
+				var sFLPUrl = aResults[1];
 
+				aNavigableContexts.forEach(function (oContext) {
+					fnOpenContextInNewTab(oContext, oUrlParser, sFLPUrl, oAppComponent);
+				});
+			}).catch(function (oError) {
+				oLogger.error("Error while opening in new tab", oError);
+			});	
 		}
 
+		/**
+		 * Returns the promise which resolves the event handler for "Open in new tab/window" entry.
+		 * 
+		 * Negative scenario: It just returns without value when anyone of the following condition met.
+		 *   a. Navigation is not supported by the table
+		 *   b. Direct edit flow (when the edit icon is pressed on row, the object is opened with draft record) is configured.  
+		 *   c. The controller is configured with onListNavigationExtension (i.e custom navigation logic written by app).
+		 * //TODO: These negative scenarios need to be revisited
+		 * 
+		 * @param {FocusInfo} oFocusInfo 
+		 * @returns {Promise<Function|undefined>} Promise which resolves the handler method
+		 */
+		function getHandlePromiseForOpenInNewTab (oFocusInfo) {
+			var getHandler = function (bEnabled, oFocusInfo, aNavigableContexts) {
+				return bEnabled && fnOpenNavigableContextsInNewTab.bind(null, oFocusInfo, aNavigableContexts);
+			};
 
-		function getNavigationOptions(oFocusInfo){
-			var oRet = {};
-			if (!bNavigationSupported || oFocusInfo.applicableContexts.length !== 1){
-				return oRet;
+			var bDirectEdit = oTemplateUtils.oServices.oApplication.getEditFlowOfRoot() === "direct";
+			var bOnListNavigationExtensionFound = oController.hasOwnProperty("onListNavigationExtension");
+			if (!bNavigationSupported || bDirectEdit || bOnListNavigationExtensionFound) {
+				return;
 			}
-			var oSelectedContext = oFocusInfo.applicableContexts[0];
-			oRet.openForEdit = oConfiguration.getOpenForEdit && oConfiguration.getOpenForEdit(oSelectedContext);
-			if (oRet.openForEdit){ // currently we assume that the options open for edit and open are exclusive
-				return oRet;
+
+			// Enable the context menu entry only if at least one navigable context is available
+			var aNavigableContexts = oFocusInfo.applicableContexts.filter(fnIsContextNavigable);
+			var bEnabled = aNavigableContexts.length > 0;
+
+			return Promise.resolve(getHandler(bEnabled, oFocusInfo, aNavigableContexts));
+		}
+
+		/**
+		 * Adds "Open in wew tab/window" entry to context menu
+		 * @param {FocusInfo} oFocusInfo 
+		 * @param {Array<ContextMenuEntry>} aItems 
+		 */
+		function fnAddOpenInNewTabToContextMenu(oFocusInfo, aItems) {
+			var oHandlePromise = getHandlePromiseForOpenInNewTab(oFocusInfo);
+			var bStartsSection = true;
+			if (oHandlePromise) {
+				fnAddMainMenuItem(aItems, oCommonUtils.getText("ST_OPEN_NEW_TAB_OR_WINDOW"), null, bStartsSection, oHandlePromise);		
 			}
-			oRet.open = fnNavigateToContext.bind(null, oSelectedContext, 0);
-			var oDraftInfo = oTemplateUtils.oServices.oApplication.getDraftInfoForContext(oSelectedContext);
-			oRet.openExpad = !oDraftInfo.bIsDraft && fnNavigateToContext.bind(null, oSelectedContext);
-			return oRet;
 		}
 
-		/* eslint-disable */
+		/************************************************************
+		 * End of methods related to "Open in new tab" functionality
+		 ************************************************************/
+
 		function getContextMenuItems(oEvent){
 			var oFocusInfo = oPresentationControlHandler.getFocusInfoForContextMenuEvent(oEvent);
 			mHandlers = Object.create(null);
 			var aRet = [];
+			// Add the toolbar buttons to context menu
 			fnAddToolbarButtonsToContextMenu(oFocusInfo, aRet);
-			// fnAddInlineActionsToContextMenu(oFocusInfo, aRet);
-			var oNavigationOptions = getNavigationOptions(oFocusInfo);
-			if (oNavigationOptions.openExpad1){ // temp
-				fnAddMainMenuItem(aRet, oCommonUtils.getText("ST_OPEN_NEW_TAB"), null, true, Promise.resolve(oNavigationOptions.openExpad.bind(null, 1)));
-				fnAddMainMenuItem(aRet, oCommonUtils.getText("ST_OPEN_NEW_WINDOW"), null, false, Promise.resolve(oNavigationOptions.openExpad.bind(null, 2)));
-			}			
+			//Add an entry for "Open in new tab or window"
+			fnAddOpenInNewTabToContextMenu(oFocusInfo, aRet);
 			return aRet;
 		}
-		/* eslint-enable */
 
 		function fnBeforeOpenContextMenu(oEvent){
-			oEvent.preventDefault();
-			// var aContextMenuItems = getContextMenuItems(oEvent);
-			// oTemplatePrivateModel.setProperty(sModelPath + "/items", aContextMenuItems);
-			// if (aContextMenuItems.length === 0) {
-			// 	oEvent.preventDefault();
-			// }			
+			var aContextMenuItems = getContextMenuItems(oEvent);
+			oTemplatePrivateModel.setProperty(sModelPath + "/items", aContextMenuItems);
+			if (aContextMenuItems.length === 0) {
+				oEvent.preventDefault();
+			}			
 		}
 
 		function onContextMenu(oEvent){

package/src/sap/suite/ui/generic/template/lib/MessageUtils.js

@@ -462,9 +462,37 @@ sap.ui.define([
 					oSettingModel.setProperty("/cancelButtonText", oTemplateContract.getText("CANCEL"));
 					oSettingModel.setProperty("/closeButtonText", oTemplateContract.getText("ST_GENERIC_DIALOG_CLOSE_BUT"));
 				};
+				/**
+				 * Callback function that resolves a promise after validating an URL.
+				 * The URL is validated by sap.ushell.services.Navigation#isUrlSupported method.
+				 * 
+				 * @callback sap.m.MessageView~asyncURLHandler
+				 * @param {object} oConfig A single parameter object
+				 * @param {string} oConfig.url URL to validate
+				 * @param {string|int} oConfig.id ID of the validation job
+				 * @param {object} oConfig.promise Promise object that contains resolve and reject methods
+				 * @param {function} oConfig.promise.resolve Method to resolve promise
+				 * @param {function} oConfig.promise.reject Method to reject promise
+				 */
+				var fnAsyncURLHandler = function (oConfig) {
+					var UShellContainer = sap.ui.require("sap/ushell/Container");
+					if (!UShellContainer) {
+						oConfig.promise.resolve({allowed: false, id: oConfig.id});
+					}
+					UShellContainer.getServiceAsync("Navigation").then(function (oNavService) {
+						oNavService.isUrlSupported(oConfig.url).then(function () {
+							oConfig.promise.resolve({allowed: true, id: oConfig.id});
+						}).catch(function () {
+							oConfig.promise.resolve({allowed: false, id: oConfig.id});
+						});
+					});
+				};
+
 				oTemplateContract.oApplicationProxy.getDialogFragmentAsync("sap.suite.ui.generic.template.fragments.MessageDialog", oDialogFragmentController, "settings", fnOnFragmentCreated, false, true).then(function(odialog){
 					oDialog = odialog;
 					oMessageView = oDialog.getContent()[0];
+					// Add the URL handler to message view
+					oMessageView.setAsyncURLHandler(fnAsyncURLHandler);
 					// the following code prepares the grouping of messages.
 					// Note that grouping will only be done when at least one message is attached to another group then the generic one
 					var oModel = oDialog.getModel();

package/src/sap/suite/ui/generic/template/lib/PageLeaveHandler.js

@@ -188,7 +188,6 @@ sap.ui.define(["sap/ui/base/Object",
 
 		// public instance methods
 		return {
-			discardDraft: fnDiscardDraft,
 			performAfterDiscardOrKeepDraft: fnPerformAfterDiscardOrKeepDraft
 		};
 	}