@openui5/sap.ui.rta 1.103.0 → 1.105.0

package/src/sap/ui/rta/util/changeVisualization/ChangeVisualization.js

@@ -8,13 +8,10 @@ sap.ui.define([
 	"sap/ui/core/Fragment",
 	"sap/base/util/restricted/_difference",
 	"sap/base/util/deepEqual",
-	"sap/base/Log",
 	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/core/Control",
 	"sap/ui/dt/OverlayRegistry",
 	"sap/ui/dt/ElementUtil",
-	"sap/ui/fl/apply/_internal/changes/Utils",
-	"sap/ui/fl/write/api/ChangesWriteAPI",
 	"sap/ui/fl/write/api/PersistenceWriteAPI",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils",
@@ -26,13 +23,10 @@ sap.ui.define([
 	Fragment,
 	difference,
 	deepEqual,
-	Log,
 	JsControlTreeModifier,
 	Control,
 	OverlayRegistry,
 	ElementUtil,
-	ChangesUtils,
-	ChangesWriteAPI,
 	PersistenceWriteAPI,
 	Layer,
 	FlUtils,
@@ -93,7 +87,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeVisualization
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.103.0
+	 * @version 1.105.0
 	 * @private
 	 */
 	var ChangeVisualization = Control.extend("sap.ui.rta.util.changeVisualization.ChangeVisualization", {
@@ -122,11 +116,12 @@ sap.ui.define([
 			}
 		},
 		constructor: function() {
-			Control.prototype.constructor.apply(this, arguments);
-
 			this._oChangeIndicatorRegistry = new ChangeIndicatorRegistry({
 				commandCategories: VALID_COMMANDS
 			});
+
+			Control.prototype.constructor.apply(this, arguments);
+
 			this._oTextBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.rta");
 			this.setModel(new ResourceModel({
 				bundle: this._oTextBundle
@@ -149,6 +144,7 @@ sap.ui.define([
 			this._reset();
 		}
 		this.setProperty("rootControlId", sRootControlId);
+		this._oChangeIndicatorRegistry.setRootControlId(sRootControlId);
 	};
 
 	ChangeVisualization.prototype._getComponent = function() {
@@ -274,15 +270,12 @@ sap.ui.define([
 	 */
 	ChangeVisualization.prototype.onCommandCategorySelection = function(oEvent) {
 		var sSelectedCommandCategory = oEvent.getSource().getBindingContext("visualizationModel").getObject().key;
-		return this._selectCommandCategory(sSelectedCommandCategory);
+		this._selectCommandCategory(sSelectedCommandCategory);
 	};
 
 	ChangeVisualization.prototype._selectCommandCategory = function(sSelectedCommandCategory) {
 		this._sSelectedCommandCategory = sSelectedCommandCategory;
 
-		var aRegisteredChanges = this._oChangeIndicatorRegistry.getChanges();
-		var aRelevantChanges = this._getChangesForCommandCategory(sSelectedCommandCategory, aRegisteredChanges);
-
 		var sCommandCategoryText = this._getCommandCategoryButton(sSelectedCommandCategory);
 
 		this._updateVisualizationModel({
@@ -290,52 +283,8 @@ sap.ui.define([
 			commandCategoryText: sCommandCategoryText
 		});
 
-		return Promise.all(aRelevantChanges.map(function(oChange) {
-			return this._getVisualizationInfo(oChange)
-				.then(function(mVisualizationInfo) {
-					this._oChangeIndicatorRegistry.addVisualizationInfo(
-						oChange.change.getId(),
-						mVisualizationInfo
-					);
-				}.bind(this));
-		}.bind(this)))
-			.then(function() {
-				this._updateChangeIndicators();
-				this._setFocusedIndicator();
-			}.bind(this));
-	};
-
-	ChangeVisualization.prototype._getVisualizationInfo = function(mChangeInformation) {
-		var oComponent = this._getComponent();
-
-		function getSelectorIds(aSelectorList) {
-			if (!aSelectorList) {
-				return undefined;
-			}
-			return aSelectorList
-				.map(function(vSelector) {
-					var oElement = typeof vSelector.getId === "function"
-						? vSelector
-						: JsControlTreeModifier.bySelector(vSelector, oComponent);
-					return oElement && oElement.getId();
-				})
-				.filter(Boolean);
-		}
-
-		return this._getInfoFromChangeHandler(oComponent, mChangeInformation.change)
-			.then(function(oInfoFromChangeHandler) {
-				var mVisualizationInfo = oInfoFromChangeHandler || {};
-				var aAffectedElementIds = (
-					getSelectorIds(mVisualizationInfo.affectedControls || [mChangeInformation.change.getSelector()])
-				);
-
-				return {
-					affectedElementIds: aAffectedElementIds,
-					dependentElementIds: getSelectorIds(mVisualizationInfo.dependentControls) || [],
-					displayElementIds: getSelectorIds(mVisualizationInfo.displayControls) || aAffectedElementIds,
-					payload: mVisualizationInfo.payload
-				};
-			});
+		this._updateChangeIndicators();
+		this._setFocusedIndicator();
 	};
 
 	ChangeVisualization.prototype._getCommandForChange = function(oChange) {
@@ -382,36 +331,6 @@ sap.ui.define([
 			&& searchForCommand(OverlayRegistry.getOverlay(oLastDependentSelectorControl));
 	};
 
-	ChangeVisualization.prototype._getInfoFromChangeHandler = function(oAppComponent, oChange) {
-		var oControl = JsControlTreeModifier.bySelector(oChange.getSelector(), oAppComponent);
-		if (oControl) {
-			var mPropertyBag = {
-				modifier: JsControlTreeModifier,
-				appComponent: oAppComponent,
-				view: FlUtils.getViewForControl(oControl)
-			};
-			var mControl = ChangesUtils.getControlIfTemplateAffected(oChange, oControl, mPropertyBag);
-			return ChangesWriteAPI.getChangeHandler({
-				changeType: oChange.getChangeType(),
-				element: mControl.control,
-				modifier: JsControlTreeModifier,
-				layer: oChange.getLayer()
-			})
-				.then(function(oChangeHandler) {
-					if (oChangeHandler && typeof oChangeHandler.getChangeVisualizationInfo === "function") {
-						return oChangeHandler.getChangeVisualizationInfo(oChange, oAppComponent);
-					}
-					return undefined;
-				})
-				.catch(function(vErr) {
-					Log.error(vErr);
-					return undefined;
-				});
-		}
-
-		return Promise.resolve();
-	};
-
 	ChangeVisualization.prototype._collectChanges = function() {
 		var oComponent = this._getComponent();
 		var mPropertyBag = {
@@ -430,7 +349,7 @@ sap.ui.define([
 			var aRegisteredChangeIds = this._oChangeIndicatorRegistry.getChangeIds();
 			var oCurrentChanges = aChanges
 				.filter(function(oChange) {
-					return oChange.getFileType() === 'change';
+					return oChange.getFileType() === "change";
 				})
 				.reduce(function(oChanges, oChange) {
 					oChanges[oChange.getId()] = oChange;
@@ -443,12 +362,14 @@ sap.ui.define([
 				this._oChangeIndicatorRegistry.removeChange(sChangeIdToRemove);
 			}.bind(this));
 
+			var aPromises = [];
 			// Register missing changes
 			difference(aCurrentChangeIds, aRegisteredChangeIds).forEach(function(sChangeIdToAdd) {
 				var oChangeToAdd = oCurrentChanges[sChangeIdToAdd];
 				var sCommandName = this._getCommandForChange(oChangeToAdd);
-				this._oChangeIndicatorRegistry.registerChange(oChangeToAdd, sCommandName);
+				aPromises.push(this._oChangeIndicatorRegistry.registerChange(oChangeToAdd, sCommandName));
 			}.bind(this));
+			return Promise.all(aPromises);
 		}.bind(this));
 	};
 
@@ -483,14 +404,26 @@ sap.ui.define([
 		var aVisualizedChanges = [];
 		Object.keys(oSelectors)
 			.forEach(function(sSelectorId) {
-				var aChanges = oSelectors[sSelectorId];
+				var aRelevantChanges = this._filterRelevantChanges(oSelectors[sSelectorId]);
 				var oOverlay = OverlayRegistry.getOverlay(sSelectorId);
+				if (!oOverlay) {
+					// When the selector has no Overlay, check if there is a relevant container Overlay
+					// e.g. when a SmartForm group is removed
+					aRelevantChanges.some(function(oChange) {
+						var oElementOverlay = OverlayRegistry.getOverlay(oChange.affectedElementId);
+						var oRelevantContainer = oElementOverlay && oElementOverlay.getRelevantContainer();
+						if (oRelevantContainer) {
+							oOverlay = OverlayRegistry.getOverlay(oRelevantContainer);
+							return true;
+						}
+						return false;
+					});
+				}
 				if (!oOverlay || !oOverlay.getDomRef() || !oOverlay.isVisible()) {
 					// Change is not visible
 					return undefined;
 				}
 				var oOverlayPosition = oOverlay.getDomRef().getClientRects()[0] || { left: 0, top: 0 };
-				var aRelevantChanges = this._filterRelevantChanges(aChanges);
 				aRelevantChanges.forEach(function (oChange) {
 					aVisualizedChanges.push(oChange);
 				});
@@ -500,8 +433,13 @@ sap.ui.define([
 					changes: aRelevantChanges
 				};
 
-				if (!this._oChangeIndicatorRegistry.hasChangeIndicator(sSelectorId)) {
+				var oChangeIndicator = this._oChangeIndicatorRegistry.getChangeIndicator(sSelectorId);
+				var sOverlayId = oOverlay.getId();
+				if (!oChangeIndicator) {
 					this._createChangeIndicator(oOverlay, sSelectorId);
+				} else if (oChangeIndicator.getOverlayId() !== sOverlayId) {
+					// Overlay id might change, e.g. during undo/redo of dirty changes
+					oChangeIndicator.setOverlayId(sOverlayId);
 				}
 				return undefined;
 			}.bind(this));
@@ -522,18 +460,19 @@ sap.ui.define([
 		}
 	};
 
-	ChangeVisualization.prototype._filterRelevantChanges = function(aChanges) {
-		if (!Array.isArray(aChanges)) {
-			return aChanges;
+	ChangeVisualization.prototype._filterRelevantChanges = function(aChangeVizInfo) {
+		if (!Array.isArray(aChangeVizInfo)) {
+			return aChangeVizInfo;
 		}
 		var oRootData = this._oChangeVisualizationModel.getData();
 
-		return aChanges.filter(function(oChange) {
+		return aChangeVizInfo.filter(function(oChangeVizInfo) {
 			return (
-				!oChange.dependent
+				!oChangeVizInfo.dependent
+				&& oChangeVizInfo.commandCategory
 				&& (
-					oRootData.commandCategory === 'all'
-					|| oRootData.commandCategory === oChange.commandCategory
+					oRootData.commandCategory === CATEGORY_ALL
+					|| oRootData.commandCategory === oChangeVizInfo.commandCategory
 				)
 			);
 		});
@@ -552,10 +491,6 @@ sap.ui.define([
 		oChangeIndicator.setModel(this._oChangeVisualizationModel);
 		oChangeIndicator.bindElement("/content/" + sSelectorId);
 		oChangeIndicator.setModel(this.getModel("i18n"), "i18n");
-
-		// Temporarily place the indicator in the static area
-		// It will move itself to the correct overlay after rendering
-		oChangeIndicator.placeAt(sap.ui.getCore().getStaticAreaRef());
 		this._oChangeIndicatorRegistry.registerChangeIndicator(sSelectorId, oChangeIndicator);
 	};
 
@@ -626,8 +561,8 @@ sap.ui.define([
 		this.setIsActive(true);
 		// show all change visualizations at startup
 		this._updateChangeRegistry()
-			.then(this._selectCommandCategory.bind(this, this._sSelectedCommandCategory))
 			.then(function() {
+				this._selectCommandCategory(this._sSelectedCommandCategory);
 				this._updateVisualizationModelMenuData();
 				oToolbar.setModel(this._oChangeVisualizationModel, "visualizationModel");
 			}.bind(this));

package/src/sap/ui/rta/util/changeVisualization/ChangeVisualizationUtils.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */

package/src/sap/ui/rta/util/changeVisualization/categories/CombineVisualization.js

@@ -0,0 +1,87 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/core/Core",
+	"sap/ui/core/util/reflection/JsControlTreeModifier",
+	"sap/ui/dt/ElementUtil",
+	"sap/ui/rta/util/changeVisualization/ChangeVisualizationUtils"
+], function(
+	Core,
+	JsControlTreeModifier,
+	ElementUtil,
+	ChangeVisualizationUtils
+) {
+	"use strict";
+
+	var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
+
+	var CombineVisualization = {};
+
+	/**
+	 * Creates a localized description for combine changes based on the provided
+	 * payload containing the combined elements.
+	 *
+	 * @param {object} mPayload - Change visualization payload from the change handler
+	 * @param {array.<string>} mPayload.originalSelectors - Selectors of the elements that were combined
+	 * @param {string} sLabel - Current element label
+	 * @param {object} mPropertyBag - Additional properties
+	 * @param {sap.ui.core.Component} mPropertyBag.appComponent - Application component
+	 * @returns {object} Map containing localized description text and tooltip
+	 */
+	CombineVisualization.getDescription = function (mPayload, sLabel, mPropertyBag) {
+		var iOriginalSelectorCount = (mPayload.originalSelectors || []).length;
+		if (iOriginalSelectorCount < 2) {
+			// Fallback if no payload was provided
+			return {
+				descriptionText: oRtaResourceBundle.getText(
+					"TXT_CHANGEVISUALIZATION_CHANGE_COMBINE",
+					[ChangeVisualizationUtils.shortenString(sLabel)]
+				),
+				descriptionTooltip: oRtaResourceBundle.getText(
+					"TXT_CHANGEVISUALIZATION_CHANGE_COMBINE",
+					[sLabel]
+				)
+			};
+		}
+
+		var oAppComponent = mPropertyBag.appComponent;
+		var aOriginalSelectors = mPayload.originalSelectors;
+		var aLabels = aOriginalSelectors.map(function (oSelector) {
+			var sId = JsControlTreeModifier.getControlIdBySelector(oSelector, oAppComponent);
+			var oControl = Core.byId(sId);
+			return oControl ? ElementUtil.getLabelForElement(oControl) : sId;
+		});
+		var aShortLabels = aLabels.map(ChangeVisualizationUtils.shortenString);
+
+		if (iOriginalSelectorCount === 2) {
+			return {
+				descriptionText: oRtaResourceBundle.getText(
+					"TXT_CHANGEVISUALIZATION_CHANGE_COMBINE_TWO",
+					aShortLabels
+				),
+				descriptionTooltip: oRtaResourceBundle.getText(
+					"TXT_CHANGEVISUALIZATION_CHANGE_COMBINE_TWO",
+					aLabels
+				)
+			};
+		}
+
+		return {
+			descriptionText: oRtaResourceBundle.getText(
+				"TXT_CHANGEVISUALIZATION_CHANGE_COMBINE_MANY",
+				[aLabels.length]
+			),
+			descriptionTooltip: aLabels
+				.map(function(sLabel) {
+					return "\"" + sLabel + "\"";
+				})
+				.join(",\n")
+		};
+	};
+
+	return CombineVisualization;
+});

package/src/sap/ui/rta/util/changeVisualization/categories/MoveVisualization.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -40,9 +40,9 @@ sap.ui.define([
 		);
 
 		if (sSourceParentId !== sTargetParentId) {
-			sButtonText = oRtaResourceBundle.getText("BTN_CHANGEVISUALIZATION_SHOW_DEPENDENT_CONTAINER_MOVE");
 			sDescriptionText = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_MOVE", ChangeVisualizationUtils.shortenString(sLabel));
-			sDescriptionTooltip = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_MOVE", sLabel);
+			sDescriptionTooltip = (sSourceParentId && oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_MOVE", sLabel)) || "";
+			sButtonText = sSourceParentId && oRtaResourceBundle.getText("BTN_CHANGEVISUALIZATION_SHOW_DEPENDENT_CONTAINER_MOVE");
 		}
 		return { descriptionText: sDescriptionText, descriptionTooltip: sDescriptionTooltip, buttonText: sButtonText };
 	};

package/src/sap/ui/rta/util/changeVisualization/categories/RenameVisualization.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */

package/src/sap/ui/rta/util/changeVisualization/categories/SplitVisualization.js

@@ -1,12 +1,14 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
 sap.ui.define([
+	"sap/ui/core/Core",
 	"sap/ui/rta/util/changeVisualization/ChangeVisualizationUtils"
 ], function(
+	Core,
 	ChangeVisualizationUtils
 ) {
 	"use strict";
@@ -18,11 +20,11 @@ sap.ui.define([
 	 * current element label
 	 *
 	 * @param {object} mPayload - Change visualization payload from the change handler
-	 * @param {string} sLabel - Change handler label
+	 * @param {string} sLabel - Current element label
 	 * @returns {object} Localized description text and button text
 	 */
 	SplitVisualization.getDescription = function (mPayload, sLabel) {
-		var oRtaResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.rta");
+		var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
 		var sDescriptionText = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_SPLIT", ChangeVisualizationUtils.shortenString(sLabel));
 		var sDescriptionTooltip = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_SPLIT", sLabel);
 		var sButtonText = oRtaResourceBundle.getText("BTN_CHANGEVISUALIZATION_SHOW_DEPENDENT_CONTAINER_SPLIT");

package/src/sap/ui/rta/util/changeVisualization/categories/getVisualizationCategory.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -7,10 +7,12 @@
 sap.ui.define([
 	"sap/ui/rta/util/changeVisualization/categories/RenameVisualization",
 	"sap/ui/rta/util/changeVisualization/categories/MoveVisualization",
+	"sap/ui/rta/util/changeVisualization/categories/CombineVisualization",
 	"sap/ui/rta/util/changeVisualization/categories/SplitVisualization"
 ], function(
 	RenameVisualization,
 	MoveVisualization,
+	CombineVisualization,
 	SplitVisualization
 ) {
 	"use strict";
@@ -18,10 +20,16 @@ sap.ui.define([
 	var mCategories = {
 		rename: RenameVisualization,
 		move: MoveVisualization,
+		combine: CombineVisualization,
 		split: SplitVisualization
 	};
 
-	return function(sCategoryName) {
+	return function(mIndicatorInformation) {
+		var sCategoryName = mIndicatorInformation.commandName;
+		// to enable e.g. move changes in settings commands to show the 'Show Source' button
+		if (sCategoryName === "settings") {
+			sCategoryName = mIndicatorInformation.commandCategory;
+		}
 		return mCategories[sCategoryName];
 	};
 });