@openui5/sap.ui.integration 1.105.0 → 1.106.0

package/src/sap/ui/integration/util/Validators.js

@@ -0,0 +1,125 @@
+/*!
+ * 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([], function () {
+	"use strict";
+
+	/**
+	 * Utility class helping with input validations.
+	 *
+	 * @author SAP SE
+	 * @version 1.106.0
+	 *
+	 * @private
+	 * @alias sap.ui.integration.util.Validators
+	 */
+	var Validators = {
+		string: {
+			maxLength: function (v, max) {
+				return v.length <= max;
+			},
+			maxLengthTxt: "EDITOR_VAL_MAXLENGTH",
+			minLength: function (v, min) {
+				return v.length >= min;
+			},
+			minLengthTxt: "EDITOR_VAL_MINLENGTH",
+			pattern: function (v, pattern) {
+				var p = new RegExp(pattern);
+				return p.test(v);
+			},
+			patternTxt: "EDITOR_VAL_NOMATCH",
+			required: function (v, b) {
+				return !b || !!v;
+			},
+			requiredTxt: "EDITOR_VAL_TEXTREQ",
+			validateTxt: "EDITOR_VAL_NOMATCH"
+		},
+		"string[]": {
+			maxLength: function (v, max) {
+				return Array.isArray(v) && v.length <= max;
+			},
+			maxLengthTxt: "EDITOR_VAL_LISTMAXLENGTH",
+			minLength: function (v, min) {
+				return Array.isArray(v) && v.length >= min;
+			},
+			minLengthTxt: "EDITOR_VAL_LISTMINLENGTH",
+			required: function (v, b) {
+				return Array.isArray(v) && v.length > 0;
+			},
+			requiredTxt: "EDITOR_VAL_LISTREQ"
+		},
+		integer: {
+			maximum: function (v, valValue, valSettings) {
+				if (valSettings.exclusiveMaximum) {
+					valSettings._txt = "maximumExclusiveTxt";
+					return v < valValue;
+				}
+				return v <= valValue;
+			},
+			maximumTxt: "EDITOR_VAL_MAX",
+			maximumExclusiveTxt: "EDITOR_VAL_MAX_E",
+			minimum: function (v, valValue, valSettings) {
+				if (valSettings.exclusiveMinimum) {
+					valSettings._txt = "minimumExclusiveTxt";
+					return v > valValue;
+				}
+				return v >= valValue;
+			},
+			minimumTxt: "EDITOR_VAL_MIN",
+			minimumExclusiveTxt: "EDITOR_VAL_MIN_E",
+			multipleOf: function (v, valValue) {
+				return (v % valValue) === 0;
+			},
+			multipleOfTxt: "EDITOR_VAL_MULTIPLE",
+			required: function (v, b) {
+				return !isNaN(v) && v !== "";
+			},
+			requiredTxt: "EDITOR_VAL_NUMBERREQ",
+			validateTxt: "EDITOR_VAL_NOMATCH"
+		},
+		number: {
+			maximum: function (v, valValue, valSettings) {
+				if (valSettings.exclusiveMaximum) {
+					valSettings._txt = "maximumExclusiveTxt";
+					return v < valValue;
+				}
+				return v <= valValue;
+			},
+			maximumTxt: "EDITOR_VAL_MAX",
+			maximumExclusiveTxt: "EDITOR_VAL_MAX_E",
+			minimum: function (v, valValue, valSettings) {
+				if (valSettings.exclusiveMinimum) {
+					valSettings._txt = "minimumExclusiveTxt";
+					return v > valValue;
+				}
+				return v >= valValue;
+			},
+			minimumTxt: "EDITOR_VAL_MIN",
+			minimumExclusiveTxt: "EDITOR_VAL_MAX_E",
+			multipleOf: function (v, valValue) {
+				return (v % valValue) === 0;
+			},
+			multipleOfTxt: "EDITOR_VAL_MULTIPLE",
+			required: function (v, b) {
+				return !isNaN(v) && v !== "";
+			},
+			requiredTxt: "EDITOR_VAL_NUMBERREQ",
+			validateTxt: "EDITOR_VAL_NOMATCH"
+		},
+		keyValuePair: {
+			required: function (v, b) {
+				return !b || !!v.value;
+			},
+			requiredTxt: "EDITOR_VAL_FIELDREQ",
+			restrictToPredefinedOptions: function (v, b) {
+				return (b && !v.value && !v.key) || (b && !!v.key);
+			},
+			restrictToPredefinedOptionsTxt: "EDITOR_ONLY_LISTED_VALUES_ALLOWED"
+		}
+	};
+
+	return Validators;
+});

package/src/sap/ui/integration/widgets/Card.js

@@ -103,7 +103,7 @@ sap.ui.define([
 	/**
 	 * @const A list of model names which are used internally by the card.
 	 */
-	var INTERNAL_MODEL_NAMES = ["parameters", "filters", "paginator", "form", "context", "i18n"];
+	var INTERNAL_MODEL_NAMES = ["parameters", "filters", "paginator", "form", "messages", "context", "i18n"];
 
 	var RESERVED_PARAMETER_NAMES = ["visibleItems", "allItems"];
 
@@ -188,7 +188,7 @@ sap.ui.define([
 	 * @extends sap.f.CardBase
 	 *
 	 * @author SAP SE
-	 * @version 1.105.0
+	 * @version 1.106.0
 	 * @public
 	 * @constructor
 	 * @see {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
@@ -203,6 +203,7 @@ sap.ui.define([
 
 				/**
 				 * Optional property which can be used by the host to reference the card.
+				 * It will be forwarded to any children cards.
 				 * Does not affect the card behavior.
 				 */
 				referenceId : {
@@ -255,12 +256,15 @@ sap.ui.define([
 				 *
 				 * This can be a list of flexibility changes generated during designtime.
 				 *
-				 * Each level of changes is an item in the list. The change has property "content" which contains the configuration, which will be merged on top of the original <code>sap.card</code> section.
+				 * Each item in the array represents a separate level of changes. For example, the first item might be created by an administrator, the second by a page administrator and the third by the end user.
+				 *
+				 * The order of the items is the order in which the changes will be merged on top of each other. So the last item will overwrite the previous items where the paths match.
 				 *
 				 * Example:
 				 * <pre>
 				 * [
 				 * 	{
+				 * 		// Administrator
 				 * 		"/sap.card/header/title": "My Configured Title in Default Language",
 				 * 		"/sap.card/content/maxItems": 10,
 				 * 		"texts": {
@@ -270,13 +274,13 @@ sap.ui.define([
 				 * 		}
 				 * 	},
 				 * 	{
-				 * 		"/sap.card/header/title": "My Configured Title in Default Language",
-				 * 		"/sap.card/content/maxItems": 10,
-				 * 		"texts": {
-				 * 			"en-US": {
-				 * 				"/sap.card/header/title": "My Configured Title in US-English"
-				 * 			}
-				 * 		}
+				 * 		// Page administrator
+				 * 		"/sap.card/content/maxItems": 5
+				 * 	},
+				 * 	{
+				 * 		// End user
+				 *      "/sap.card/header/title": "Title by End User",
+				 * 		"/sap.card/content/maxItems": 8
 				 * 	}
 				 * ]
 				 * </pre>
@@ -477,8 +481,8 @@ sap.ui.define([
 		this._bFirstRendering = true;
 		this._aFundamentalErrors = [];
 		this._sPerformanceId = "UI5 Integration Cards - " + this.getId() + "---";
-		this._fnOnCardReady = function () {
-			this._bCardReady = true;
+		this._fnOnDataReady = function () {
+			this._bDataReady = true;
 		}.bind(this);
 
 		/**
@@ -488,7 +492,7 @@ sap.ui.define([
 		 * @experimental since 1.79
 		 * @public
 		 * @author SAP SE
-		 * @version 1.105.0
+		 * @version 1.106.0
 		 * @borrows sap.ui.integration.widgets.Card#getDomRef as getDomRef
 		 * @borrows sap.ui.integration.widgets.Card#setVisible as setVisible
 		 * @borrows sap.ui.integration.widgets.Card#getParameters as getParameters
@@ -515,6 +519,7 @@ sap.ui.define([
 		 * @borrows sap.ui.integration.widgets.Card#showCard as showCard
 		 * @borrows sap.ui.integration.widgets.Card#hide as hide
 		 * @borrows sap.ui.integration.widgets.Card#getOpener as getOpener
+		 * @borrows sap.ui.integration.widgets.Card#validateControls as validateControls
 		 */
 		this._oLimitedInterface = new Interface(this, [
 			"getDomRef",
@@ -542,7 +547,8 @@ sap.ui.define([
 			"hideLoadingPlaceholders",
 			"showCard",
 			"hide",
-			"getOpener"
+			"getOpener",
+			"validateControls"
 		]);
 	};
 
@@ -569,6 +575,13 @@ sap.ui.define([
 						ParameterMap.getParamsForModel()
 					);
 				break;
+				case "messages":
+					oModel = new JSONModel({
+						hasErrors: false,
+						hasWarnings: false,
+						records: []
+					});
+					break;
 				default:
 					oModel = new JSONModel();
 				break;
@@ -600,17 +613,18 @@ sap.ui.define([
 	Card.prototype._initReadyState = function () {
 		this._aReadyPromises = [];
 
+		this._awaitEvent("_dataReady");
+		this._awaitEvent("_dataPassedToContent");
 		this._awaitEvent("_headerReady");
 		this._awaitEvent("_filterBarReady");
 		this._awaitEvent("_contentReady");
-		this._awaitEvent("_cardReady");
 
 		Promise.all(this._aReadyPromises).then(function () {
 			this._bReady = true;
 			this.fireEvent("_ready");
 		}.bind(this));
 
-		this.attachEventOnce("_cardReady", this._fnOnCardReady);
+		this.attachEventOnce("_dataReady", this._fnOnDataReady);
 	};
 
 	/**
@@ -620,9 +634,9 @@ sap.ui.define([
 	 */
 	Card.prototype._clearReadyState = function () {
 		this._bReady = false;
-		this._bCardReady = false;
+		this._bDataReady = false;
 		this._aReadyPromises = [];
-		this.detachEvent("_cardReady", this._fnOnCardReady);
+		this.detachEvent("_dataReady", this._fnOnDataReady);
 	};
 
 	/**
@@ -648,7 +662,7 @@ sap.ui.define([
 				Measurement.end(this._sPerformanceId + "firstRenderingWithStaticData");
 			}
 
-			if (this._bCardReady && !Measurement.getMeasurement(this._sPerformanceId + "firstRenderingWithDynamicData").end) {
+			if (this._bDataReady && !Measurement.getMeasurement(this._sPerformanceId + "firstRenderingWithDynamicData").end) {
 				Measurement.end(this._sPerformanceId + "firstRenderingWithDynamicData");
 			}
 		}
@@ -816,12 +830,12 @@ sap.ui.define([
 			}.bind(this))
 			.then(this._applyManifest.bind(this))
 			.catch(function (e) {
-				if (e.message !== CARD_DESTROYED_ERROR) {
-					this._applyManifest();
+				if (e.message === CARD_DESTROYED_ERROR) {
 					return;
 				}
 
 				this._logFundamentalError(e.message);
+				this._applyManifest();
 			}.bind(this));
 	};
 
@@ -877,6 +891,22 @@ sap.ui.define([
 		return this._aFundamentalErrors;
 	};
 
+	/**
+	 * Causes all of the controls within the Card
+	 * that support validation to validate their data.
+	 * @public
+	 * @experimental
+	 * @returns {boolean} if all of the controls validated successfully; otherwise, false
+	 */
+	Card.prototype.validateControls = function () {
+		var oCardContent = this.getCardContent();
+		if (oCardContent) {
+			oCardContent.validateControls();
+		}
+
+		return !this.getModel("messages").getProperty("/hasErrors");
+	};
+
 	/**
 	 * Prepares the manifest and applies all settings.
 	 */
@@ -1519,7 +1549,8 @@ sap.ui.define([
 			oModel;
 
 		if (!oDataSettings) {
-			this.fireEvent("_cardReady");
+			this.fireEvent("_dataReady");
+			this.fireEvent("_dataPassedToContent");
 			return;
 		}
 
@@ -1541,7 +1572,8 @@ sap.ui.define([
 		}
 
 		if (!oModel) {
-			this.fireEvent("_cardReady");
+			this.fireEvent("_dataReady");
+			this.fireEvent("_dataPassedToContent");
 			return;
 		}
 
@@ -1556,9 +1588,11 @@ sap.ui.define([
 			if (this._createContentPromise) {
 				this._createContentPromise.then(function (oContent) {
 					oContent.onDataChanged();
+					this.fireEvent("_dataPassedToContent");
 					this.onDataRequestComplete();
 				}.bind(this));
 			} else {
+				this.fireEvent("_dataPassedToContent");
 				this.onDataRequestComplete();
 			}
 
@@ -1570,17 +1604,21 @@ sap.ui.define([
 			}.bind(this));
 
 			this._oDataProvider.attachDataChanged(function (oEvent) {
+				this.fireEvent("_dataReady");
 				oModel.setData(oEvent.getParameter("data"));
-			});
+			}.bind(this));
 
 			this._oDataProvider.attachError(function (oEvent) {
+				this.fireEvent("_dataReady");
+				this.fireEvent("_dataPassedToContent");
 				this._handleError("Data service unavailable. " + oEvent.getParameter("message"));
 				this.onDataRequestComplete();
 			}.bind(this));
 
 			this._oDataProvider.triggerDataUpdate();
 		} else {
-			this.fireEvent("_cardReady");
+			this.fireEvent("_dataReady");
+			this.fireEvent("_dataPassedToContent");
 		}
 	};
 
@@ -2278,7 +2316,6 @@ sap.ui.define([
 		var oContent = this.getCardContent(),
 			oLoadingProvider = this.getAggregation("_loadingProvider");
 
-		this.fireEvent("_cardReady");
 		this.hideLoadingPlaceholders(CardArea.Header);
 		this.hideLoadingPlaceholders(CardArea.Filters);
 
@@ -2477,10 +2514,18 @@ sap.ui.define([
 	 * @private
 	 */
 	Card.prototype.getContentPageSize = function (oContentConfig) {
-		var iMaxItems = parseInt(BindingResolver.resolveValue(oContentConfig, this).maxItems) || 0,
+		var iMaxItems = 0,
 			oFooter = this.getAggregation("_footer"),
 			oPaginator;
 
+		if (oContentConfig.maxItems !== undefined) {
+			if (typeof oContentConfig.maxItems === "number") {
+				iMaxItems = oContentConfig.maxItems;
+			} else {
+				iMaxItems = parseInt(BindingResolver.resolveValue(oContentConfig, this).maxItems) || 0;
+			}
+		}
+
 		if (!oFooter) {
 			return iMaxItems;
 		}
@@ -2568,7 +2613,8 @@ sap.ui.define([
 			oChildCard = this._createCard({
 				width: oParameters.width,
 				host: this.getHostInstance(),
-				parameters: oParameters.parameters
+				parameters: oParameters.parameters,
+				referenceId: this.getReferenceId()
 			});
 
 		oChildCard.setAssociation("openerReference", this);

package/src/sap/ui/integration/designtime/baseEditor/propertyEditor/textAreaEditor/TextAreaEditor.fragment.xml

@@ -1,14 +0,0 @@
-<core:FragmentDefinition
-	xmlns="sap.m"
-	xmlns:core="sap.ui.core"
->
-	<TextArea
-		value="{displayValue}"
-		width="100%"
-		enabled="{config/enabled}"
-		placeholder="{config/placeholder}"
-		liveChange="_onLiveChange"
-		growing="true"
-		growingMaxLines="7"
-	/>
-</core:FragmentDefinition>

package/src/sap/ui/integration/designtime/baseEditor/propertyEditor/textAreaEditor/TextAreaEditor.js

@@ -1,126 +0,0 @@
-/*!
- * 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/integration/designtime/baseEditor/propertyEditor/BasePropertyEditor",
-	"sap/base/util/restricted/_isNil"
-], function (
-	BasePropertyEditor,
-	_isNil
-) {
-	"use strict";
-
-	/**
-	 * @class
-	 * Constructor for a new <code>TextAreaEditor</code>.
-	 * This allows to set a code editor or binding strings for a specified property of a JSON object.
-	 * The editor is rendered as a {@link sap.m.TextArea}.
-	 *
-	 * <h3>Configuration</h3>
-	 *
-	 * <table style="width:100%;">
-	 * <tr style="text-align:left">
-	 * 	<th>Option</th>
-	 * 	<th>Type</th>
-	 * 	<th>Default</th>
-	 * 	<th>Description</th>
-	 * </tr>
-	 * <tr>
-	 * 	<td><code>type</code></td>
-	 *  <td><code>string</code></td>
-	 * 	<td><code>json</code></td>
-	 * 	<td>The type of the code in the editor used for syntax highlighting</td>
-	 * </tr>
-	 * <tr>
-	 * 	<td><code>allowBindings</code></td>
-	 *  <td><code>boolean</code></td>
-	 * 	<td><code>true</code></td>
-	 * 	<td>Whether binding strings can be set instead of selecting items</td>
-	 * </tr>
-	 * <tr>
-	 * 	<td><code>maxLength</code></td>
-	 *  <td><code>number</code></td>
-	 * 	<td></td>
-	 * 	<td>Maximum number of characters</td>
-	 * </tr>
-	 * </table>
-	 *
-	 * @extends sap.ui.integration.designtime.baseEditor.propertyEditor.BasePropertyEditor
-	 * @alias sap.ui.integration.designtime.baseEditor.propertyEditor.textAreaEditor.TextAreaEditor
-	 * @author SAP SE
-	 * @since 1.85
-	 * @version 1.105.0
-	 *
-	 * @private
-	 * @experimental 1.85
-	 * @ui5-restricted
-	 */
-	var TextAreaEditor = BasePropertyEditor.extend("sap.ui.integration.designtime.baseEditor.propertyEditor.textAreaEditor.TextAreaEditor", {
-		xmlFragment: "sap.ui.integration.designtime.baseEditor.propertyEditor.textAreaEditor.TextAreaEditor",
-		metadata: {
-			library: "sap.ui.integration"
-		},
-		renderer: BasePropertyEditor.getMetadata().getRenderer().render
-	});
-
-	TextAreaEditor.configMetadata = Object.assign({}, BasePropertyEditor.configMetadata, {
-		allowBindings: {
-			defaultValue: true,
-			mergeStrategy: "mostRestrictiveWins"
-		},
-		typeLabel: {
-			defaultValue: "BASE_EDITOR.TYPES.OBJECT"
-		}
-	});
-
-	TextAreaEditor.prototype.getDefaultValidators = function () {
-		var oConfig = this.getConfig();
-		return Object.assign(
-			{},
-			BasePropertyEditor.prototype.getDefaultValidators.call(this),
-			{
-				notABinding: {
-					type: "notABinding",
-					isEnabled: !oConfig.allowBindings
-				},
-				maxLength: {
-					type: "maxLength",
-					isEnabled: typeof oConfig.maxLength === "number",
-					config: {
-						maxLength: oConfig.maxLength
-					}
-				}
-			}
-		);
-	};
-
-	TextAreaEditor.prototype.formatValue = function (vValue) {
-		vValue = JSON.stringify(vValue, null, "\t");
-		if (typeof vValue === "object" && !vValue.length) {
-			vValue = vValue.replace(/\"\$\$([a-zA-Z]*)\$\$\"/g, function (s) {
-				return s.substring(3, s.length - 3);
-			});
-		}
-		return vValue;
-	};
-
-	TextAreaEditor.prototype._onLiveChange = function () {
-		var oTextArea = this.getContent();
-		var sValue = oTextArea.getValue();
-		if (!sValue || sValue === "") {
-			this.setValue(undefined);
-		} else {
-			try {
-				var oValue = JSON.parse(sValue);
-				this.setValue(oValue);
-			} catch (e) {
-				oTextArea.setValueState("Error");
-				oTextArea.setValueStateText(this.getI18nProperty("BASE_EDITOR.VALIDATOR.NOT_A_JSONOBJECT"));
-			}
-		}
-	};
-
-	return TextAreaEditor;
-});