@openui5/sap.ui.integration 1.111.2 → 1.112.2

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

@@ -11,7 +11,7 @@ sap.ui.define([], function () {
 	 * Utility class helping with input validations.
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Validators

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

@@ -10,6 +10,7 @@ sap.ui.define([
 	"sap/ui/base/Interface",
 	"sap/ui/thirdparty/jquery",
 	"sap/ui/core/Core",
+	"sap/ui/core/library",
 	"sap/ui/integration/util/Manifest",
 	"sap/ui/integration/util/ServiceManager",
 	"sap/base/Log",
@@ -49,6 +50,7 @@ sap.ui.define([
 	Interface,
 	jQuery,
 	Core,
+	coreLibrary,
 	CardManifest,
 	ServiceManager,
 	Log,
@@ -115,6 +117,8 @@ sap.ui.define([
 
 	var CardDesign = library.CardDesign;
 
+	var CardPreviewMode = library.CardPreviewMode;
+
 	var CARD_DESTROYED_ERROR = "Card is destroyed!";
 
 	var FlexRendertype = mLibrary.FlexRendertype;
@@ -125,6 +129,8 @@ sap.ui.define([
 
 	var MODULE_PREFIX = "module:";
 
+	var MessageType = coreLibrary.MessageType;
+
 	/**
 	 * Constructor for a new <code>Card</code>.
 	 *
@@ -182,7 +188,7 @@ sap.ui.define([
 	 * @extends sap.f.CardBase
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 * @public
 	 * @constructor
 	 * @see {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
@@ -290,6 +296,7 @@ sap.ui.define([
 				 * @experimental Since 1.109
 				 * @private
 				 * @since 1.109
+				 * @deprecated Since 1.112. Use <code>previewMode</code> instead.
 				 */
 				useMockData: {
 					type: "boolean",
@@ -306,6 +313,23 @@ sap.ui.define([
 					type: "sap.ui.integration.CardDesign",
 					group: "Appearance",
 					defaultValue: CardDesign.Solid
+				},
+
+				/**
+				 * Preview mode of the <code>Card</code>.
+				 * Helpful in scenarios when the end user is choosing or configuring a card.
+				 * <ul>
+				 * <li>When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData" in the manifest. If such configuration is missing, then the real data is loaded.</li>
+				 * <li>When set to "Abstract", the card shows abstract placeholder without loading data.</li>
+				 * <li>When set to "Off", the card displays real data.</li>
+				 * </ul>
+				 * @experimental Since 1.112
+				 * @since 1.112
+				 */
+				previewMode: {
+					type: "sap.ui.integration.CardPreviewMode",
+					group: "Behavior",
+					defaultValue: CardPreviewMode.Off
 				}
 			},
 			aggregations: {
@@ -383,6 +407,10 @@ sap.ui.define([
 
 				/**
 				 * Fired when an action is triggered on the card.
+				 *
+				 * When an action is triggered in the card it can be handled on several places by "action" event handlers. In consecutive order those places are: <code>Extension</code>, <code>Card</code>, <code>Host</code>.
+				 * Each of them can prevent the next one to handle the action by calling <code>oEvent.preventDefault()</code>.
+				 *
 				 * @experimental since 1.64
 				 * Disclaimer: this event is in a beta state - incompatible API changes may be done before its official public release. Use at your own discretion.
 				 */
@@ -502,7 +530,7 @@ sap.ui.define([
 		this._oContentFactory = new ContentFactory(this);
 		this._oCardObserver = new CardObserver(this);
 		this._aSevereErrors = [];
-		this._sPerformanceId = "UI5 Integration Cards - " + this.getId() + "---";
+		this._sPerformanceId = "UI5 Integration Cards " + this.getId() + " ";
 		this._aActiveLoadingProviders = [];
 		this._fnOnDataReady = function () {
 			this._bDataReady = true;
@@ -515,7 +543,7 @@ sap.ui.define([
 		 * @experimental since 1.79
 		 * @public
 		 * @author SAP SE
-		 * @version 1.111.2
+		 * @version 1.112.2
 		 * @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
@@ -587,17 +615,17 @@ sap.ui.define([
 			switch (sModelName) {
 				case "context":
 					oModel = new ContextModel();
-				break;
+					break;
 				case "i18n":
 					oModel = new ResourceModel({
 						bundle: this._oIntegrationRb
 					});
-				break;
+					break;
 				case "parameters":
 					oModel = new JSONModel(
 						ParameterMap.getParamsForModel()
 					);
-				break;
+					break;
 				case "messages":
 					oModel = new JSONModel({
 						hasErrors: false,
@@ -607,7 +635,6 @@ sap.ui.define([
 					break;
 				default:
 					oModel = new JSONModel();
-				break;
 			}
 
 			this.setModel(oModel, sModelName);
@@ -937,10 +964,10 @@ sap.ui.define([
 		return !this.getModel("messages").getProperty("/hasErrors");
 	};
 
-	Card.prototype._validateContentControls = function (bShowValueState) {
+	Card.prototype._validateContentControls = function (bShowValueState, bSkipFiringStateChangedEvent) {
 		var oCardContent = this.getCardContent();
 		if (oCardContent && oCardContent.isA("sap.ui.integration.cards.BaseContent")) {
-			oCardContent.validateControls(bShowValueState);
+			oCardContent.validateControls(bShowValueState, bSkipFiringStateChangedEvent);
 		}
 	};
 
@@ -1133,6 +1160,41 @@ sap.ui.define([
 		oFilter.setValueFromOutside(vValue);
 	};
 
+	/**
+	 * Sets the values of form fields in the Object card.
+	 * Each value in the aFormValues array must have a
+	 * key and the respective value for ObjectGroupItems as defined in the card's manifest:
+	 * <code>[
+	 *     {
+	 *         "id": "textAreaItemId",
+	 *         "value": "New value"
+	 *     },
+	 *     {
+	 *         "id": "textAreaItemId",
+	 *         "value": "New value"
+	 *     },
+	 *     {
+	 *         "id": "comboBoxItemId",
+	 *         "selectedKey": "key"
+	 *     }
+	 * ]</code>
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @param {object[]} aFormValues Array key and value
+	 */
+	Card.prototype.setFormValues = function (aFormValues) {
+		var oContent  = this.getCardContent();
+		if (oContent && !oContent.isA("sap.ui.integration.cards.ObjectContent")) {
+			Log.error("Setting form element values is available only on an Object card" , "sap.ui.integration.widgets.Card");
+			return;
+		}
+
+		aFormValues.forEach(function (oFieldData) {
+			oContent.setFormFieldValue(oFieldData);
+		});
+	};
+
 	/**
 	 * Refreshes the card data by triggering all data requests.
 	 *
@@ -1266,6 +1328,7 @@ sap.ui.define([
 	Card.prototype._cleanupOldManifest = function() {
 		this._aReadyPromises = null;
 
+		this.getModel().setData({});
 		this.getModel("filters").setData({});
 		this.getModel("parameters").setData({});
 		this.getModel("paginator").setData({});
@@ -1562,7 +1625,7 @@ sap.ui.define([
 				extension: oExtension,
 				csrfTokensConfig: this._oCardManifest.get(MANIFEST_PATHS.CSRF_TOKENS),
 				card: this
-			});
+			}).attachEvent("liveDataFallback", this._onLiveDataFallback, this);
 
 			this._registerCustomModels();
 
@@ -1843,7 +1906,7 @@ sap.ui.define([
 	};
 
 	/**
-	 * Lazily load and create a specific type of card content based on sap.card/content part of the manifest
+	 * Creates specific type of card content based on sap.card/content part of the manifest
 	 *
 	 * @private
 	 */
@@ -1861,13 +1924,6 @@ sap.ui.define([
 			return;
 		}
 
-		if (this._bIsPreviewMode) {
-			// TODO: refactor preview to remove temporary content
-			this.setAggregation("_content", this._getTemporaryContent(sCardType, oContentManifest));
-			this.fireEvent("_contentReady");
-			return;
-		}
-
 		try {
 			oContent = this.createContent({
 				cardType: sCardType,
@@ -2115,31 +2171,6 @@ sap.ui.define([
 		return this._oContentMessage;
 	};
 
-	Card.prototype._getTemporaryContent = function (sCardType, oContentManifest) {
-		var oLoadingProvider = this.getAggregation("_loadingProvider");
-		var oTemporaryContent;
-
-		if (oLoadingProvider) {
-			oTemporaryContent = oLoadingProvider.createContentPlaceholder(oContentManifest, sCardType, this);
-
-			oTemporaryContent.addEventDelegate({
-				onAfterRendering: function () {
-					if (!this._oCardManifest) {
-						return;
-					}
-
-					var sHeight = this._oContentFactory.getClass(sCardType).getMetadata().getRenderer().getMinHeight(oContentManifest, oTemporaryContent, this);
-
-					if (this.getHeight() === "auto") { // if there is no height specified the default value is "auto"
-						oTemporaryContent.$().css({ "min-height": sHeight });
-					}
-				}
-			}, this);
-		}
-
-		return oTemporaryContent;
-	};
-
 	/**
 	 * Sets a new value for the <code>dataMode</code> property.
 	 *
@@ -2419,20 +2450,27 @@ sap.ui.define([
 	 *
 	 * To be used only inside the designtime.
 	 *
+	 * @deprecated since 1.112
 	 * @private
 	 * @param {boolean} bIsPreviewMode True if the card should be in preview mode.
 	 */
 	Card.prototype._setPreviewMode = function (bIsPreviewMode) {
-		this._bIsPreviewMode = bIsPreviewMode;
-
 		if (bIsPreviewMode) {
-			this.addStyleClass("sapFCardPreview");
+			this.setPreviewMode(CardPreviewMode.Abstract);
 		} else {
-			this.removeStyleClass("sapFCardPreview");
+			this.setPreviewMode(CardPreviewMode.Off);
 		}
+	};
 
-		this._bApplyManifest = true;
-		this.invalidate();
+	Card.prototype.setPreviewMode = function (sPreviewMode) {
+		var sOldMode = this.getPreviewMode();
+		this.setProperty("previewMode", sPreviewMode);
+
+		if (sOldMode !== this.getPreviewMode()) {
+			this._bApplyManifest = true;
+		}
+
+		return this;
 	};
 
 	/**
@@ -2554,7 +2592,7 @@ sap.ui.define([
 	Card.prototype._onReady = function () {
 		this._bReady = true;
 		this._setActionButtonsEnabled(true);
-		this._validateContentControls();
+		this._validateContentControls(false, true);
 		this.fireEvent("_ready");
 		this._fireStateChanged();
 	};
@@ -2801,5 +2839,13 @@ sap.ui.define([
 		return new Card(oSettings);
 	};
 
+	Card.prototype._onLiveDataFallback = function () {
+		Log.error("'mockData' configuration is missing, but the card 'previewMode' is 'MockData'. Real data will be loaded.", this);
+
+		this.attachEventOnce("manifestApplied", function () {
+			this.showMessage(this._oIntegrationRb.getText("CARD_MISSING_PREVIEW_CONFIGURATION"), MessageType.Information);
+		}.bind(this));
+	};
+
 	return Card;
 });

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

@@ -14,6 +14,7 @@ sap.ui.define([
 		TYPE: "/sap.card/type"
 	};
 	var CardDesign = library.CardDesign;
+	var CardPreviewMode = library.CardPreviewMode;
 
 	return FCardRenderer.extend("sap.ui.integration.widgets.CardRenderer", {
 		apiVersion: 2,
@@ -39,6 +40,10 @@ sap.ui.define([
 			if (oCard.getDesign() === CardDesign.Transparent) {
 				oRm.class("sapFCardTransparent");
 			}
+
+			if (oCard.getPreviewMode() === CardPreviewMode.Abstract) {
+				oRm.class("sapFCardPreview");
+			}
 		},
 
 		/**

package/src/sap-ui-integration.js

@@ -125,7 +125,7 @@
 	}
 
 	function initTags() {
-		coreInstance.loadLibraries(["sap/ui/integration"], {
+		coreInstance.loadLibrary("sap.ui.integration", {
 			async: true
 		}).then(function () {
 			//register the tags for this library

package/ui5.yaml

@@ -47,6 +47,14 @@ builder:
               - sap/ui/core/support/Hotkeys.js
               - '!sap/ui/integration/thirdparty/'
               - '!sap/ui/integration/designtime/thirdparty/'
+              # own manifest
+              - sap/ui/integration/manifest.json
+              # manifests for library dependencies
+              - sap/ui/core/manifest.json
+              - sap/m/manifest.json
+              - sap/f/manifest.json
+              - sap/ui/unified/manifest.json
+              - sap/ui/layout/manifest.json
             resolve: true
             renderer: true
           - mode: require

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

@@ -1,204 +0,0 @@
-/*!
- * OpenUI5
- * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
- * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
- */
-
-sap.ui.define([
-	"sap/ui/core/library",
-	"./Validators",
-	"./BindingResolver",
-	"sap/base/Log"],
-	function (coreLibrary,
-			  Validators,
-			  BindingResolver,
-			  Log) {
-		"use strict";
-
-		var ValueState = coreLibrary.ValueState;
-
-		function _getValidationValue(oControl) {
-			if (oControl.isA("sap.m.ComboBox")) {
-				return {
-					key: oControl.getSelectedKey(),
-					value: oControl.getValue()
-				};
-			} else {
-				return oControl.getValue();
-			}
-		}
-
-		function _getInputType(oItem) {
-			switch (oItem.type) {
-				case "ComboBox":
-					return "keyValuePair";
-				default:
-					return "string";
-			}
-		}
-
-		function removeMessageFromControl(oControl, oMessagesModel) {
-			var sBindingPath = "/" + oControl._oItem.id,
-				oMessagesModelData = oMessagesModel.getData(),
-				i,
-				bHasChange = false;
-
-			oControl.setValueState(ValueState.None);
-
-			for (i = 0; i < oMessagesModelData.records.length; i++) {
-				if (oMessagesModelData.records[i].bindingPath === sBindingPath) {
-					oMessagesModelData.records.splice(i, 1);
-					bHasChange = true;
-					break;
-				}
-			}
-
-			if (bHasChange) {
-				oMessagesModel.setData(oMessagesModelData);
-			}
-		}
-
-		function updateMessageModel(oMessagesModel) {
-			var aRecords = oMessagesModel.getProperty("/records");
-
-			oMessagesModel.setProperty("/hasErrors", !!aRecords.find(function (oRecord) {
-				return oRecord.type === ValueState.Error;
-			}));
-
-			oMessagesModel.setProperty("/hasWarnings", !!aRecords.find(function (oRecord) {
-				return oRecord.type === ValueState.Warning;
-			}));
-		}
-
-		function getExtensionFunctionName (sValue, oExtension) {
-			var sValidationFunctionName;
-
-			if (!sValue.startsWith("extension.")) {
-				Log.error("Validation function should start with 'extension.'");
-				return false;
-			}
-
-			if (!oExtension) {
-				Log.error("Extension is not defined.");
-				return false;
-			}
-
-			sValidationFunctionName = sValue.replace("extension.", "");
-
-			if (!oExtension[sValidationFunctionName]) {
-				Log.error("No such function.", sValidationFunctionName, "sap.ui.integration.widgets.Card");
-				return false;
-			}
-
-			return sValidationFunctionName;
-		}
-
-		/**
-		 * Utility class helping with form validation.
-		 *
-		 * @author SAP SE
-		 * @version 1.111.2
-		 *
-		 * @private
-		 * @alias sap.ui.integration.util.Forms
-		 */
-		var Forms = {
-			validateControl: function (oControl, oCard, bShowValueState) {
-				var oValue = _getValidationValue(oControl),
-					oMessagesModel = oCard.getModel("messages"),
-					oResourceBundle = oCard.getModel("i18n").getResourceBundle(),
-					oExtension = oCard.getAggregation("_extension"),
-					oItem = oControl._oItem,
-					oBindingContext = oControl.getBindingContext(),
-					sBindingPath = oBindingContext ? oBindingContext.getPath() : "",
-					sInputType,
-					oValidator,
-					oValidationValue,
-					fnValidationFunc,
-					sValueState,
-					sValueStateText,
-					bValid,
-					bHasErrorSet = false,
-					oMessagesModelData,
-					aResolvedValidations;
-
-				removeMessageFromControl(oControl, oMessagesModel);
-
-				if (!oItem || !oItem.validations) {
-					return;
-				}
-
-				aResolvedValidations = BindingResolver.resolveValue(oItem.validations, oControl, sBindingPath);
-
-				sInputType = _getInputType(oItem);
-				oValidator = Validators[sInputType];
-
-				aResolvedValidations.forEach(function (mValidationConfig) {
-
-					for (var sKey in mValidationConfig) {
-						if (bHasErrorSet) {
-							return;
-						}
-						oValidationValue = mValidationConfig[sKey];
-
-						if (sKey === "validate") {
-							var sValidationFunctionName = getExtensionFunctionName(oValidationValue, oExtension);
-
-							if (sValidationFunctionName) {
-								fnValidationFunc = oExtension[sValidationFunctionName];
-							}
-						} else {
-							fnValidationFunc = oValidator[sKey];
-						}
-
-						if (typeof fnValidationFunc !== "function") {
-							continue;
-						}
-
-						bValid = fnValidationFunc(oValue, oValidationValue);
-						if (!bValid) {
-							sValueState = mValidationConfig.type || ValueState.Error;
-							sValueStateText = mValidationConfig.message || oResourceBundle.getText(oValidator[sKey + "Txt"], oValidationValue);
-
-							oMessagesModelData = oMessagesModel.getData();
-							oMessagesModelData.records.push({
-								message: sValueStateText,
-								type: sValueState,
-								bindingPath: "/" + oItem.id
-							});
-							oMessagesModel.setData(oMessagesModelData);
-
-							if (bShowValueState || oControl._bShowValueState) {
-								oControl._bShowValueState = true;
-								oControl.setValueState(sValueState);
-								oControl.setValueStateText(sValueStateText);
-							}
-							bHasErrorSet = true;
-						}
-					}
-				});
-
-				updateMessageModel(oMessagesModel);
-			},
-			getRequiredValidationValue: function (oItem) {
-				var aValidations = oItem.validations || [],
-					oValidation,
-					i,
-					sKey;
-
-				for (i = 0; i < aValidations.length; i++) {
-					oValidation = aValidations[i];
-
-					for (sKey in oValidation) {
-						if (sKey === "required") {
-							return oValidation[sKey];
-						}
-					}
-				}
-
-				return false;
-			}
-		};
-
-		return Forms;
-	});