@openui5/sap.ui.rta 1.115.1 → 1.117.0

package/src/sap/ui/rta/plugin/additionalElements/ActionExtractor.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * handled by the AdditionalElements Plugin (Reveal, Add Via Delegate, Add Custom)
 	 *
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 * @private
 	 * @since 1.94
 	 * @experimental Since 1.94. This class is experimental and provides only limited functionality. Also the API might be changed in future.
@@ -44,14 +44,14 @@ sap.ui.define([
 		var aRequiredLibraries = DelegateMediatorAPI.getKnownDefaultDelegateLibraries();
 		aRequiredLibraries.forEach(function(sLibrary) {
 			var oLoadLibraryPromise = sap.ui.getCore().loadLibrary(sLibrary, { async: true })
-				.then(function() {
-					return Promise.resolve(sLibrary);
-				})
-				.catch(function(vError) {
-					Log.warning("Required library not available: ", vError);
-					// Ignore the error here as the default delegate might not be required
-					return Promise.resolve();
-				});
+			.then(function() {
+				return Promise.resolve(sLibrary);
+			})
+			.catch(function(vError) {
+				Log.warning("Required library not available: ", vError);
+				// Ignore the error here as the default delegate might not be required
+				return Promise.resolve();
+			});
 			aLoadLibraryPromises.push(oLoadLibraryPromise);
 		});
 		return Promise.all(aLoadLibraryPromises);
@@ -59,27 +59,28 @@ sap.ui.define([
 
 	function getAddViaDelegateActionData(mAction, oDesignTimeMetadata, oPlugin) {
 		return oPlugin.hasChangeHandler(mAction.changeType, mAction.element)
-			.then(function (bHasChangeHandler) {
-				if (bHasChangeHandler) {
-					return {
-						aggregationName: mAction.aggregation,
-						addPropertyActionData: {
-							designTimeMetadata: oDesignTimeMetadata,
-							action: mAction,
-							delegateInfo: {
-								payload: mAction.delegateInfo.payload || {},
-								delegate: mAction.delegateInfo.instance,
-								modelType: mAction.delegateInfo.modelType,
-								requiredLibraries: mAction.delegateInfo.requiredLibraries
-							}
+		.then(function(bHasChangeHandler) {
+			if (bHasChangeHandler) {
+				return {
+					aggregationName: mAction.aggregation,
+					addPropertyActionData: {
+						designTimeMetadata: oDesignTimeMetadata,
+						action: mAction,
+						delegateInfo: {
+							payload: mAction.delegateInfo.payload || {},
+							delegate: mAction.delegateInfo.instance,
+							modelType: mAction.delegateInfo.modelType,
+							requiredLibraries: mAction.delegateInfo.requiredLibraries,
+							delegateType: mAction.delegateInfo.delegateType
 						}
-					};
-				}
-				return undefined;
-			});
+					}
+				};
+			}
+			return undefined;
+		});
 	}
 
-	function getInvisibleElements (oParentOverlay, sAggregationName, oPlugin) {
+	function getInvisibleElements(oParentOverlay, sAggregationName, oPlugin) {
 		var oParentElement = oParentOverlay.getElement();
 		if (!oParentElement) {
 			return [];
@@ -132,7 +133,7 @@ sap.ui.define([
 	function isValidAction(oCheckElementOverlay, mParents, mAction, oPlugin) {
 		var bValidAction = mAction.changeType && oPlugin.hasStableId(oCheckElementOverlay);
 		if (bValidAction && oCheckElementOverlay !== mParents.relevantContainerOverlay) {
-			//relevant container is needed for some changes, so it must have a stable ID
+			// relevant container is needed for some changes, so it must have a stable ID
 			bValidAction = oPlugin.hasStableId(mParents.relevantContainerOverlay);
 		}
 		return bValidAction;
@@ -146,39 +147,45 @@ sap.ui.define([
 			if (bValidAction) {
 				mAction.element = oCheckElement;
 				return DelegateMediatorAPI.getDelegateForControl({
-					control: mParents.relevantContainer, //delegate will always be added on the relevant container
+					control: mParents.relevantContainer, // delegate will always be added on the relevant container
 					modifier: JsControlTreeModifier,
 					supportsDefault: mAction.supportsDefaultDelegate
 				})
-					.then(function(mDelegateInfo) {
-						if (mDelegateInfo && mDelegateInfo.names && mDelegateInfo.names.length) {
-							var aRequiredLibraries = DelegateMediatorAPI.getRequiredLibrariesForDefaultDelegate({
-								delegateName: mDelegateInfo.names,
-								control: mParents.relevantContainer
-							});
-
-							// Check if all required libraries were successfully loaded
-							if (
-								difference(
-									aRequiredLibraries,
-									aDefaultDelegateLibraries.filter(Boolean)
-								).length === 0
-							) {
-								mAction.delegateInfo = mDelegateInfo;
-								aFilteredActions.push(mAction);
-							}
+				.then(function(mDelegateInfo) {
+					// Only complete delegators can be used for additional elements
+					if (
+						mDelegateInfo &&
+						mDelegateInfo.names &&
+						mDelegateInfo.names.length &&
+						mDelegateInfo.delegateType === DelegateMediatorAPI.types.COMPLETE
+					) {
+						var aRequiredLibraries = DelegateMediatorAPI.getRequiredLibrariesForDefaultDelegate({
+							delegateName: mDelegateInfo.names,
+							control: mParents.relevantContainer
+						});
+
+						// Check if all required libraries were successfully loaded
+						if (
+							difference(
+								aRequiredLibraries,
+								aDefaultDelegateLibraries.filter(Boolean)
+							).length === 0
+						) {
+							mAction.delegateInfo = mDelegateInfo;
+							aFilteredActions.push(mAction);
 						}
-						return aFilteredActions;
-					});
+					}
+					return aFilteredActions;
+				});
 			}
 			return aFilteredActions;
 		}
 
-		return aActions.reduce(function (oPreviousActionsPromise, mAction) {
+		return aActions.reduce(function(oPreviousActionsPromise, mAction) {
 			return oPreviousActionsPromise
-				.then(function(aFilteredActions) {
-					return fnFilterActions(aFilteredActions, mAction);
-				});
+			.then(function(aFilteredActions) {
+				return fnFilterActions(aFilteredActions, mAction);
+			});
 		}, Promise.resolve([]));
 	}
 
@@ -237,7 +244,7 @@ sap.ui.define([
 						var mParents = AdditionalElementsUtils.getParents(true, oOverlay, oPlugin);
 						if (bHasChangeHandler) {
 							if (mRevealAction.changeOnRelevantContainer) {
-								//we have the child overlay, so we need the parents
+								// we have the child overlay, so we need the parents
 								bRevealEnabled = oPlugin.hasStableId(mParents.relevantContainerOverlay)
 									&& oPlugin.hasStableId(mParents.parentOverlay);
 							} else {
@@ -320,7 +327,7 @@ sap.ui.define([
 			oRevealActionsPromise,
 			oAddPropertyActionsPromise
 		]).then(function(aAllActions) {
-			//join and condense all action data
+			// join and condense all action data
 			var mAllActions = merge(aAllActions[0], aAllActions[1]);
 			oSourceElementOverlay._mAddActions = oSourceElementOverlay._mAddActions || {asSibling: {}, asChild: {}};
 			oSourceElementOverlay._mAddActions[sSiblingOrChild] = mAllActions;
@@ -364,7 +371,7 @@ sap.ui.define([
 		if (mParents.relevantContainer !== mParents.parent) {
 			aParents = ElementUtil.findAllSiblingsInContainer(mParents.parent, mParents.relevantContainer).map(function(oParent) {
 				return OverlayRegistry.getOverlay(oParent);
-			}).filter(function (oOverlay) {
+			}).filter(function(oOverlay) {
 				return oOverlay;
 			});
 		}
@@ -384,12 +391,12 @@ sap.ui.define([
 					return getRevealActionFromAggregations(aParents, mReveal, sAggregationName, aAggregationNames, oPlugin);
 				});
 			}, Promise.resolve({}))
-				.then(function(mAggregatedReveal) {
-					if (bSibling) {
-						mRevealCache[mParents.parentOverlay.getId()] = mAggregatedReveal;
-					}
-					return mAggregatedReveal;
-				});
+			.then(function(mAggregatedReveal) {
+				if (bSibling) {
+					mRevealCache[mParents.parentOverlay.getId()] = mAggregatedReveal;
+				}
+				return mAggregatedReveal;
+			});
 		}
 		return Promise.resolve({});
 	};
@@ -406,32 +413,32 @@ sap.ui.define([
 		var mParents = AdditionalElementsUtils.getParents(bSibling, oSourceElementOverlay, oPlugin);
 		var oDesignTimeMetadata = mParents.parentOverlay && mParents.parentOverlay.getDesignTimeMetadata();
 		return Promise.resolve()
-			.then(function() {
-				var aActions = oDesignTimeMetadata ? oDesignTimeMetadata.getActionDataFromAggregations("add", mParents.parent, undefined, "delegate") : [];
-				if (aActions.length) {
-					return loadKnownDefaultDelegateLibraries()
-						.then(filterValidAddPropertyActions.bind(this, aActions, mParents, oPlugin));
-				}
-				return [];
-			}.bind(this))
-			.then(function(aActions) {
-				return aActions.reduce(function (oPreviousPromise, oAction) {
-					return oPreviousPromise
-						.then(function (oReturn) {
-							return getAddViaDelegateActionData.call(this, oAction, oDesignTimeMetadata, oPlugin)
-								.then(function (mAction) {
-									if (mAction) {
-										mAction.addPropertyActionData.relevantContainer = mParents.relevantContainer;
-										if (!oReturn[mAction.aggregationName]) {
-											oReturn[mAction.aggregationName] = {};
-										}
-										oReturn[mAction.aggregationName].addViaDelegate = mAction.addPropertyActionData;
-									}
-									return oReturn;
-								});
-						}.bind(this));
-				}.bind(this), Promise.resolve({}));
-			}.bind(this));
+		.then(function() {
+			var aActions = oDesignTimeMetadata ? oDesignTimeMetadata.getActionDataFromAggregations("add", mParents.parent, undefined, "delegate") : [];
+			if (aActions.length) {
+				return loadKnownDefaultDelegateLibraries()
+				.then(filterValidAddPropertyActions.bind(this, aActions, mParents, oPlugin));
+			}
+			return [];
+		}.bind(this))
+		.then(function(aActions) {
+			return aActions.reduce(function(oPreviousPromise, oAction) {
+				return oPreviousPromise
+				.then(function(oReturn) {
+					return getAddViaDelegateActionData.call(this, oAction, oDesignTimeMetadata, oPlugin)
+					.then(function(mAction) {
+						if (mAction) {
+							mAction.addPropertyActionData.relevantContainer = mParents.relevantContainer;
+							if (!oReturn[mAction.aggregationName]) {
+								oReturn[mAction.aggregationName] = {};
+							}
+							oReturn[mAction.aggregationName].addViaDelegate = mAction.addPropertyActionData;
+						}
+						return oReturn;
+					});
+				}.bind(this));
+			}.bind(this), Promise.resolve({}));
+		}.bind(this));
 	};
 
 	return ActionExtractor;

package/src/sap/ui/rta/plugin/additionalElements/AddElementsDialog.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @class Context - Dialog for available Fields in Runtime Authoring
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 * @constructor
 	 * @private
 	 * @since 1.44
@@ -83,10 +83,10 @@ sap.ui.define([
 			customFieldVisible: false,
 			businessContextVisible: false,
 			customFieldButtonTooltip: "",
-			businessContextTexts: [{text: ""}] //empty element in first place, to be replaced by the headerText (see: addExtensionData)
+			businessContextTexts: [{text: ""}] // empty element in first place, to be replaced by the headerText (see: addExtensionData)
 		});
 
-		this._oDialogPromise.then(function (oDialog) {
+		this._oDialogPromise.then(function(oDialog) {
 			oDialog.setModel(this._oDialogModel);
 			if (!oRTAResourceModel) {
 				oRTAResourceModel = new ResourceModel({bundleName: "sap.ui.rta.messagebundle"});
@@ -97,8 +97,8 @@ sap.ui.define([
 
 			this._oDialogModel.setProperty("/listNoDataText", oRTAResourceModel.getProperty("MSG_NO_FIELDS").toLowerCase());
 
-			//retrieve List to set the sorting for the 'items' aggregation, since sap.ui.model.Sorter
-			//does not support binding to a model property...
+			// retrieve List to set the sorting for the 'items' aggregation, since sap.ui.model.Sorter
+			// does not support binding to a model property...
 			this._oList = sap.ui.getCore().byId(this.getId() + "--rta_addElementsDialogList");
 			this._bDescendingSortOrder = false;
 		}.bind(this));
@@ -127,21 +127,21 @@ sap.ui.define([
 			oDialog.close();
 			this._fnResolveOnDialogConfirm();
 		}.bind(this));
-		//indicate that the dialog has been closed and the selected fields (if any) are to be added to the UI
+		// indicate that the dialog has been closed and the selected fields (if any) are to be added to the UI
 	};
 
 	/**
 	 * Close dialog. All sections will be reverted
 	 */
 	AddElementsDialog.prototype._cancelDialog = function() {
-		//clear all selections
+		// clear all selections
 		this._oDialogModel.getObject("/elements").forEach(function(oElem) {
 			oElem.selected = false;
 		});
 		this._oDialogPromise.then(function(oDialog) {
 			oDialog.close();
 		});
-		//indicate that the dialog has been closed without choosing to add any fields (canceled)
+		// indicate that the dialog has been closed without choosing to add any fields (canceled)
 		this._fnRejectOnDialogCancel();
 	};
 
@@ -184,7 +184,7 @@ sap.ui.define([
 	 *
 	 * @private
 	 */
-	AddElementsDialog.prototype._resortList = function () {
+	AddElementsDialog.prototype._resortList = function() {
 		this._bDescendingSortOrder = !this._bDescendingSortOrder;
 		var oBinding = this._oList.getBinding("items");
 		var aSorter = [];
@@ -219,7 +219,7 @@ sap.ui.define([
 	 *
 	 * @private
 	 */
-	AddElementsDialog.prototype._redirectToCustomFieldCreation = function () {
+	AddElementsDialog.prototype._redirectToCustomFieldCreation = function() {
 		this.fireOpenCustomField();
 		this._oDialogPromise.then(function(oDialog) {
 			oDialog.close();
@@ -261,31 +261,31 @@ sap.ui.define([
 	 * @returns {Promise<undefined>} A promise resolving to undefined
 	 * @public
 	 */
-	AddElementsDialog.prototype.addExtensionData = function (aExtensionData) {
-		//clear old values from last run
+	AddElementsDialog.prototype.addExtensionData = function(aExtensionData) {
+		// clear old values from last run
 		this._removeExtensionDataTexts();
 
 		var aBusinessContextTexts = this._oDialogModel.getObject("/businessContextTexts");
 		if (aExtensionData && aExtensionData.length > 0) {
-			aExtensionData.forEach(function (oContext) {
+			aExtensionData.forEach(function(oContext) {
 				aBusinessContextTexts.push({
 					text: oContext.description
 				});
 			}, this);
 		} else {
-			//Message "none" when no extension data is available
+			// Message "none" when no extension data is available
 			aBusinessContextTexts.push({
 				text: oRTAResourceModel.getProperty("MSG_NO_BUSINESS_CONTEXTS")
 			});
 		}
-		//set the container visible
+		// set the container visible
 		this._setBusinessContextVisible(true);
 
 		return FieldExtensibility.getTexts().then(function(oFieldExtensibilityTexts) {
 			if (oFieldExtensibilityTexts) {
 				this._oDialogModel.setProperty("/customFieldButtonTooltip", oFieldExtensibilityTexts.tooltip);
-				//the first entry is always the "header" to be set by the implementation of FieldExtensibility
-				//it is set during the instantiation of the model, in the 'init' function
+				// the first entry is always the "header" to be set by the implementation of FieldExtensibility
+				// it is set during the instantiation of the model, in the 'init' function
 				this._oDialogModel.setProperty("/businessContextTexts/0/text", oFieldExtensibilityTexts.headerText);
 			}
 		}.bind(this));
@@ -296,7 +296,7 @@ sap.ui.define([
 	 * (except for the title)
 	 * @private
 	 */
-	AddElementsDialog.prototype._removeExtensionDataTexts = function () {
+	AddElementsDialog.prototype._removeExtensionDataTexts = function() {
 		var aBusinessContextTexts = this._oDialogModel.getObject("/businessContextTexts");
 		aBusinessContextTexts.splice(1);
 	};