@openui5/sap.ui.rta 1.106.0 → 1.107.1

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

@@ -14,8 +14,7 @@ sap.ui.define([
 	"sap/ui/dt/ElementUtil",
 	"sap/ui/fl/write/api/ChangesWriteAPI",
 	"sap/ui/fl/Utils",
-	"sap/ui/fl/changeHandler/common/ChangeCategories",
-	"sap/ui/core/Core"
+	"sap/ui/fl/changeHandler/common/ChangeCategories"
 ], function(
 	includes,
 	values,
@@ -26,8 +25,7 @@ sap.ui.define([
 	ElementUtil,
 	ChangesWriteAPI,
 	FlUtils,
-	ChangeCategories,
-	Core
+	ChangeCategories
 ) {
 	"use strict";
 
@@ -39,7 +37,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry
 	 * @author SAP SE
 	 * @since 1.86.0
-	 * @version 1.106.0
+	 * @version 1.107.1
 	 * @private
 	 */
 	var ChangeIndicatorRegistry = ManagedObject.extend("sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry", {
@@ -123,7 +121,7 @@ sap.ui.define([
 					id: oChangeIndicatorData.change.getId(),
 					dependent: bDependent,
 					affectedElementId: sAffectedElementId,
-					payload: oChangeIndicatorData.visualizationInfo.payload || {}
+					descriptionPayload: oChangeIndicatorData.visualizationInfo.descriptionPayload || {}
 				},
 				_omit(oChangeIndicatorData, ["visualizationInfo"])
 			));
@@ -133,16 +131,13 @@ sap.ui.define([
 			.forEach(function (oChangeIndicatorData) {
 				oChangeIndicatorData.visualizationInfo.displayElementIds
 				.forEach(function (sId, iIndex) {
-					// in some cases (like with simple forms) you have to pass the stable id of the child element because the parent id is unstable
-					if (oChangeIndicatorData.visualizationInfo.hasParentWithUnstableId) {
-						sId = Core.byId(sId).getParent().getId();
-					}
 					addSelector(sId, oChangeIndicatorData.visualizationInfo.affectedElementIds[iIndex], oChangeIndicatorData, false);
 				});
 
-				oChangeIndicatorData.visualizationInfo.dependentElementIds.forEach(function (sId) {
-					addSelector(sId, sId, oChangeIndicatorData, true);
-				});
+				oChangeIndicatorData.visualizationInfo.dependentElementIds
+					.forEach(function (sId) {
+						addSelector(sId, sId, oChangeIndicatorData, true);
+					});
 			});
 
 		return oChangeIndicators;
@@ -180,8 +175,8 @@ sap.ui.define([
 			var aCategories = this.getChangeCategories();
 			var sChangeCategory;
 			// For "settings", the control developer can choose one of the existing categories
-			if (sCommandName === "settings" && includes(Object.keys(aCategories), mChangeVisualizationInfo.payload.category)) {
-				sChangeCategory = mChangeVisualizationInfo.payload.category;
+			if (sCommandName === "settings" && includes(Object.keys(aCategories), mChangeVisualizationInfo.descriptionPayload.category)) {
+				sChangeCategory = mChangeVisualizationInfo.descriptionPayload.category;
 			} else {
 				sChangeCategory = Object.keys(aCategories).find(function (sChangeCategoryName) {
 					return includes(aCategories[sChangeCategoryName], sCommandName);
@@ -224,8 +219,8 @@ sap.ui.define([
 					affectedElementIds: aAffectedElementIds,
 					dependentElementIds: getSelectorIds(mVisualizationInfo.dependentControls) || [],
 					displayElementIds: getSelectorIds(mVisualizationInfo.displayControls) || aAffectedElementIds,
-					hasParentWithUnstableId: mVisualizationInfo.hasParentWithUnstableId,
-					payload: mVisualizationInfo.payload || {}
+					updateRequired: mVisualizationInfo.updateRequired,
+					descriptionPayload: mVisualizationInfo.descriptionPayload || {}
 				};
 			});
 	}
@@ -287,5 +282,17 @@ sap.ui.define([
 		delete this._oRegisteredChanges[sChangeId];
 	};
 
+	/**
+	 * Removes changes with the updateRequired flag from the registry so the change can be re-registered and
+	 * the visualizationInfo is updated => if an element has an unstable id this updates the id information in the registry (e.g simple forms)
+	 */
+	ChangeIndicatorRegistry.prototype.removeOutdatedRegisteredChanges = function () {
+		this.getAllRegisteredChanges().forEach(function(oChange) {
+			if (oChange.visualizationInfo && oChange.visualizationInfo.updateRequired) {
+				this.removeRegisteredChange(oChange.change.getId());
+			}
+		}.bind(this));
+	};
+
 	return ChangeIndicatorRegistry;
 });

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

@@ -57,7 +57,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeVisualization
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.106.0
+	 * @version 1.107.1
 	 * @private
 	 */
 	var ChangeVisualization = Control.extend("sap.ui.rta.util.changeVisualization.ChangeVisualization", {
@@ -315,6 +315,7 @@ sap.ui.define([
 
 	ChangeVisualization.prototype._updateChangeRegistry = function() {
 		return this._collectChanges().then(function(aChanges) {
+			this._oChangeIndicatorRegistry.removeOutdatedRegisteredChanges();
 			var aRegisteredChangeIds = this._oChangeIndicatorRegistry.getRegisteredChangeIds();
 			var oCurrentChanges = aChanges
 				.filter(function(oChange) {
@@ -330,7 +331,7 @@ sap.ui.define([
 
 			// Remove registered changes which no longer exist
 			difference(aRegisteredChangeIds, aCurrentChangeIds).forEach(function(sChangeIdToRemove) {
-				this._oChangeIndicatorRegistry.removeChange(sChangeIdToRemove);
+				this._oChangeIndicatorRegistry.removeRegisteredChange(sChangeIdToRemove);
 			}.bind(this));
 
 			var aPromises = [];
@@ -353,7 +354,9 @@ sap.ui.define([
 		var aDependentElements = this._oChangeIndicatorRegistry.getRegisteredChange(sChangeId).visualizationInfo.dependentElementIds;
 		aDependentElements.forEach(function(sElementId) {
 			var oOverlayDomRef = OverlayRegistry.getOverlay(sElementId).getDomRef();
-			oOverlayDomRef.scrollIntoViewIfNeeded();
+			oOverlayDomRef.scrollIntoView({
+				block: "nearest"
+			});
 			oOverlayDomRef.classList.add("sapUiRtaChangeIndicatorDependent");
 			oOverlayDomRef.addEventListener("animationend", function() {
 				oOverlayDomRef.classList.remove("sapUiRtaChangeIndicatorDependent");

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

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * 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 {object} mPayload - Change visualization description 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

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

@@ -19,9 +19,9 @@ sap.ui.define([
 	 * Creates a localized description and button text for move changes based on the provided
 	 * current element label.
 	 *
-	 * @param {object} mPayload - Change visualization payload from the change handler
-	 * @param {string} mPayload.sourceParentContainer - Parent container from where the element was moved
-	 * @param {string} mPayload.targetParentContainer - Parent container to where the element was moved
+	 * @param {object} mPayload - Change visualization description payload from the change handler
+	 * @param {string} mPayload.sourceContainer - container from where the element was moved
+	 * @param {string} mPayload.targetContainer - container to where the element was moved
 	 * @param {string} sLabel - Change handler label
 	 * @param {object} mPropertyBag - Additional properties
 	 * @returns {object} Localized description text and button text
@@ -32,19 +32,20 @@ sap.ui.define([
 		var sDescriptionTooltip = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_MOVE_WITHIN", sLabel);
 		var sButtonText;
 		var oAppComponent = mPropertyBag.appComponent;
-		var sSourceParentId = (
-			mPayload.sourceParentContainer
-			&& JsControlTreeModifier.getControlIdBySelector(mPayload.sourceParentContainer, oAppComponent)
+
+		var sSourceId = (
+			mPayload.sourceContainer
+			&& JsControlTreeModifier.getControlIdBySelector(mPayload.sourceContainer, oAppComponent)
 		);
-		var sTargetParentId = (
-			mPayload.targetParentContainer
-			&& JsControlTreeModifier.getControlIdBySelector(mPayload.targetParentContainer, oAppComponent)
+		var sTargetId = (
+			mPayload.targetContainer
+			&& JsControlTreeModifier.getControlIdBySelector(mPayload.targetContainer, oAppComponent)
 		);
 
-		if (sSourceParentId !== sTargetParentId) {
+		if (sSourceId !== sTargetId) {
 			sDescriptionText = oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_MOVE", ChangeVisualizationUtils.shortenString(sLabel));
-			sDescriptionTooltip = (sSourceParentId && oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_MOVE", sLabel)) || "";
-			sButtonText = sSourceParentId && oRtaResourceBundle.getText("BTN_CHANGEVISUALIZATION_SHOW_DEPENDENT_CONTAINER_MOVE");
+			sDescriptionTooltip = (sSourceId && oRtaResourceBundle.getText("TXT_CHANGEVISUALIZATION_CHANGE_MOVE", sLabel)) || "";
+			sButtonText = sSourceId && oRtaResourceBundle.getText("BTN_CHANGEVISUALIZATION_SHOW_DEPENDENT_CONTAINER_MOVE");
 		}
 		return { descriptionText: sDescriptionText, descriptionTooltip: sDescriptionTooltip, buttonText: sButtonText };
 	};

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

@@ -17,7 +17,7 @@ sap.ui.define([
 	 * Creates a localized description for rename changes based on the provided
 	 * change handler payload or the current element label.
 	 *
-	 * @param {object} mPayload - Change visualization payload from the change handler
+	 * @param {object} mPayload - Change visualization description payload from the change handler
 	 * @param {string} [mPayload.originalLabel] - Label before the change was applied
 	 * @param {object} [mPayload.newLabel] - Label after the change was applied
 	 * @param {string} sFallbackLabel - New label as a fallback if change handler provides no info

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

@@ -19,7 +19,7 @@ sap.ui.define([
 	 * Creates a localized description and button text for split changes based on the provided
 	 * current element label
 	 *
-	 * @param {object} mPayload - Change visualization payload from the change handler
+	 * @param {object} mPayload - Change visualization description payload from the change handler
 	 * @param {string} sLabel - Current element label
 	 * @returns {object} Localized description text and button text
 	 */