@openui5/sap.ui.rta 1.115.1 → 1.117.0

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

@@ -7,12 +7,12 @@
 sap.ui.define([
 	"sap/ui/core/Core",
 	"sap/ui/core/Fragment",
+	"sap/base/util/isEmptyObject",
 	"sap/base/util/restricted/_difference",
 	"sap/base/util/deepEqual",
 	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/core/Control",
 	"sap/ui/dt/OverlayRegistry",
-	"sap/ui/dt/OverlayUtil",
 	"sap/ui/dt/ElementUtil",
 	"sap/ui/fl/write/api/PersistenceWriteAPI",
 	"sap/ui/fl/Layer",
@@ -26,12 +26,12 @@ sap.ui.define([
 ], function(
 	Core,
 	Fragment,
+	isEmptyObject,
 	difference,
 	deepEqual,
 	JsControlTreeModifier,
 	Control,
 	OverlayRegistry,
-	OverlayUtil,
 	ElementUtil,
 	PersistenceWriteAPI,
 	Layer,
@@ -59,6 +59,21 @@ sap.ui.define([
 		return !oOverlay || !oOverlay.getDomRef() || !oOverlay.isVisible();
 	}
 
+	function _determineElementOverlay(oElementId, oAffectedElementId) {
+		var oOverlay = OverlayRegistry.getOverlay(oElementId);
+		if (!oOverlay) {
+			// When the element has no Overlay, check if there is a relevant container Overlay
+			// e.g. change on a SmartForm group (Element: parent Form; Relevant Container: SmartForm)
+			var oElementOverlay = OverlayRegistry.getOverlay(oAffectedElementId);
+			var oRelevantContainer = oElementOverlay && oElementOverlay.getRelevantContainer();
+			if (oRelevantContainer) {
+				oOverlay = OverlayRegistry.getOverlay(oRelevantContainer);
+			}
+		}
+
+		return oOverlay;
+	}
+
 	/**
 	 * @class
 	 * Root control for RTA change visualization.
@@ -67,7 +82,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeVisualization
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 * @private
 	 */
 	var ChangeVisualization = Control.extend("sap.ui.rta.util.changeVisualization.ChangeVisualization", {
@@ -163,12 +178,12 @@ sap.ui.define([
 		if (this.getProperty("rootControlId")) {
 			this._oChangeIndicatorRegistry.reset();
 			this._updateChangeRegistry()
-				.then(function() {
-					this._selectChangeCategory(this._sSelectedChangeCategory);
-					this._selectChangeState(ChangeStates.ALL);
-					this._updateVisualizationModelMenuData();
-					oToolbar.setModel(this._oChangeVisualizationModel, "visualizationModel");
-				}.bind(this));
+			.then(function() {
+				this._selectChangeCategory(this._sSelectedChangeCategory);
+				this._selectChangeState(ChangeStates.ALL);
+				this._updateVisualizationModelMenuData();
+				oToolbar.setModel(this._oChangeVisualizationModel, "visualizationModel");
+			}.bind(this));
 		}
 	};
 
@@ -176,7 +191,11 @@ sap.ui.define([
 		this._oChangeIndicatorRegistry.reset();
 	};
 
-	ChangeVisualization.prototype._determineChangeVisibility = function(aRegisteredIndependentChanges, aAllRelevantChanges, sVisualizedChangeState) {
+	ChangeVisualization.prototype._determineChangeVisibility = function(
+		aRegisteredIndependentChanges,
+		aAllRelevantChanges,
+		sVisualizedChangeState
+	) {
 		function filterRelevantChanges(aChanges) {
 			return aChanges.filter(function(oChange) {
 				if (
@@ -201,7 +220,7 @@ sap.ui.define([
 			return oChange.id;
 		});
 
-		aRegisteredIndependentChanges.forEach(function (oChange) {
+		aRegisteredIndependentChanges.forEach(function(oChange) {
 			if (oChange.changeStates.includes(ChangeStates.DIRTY)) {
 				bHasDraftChanges = true;
 				bHasDirtyChanges = true;
@@ -209,7 +228,10 @@ sap.ui.define([
 				bHasDraftChanges = true;
 			}
 
-			var oOverlay = OverlayRegistry.getOverlay(oChange.visualizationInfo.displayElementIds[0]);
+			var oOverlay = _determineElementOverlay(
+				oChange.visualizationInfo.displayElementIds[0],
+				oChange.visualizationInfo.affectedElementIds[0]
+			);
 
 			if (!aAllRelevantChangeIds.includes(oChange.change.getId())) {
 				aHiddenChanges.push(oChange);
@@ -266,7 +288,10 @@ sap.ui.define([
 		aCommandData.unshift({
 			key: ChangeCategories.ALL,
 			count: this._getChangesForChangeCategory(ChangeCategories.ALL, oSortedChanges.relevantVisualizedChanges).length,
-			title: this._getChangeCategoryLabel(ChangeCategories.ALL, this._getChangesForChangeCategory(ChangeCategories.ALL, oSortedChanges.relevantVisualizedChanges).length),
+			title: this._getChangeCategoryLabel(ChangeCategories.ALL, this._getChangesForChangeCategory(
+				ChangeCategories.ALL,
+				oSortedChanges.relevantVisualizedChanges
+			).length),
 			icon: ChangeCategories.getIconForCategory(ChangeCategories.ALL)
 		});
 
@@ -313,18 +338,18 @@ sap.ui.define([
 				id: this._getComponent().createId("changeVisualization_changesList"),
 				controller: this
 			})
-				.then(function(oPopover) {
-					this._oToolbarButton.addDependent(oPopover);
-					oPopover.setModel(this._oChangeVisualizationModel, "visualizationModel");
-					oPopover.openBy(this._oToolbarButton);
-					this.setPopover(oPopover);
-					//Currently required because of an binding issue from the control
-					//At the first opening of the popover the controls don't get updated when the bound
-					//model changes. With the reopening this Problem gets fixed
-					//TODO Remove once control owners have fixed the issue
-					oPopover.close();
-					oPopover.openBy(this._oToolbarButton);
-				}.bind(this));
+			.then(function(oPopover) {
+				this._oToolbarButton.addDependent(oPopover);
+				oPopover.setModel(this._oChangeVisualizationModel, "visualizationModel");
+				oPopover.openBy(this._oToolbarButton);
+				this.setPopover(oPopover);
+				// Currently required because of an binding issue from the control
+				// At the first opening of the popover the controls don't get updated when the bound
+				// model changes. With the reopening this Problem gets fixed
+				// TODO Remove once control owners have fixed the issue
+				oPopover.close();
+				oPopover.openBy(this._oToolbarButton);
+			}.bind(this));
 			return;
 		}
 
@@ -381,7 +406,7 @@ sap.ui.define([
 			return sCommand;
 		}
 
-		if (!oChange.getSelector || !oChange.getSelector()) {
+		if (!oChange.getSelector || !oChange.getSelector() || isEmptyObject(oChange.getSelector())) {
 			return false;
 		}
 
@@ -448,10 +473,10 @@ sap.ui.define([
 			}
 			var aRegisteredChangeIds = this._oChangeIndicatorRegistry.getRegisteredChangeIds();
 			var oCurrentChanges = aChanges
-				.reduce(function(oChanges, oChange) {
-					oChanges[oChange.getId()] = oChange;
-					return oChanges;
-				}, {});
+			.reduce(function(oChanges, oChange) {
+				oChanges[oChange.getId()] = oChange;
+				return oChanges;
+			}, {});
 			var aCurrentChangeIds = Object.keys(oCurrentChanges);
 
 			// Remove registered changes which no longer exist
@@ -503,20 +528,8 @@ sap.ui.define([
 		Object.keys(oSelectors).forEach(function(sSelectorId) {
 			var aChangesOnIndicator = 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. change on a SmartForm group (Selector: parent Form; Relevant Container: SmartForm)
-				aChangesOnIndicator.some(function(oChange) {
-					var oElementOverlay = OverlayRegistry.getOverlay(oChange.affectedElementId);
-					var oRelevantContainer = oElementOverlay && oElementOverlay.getRelevantContainer();
-					if (oRelevantContainer) {
-						oOverlay = OverlayRegistry.getOverlay(oRelevantContainer);
-						return true;
-					}
-					return false;
-				});
-			}
+			var oOverlay = _determineElementOverlay(sSelectorId, aChangesOnIndicator[0].affectedElementId);
+
 			if (_isOverlayInvisible(oOverlay)) {
 				// Change is not visible
 				return undefined;
@@ -647,15 +660,15 @@ sap.ui.define([
 		Core.applyChanges();
 
 		var aVisibleIndicators = this._oChangeIndicatorRegistry.getChangeIndicators()
-			.filter(function(oIndicator) {
-				return oIndicator.getVisible();
-			})
-			.sort(function(oIndicator1, oIndicator2) {
-				var iDeltaY = oIndicator1.getPosY() - oIndicator2.getPosY();
-				var iDeltaX = oIndicator1.getPosX() - oIndicator2.getPosX();
-				// Only consider x value if y is the same
-				return iDeltaY || iDeltaX;
-			});
+		.filter(function(oIndicator) {
+			return oIndicator.getVisible();
+		})
+		.sort(function(oIndicator1, oIndicator2) {
+			var iDeltaY = oIndicator1.getPosY() - oIndicator2.getPosY();
+			var iDeltaX = oIndicator1.getPosX() - oIndicator2.getPosX();
+			// Only consider x value if y is the same
+			return iDeltaY || iDeltaX;
+		});
 
 		if (aVisibleIndicators.length === 0) {
 			return;
@@ -678,7 +691,7 @@ sap.ui.define([
 		}
 	};
 
-	ChangeVisualization.prototype._toggleRootOverlayClickHandler = function (bEnable) {
+	ChangeVisualization.prototype._toggleRootOverlayClickHandler = function(bEnable) {
 		var oRootOverlayDomRef = this.oRootOverlay && this.oRootOverlay.getDomRef();
 		if (oRootOverlayDomRef) {
 			if (bEnable) {
@@ -732,15 +745,15 @@ sap.ui.define([
 		this.setIsActive(true);
 		// show all change visualizations at startup
 		this._updateChangeRegistry()
-			.then(function() {
-				this._selectChangeCategory(this._sSelectedChangeCategory);
-				// This is required to avoid flickering of the toolbar when switching
-				// to visualization mode when the mode switcher is displayed as icons
-				oToolbar.adjustToolbarSectionWidths();
-
-				this._updateVisualizationModelMenuData();
-				oToolbar.setModel(this._oChangeVisualizationModel, "visualizationModel");
-			}.bind(this));
+		.then(function() {
+			this._selectChangeCategory(this._sSelectedChangeCategory);
+			// This is required to avoid flickering of the toolbar when switching
+			// to visualization mode when the mode switcher is displayed as icons
+			oToolbar.adjustToolbarSectionWidths();
+
+			this._updateVisualizationModelMenuData();
+			oToolbar.setModel(this._oChangeVisualizationModel, "visualizationModel");
+		}.bind(this));
 	};
 
 	return ChangeVisualization;

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

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @param {sap.ui.core.Component} mPropertyBag.appComponent - Application component
 	 * @returns {object} Map containing localized description text and tooltip
 	 */
-	CombineVisualization.getDescription = function (mPayload, sLabel, mPropertyBag) {
+	CombineVisualization.getDescription = function(mPayload, sLabel, mPropertyBag) {
 		var iOriginalSelectorCount = (mPayload.originalSelectors || []).length;
 		if (iOriginalSelectorCount < 2) {
 			// Fallback if no payload was provided
@@ -50,7 +50,7 @@ sap.ui.define([
 
 		var oAppComponent = mPropertyBag.appComponent;
 		var aOriginalSelectors = mPayload.originalSelectors;
-		var aLabels = aOriginalSelectors.map(function (oSelector) {
+		var aLabels = aOriginalSelectors.map(function(oSelector) {
 			var sId = JsControlTreeModifier.getControlIdBySelector(oSelector, oAppComponent);
 			var oControl = Core.byId(sId);
 			return oControl ? ElementUtil.getLabelForElement(oControl) : sId;
@@ -76,10 +76,10 @@ sap.ui.define([
 				[aLabels.length]
 			),
 			descriptionTooltip: aLabels
-				.map(function(sLabel) {
-					return "\"" + sLabel + "\"";
-				})
-				.join(",\n")
+			.map(function(sLabel) {
+				return "\"" + sLabel + "\"";
+			})
+			.join(",\n")
 		};
 	};
 

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

@@ -24,7 +24,7 @@ sap.ui.define([
 	 * @param {string} sLabel - Current element label
 	 * @returns {object} Map containing localized description text and tooltip
 	 */
-	CreateContainerVisualization.getDescription = function (mPayload, sLabel) {
+	CreateContainerVisualization.getDescription = function(mPayload, sLabel) {
 		var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
 		var sElementLabel = mPayload.originalLabel || sLabel;
 		var sShortenedElementLabel = ChangeVisualizationUtils.shortenString(sElementLabel);

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

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @param {string} sLabel - Current element label
 	 * @returns {object} Localized description text and button text
 	 */
-	SplitVisualization.getDescription = function (mPayload, sLabel) {
+	SplitVisualization.getDescription = function(mPayload, sLabel) {
 		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);

package/src/sap/ui/rta/util/hasStableId.js

@@ -8,7 +8,7 @@ sap.ui.define([
 	"sap/ui/fl/Utils",
 	"sap/ui/dt/ElementUtil",
 	"sap/base/util/isPlainObject"
-], function (
+], function(
 	FlUtils,
 	ElementUtil,
 	isPlainObject
@@ -52,7 +52,7 @@ sap.ui.define([
 
 			if (aStableElements.length > 0) {
 				if (isCloneFromAggregationBinding(oElementOverlay.getElement())) {
-					bUnstable = aStableElements.some(function (vStableElement) {
+					bUnstable = aStableElements.some(function(vStableElement) {
 						var vControl;
 						var oAppComponent;
 						var bUnstable = false;

package/src/sap/ui/rta/util/showMessageBox.js

@@ -9,7 +9,7 @@ sap.ui.define([
 	"sap/ui/layout/HorizontalLayout",
 	"sap/m/Link",
 	"sap/m/Text"
-], function (
+], function(
 	MessageBox,
 	HorizontalLayout,
 	Link,
@@ -45,7 +45,7 @@ sap.ui.define([
 	function convertIntoControls(aSymbols) {
 		var oLayout = new HorizontalLayout({
 			allowWrapping: true,
-			content: aSymbols.map(function (sSymbol) {
+			content: aSymbols.map(function(sSymbol) {
 				if (isLink(sSymbol)) {
 					var mLink = extractLink(sSymbol);
 					return new Link({
@@ -72,7 +72,7 @@ sap.ui.define([
 		var aSymbols = [sMessage];
 		var aLinks = getLinks(sMessage);
 
-		aLinks.forEach(function (sLink) {
+		aLinks.forEach(function(sLink) {
 			var i = 0;
 			while (i < aSymbols.length) {
 				var sSymbol = aSymbols[i];
@@ -83,7 +83,7 @@ sap.ui.define([
 					var aParts = sSymbol.split(sLink);
 					var aInsert = [];
 
-					aParts.forEach(function (sPart, iIndex, aOriginal) { // eslint-disable-line no-loop-func
+					aParts.forEach(function(sPart, iIndex, aOriginal) { // eslint-disable-line no-loop-func
 						aInsert.push(sPart);
 						if (iIndex !== aOriginal.length - 1) {
 							aInsert.push(sLink);
@@ -99,7 +99,6 @@ sap.ui.define([
 		return aSymbols;
 	}
 
-
 	/**
 	 * Displays sap.m.MessageBox and interprets markdown links in the messages.
 	 *

package/src/sap/ui/rta/util/validateFlexEnabled.js

@@ -13,7 +13,7 @@ sap.ui.define([
 	"sap/base/Log",
 	"sap/ui/rta/Utils",
 	"sap/ui/dt/Util"
-], function (
+], function(
 	FlUtils,
 	MessageBox,
 	ObjectPath,
@@ -24,7 +24,7 @@ sap.ui.define([
 	DtUtil
 ) {
 	"use strict";
-	return function (oRta) {
+	return function(oRta) {
 		var mMessageBoxShow = {};
 		var aPendingOverlaysToValidate = [];
 		var oComponent = FlUtils.getAppComponentForControl(oRta.getRootControlInstance());
@@ -88,7 +88,7 @@ sap.ui.define([
 			var oElementOverlayCreated = oEvent.getParameters().elementOverlay;
 			if (oRta.getMode() === "adaptation") {
 				var oComponent = FlUtils.getAppComponentForControl(oRta.getRootControlInstance());
-				DtUtil.waitForSynced(oRta._oDesignTime, function (oOverlay) {
+				DtUtil.waitForSynced(oRta._oDesignTime, function(oOverlay) {
 					if (_isControlAvailable(oOverlay)) {
 						_handleUnstableIds(oRta, oComponent, [oOverlay]);
 					}
@@ -102,14 +102,14 @@ sap.ui.define([
 			var aUnstableOverlays = validateStableIds(aElementOverlays, oComponent);
 
 			if (aUnstableOverlays.length) {
-				aUnstableOverlays.forEach(function (oElementOverlay) {
+				aUnstableOverlays.forEach(function(oElementOverlay) {
 					Log.error("Control ID was generated dynamically by SAPUI5. To support SAPUI5 flexibility, a stable control ID is needed to assign the changes to.", oElementOverlay.getElement().getId());
 				});
 				_displayMessage(oRta, oComponent, "MSG_UNSTABLE_ID_FOUND", "ERROR", "HEADER_ERROR");
 			}
 		}
 
-		oRta.attachEventOnce("stop", function () {
+		oRta.attachEventOnce("stop", function() {
 			_setMessageBoxShow(oComponent.getId(), false);
 		});
 

package/src/sap/ui/rta/util/validateStableIds.js

@@ -11,7 +11,7 @@ sap.ui.define([
 	"sap/ui/core/Fragment",
 	"sap/ui/dt/OverlayUtil",
 	"sap/base/util/isPlainObject"
-], function (
+], function(
 	ObjectPath,
 	hasStableId,
 	View,
@@ -38,11 +38,11 @@ sap.ui.define([
 		var aViewExtensions = [];
 
 		if (isPlainObject(mViewExtensions)) {
-			Object.keys(mViewExtensions).forEach(function (sViewExtensionGroupName) {
+			Object.keys(mViewExtensions).forEach(function(sViewExtensionGroupName) {
 				if (sViewExtensionGroupName.startsWith("sap.suite.ui.generic.template")) {
 					var mViewExtensionGroup = mViewExtensions[sViewExtensionGroupName];
 
-					Object.keys(mViewExtensionGroup).forEach(function (sViewExtensionName) {
+					Object.keys(mViewExtensionGroup).forEach(function(sViewExtensionName) {
 						aViewExtensions.push(mViewExtensionGroup[sViewExtensionName]);
 					});
 				}
@@ -58,7 +58,7 @@ sap.ui.define([
 		for (var i = 0, l = aElementOverlays.length; i < l; i++) {
 			var oElementOverlay = aElementOverlays[i];
 			var oElement = oElementOverlay.getElement();
-			var bIsExtensionOverlay = aExtensionList.some(function (mViewExtension) { // eslint-disable-line no-loop-func
+			var bIsExtensionOverlay = aExtensionList.some(function(mViewExtension) { // eslint-disable-line no-loop-func
 				var ClassDeclaration = ObjectPath.get(mViewExtension.className);
 				var sExtensionName;
 				var sElementName;
@@ -91,8 +91,8 @@ sap.ui.define([
 
 		var aRelevantOverlays = [];
 
-		aExtensionOverlays.forEach(function (oElementOverlay) {
-			OverlayUtil.iterateOverlayElementTree(oElementOverlay, function (oElementOverlay) {
+		aExtensionOverlays.forEach(function(oElementOverlay) {
+			OverlayUtil.iterateOverlayElementTree(oElementOverlay, function(oElementOverlay) {
 				aRelevantOverlays.push(oElementOverlay);
 			});
 		});
@@ -100,7 +100,7 @@ sap.ui.define([
 		return aRelevantOverlays;
 	}
 
-	return function (aElementOverlays, oComponent) {
+	return function(aElementOverlays, oComponent) {
 		var aResult = [];
 
 		var aRelevantOverlays = aElementOverlays.slice(0);
@@ -115,7 +115,7 @@ sap.ui.define([
 			);
 		}
 
-		aResult = aRelevantOverlays.filter(function (oElementOverlay) {
+		aResult = aRelevantOverlays.filter(function(oElementOverlay) {
 			return (
 				!oElementOverlay.getDesignTimeMetadata().markedAsNotAdaptable()
 				&& !hasStableId(oElementOverlay)

package/ui5.yaml

@@ -1,5 +1,5 @@
 ---
-specVersion: "2.0"
+specVersion: "3.0"
 type: library
 metadata:
   name: sap.ui.rta