@sapui5/sap.suite.ui.generic.template 1.131.1 → 1.133.0

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

@@ -24,7 +24,7 @@ sap.ui.define([
 	"sap/base/util/extend",
 	"sap/base/util/isPlainObject",
 	"sap/m/NavContainer",
-	"sap/f/FlexibleColumnLayout",
+	"sap/suite/ui/generic/template/lib/FlexibleColumnLayoutHelper",
 	"sap/ui/core/UIComponent",
 	"sap/ui/model/base/ManagedObjectModel",
 	"sap/ui/model/Filter",
@@ -59,14 +59,16 @@ sap.ui.define([
 	"sap/suite/ui/generic/template/lib/ai/FioriAIHandler",
 	"sap/suite/ui/generic/template/lib/RetryAfterHandler",
 	"sap/suite/ui/generic/template/js/RuntimeFormatters",  // just to make sure that this class is loaded
-	"sap/f/FlexibleColumnLayoutData",
-	"sap/f/FlexibleColumnLayoutDataForDesktop",
-	"sap/f/FlexibleColumnLayoutDataForTablet"
+	"sap/suite/ui/generic/template/lib/ShellPersonalizationService",
+	// As per UI5 2.0 mandate, making sure that the routers are loaded before the AppComponent is initialized.
+	// Please don't remove them
+	"sap/m/routing/Router",
+	"sap/f/routing/Router"
 ], function(
 	extend,
 	isPlainObject,
 	NavContainer,
-	FlexibleColumnLayout,
+	FlexibleColumnLayoutHelper,
 	UIComponent,
 	ManagedObjectModel,
 	Filter,
@@ -97,13 +99,11 @@ sap.ui.define([
 	JouleContextProvider,
 	ServiceFactoryRegistry,
 	VersionInfo,
-	IllustratedMessageType, 
+	IllustratedMessageType,
 	FioriAIHandler,
 	RetryAfterHandler,
 	RuntimeFormatters,
-	FlexibleColumnLayoutData,
-	FlexibleColumnLayoutDataForDesktop,
-	FlexibleColumnLayoutDataForTablet
+	ShellPersonalizationService
 ) {
 	"use strict";
 	var	sClassName = "lib.AppComponent";
@@ -147,8 +147,6 @@ sap.ui.define([
 
 		var fnLeaveAppResolve;
 		var oTemplateContract = { // template contract object which is used for data interchange between framework classes
-			getStoredLayout: getStoredLayout,
-			setColumnDistributionModel: setColumnDistributionModel,
 			oAppComponent: oAppComponent,
 			leaveAppPromise: Promise.resolve(),	// promise which is resolved once the user leaves the component
 			ghostapp: (function(){
@@ -280,9 +278,6 @@ sap.ui.define([
 		var oNavigationController; // instance of NavigationController
 		var fnDeregister; // function to be called to deregister at TemplateContract
 
-		var shellPersonalizationService;
-		var applicationPersonalizers = {};
-
 		// Begin: Private helper methods called in init
 
 		// This function instantiates the global private model that can be used as named model with name  _templPrivGlobal in all views and fragments.
@@ -519,215 +514,11 @@ sap.ui.define([
 			var oRetryAfterHandler = new RetryAfterHandler(oTemplateContract, oAppComponent);
 			oRetryAfterHandler.registerRetryAfterHandler();
 
-			if (UShellContainer) {
-				var oShellPersonalizationServicePromise = UShellContainer.getServiceAsync("PersonalizationV2");
-				oShellPersonalizationServicePromise.then((oShellPersonalizationService) => {
-					shellPersonalizationService = oShellPersonalizationService;
-				});
-			}
-			
-			oLogger.info("Init done for AppComponent " + sAppComponentId);
-		}
-
-		/**
-		 * Gets the personalizer from the shell service.
-		 * We set some defaults for the scope object.
-		 * @param persId Personalization object
-		 * @param scope Scope object
-		 * @param component
-		 * @returns {Promise<PersonalizerType> | undefined} Personalizer object which handles personalization
-		 */
-		async function getPersonalizer(persId, scope, component) {
-			if (!shellPersonalizationService) {
-				return;
-			}
-			scope = {
-				// merge some defaults
-				keyCategory: shellPersonalizationService.constants.keyCategory.FIXED_KEY,
-				writeFrequency: shellPersonalizationService.constants.writeFrequency.LOW,
-				clientStorageAllowed: false,
-				validity: Infinity,
-				...scope
-			};
-			return shellPersonalizationService.getPersonalizer(persId, scope, component);
-		}
-
-		/**
-		 * Prepares the container name for personalizer.
-		 * @returns Container name
-		 */
-		function getContainerName() {
-			// personalizer logs error if name longer than 40 symbols
-			var sContainer = `App#${(oAppComponent).getManifest()["sap.app"].id}`;
-			return sContainer;
-		}
-
-		/**
-		 * Initializes the personalizer to access the Application data stored in the shell Personalization.
-		 * @param {string} itemName The name of the item for which the personalizer is created.
-		 * @returns {Promise<PersonalizerType>} A personalizer
-		 */
-		async function getApplicationPersonalizer(itemName) {
-			if (!applicationPersonalizers[itemName]) {
-				applicationPersonalizers[itemName] = getPersonalizer(
-					{
-						container: getContainerName(),
-						item: itemName
-					},
-					{},
-					oAppComponent
-				);
-			}
-			return applicationPersonalizers[itemName];
-		}
-
-		/**
-		 * Returns data from the personalization service.
-		 * @param {string} itemName
-		 * @returns {Promise<object | undefined>} Data
-		 */
-		async function getApplicationPersonalizationData(itemName) {
-			return (await (await getApplicationPersonalizer(itemName))?.getPersData());
-		}
-
-		/**
-		 * Stores an object in the personalization service.
-		 * @param {string} itemName
-		 * @param {object} data
-		 * @returns {Promise<void>} A promise
-		 */
-		async function setApplicationPersonalizationData(itemName, data) {
-			(await getApplicationPersonalizer(itemName)).setPersData(data);
-		}
-
-		/**
-		 * Retieves the FCL state from the personalization service.
-		 * @returns The FCL state
-		 */
-		async function getFCLPersonalizationData() {
-			var oEmptyFCLState = {
-				defaultLayouts: {},
-				columnsDistribution: {
-					desktop: {},
-					tablet: {}
-				}
-			};
-			return ((await getApplicationPersonalizationData("FCL-Personalization")) ?? oEmptyFCLState);
-		}
+			oTemplateContract.oShellPersonalizationService = new ShellPersonalizationService(oTemplateContract);
+			var oShellPersonalizatonServicePromise = oTemplateContract.oShellPersonalizationService.init();
+			oTemplateContract.oBusyHelper.setBusy(oShellPersonalizatonServicePromise, undefined, undefined, true);
 
-		/**
-		 * Sets the FCL state in the personalization service.
-		 * @param fclState The FCL state
-		 */
-		function setFCLPersonalizationData(fclState) {
-			setApplicationPersonalizationData("FCL-Personalization", fclState);
-		}
-
-		/**
-		 * Requests the FCL state from the personalization service and sets the model accordingly.
-		 */
-		async function setColumnDistributionModel() {
-			if (!shellPersonalizationService) {
-				return;
-			}
-			var oColumnsDistribution = (await getFCLPersonalizationData()).columnsDistribution;
-			if (oColumnsDistribution) {
-				var oTemplatePrivateGlobalModel = oAppComponent.getModel("_templPrivGlobal");
-				oTemplatePrivateGlobalModel.setProperty("/generic/FCL/FCLColumnsDistribution", oColumnsDistribution);
-			}
-		}
-
-		/**
-		 * Is called when the user changes the FCL columns distribution.
-		 * Updates the FCL state in the personalization service.
-		 * @param {Event<{ media: "tablet" | "desktop"; layout: LayoutTypeType; columnsSizes: string }>} event
-		 */
-		async function onColumnsDistributionChange(event) {
-			if (!shellPersonalizationService) {
-				return;
-			}
-			
-			var { media, layout, columnsSizes } = event.getParameters();
-			
-			var oTemplatePrivateGlobalModel = oAppComponent.getModel("_templPrivGlobal");
-			oTemplatePrivateGlobalModel.setProperty(`/generic/FCL/FCLColumnsDistribution/${media}/${layout}`, columnsSizes);
-			
-			var oFclState = await getFCLPersonalizationData();
-			var iColumnsDisplayed = getNumberOfColumnsFromLayout(layout);
-			if (iColumnsDisplayed) {
-				oFclState.defaultLayouts[iColumnsDisplayed] = layout;
-				oFclState.columnsDistribution[media][layout] = columnsSizes;
-				setFCLPersonalizationData(oFclState);
-			}
-		}
-
-		/**
-		 * Gets the number of columns displayed in the FCL based on the layout.
-		 * @param {LayoutTypeType} layout  The layout
-		 * @returns {1 | 2 | 3 | null} The number of columns displayed
-		 */
-		function getNumberOfColumnsFromLayout(layout) {
-			var iColumnsDisplayed = /^(One|Two|Three)Column/.exec(layout)?.[1];
-			switch (iColumnsDisplayed) {
-				case "One":
-					return 1;
-				case "Two":
-					return 2;
-				case "Three":
-					return 3;
-				default:
-					return null;
-			}
-		}
-
-		/**
-		 * Gets the layout stored in the personalization service based on the proposed layout.
-		 * @param {LayoutTypeType | undefined } proposedLayout
-		 * @returns The FCL layout stored in the personalization service
-		 */
-		async function getStoredLayout(oProposedLayout) {
-			if (shellPersonalizationService) {
-				var iColumnsDisplayed = getNumberOfColumnsFromLayout(oProposedLayout);
-				if (iColumnsDisplayed) {
-					var defaultLayouts = (await getFCLPersonalizationData()).defaultLayouts;
-					return defaultLayouts?.[iColumnsDisplayed] ?? oProposedLayout;
-				}
-			}
-			return oProposedLayout;
-		}
-
-		function initFlexibleColumnLayout() {
-			var oFCL = new FlexibleColumnLayout();
-
-			var oLayoutData = new FlexibleColumnLayoutData();
-			var oDesktopLayoutData = new FlexibleColumnLayoutDataForDesktop();
-			var oTabletLayoutData = new FlexibleColumnLayoutDataForTablet();
-			
-			var sFCLColumnsDistributionPath = "_templPrivGlobal>/generic/FCL/FCLColumnsDistribution";
-			var sDesktopFCLColumnsDistributionPath = `${sFCLColumnsDistributionPath}/desktop`;
-			var sTabletFCLColumnsDistributionPath = `${sFCLColumnsDistributionPath}/tablet`;
-			
-			oDesktopLayoutData.bindProperty("twoColumnsBeginExpanded", `${sDesktopFCLColumnsDistributionPath}/TwoColumnsBeginExpanded`);
-			oDesktopLayoutData.bindProperty("twoColumnsMidExpanded", `${sDesktopFCLColumnsDistributionPath}/TwoColumnsMidExpanded`);
-			oDesktopLayoutData.bindProperty("threeColumnsBeginExpandedEndHidden", `${sDesktopFCLColumnsDistributionPath}/ThreeColumnsBeginExpandedEndHidden`);
-			oDesktopLayoutData.bindProperty("threeColumnsEndExpanded", `${sDesktopFCLColumnsDistributionPath}/ThreeColumnsEndExpanded`);
-			oDesktopLayoutData.bindProperty("threeColumnsMidExpanded", `${sDesktopFCLColumnsDistributionPath}/ThreeColumnsMidExpanded`);
-			oDesktopLayoutData.bindProperty("threeColumnsMidExpandedEndHidden", `${sDesktopFCLColumnsDistributionPath}/ThreeColumnsMidExpandedEndHidden`);
-
-			oTabletLayoutData.bindProperty("twoColumnsBeginExpanded", `${sTabletFCLColumnsDistributionPath}/TwoColumnsBeginExpanded`);
-			oTabletLayoutData.bindProperty("twoColumnsMidExpanded", `${sTabletFCLColumnsDistributionPath}/TwoColumnsMidExpanded`);
-			oTabletLayoutData.bindProperty("threeColumnsBeginExpandedEndHidden", `${sTabletFCLColumnsDistributionPath}/ThreeColumnsBeginExpandedEndHidden`);
-			oTabletLayoutData.bindProperty("threeColumnsEndExpanded", `${sTabletFCLColumnsDistributionPath}/ThreeColumnsEndExpanded`);
-			oTabletLayoutData.bindProperty("threeColumnsMidExpanded", `${sTabletFCLColumnsDistributionPath}/ThreeColumnsMidExpanded`);
-			oTabletLayoutData.bindProperty("threeColumnsMidExpandedEndHidden", `${sTabletFCLColumnsDistributionPath}/ThreeColumnsMidExpandedEndHidden`);
-
-			oLayoutData.setDesktopLayoutData(oDesktopLayoutData);
-			oLayoutData.setTabletLayoutData(oTabletLayoutData);
-			oFCL.setAggregation("layoutData", oLayoutData);
-
-			oFCL.attachColumnsDistributionChange(onColumnsDistributionChange);
-
-			return oFCL;
+			oLogger.info("Init done for AppComponent " + sAppComponentId);
 		}
 
 		function createContent(){
@@ -736,8 +527,8 @@ sap.ui.define([
 				return "";
 			}
 			if (oAppComponent.getFlexibleColumnLayout()){
-				var oFCL = initFlexibleColumnLayout();
-				
+				var oFCL = new FlexibleColumnLayoutHelper(oTemplateContract).initFlexibleColumnLayout();
+
 				oTemplateContract.oNavigationHost = oFCL;
 				oTemplateContract.aNavigationObservers = [
 					new ProcessObserver({
@@ -1160,7 +951,7 @@ sap.ui.define([
 	 * @public
 	 * @extends sap.ui.core.UIComponent
 	 * @author SAP SE
-	 * @version 1.131.1
+	 * @version 1.133.0
 	 * @name sap.suite.ui.generic.template.lib.AppComponent
 	 */
 	var oAppComponent = UIComponent.extend("sap.suite.ui.generic.template.lib.AppComponent", {

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

@@ -10,10 +10,15 @@
  */
 
  sap.ui.define(["sap/ui/base/Object", "sap/ui/model/Filter", "sap/ui/model/FilterOperator", "sap/base/util/extend", "sap/suite/ui/generic/template/lib/MessageUtils", "sap/ui/model/json/JSONModel", 
- "sap/suite/ui/generic/template/genericUtilities/controlHelper", "sap/ui/core/message/MessageType"
-], function(BaseObject, Filter, FilterOperator, extend, MessageUtils, JSONModel, controlHelper, MessageType) {
+	"sap/suite/ui/generic/template/genericUtilities/controlHelper", "sap/ui/core/message/MessageType",
+	"sap/suite/ui/generic/template/genericUtilities/FeLogger"
+], function(BaseObject, Filter, FilterOperator, extend, MessageUtils, JSONModel, controlHelper, MessageType, FeLogger) {
 	"use strict";
 
+	var oFeLogger = new FeLogger("lib.CRUDActionHandler");
+	var oLogger = oFeLogger.getLogger();
+	oLogger.setLevel(oFeLogger.Level.ALL);
+
 	// A Filter that filters for messages that are at least of severity warning
 	var oAtLeastWarningFilter = new Filter({
 		filters: [new Filter({
@@ -229,7 +234,11 @@
 		// Performs an Activate/Save resp. Apply operation when all prerequisites are given
 		function fnPrepareAndRunSaveOperation(bIsActivation, fnOperation){
 			oTemplateContract.oApplicationProxy.performAfterSideEffectExecution(function(){
-				fnBeforeOperation(bIsActivation).then(fnOperation);
+				fnBeforeOperation(bIsActivation)
+					.then(fnOperation)
+					.catch(function(){
+						oLogger.info("Can't proceed with 'Save' as 'fnBeforeOperation' checks have failed");
+					});
 			}, true);
 		}
 

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

@@ -216,7 +216,7 @@ sap.ui.define(["sap/ui/model/Context", "sap/suite/ui/generic/template/lib/Messag
 						]);
 				var sEdit =  oResourceObject.getText("Edit");
 				var sCancel =  oResourceObject.getText("CANCEL");
-					MessageBox.warning(sWarningText, {
+				MessageBox.warning(sWarningText, {
 					title: oResourceObject.getText("ST_UNSAVED_CHANGES_TITLE"),
 					actions: [sEdit, sCancel],
 					emphasizedAction: sEdit,
@@ -224,7 +224,7 @@ sap.ui.define(["sap/ui/model/Context", "sap/suite/ui/generic/template/lib/Messag
 						if (sAction === sEdit) {
 							resolve();
 						} else if (sAction === sCancel) {
-							if (bOpenInEditMode) {
+							if (bOpenInEditMode && oViewProxy && oViewProxy.navigateUp) {
 								oViewProxy.navigateUp();
 							}
 						}
@@ -368,7 +368,9 @@ sap.ui.define(["sap/ui/model/Context", "sap/suite/ui/generic/template/lib/Messag
 												});
 												oApplication.getBusyHelper().setBusy(oUnsavedChangesEditPromise, true);
 											};
-											var editRejection = Function.prototype;
+											var editRejection = reject({
+												cancelled: true
+											});
 											var unSavedChangesDialogPromise = fnUnsavedChangesDialog(undefined, oResponse.DraftAdministrativeData,oCommonUtils, oViewProxy, bOpenInEditMode);
 											unSavedChangesDialogPromise.then(editConfirmation,editRejection);
 										}

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

@@ -27,7 +27,8 @@ sap.ui.define(["sap/ui/base/Object",
 	'sap/ui/performance/trace/FESRHelper',
 	"sap/ui/core/CustomData",
 	"sap/m/VBox",
-	"sap/suite/ui/generic/template/genericUtilities/utils"
+	"sap/suite/ui/generic/template/genericUtilities/utils",
+	"sap/ui/core/Element"
 ], function(
 	BaseObject,
 	Event,
@@ -58,7 +59,9 @@ sap.ui.define(["sap/ui/base/Object",
 	FESRHelper,
 	CustomData,
 	VBox,
-	genericUtils) {
+	genericUtils,
+	Element
+) {
 	"use strict";
 
 	var oLogger = new FeLogger("lib.CommonEventHandlers").getLogger();
@@ -829,7 +832,7 @@ sap.ui.define(["sap/ui/base/Object",
 							// Element.closest is not supported in IE11 so we are injecting polyFill as dependency
 							var closestUI5ControlNode = oElement.closest('[data-sap-ui]');
 							if (closestUI5ControlNode) {
-								oControl = sap.ui.getCore().byId(closestUI5ControlNode.id);
+								oControl = Element.getElementById(closestUI5ControlNode.id);
 							}
 						}
 					}
@@ -981,7 +984,16 @@ sap.ui.define(["sap/ui/base/Object",
 							onSemanticObjectLinkNavigationPressed : oController._templateEventHandlers.onSemanticObjectLinkNavigationPressed.bind(oController._templateEventHandlers),
 							onDataFieldWithIntentBasedNavigation  : oController._templateEventHandlers.onDataFieldWithIntentBasedNavigation.bind(oController._templateEventHandlers),
 							onDataFieldWithEmail: oController._templateEventHandlers.onDataFieldWithEmail.bind(oController._templateEventHandlers),
-							onTeamsCollabOptionPress: onTeamsCollabOptionPress.bind(this)
+							onTeamsCollabOptionPress: onTeamsCollabOptionPress.bind(this),
+							onContactDetails: onContactDetails.bind(this),
+							// Ignoring the below events since quick view forms don't handle side effects. Handle them if support is added in the future.
+							onSmartFieldModeToggled: Function.prototype, 
+							onSmartFieldModelValueChanged: Function.prototype,
+							// Ignoring this event as SmartMultiInput isn't rendered in the quick view smart form.
+							submitChangesForSmartMultiInput: Function.prototype,
+							// Handle the event only if it's supported in the current floor plan.
+							onDataFieldWithNavigationPath: oController._templateEventHandlers.onDataFieldWithNavigationPath?.bind(oController._templateEventHandlers) || Function.prototype,
+							onSmartFieldPress: oController._templateEventHandlers.onSmartFieldPress?.bind(oController._templateEventHandlers) || Function.prototype
 						},
 						onInit : function() {},
 						onExit : function() {},
@@ -1095,6 +1107,9 @@ sap.ui.define(["sap/ui/base/Object",
 								oMainNavigation.setDescription(oTexts.secondText);
 							}
 							sTitle = oTexts.firstText;
+							if (sTextArrangement && oTexts.secondText) {
+								sTitle = oTexts.firstText + " " + oTexts.secondText;
+							}
 						}
 					}
 					fnRenderTeamsCollabOptionsOnContactCard(oEntityType, oEventParameters, aTeamsCollabOptions, oControl, sControlBindingContextPath);
@@ -1663,6 +1678,10 @@ sap.ui.define(["sap/ui/base/Object",
 					if (oError.lockedByUser) {
 						var sLockText = oCommonUtils.getText("ST_GENERIC_DRAFT_LOCKED_BY_USER", [" ", oError.lockedByUser]);
 						MessageBox.error(sLockText);
+					} else if (oError.cancelled) {
+						if (oViewProxy && oViewProxy.navigateUp){
+							oViewProxy.navigateUp();
+						}
 					} else {
 						MessageUtils.handleError(MessageUtils.operations.editEntity, oController, oServices, oError);
 						if (oViewProxy && oViewProxy.navigateUp){
@@ -2605,7 +2624,7 @@ sap.ui.define(["sap/ui/base/Object",
 		function onSmartLabelAttachFieldVisibility(oSmartField, sViewId){
 			var sValue = oSmartField.data('LabelId');
 			var sSmartLabelId = sViewId + '--' + sValue;
-			var oSmartLabel = sap.ui.getCore().byId(sSmartLabelId);
+			var oSmartLabel = Element.getElementById(sSmartLabelId);
 			if (oSmartLabel) {
 			oSmartLabel.attachFieldVisibilityChange(oSmartField);
 			}