@sapui5/sap.fe.templates 1.96.0 → 1.97.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.fe.templates",
-	"version": "1.96.0",
+	"version": "1.97.0",
 	"description": "SAPUI5 Library sap.fe.templates",
 	"license": "SEE LICENSE IN LICENSE.txt",
 	"author": "SAP SE (https://www.sap.com)",
@@ -8,14 +8,17 @@
 	"scripts": {
 		"build": "tsc -v && tsc --project tsconfig-build.json",
 		"prepare-npm-sources": "babel target/npm-sources/src --out-dir target/npm-sources/src --extensions \".ts\" --config-file ../../.babelrc",
-		"test": "echo 'nothing to do'"
+		"test": "jest",
+		"test-refs": "jest --config jest.config-refs.js",
+		"test-updateSnapshots": "jest -u"
 	},
 	"keywords": [
 		"sapui5",
 		"ui5"
 	],
 	"devDependencies": {
+		"ts-node": "^9.1.1",
 		"@babel/cli": "^7.14.8",
-		"@ui5/cli": "^2.10.0"
+		"@ui5/cli": "^2.14.0"
 	}
 }

package/src/sap/fe/templates/.library

@@ -6,7 +6,7 @@
     <copyright>SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
     </copyright>
-    <version>1.96.0</version>
+    <version>1.97.0</version>
 
     <documentation>UI5 library: sap.fe.templates</documentation>
 

package/src/sap/fe/templates/ListReport/ListReport.view.xml

@@ -64,7 +64,7 @@
 											<v:VariantManagement
 														id="{= ID.generate([ ${converterContext>filterBarId}, 'VariantManagement']) }"
 														unittest:id="listReportVMControlTest"
-														for="{converterContext>filterBarId}"
+														for="{converterContext>variantManagement/targetControlIds}"
 														showSetAsDefault="true"
 														select=".handlers.onVariantSelected"
 														save=".handlers.onVariantSaved"
@@ -101,7 +101,7 @@
 										<v:VariantManagement
 													id="{= ID.generate([ ${converterContext>filterBarId}, 'VariantManagement']) }"
 													unittest:id="listReportVMControlTest"
-													for="{converterContext>filterBarId}"
+													for="{converterContext>variantManagement/targetControlIds}"
 													showSetAsDefault="true"
 													select=".handlers.onVariantSelected"
 													save=".handlers.onVariantSaved"

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

@@ -34,7 +34,8 @@ sap.ui.define(
 		"sap/fe/macros/CommonHelper",
 		"sap/fe/core/controllerextensions/KPIManagement",
 		"sap/fe/templates/TableScroller",
-		"sap/fe/core/controllerextensions/Placeholder"
+		"sap/fe/core/controllerextensions/Placeholder",
+		"sap/ui/fl/write/api/ControlPersonalizationWriteAPI"
 	],
 	function(
 		PageController,
@@ -66,7 +67,8 @@ sap.ui.define(
 		CommonHelper,
 		KPIManagement,
 		TableScroller,
-		Placeholder
+		Placeholder,
+		ControlPersonalizationWriteAPI
 	) {
 		"use strict";
 		var TemplateContentView = CoreLibrary.TemplateContentView,
@@ -141,7 +143,13 @@ sap.ui.define(
 						CommonUtils.addEventToBindingInfo(oControl, "dataRequested", oUpdateCounts);
 					});
 				}
+				//TODO: This is only a temporary approach and will be removed once app state behaviour is finalized.
 
+				var oUrlParser = sap.ushell && sap.ushell.Container.getService("URLParsing");
+				var oUrlParams = oUrlParser && oUrlParser.parseParameters(window.location.search);
+				if (oUrlParams && oUrlParams["sap-fe-test-appState"]) {
+					this.bTestAppState = true;
+				}
 				oInternalModelContext.setProperty("hasPendingFilters", true);
 				oInternalModelContext.setProperty("appliedFilters", "");
 				oInternalModelContext.setProperty("hideDraftInfo", false);
@@ -245,21 +253,14 @@ sap.ui.define(
 					});
 			},
 			onPageReady: function(mParameters) {
-				var oLastFocusedControl = mParameters.lastFocusedControl;
-				var oView = this.getView();
-				// set the focus to the first action button, or to the first editable input if in editable mode
-				if (oLastFocusedControl && oLastFocusedControl.controlId && oLastFocusedControl.focusInfo) {
-					var oFocusControl = oView.byId(oLastFocusedControl.controlId);
-					if (oFocusControl) {
-						oFocusControl.applyFocusInfo(oLastFocusedControl.focusInfo);
-					}
-				}
-
 				// Enabling mandatory filter fields message dialog and focusing on them
-				var oFilterBar = this._getFilterBarControl();
-				if (oFilterBar && !oFilterBar.getShowMessages()) {
-					oFilterBar.setShowMessages(true);
-					oFilterBar.setFocusOnFirstErroneousField();
+				if (mParameters.forceFocus) {
+					var oFilterBar = this._getFilterBarControl();
+
+					if (oFilterBar && !oFilterBar.getShowMessages()) {
+						oFilterBar.setShowMessages(true);
+						oFilterBar.setFocusOnFirstErroneousField();
+					}
 				}
 			},
 
@@ -589,10 +590,10 @@ sap.ui.define(
 				this._getCurrentControl();
 			},
 			_updateCounts: function() {
-				this._updateMutliModeCounts();
+				this._updateMultiModeCounts();
 			},
 			/**
-			 * Method to determine if a tab from the list report is a custom tab..
+			 * Method to determine if a tab from the list report is a custom tab.
 			 *
 			 * @function
 			 * @name _isCustomTab
@@ -602,7 +603,7 @@ sap.ui.define(
 				var oMultiModeControl = this._getMultiModeControl();
 				return oMultiModeControl && oMultiModeControl.getSelectedKey().indexOf("::CustomTab::") > -1;
 			},
-			_updateMutliModeCounts: function() {
+			_updateMultiModeCounts: function() {
 				var that = this;
 				var aBindingPromises = [];
 				var oMultiModeControl = this._getMultiModeControl();
@@ -680,54 +681,74 @@ sap.ui.define(
 			},
 			handlers: {
 				onTabMultiModeChange: function(oEvent) {
-					this._updateMultiModeSelectedControl();
-					this._updateMultiControlHiddenStatus();
-					var oFilterBar = this._getFilterBarControl();
-					var oInternalModelContext = this.getView().getBindingContext("internal");
-					var oDisplayedControl = this._getCurrentControl();
-					var oMultiModeControl = this._getMultiModeControl();
-					oInternalModelContext.setProperty("tabs/selected", oMultiModeControl.getSelectedKey());
-					if (oFilterBar && oInternalModelContext.getProperty("hasPendingFilters") !== true) {
-						// No pending filters into FilterBar
-						if (this._isCustomTab()) {
-							var oFilterConditions = oFilterBar.getFilterConditions();
-							this.onViewNeedsRefresh({
-								filterConditions: oFilterConditions,
-								currentTabId: oMultiModeControl.getSelectedKey(),
-								refreshCause: "tabChanged"
-							});
-						} else if (
-							!oDisplayedControl.isA("sap.ui.mdc.ChartNew") &&
-							(!oDisplayedControl.getRowBinding() || // first time the tab/table is displayed
-								oDisplayedControl.data("outdatedRows") === true)
-						) {
-							// Search has been triggered on a different tab {}
-							oDisplayedControl.rebindTable();
-							oDisplayedControl.data("outdatedRows", false);
-						} else if (
-							oDisplayedControl.isA("sap.ui.mdc.ChartNew") &&
-							(!oDisplayedControl
-								.getControlDelegate()
-								._getChart(oDisplayedControl)
-								.getBinding("data") || // first time the tab/chart is displayed
-								oDisplayedControl.data("outdatedRows") === true)
-						) {
-							var oInnerChart = oDisplayedControl.getControlDelegate()._getChart(oDisplayedControl);
-							oDisplayedControl.getControlDelegate().rebindChart(oDisplayedControl, oInnerChart.getBindingInfo("data"));
-							oDisplayedControl.data("outdatedRows", false);
+					if (oEvent && oEvent.mParameters && oEvent.mParameters.previousKey != oEvent.mParameters.selectedKey) {
+						this._updateMultiModeSelectedControl();
+						this._updateMultiControlHiddenStatus();
+						var oFilterBar = this._getFilterBarControl();
+						var oInternalModelContext = this.getView().getBindingContext("internal");
+						var oDisplayedControl = this._getCurrentControl();
+						var oMultiModeControl = this._getMultiModeControl();
+						var sSelectedKey = oMultiModeControl.getSelectedKey();
+
+						oInternalModelContext.setProperty("tabs/selected", sSelectedKey);
+						if (oFilterBar && oInternalModelContext.getProperty("hasPendingFilters") !== true) {
+							// No pending filters into FilterBar
+							if (this._isCustomTab()) {
+								var oFilterConditions = oFilterBar.getFilterConditions();
+								this.onViewNeedsRefresh({
+									filterConditions: oFilterConditions,
+									currentTabId: sSelectedKey,
+									refreshCause: "tabChanged"
+								});
+							} else if (
+								!oDisplayedControl.isA("sap.ui.mdc.ChartNew") &&
+								(!oDisplayedControl.getRowBinding() || // first time the tab/table is displayed
+									oDisplayedControl.data("outdatedRows") === true)
+							) {
+								// Search has been triggered on a different tab {}
+								oDisplayedControl.rebindTable();
+								oDisplayedControl.data("outdatedRows", false);
+							} else if (
+								oDisplayedControl.isA("sap.ui.mdc.ChartNew") &&
+								(!oDisplayedControl
+									.getControlDelegate()
+									._getChart(oDisplayedControl)
+									.getBinding("data") || // first time the tab/chart is displayed
+									oDisplayedControl.data("outdatedRows") === true)
+							) {
+								var oInnerChart = oDisplayedControl.getControlDelegate()._getChart(oDisplayedControl);
+								oDisplayedControl.getControlDelegate().rebindChart(oDisplayedControl, oInnerChart.getBindingInfo("data"));
+								oDisplayedControl.data("outdatedRows", false);
+							}
 						}
+						/* Need to disable it because of IconTabBar regression : BCP 2170302705
+						var sPreviousSelectedKey = oEvent && oEvent.mParameters ? oEvent.mParameters.previousKey : undefined;
+
+						ControlPersonalizationWriteAPI.add({
+							changes: [
+								{
+									changeSpecificData: {
+										changeType: "selectIconTabBarFilter",
+										content: {
+											selectedKey: sSelectedKey,
+											previousSelectedKey: sPreviousSelectedKey
+										}
+									},
+									selectorElement: oMultiModeControl
+								}
+							]
+						});
+						*/
+						this.getExtensionAPI().updateAppState();
 					}
-					this.getExtensionAPI().updateAppState();
 				},
 				onFiltersChanged: function(oEvent) {
 					var oFilterBar = this._getFilterBarControl(),
 						oInternalModelContext = this.getView().getBindingContext("internal");
 					// Pending filters into FilterBar to be used for custom views
 					this.onPendingFilters();
-					var bHideDraft = FilterUtils.getEditStateIsHideDraft(oFilterBar.getConditions());
 					oInternalModelContext.setProperty("appliedFilters", oFilterBar.getAssignedFiltersText().filtersText);
 					oInternalModelContext.setProperty("hasPendingFilters", true);
-					oInternalModelContext.setProperty("hideDraftInfo", bHideDraft);
 					if (oEvent.getParameter("conditionsBased")) {
 						this.getExtensionAPI().updateAppState();
 					}
@@ -737,6 +758,9 @@ sap.ui.define(
 						oVM = oEvent.getSource();
 					// setTimeout cause the variant needs to be applied before judging the auto search or updating the app state
 					setTimeout(function() {
+						if (that._isMultiMode()) {
+							that.handlers.onTabMultiModeChange.apply(that);
+						}
 						if (that._shouldAutoTriggerSearch(oVM)) {
 							// the app state will be updated via onSearch handler
 							return that._getFilterBarControl().triggerSearch();
@@ -757,7 +781,9 @@ sap.ui.define(
 					var oFilterBar = this._getFilterBarControl();
 					var oInternalModelContext = this.getView().getBindingContext("internal");
 					var oMdcChart = this.getChartControl();
+					var bHideDraft = FilterUtils.getEditStateIsHideDraft(oFilterBar.getConditions());
 					oInternalModelContext.setProperty("hasPendingFilters", false);
+					oInternalModelContext.setProperty("hideDraftInfo", bHideDraft);
 					if (this._isMultiMode()) {
 						var aControls = this._getControls(),
 							oMultiModeControl = this._getMultiModeControl();
@@ -816,7 +842,7 @@ sap.ui.define(
 				 *
 				 * @param {object} oController
 				 * @param {string} sOutboundTarget Name of the outbound target (needs to be defined in the manifest)
-				 * @param {sap.ui.model.odata.v4.Context} oContext The context that contain the data for the target app
+				 * @param {sap.ui.model.odata.v4.Context} oContext The context that contains the data for the target app
 				 * @param {string} sCreatePath Create path when the chevron is created.
 				 * @returns {Promise} Promise which is resolved once the navigation is triggered
 				 * @ui5-restricted
@@ -908,6 +934,11 @@ sap.ui.define(
 							)
 							.setVisible(true);
 					}
+				},
+				onTableStateChanged: function(oEvent) {
+					if (this.bTestAppState) {
+						this.getExtensionAPI().updateAppState();
+					}
 				}
 			},
 			formatters: {
@@ -930,9 +961,9 @@ sap.ui.define(
 					}
 				},
 				/**
-				 * Method to set the message text for the multi-EntitySet scenario when fields in the FilterBar need to be ignored.
+				 * Method to set the message text for the multiple entity sets when fields in the FilterBar need to be ignored.
 				 *
-				 * @param {Array} aIgnoredFields Array of ignored fields in the FilterBar for the current tab (multi EntitySet scenario)
+				 * @param {Array} aIgnoredFields Array of ignored fields in the FilterBar for the current tab (multiple entity sets)
 				 * @param {string} sTabTitle Tab title
 				 * @returns {string} Message text
 				 */

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

@@ -7,13 +7,14 @@ sap.ui.define(
 		"sap/fe/core/library",
 		"sap/fe/navigation/library",
 		"sap/fe/core/CommonUtils",
+		"sap/fe/core/helpers/KeepAliveHelper",
 		"sap/ui/fl/apply/api/ControlVariantApplyAPI",
 		"sap/ui/mdc/p13n/StateUtil",
 		"sap/ui/Device",
 		"sap/ui/mdc/enum/ConditionValidated",
 		"sap/base/Log"
 	],
-	function(CoreLibrary, NavLibrary, CommonUtils, ControlVariantApplyAPI, StateUtil, Device, ConditionValidated, Log) {
+	function(CoreLibrary, NavLibrary, CommonUtils, KeepAliveHelper, ControlVariantApplyAPI, StateUtil, Device, ConditionValidated, Log) {
 		"use strict";
 
 		var NavType = NavLibrary.NavType,
@@ -48,7 +49,7 @@ sap.ui.define(
 				var oView = this.getView(),
 					oController = oView.getController(),
 					aViewControls = oController._getControls(),
-					aControlsToRefresh = CommonUtils.getControlsForRefresh(oView, aViewControls);
+					aControlsToRefresh = KeepAliveHelper.getControlsForRefresh(oView, aViewControls);
 
 				Array.prototype.push.apply(aControls, aControlsToRefresh);
 			},
@@ -56,7 +57,8 @@ sap.ui.define(
 				var oView = this.getView(),
 					oController = oView.getController(),
 					oViewData = oView.getViewData(),
-					bControlVM = oViewData.variantManagement === VariantManagement.Control;
+					bControlVM = oViewData.variantManagement === VariantManagement.Control,
+					that = this;
 
 				if (oController._isMultiMode()) {
 					aStateControls.push(oController._getMultiModeControl());
@@ -74,6 +76,9 @@ sap.ui.define(
 					if (bControlVM) {
 						aStateControls.push(oTable.getVariant());
 					}
+					if (that.getView().getController().bTestAppState) {
+						aStateControls.push(oTable);
+					}
 				});
 
 				if (oController._hasMultiVisualizations()) {
@@ -83,6 +88,22 @@ sap.ui.define(
 				aStateControls.push(oController._getFilterBarControl());
 				aStateControls.push(oView.byId("fe::ListReport"));
 			},
+			adaptControlStateHandler: function(oControl, aControlHandler) {
+				if (oControl.isA("sap.ui.fl.variants.VariantManagement")) {
+					aControlHandler.push({
+						retrieve: function(oVM) {
+							return {
+								"variantId": oVM.getCurrentVariantKey()
+							};
+						},
+						apply: function(oVM, oControlState) {
+							if (oControlState && oControlState.variantId !== undefined) {
+								oVM.setModified(true);
+							}
+						}
+					});
+				}
+			},
 			retrieveAdditionalStates: function(mAdditionalStates) {
 				var oView = this.getView(),
 					oController = oView.getController(),
@@ -217,9 +238,12 @@ sap.ui.define(
 			},
 
 			_applyControlVariant: function(oVariant, sVariantID, bFilterVariantApplied) {
+				var sVariantReference = this._checkIfVariantIdIsAvailable(oVariant, sVariantID)
+					? sVariantID
+					: oVariant.getStandardVariantKey();
 				var oVM = ControlVariantApplyAPI.activateVariant({
 					element: oVariant,
-					variantReference: sVariantID
+					variantReference: sVariantReference
 				});
 				return oVM.then(function() {
 					return bFilterVariantApplied;
@@ -304,9 +328,11 @@ sap.ui.define(
 				} else {
 					oPromise = Promise.resolve(true);
 				}
-
 				return oPromise.then(function(bClearFilterAndReplaceWithAppState) {
 					if (bClearFilterAndReplaceWithAppState) {
+						if (that.getView().getController().bTestAppState) {
+							return that._fnApplyConditions(oFilterBar, oConditions);
+						}
 						return that._fnClearFilterAndReplaceWithAppState(oFilterBar, oConditions);
 					}
 				});

package/src/sap/fe/templates/ObjectPage/AnnotationHelper.js

@@ -359,7 +359,7 @@ sap.ui.define(
 					entitySetName: CommonHelper.addSingleQuotes(sEntitySetName),
 					invocationGrouping: CommonHelper.addSingleQuotes(sInvocationGroup),
 					model: "${$source>/}.getModel()",
-					label: CommonHelper.addSingleQuotes(oDataField && oDataField.Label),
+					label: CommonHelper.addSingleQuotes(oDataField && oDataField.Label, true),
 					isNavigable: oHeaderAction && oHeaderAction.isNavigable,
 					defaultValuesExtensionFunction:
 						oHeaderAction && oHeaderAction.defaultValuesExtensionFunction
@@ -392,7 +392,7 @@ sap.ui.define(
 					entitySetName: CommonHelper.addSingleQuotes(sEntitySetName),
 					invocationGrouping: CommonHelper.addSingleQuotes(sInvocationGroup),
 					model: "${$source>/}.getModel()",
-					label: CommonHelper.addSingleQuotes(oDataField && oDataField.Label),
+					label: CommonHelper.addSingleQuotes(oDataField && oDataField.Label, true),
 					isNavigable: oHeaderAction && oHeaderAction.isNavigable,
 					defaultValuesExtensionFunction:
 						oHeaderAction && oHeaderAction.defaultValuesExtensionFunction

package/src/sap/fe/templates/ObjectPage/Component.js

@@ -68,6 +68,12 @@ sap.ui.define(
 						prepareOnEdit: {
 							type: "boolean",
 							defaultValue: false
+						},
+						/**
+						 * Defines the properties which can be used for inbound Navigation
+						 */
+						inboundParameters: {
+							type: "object"
 						}
 					},
 					library: "sap.fe.templates",
@@ -99,12 +105,23 @@ sap.ui.define(
 							oParamters
 						);
 
+						var oStartUpParams =
+								this.oAppComponent &&
+								this.oAppComponent.getComponentData() &&
+								this.oAppComponent.getComponentData().startupParameters,
+							oInboundParameters = this.getViewData().inboundParameters,
+							createParams;
+						if (oStartUpParams.preferredMode && oStartUpParams.preferredMode[0].indexOf("create") !== -1) {
+							createParams = CommonUtils.getAdditionalParamsForCreate(oStartUpParams, oInboundParameters);
+						}
+
 						// for now wait until the view and the controller is created
 						that.getRootControl()
 							.getController()
 							.editFlow.createDocument(oListBinding, {
 								creationMode: "Sync",
-								createAction: bActionCreate
+								createAction: bActionCreate,
+								data: createParams
 							})
 							.finally(function() {
 								that.DeferredContextCreated = false;