@openui5/sap.ui.integration 1.103.1 → 1.106.0

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

@@ -38,6 +38,8 @@ sap.ui.define([
 	"sap/m/IllustratedMessageType",
 	"sap/m/IllustratedMessageSize",
 	"sap/ui/integration/util/Utils",
+	"sap/ui/integration/util/ParameterMap",
+	"sap/ui/performance/Measurement",
 	"sap/m/HBox",
 	"sap/m/library"
 ], function (
@@ -75,6 +77,8 @@ sap.ui.define([
 	IllustratedMessageType,
 	IllustratedMessageSize,
 	Utils,
+	ParameterMap,
+	Measurement,
 	HBox,
 	mLibrary
 ) {
@@ -99,7 +103,7 @@ sap.ui.define([
 	/**
 	 * @const A list of model names which are used internally by the card.
 	 */
-	var RESERVED_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"];
 
@@ -119,6 +123,13 @@ sap.ui.define([
 
 	var MODULE_PREFIX = "module:";
 
+	function measurementStartTime() {
+		if (performance && performance.now) {
+			return "Start since page load: " + performance.now();
+		}
+
+		return "";
+	}
 
 	/**
 	 * Constructor for a new <code>Card</code>.
@@ -177,7 +188,7 @@ sap.ui.define([
 	 * @extends sap.f.CardBase
 	 *
 	 * @author SAP SE
-	 * @version 1.103.1
+	 * @version 1.106.0
 	 * @public
 	 * @constructor
 	 * @see {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
@@ -190,6 +201,16 @@ sap.ui.define([
 			library: "sap.ui.integration",
 			properties: {
 
+				/**
+				 * 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 : {
+					type: "string",
+					defaultValue: ""
+				},
+
 				/**
 				 * The URL of the manifest or an object.
 				 */
@@ -235,13 +256,32 @@ 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>
 				 * [
-				 *     {"content": {"header": {"title": "My title"}}},
-				 *     {"content": {"header": {"title": "My new title"}}}
+				 * 	{
+				 * 		// Administrator
+				 * 		"/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>
 				 *
@@ -428,21 +468,23 @@ sap.ui.define([
 	 * @private
 	 */
 	Card.prototype.init = function () {
-
 		CardBase.prototype.init.call(this);
 
 		this.setAggregation("_loadingProvider", new LoadingProvider());
 
+		this._oIntegrationRb = Core.getLibraryResourceBundle("sap.ui.integration");
+
 		this._initModels();
 
 		this._oContentFactory = new ContentFactory(this);
 		this._oCardObserver = new CardObserver(this);
 		this._bFirstRendering = true;
 		this._aFundamentalErrors = [];
+		this._sPerformanceId = "UI5 Integration Cards - " + this.getId() + "---";
+		this._fnOnDataReady = function () {
+			this._bDataReady = true;
+		}.bind(this);
 
-		if (this.getProperty("dataMode") === CardDataMode.Auto) {
-			this._oCardObserver.createObserver(this);
-		}
 		/**
 		 * Facade of the {@link sap.ui.integration.widgets.Card} control.
 		 * @interface
@@ -450,7 +492,7 @@ sap.ui.define([
 		 * @experimental since 1.79
 		 * @public
 		 * @author SAP SE
-		 * @version 1.103.1
+		 * @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
@@ -477,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",
@@ -504,7 +547,8 @@ sap.ui.define([
 			"hideLoadingPlaceholders",
 			"showCard",
 			"hide",
-			"getOpener"
+			"getOpener",
+			"validateControls"
 		]);
 	};
 
@@ -513,11 +557,38 @@ sap.ui.define([
 	 */
 	Card.prototype._initModels = function () {
 		this.setModel(new JSONModel());
-		this.setModel(new JSONModel(), "parameters");
-		this.setModel(new JSONModel(), "filters");
-		this.setModel(new JSONModel(), "paginator");
-		this.setModel(new JSONModel(), "form");
-		this.setModel(new ContextModel(), "context");
+
+		INTERNAL_MODEL_NAMES.forEach(function (sModelName) {
+			var oModel;
+
+			switch (sModelName) {
+				case "context":
+					oModel = new ContextModel();
+				break;
+				case "i18n":
+					oModel = new ResourceModel({
+						bundle: this._oIntegrationRb
+					});
+				break;
+				case "parameters":
+					oModel = new JSONModel(
+						ParameterMap.getParamsForModel()
+					);
+				break;
+				case "messages":
+					oModel = new JSONModel({
+						hasErrors: false,
+						hasWarnings: false,
+						records: []
+					});
+					break;
+				default:
+					oModel = new JSONModel();
+				break;
+			}
+
+			this.setModel(oModel, sModelName);
+		}.bind(this));
 	};
 
 	/**
@@ -542,15 +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("_dataReady", this._fnOnDataReady);
 	};
 
 	/**
@@ -560,7 +634,9 @@ sap.ui.define([
 	 */
 	Card.prototype._clearReadyState = function () {
 		this._bReady = false;
+		this._bDataReady = false;
 		this._aReadyPromises = [];
+		this.detachEvent("_dataReady", this._fnOnDataReady);
 	};
 
 	/**
@@ -581,6 +657,16 @@ sap.ui.define([
 	 * @private
 	 */
 	Card.prototype.onAfterRendering = function () {
+		if (Measurement.getActive() && this._isManifestReady) {
+			if (!Measurement.getMeasurement(this._sPerformanceId + "firstRenderingWithStaticData").end) {
+				Measurement.end(this._sPerformanceId + "firstRenderingWithStaticData");
+			}
+
+			if (this._bDataReady && !Measurement.getMeasurement(this._sPerformanceId + "firstRenderingWithDynamicData").end) {
+				Measurement.end(this._sPerformanceId + "firstRenderingWithDynamicData");
+			}
+		}
+
 		var oCardDomRef = this.getDomRef();
 
 		if (this.getDataMode() === CardDataMode.Auto && this._bFirstRendering) {
@@ -619,7 +705,6 @@ sap.ui.define([
 
 		if (!this._bApplyManifest && this._bApplyParameters) {
 			this._oCardManifest.processParameters(this._getContextAndRuntimeParams());
-
 			this._applyManifestSettings();
 		}
 
@@ -723,6 +808,10 @@ sap.ui.define([
 			this._oCardManifest.destroy();
 		}
 
+		Measurement.start(this._sPerformanceId + "initManifest", "Load and initialize manifest. " + measurementStartTime());
+		Measurement.start(this._sPerformanceId + "firstRenderingWithStaticData", "First rendering with static data (includes initManifest). " + measurementStartTime());
+		Measurement.start(this._sPerformanceId + "firstRenderingWithDynamicData","First rendering with dynamic card level data (includes firstRenderingWithStaticData). " + measurementStartTime());
+
 		this._oCardManifest = new CardManifest("sap.card", vManifest, sBaseUrl, this.getManifestChanges());
 
 		this._oCardManifest
@@ -732,6 +821,7 @@ sap.ui.define([
 					throw new Error(CARD_DESTROYED_ERROR);
 				}
 
+				Measurement.end(this._sPerformanceId + "initManifest");
 				this._registerManifestModulePath();
 				this._isManifestReady = true;
 				this.fireManifestReady();
@@ -740,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));
 	};
 
@@ -801,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.
 	 */
@@ -838,28 +944,9 @@ sap.ui.define([
 
 		oCardManifest.processParameters(oParameters);
 
-		this._prepareToApplyManifestSettings();
-
-		this._applyManifestSettings();
-	};
-
-	/**
-	 * Loads the messagebundle.properties for the integration library.
-	 * For performance only call this method when the translations will be needed.
-	 *
-	 * @private
-	 */
-	Card.prototype._loadDefaultTranslations = function () {
-		if (this._defaultTranslationsLoaded) {
-			return;
-		}
-
-		var oResourceBundle = Core.getLibraryResourceBundle("sap.ui.integration");
-
-		this._enhanceI18nModel(oResourceBundle);
-
-		this._defaultTranslationsLoaded = true;
-		this._oIntegrationRb = oResourceBundle;
+		this._prepareToApplyManifestSettings().then(function () {
+			this._applyManifestSettings();
+		}.bind(this));
 	};
 
 	/**
@@ -869,20 +956,20 @@ sap.ui.define([
 	 * @private
 	 */
 	Card.prototype._enhanceI18nModel = function (oResourceBundle) {
-		var oResourceModel = this.getModel("i18n");
-
-		if (oResourceModel) {
-			if (oResourceModel.getResourceBundle().oUrlInfo.url !== oResourceBundle.oUrlInfo.url) {
-				oResourceModel.enhance(oResourceBundle);
-			}
-			return;
-		}
-
-		oResourceModel = new ResourceModel({
-			bundle: oResourceBundle
+		var oResourceModel = this.getModel("i18n"),
+			oNewResourceModel;
+
+		// the library resource bundle must not be enhanced
+		// so the card resource bundle should be first
+		oNewResourceModel = new ResourceModel({
+			bundle: oResourceBundle,
+			enhanceWith: [
+				this._oIntegrationRb
+			]
 		});
 
-		this.setModel(oResourceModel, "i18n");
+		this.setModel(oNewResourceModel, "i18n");
+		oResourceModel.destroy();
 	};
 
 	/**
@@ -1057,6 +1144,7 @@ sap.ui.define([
 		this._oCardObserver = null;
 		this._oContentFactory = null;
 		this._bFirstRendering = null;
+		this._oIntegrationRb = null;
 
 		if (this._oActionsToolbar) {
 			this._oActionsToolbar.destroy();
@@ -1110,8 +1198,6 @@ sap.ui.define([
 		this.getModel("parameters").setData({});
 		this.getModel("paginator").setData({});
 
-		this.setModel(null, "i18n");
-
 		this._oContextParameters = null;
 
 		this._deregisterCustomModels();
@@ -1259,6 +1345,17 @@ sap.ui.define([
 		return this._oDestinations.getUrl(sKey);
 	};
 
+	/**
+	 * Resolves the destinations and returns a Promise with the resolved configuration.
+	 * @private
+	 * @ui5-restricted
+	 * @param {object} oConfig The configuration.
+	 * @returns {Promise} A promise which resolves with the resolved configuration.
+	 */
+	Card.prototype.processDestinations = function (oConfig) {
+		return this._oDestinations.process(oConfig);
+	};
+
 	/**
 	 * Displays a message strip above the content with the given text.
 	 * There can be only 1 message displayed. If there is a previous message, it is removed.
@@ -1269,7 +1366,7 @@ sap.ui.define([
 	 * @param {string} sMessage The message.
 	 * @param {sap.ui.core.MessageType} sType Type of the message.
 	 */
-	 Card.prototype.showMessage = function (sMessage, sType) {
+	Card.prototype.showMessage = function (sMessage, sType) {
 		if (this._createContentPromise) {
 			this._createContentPromise.then(function (oContent) {
 				oContent.showMessage(sMessage, sType);
@@ -1376,25 +1473,31 @@ sap.ui.define([
 			this._oDataProviderFactory.destroy();
 		}
 
-		this._oDestinations = new Destinations(this.getHostInstance(), this._oCardManifest.get(MANIFEST_PATHS.DESTINATIONS));
+		this._oDestinations = new Destinations({
+			host: this.getHostInstance(),
+			card: this,
+			manifestConfig: this._oCardManifest.get(MANIFEST_PATHS.DESTINATIONS)
+		});
 		this._oIconFormatter = new IconFormatter({
-			destinations: this._oDestinations,
 			card: this
 		});
 
-		this._oDataProviderFactory = new DataProviderFactory({
-			host: this.getHostInstance(),
-			destinations: this._oDestinations,
-			extension: oExtension,
-			csrfTokensConfig: this._oCardManifest.get(MANIFEST_PATHS.CSRF_TOKENS),
-			card: this
-		});
+		return this.processDestinations(this._oCardManifest.getJson()).then(function (oResult) {
+			this._oCardManifest.setJson(oResult);
 
-		this._registerCustomModels();
+			this._oDataProviderFactory = new DataProviderFactory({
+				host: this.getHostInstance(),
+				extension: oExtension,
+				csrfTokensConfig: this._oCardManifest.get(MANIFEST_PATHS.CSRF_TOKENS),
+				card: this
+			});
 
-		if (oExtension) {
-			oExtension.onCardReady();
-		}
+			this._registerCustomModels();
+
+			if (oExtension) {
+				oExtension.onCardReady();
+			}
+		}.bind(this));
 	};
 
 	/**
@@ -1415,7 +1518,6 @@ sap.ui.define([
 		this._applyFooterManifestSettings();
 
 		this.fireManifestApplied();
-
 	};
 
 	/**
@@ -1427,7 +1529,8 @@ sap.ui.define([
 
 	Card.prototype._setParametersModelData = function () {
 
-		var oCustomParameters = {},
+		var oPredefinedParameters = ParameterMap.getParamsForModel(),
+			oCustomParameters = {},
 			oCombinedParameters = this.getCombinedParameters(),
 			sKey;
 
@@ -1438,7 +1541,7 @@ sap.ui.define([
 				oCustomParameters[sKey] = {value: oCombinedParameters[sKey]};
 			}
 		}
-		this.getModel("parameters").setData(oCustomParameters);
+		this.getModel("parameters").setData(merge(oPredefinedParameters, oCustomParameters));
 	};
 
 	Card.prototype._applyDataManifestSettings = function () {
@@ -1446,11 +1549,12 @@ sap.ui.define([
 			oModel;
 
 		if (!oDataSettings) {
-			this.fireEvent("_cardReady");
+			this.fireEvent("_dataReady");
+			this.fireEvent("_dataPassedToContent");
 			return;
 		}
 
-		this.bindObject(oDataSettings.path || "/");
+		this.bindObject(BindingResolver.resolveValue(oDataSettings.path || "/", this));
 
 		if (this._oDataProvider) {
 			this._oDataProvider.destroy();
@@ -1468,7 +1572,8 @@ sap.ui.define([
 		}
 
 		if (!oModel) {
-			this.fireEvent("_cardReady");
+			this.fireEvent("_dataReady");
+			this.fireEvent("_dataPassedToContent");
 			return;
 		}
 
@@ -1483,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();
 			}
 
@@ -1497,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");
 		}
 	};
 
@@ -1857,7 +1968,6 @@ sap.ui.define([
 	 * @private
 	 */
 	Card.prototype._handleError = function (sLogMessage, bNoItems) {
-		this._loadDefaultTranslations();
 		if (!bNoItems) {
 			Log.error(sLogMessage, null, "sap.ui.integration.widgets.Card");
 		}
@@ -1909,6 +2019,11 @@ sap.ui.define([
 				case "Analytical":
 					sIllustratedMessageType = IllustratedMessageType.NoEntries;
 					sTitle = this._oIntegrationRb.getText("CARD_NO_ITEMS_ERROR_CHART");
+					break;
+				case "Object":
+					sIllustratedMessageType = IllustratedMessageType.NoData;
+					sTitle = this._oIntegrationRb.getText("CARD_NO_ITEMS_ERROR_CHART");
+					break;
 			}
 		}
 
@@ -1948,7 +2063,7 @@ sap.ui.define([
 	 * @private
 	 */
 	Card.prototype._handleNoDataItems = function (oCardContent, oError, bNoItems) {
-		if (bNoItems && this._oCardManifest.get(MANIFEST_PATHS.TYPE) === "List") {
+		if (bNoItems) {
 			oError._oCardOriginalContent = oCardContent;
 		}
 	};
@@ -2201,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);
 
@@ -2232,10 +2346,12 @@ sap.ui.define([
 	 * @returns {Promise} Resolves when the request is successful, rejects otherwise.
 	 */
 	Card.prototype.request = function (oConfiguration) {
-		return this._oDataProviderFactory
-			.create({ request: oConfiguration })
-			.setAllowCustomDataType(true)
-			.getData();
+		return this.processDestinations(oConfiguration).then(function (oResult) {
+			return this._oDataProviderFactory
+				.create({ request: oResult })
+				.setAllowCustomDataType(true)
+				.getData();
+		}.bind(this));
 	};
 
 	/**
@@ -2332,7 +2448,7 @@ sap.ui.define([
 				return;
 			}
 
-			if (RESERVED_MODEL_NAMES.indexOf(sModelName) > -1) {
+			if (INTERNAL_MODEL_NAMES.indexOf(sModelName) > -1) {
 				Log.error("The model name (data section name) '" + sModelName + "' is reserved for cards. Can not be used for creating a custom model.");
 				return;
 			}
@@ -2398,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;
 		}
@@ -2489,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>