@openui5/sap.ui.integration 1.112.2 → 1.114.0

package/src/sap/ui/integration/cards/BaseContent.js

@@ -9,10 +9,13 @@ sap.ui.define([
 	"sap/m/MessageStrip",
 	"sap/m/VBox",
 	"sap/m/library",
+	"sap/m/IllustratedMessageType",
+	"sap/m/IllustratedMessageSize",
 	"sap/ui/core/Core",
 	"sap/ui/core/Control",
 	"sap/ui/core/InvisibleMessage",
 	"sap/ui/core/library",
+	"sap/ui/integration/controls/BlockingMessage",
 	"sap/ui/integration/model/ObservableModel",
 	"sap/ui/base/ManagedObjectObserver",
 	"sap/ui/integration/util/LoadingProvider",
@@ -25,10 +28,13 @@ sap.ui.define([
 	MessageStrip,
 	VBox,
 	mLibrary,
+	IllustratedMessageType,
+	IllustratedMessageSize,
 	Core,
 	Control,
 	InvisibleMessage,
 	coreLibrary,
+	BlockingMessage,
 	ObservableModel,
 	ManagedObjectObserver,
 	LoadingProvider,
@@ -42,8 +48,10 @@ sap.ui.define([
 	// shortcut for sap.ui.core.InvisibleMessageMode
 	var InvisibleMessageMode = coreLibrary.InvisibleMessageMode;
 
-	// shortcut for sap.ui.integration.widgets.CardDesign
+	// shortcut for sap.ui.integration.CardDesign
 	var CardDesign = library.CardDesign;
+	// shortcut for sap.ui.integration.CardBlockingMessageType
+	var CardBlockingMessageType = library.CardBlockingMessageType;
 
 	/**
 	 * Constructor for a new <code>BaseContent</code>.
@@ -57,7 +65,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 * @constructor
 	 * @private
@@ -77,6 +85,20 @@ sap.ui.define([
 					type: "sap.ui.integration.CardDesign",
 					group: "Appearance",
 					defaultValue: CardDesign.Solid
+				},
+
+				/**
+				 * Content configuration from the manifest
+				 */
+				configuration: {
+					type: "object"
+				},
+
+				/**
+				 * No data configuration from the manifest
+				 */
+				noDataConfiguration: {
+					type: "object"
 				}
 			},
 			aggregations: {
@@ -111,6 +133,12 @@ sap.ui.define([
 					type: "sap.m.VBox",
 					multiple: false,
 					visibility: "hidden"
+				},
+
+				_blockingMessage: {
+					type: "sap.ui.integration.controls.BlockingMessage",
+					multiple: false,
+					visibility: "hidden"
 				}
 			},
 			associations: {
@@ -212,6 +240,13 @@ sap.ui.define([
 		return Promise.resolve();
 	};
 
+	/**
+	 * Called after the dependencies are loaded and it's safe to apply the configuration.
+	 * To be implemented by subclasses.
+	 * @abstract
+	 */
+	BaseContent.prototype.applyConfiguration = function () { };
+
 	BaseContent.prototype.setLoadDependenciesPromise = function (oPromise) {
 		this._pLoadDependencies = oPromise;
 		this.awaitEvent("_loadDependencies");
@@ -248,7 +283,7 @@ sap.ui.define([
 
 		this._bReady = false;
 		this._oAwaitedEvents.add(sEvent);
-		this.showLoadingPlaceholders();
+		this.showLoadingPlaceholders(true);
 		this.attachEventOnce(sEvent, function () {
 			this._oAwaitedEvents.delete(sEvent);
 
@@ -260,23 +295,10 @@ sap.ui.define([
 		}.bind(this));
 	};
 
-	/**
-	 * @public
-	 * @param {object} oConfiguration Content configuration from the manifest
-	 * @returns {this} Pointer to the control instance to allow method chaining
-	 */
-	BaseContent.prototype.setConfiguration = function (oConfiguration) {
-		this._oConfiguration = oConfiguration;
-
-		if (!oConfiguration) {
-			return this;
-		}
-
-		return this;
-	};
-
-	BaseContent.prototype.getConfiguration = function () {
-		return this._oConfiguration;
+	BaseContent.prototype._forceCompleteAwaitedEvents = function () {
+		this._oAwaitedEvents.forEach(function (sEvent) {
+			this.fireEvent(sEvent);
+		}.bind(this));
 	};
 
 	/**
@@ -286,7 +308,7 @@ sap.ui.define([
 	 * @returns {object} Parsed configuration - with binding infos
 	 */
 	BaseContent.prototype.getParsedConfiguration = function () {
-		var oResult = merge({}, this._oConfiguration),
+		var oResult = merge({}, this.getConfiguration()),
 			oDataSettings = oResult.data;
 
 		// do not create binding info for data
@@ -339,6 +361,60 @@ sap.ui.define([
 		}
 	};
 
+	BaseContent.prototype.showBlockingMessage = function (mSettings) {
+		this.destroyAggregation("_blockingMessage");
+		this.setAggregation("_blockingMessage", BlockingMessage.create(mSettings, this.getCardInstance()));
+		this._forceCompleteAwaitedEvents();
+	};
+
+	BaseContent.prototype.hideBlockingMessage = function () {
+		this.destroyAggregation("_blockingMessage");
+	};
+
+	BaseContent.prototype.getBlockingMessage = function () {
+		var oBlockingMessage = this.getAggregation("_blockingMessage");
+
+		if (oBlockingMessage) {
+			return {
+				type: oBlockingMessage.getType(),
+				illustrationType: oBlockingMessage.getIllustrationType(),
+				illustrationSize: oBlockingMessage.getIllustrationSize(),
+				title: oBlockingMessage.getTitle(),
+				description: oBlockingMessage.getDescription(),
+				httpResponse: oBlockingMessage.getHttpResponse()
+			};
+		}
+
+		return null;
+	};
+
+	/**
+	 * Show 'No Data' blocking message in the content. If there is configuration in the manifest, it will be applied.
+	 * @protected
+	 * @param {object} oSettings 'No Data' settings
+	 * @param {sap.m.IllustratedMessageType} oSettings.illustrationType Illustration type
+	 * @param {sap.m.IllustratedMessageSize} [oSettings.illustrationSize=sap.m.IllustratedMessageSize.Auto] Illustration size
+	 * @param {string} oSettings.title Title
+	 * @param {string} [oSettings.description] Description
+	 */
+	BaseContent.prototype.showNoDataMessage = function (oSettings) {
+		var oNoDataConfiguration = this.getNoDataConfiguration() || {};
+
+		var oMessageSettings = {
+			type: CardBlockingMessageType.NoData,
+			illustrationType: IllustratedMessageType[oNoDataConfiguration.type] || oSettings.illustrationType,
+			illustrationSize: IllustratedMessageSize[oNoDataConfiguration.size] || oSettings.illustrationSize,
+			title: oNoDataConfiguration.title || oSettings.title,
+			description: oNoDataConfiguration.description || oSettings.description
+		};
+
+		this.showBlockingMessage(oMessageSettings);
+	};
+
+	BaseContent.prototype.hideNoDataMessage = function () {
+		this.hideBlockingMessage();
+	};
+
 	/**
 	 * Requests data and bind it to the item template.
 	 *
@@ -364,7 +440,6 @@ sap.ui.define([
 		}
 
 		this._oDataProvider = this._oDataProviderFactory.create(oDataSettings, this._oServiceManager);
-		this.getAggregation("_loadingProvider").setDataProvider(this._oDataProvider);
 
 		if (oDataSettings.name) {
 			oModel = oCard.getModel(oDataSettings.name);
@@ -404,7 +479,10 @@ sap.ui.define([
 			}.bind(this));
 
 			this._oDataProvider.attachError(function (oEvent) {
-				this.handleError(oEvent.getParameter("message"));
+				this.handleError({
+					requestErrorParams: oEvent.getParameters(),
+					requestSettings: this._oDataProvider.getSettings()
+				});
 				this.onDataRequestComplete();
 			}.bind(this));
 
@@ -445,16 +523,17 @@ sap.ui.define([
 
 	/**
 	 * @private
+	 * @param {boolean} [bForce] Show the loading placeholders regardless of the data provider type
 	 * @ui5-restricted
 	 */
-	BaseContent.prototype.showLoadingPlaceholders = function () {
-		var oLoadingProvider = this.getAggregation("_loadingProvider"),
-			oCard = this.getCardInstance();
-
-		if (!oLoadingProvider) {
+	BaseContent.prototype.showLoadingPlaceholders = function (bForce) {
+		if (!bForce && this._isDataProviderJson()) {
 			return;
 		}
 
+		var oLoadingProvider = this.getAggregation("_loadingProvider"),
+			oCard = this.getCardInstance();
+
 		oLoadingProvider.setLoading(true);
 
 		if (oCard) {
@@ -470,7 +549,7 @@ sap.ui.define([
 		var oLoadingProvider = this.getAggregation("_loadingProvider"),
 			oCard = this.getCardInstance();
 
-		if (!oLoadingProvider || !oLoadingProvider.getLoading()) {
+		if (!oLoadingProvider.getLoading()) {
 			return;
 		}
 
@@ -589,14 +668,12 @@ sap.ui.define([
 		return this._bReady;
 	};
 
-	/**
-	 * @protected
-	 * @param {string} sLogMessage Message that will be logged.
-	 */
-	BaseContent.prototype.handleError = function (sLogMessage) {
-		this.fireEvent("_error", {
-			logMessage: sLogMessage
-		});
+	/*
+	* @protected
+	@ param {object} mErrorInfo The error information object.
+	*/
+	BaseContent.prototype.handleError = function (mErrorInfo) {
+		this.fireEvent("_error", { errorInfo: mErrorInfo });
 	};
 
 	BaseContent.prototype.setServiceManager = function (oServiceManager) {
@@ -614,11 +691,18 @@ sap.ui.define([
 		return this;
 	};
 
-	BaseContent.prototype.isLoading = function () {
-		var oLoadingProvider = this.getAggregation("_loadingProvider"),
-			oCard = this.getCardInstance();
+	BaseContent.prototype.isLoading  = function () {
+		if (!this.isReady()) {
+			return true;
+		}
+
+		if (this._oDataProvider) {
+			return this.getAggregation("_loadingProvider").getLoading();
+		}
 
-		return !oLoadingProvider.isDataProviderJson() && (oLoadingProvider.getLoading() || (oCard && oCard.isLoading()));
+		var oCard = this.getCardInstance();
+
+		return oCard && oCard.isLoading();
 	};
 
 	BaseContent.prototype.attachPress = function () {
@@ -701,5 +785,23 @@ sap.ui.define([
 		return oMessageContainer;
 	};
 
+	BaseContent.prototype._isDataProviderJson = function () {
+		return this._oDataProvider && this._oDataProvider.getSettings() && this._oDataProvider.getSettings()["json"];
+	};
+
+	/*
+	 * @private
+	 * @ui5-restricted sap.ui.integration
+	 */
+	BaseContent.prototype.getHeaderTitleId = function () {
+		var oCard = this.getCardInstance();
+
+		if (!oCard) {
+			return undefined;
+		}
+
+		return oCard.getId() + "-header-title-inner";
+	};
+
 	return BaseContent;
 });

package/src/sap/ui/integration/cards/BaseContentRenderer.js

@@ -40,7 +40,8 @@ sap.ui.define([
 			oCard = oCardContent.getCardInstance(),
 			bLoading = oCardContent.isLoading(),
 			bIsAbstractPreviewMode =  oCard && oCard.getPreviewMode() === CardPreviewMode.Abstract,
-			oMessageContainer = oCardContent.getAggregation("_messageContainer");
+			oMessageContainer = oCardContent.getAggregation("_messageContainer"),
+			oBlockingMessage = oCardContent.getAggregation("_blockingMessage");
 
 		sClass += sType;
 
@@ -71,7 +72,11 @@ sap.ui.define([
 			oRm.renderControl(oMessageContainer);
 		}
 
-		this.renderContent(oRm, oCardContent);
+		if (oBlockingMessage) {
+			oRm.renderControl(oBlockingMessage);
+		} else {
+			this.renderContent(oRm, oCardContent);
+		}
 
 		oRm.close("div");
 	};

package/src/sap/ui/integration/cards/BaseListContent.js

@@ -7,12 +7,14 @@
 sap.ui.define([
 	"sap/ui/integration/cards/BaseContent",
 	"sap/ui/integration/util/BindingResolver",
+	"sap/m/IllustratedMessageType",
 	"sap/ui/integration/library",
 	"sap/base/Log",
 	"sap/ui/model/Sorter"
 ], function (
 	BaseContent,
 	BindingResolver,
+	IllustratedMessageType,
 	library,
 	Log,
 	Sorter
@@ -31,7 +33,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.cards.BaseContent
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 * @constructor
 	 * @private
@@ -74,6 +76,17 @@ sap.ui.define([
 		this._bIsFirstRendering = false;
 	};
 
+	BaseListContent.prototype.onDataChanged = function () {
+		if (this.hasData()) {
+			this.hideNoDataMessage();
+		} else {
+			this.showNoDataMessage({
+				illustrationType: IllustratedMessageType.NoEntries,
+				title: this.getCardInstance().getTranslatedText("CARD_NO_ITEMS_ERROR_LISTS")
+			});
+		}
+	};
+
 	BaseListContent.prototype._keepHeight = function () {
 		if (!this.getDomRef()) {
 			return;
@@ -115,12 +128,11 @@ sap.ui.define([
 	/**
 	 * @override
 	 */
-	BaseListContent.prototype.setConfiguration = function (oConfiguration) {
-		BaseContent.prototype.setConfiguration.apply(this, arguments);
-		oConfiguration = this.getConfiguration();
+	BaseListContent.prototype.applyConfiguration = function () {
+		var oConfiguration = this.getConfiguration();
 
 		if (!oConfiguration) {
-			return this;
+			return;
 		}
 
 		var oList = this.getInnerList(),
@@ -140,8 +152,6 @@ sap.ui.define([
 		}
 
 		this._fMinHeight = 0;
-
-		return this;
 	};
 
 	/**
@@ -229,27 +239,18 @@ sap.ui.define([
 			}.bind(this));
 	};
 
-	/**
-	 * Used to show the illustrated message for no data retrieved from server.
-	 *
-	 * @protected
-	 * @param {Object} mItemConfig The item template.
-	 */
-	BaseListContent.prototype._handleNoItemsError = function (mItemConfig) {
-
-		if (!this.getInnerList()) {
-			return;
-		}
-
+	BaseListContent.prototype.hasData = function () {
 		var oInnerList = this.getInnerList(),
 			oBindingInfo = oInnerList.getBinding(oInnerList.getMetadata().getDefaultAggregationName()),
 			oModel = oBindingInfo.getModel(),
 			sPath = oBindingInfo.getPath(),
 			aItems = oModel.getProperty(sPath);
 
-		if (aItems && aItems.length === 0){
-			this.getParent()._handleError("No items available", true);
+		if (aItems && aItems.length) {
+			return true;
 		}
+
+		return false;
 	};
 
 	/**

package/src/sap/ui/integration/cards/CalendarContent.js

@@ -73,7 +73,7 @@ sap.ui.define([
 		 * @extends sap.ui.integration.cards.BaseContent
 		 *
 		 * @author SAP SE
-		 * @version 1.112.2
+		 * @version 1.114.0
 		 *
 		 * @constructor
 		 * @private
@@ -226,21 +226,16 @@ sap.ui.define([
 		};
 
 		/**
-		 * Setter for configuring a <code>sap.ui.integration.cards.CalendarContent</code>.
-		 *
-		 * @public
-		 * @param {Object} oConfiguration Configuration object used to create the internal calendar.
-		 * @returns {this} Pointer to the control instance to allow method chaining.
+		 * @override
 		 */
-		CalendarContent.prototype.setConfiguration = function (oConfiguration) {
-			BaseContent.prototype.setConfiguration.apply(this, arguments);
-			oConfiguration = this.getParsedConfiguration();
+		CalendarContent.prototype.applyConfiguration = function () {
+			var oConfiguration = this.getParsedConfiguration();
 
 			//workaround until actions refactor
 			this.fireEvent("_actionContentReady"); // todo
 
 			if (!oConfiguration) {
-				return this;
+				return;
 			}
 
 			if (oConfiguration.item) {
@@ -278,8 +273,6 @@ sap.ui.define([
 					control: this._getMoreButton()
 				});
 			}
-
-			return this;
 		};
 
 		/**

package/src/sap/ui/integration/cards/ComponentContent.js

@@ -8,12 +8,14 @@ sap.ui.define([
 	"./BaseContent",
 	"./ComponentContentRenderer",
 	"sap/ui/integration/library",
+	"sap/m/IllustratedMessageType",
 	"sap/ui/core/ComponentContainer",
 	"sap/ui/core/Component"
 ], function (
 	BaseContent,
 	ComponentContentRenderer,
 	library,
+	IllustratedMessageType,
 	ComponentContainer,
 	Component
 ) {
@@ -33,7 +35,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.cards.BaseContent
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 * @experimental
 	 * @constructor
@@ -58,9 +60,8 @@ sap.ui.define([
 		}
 	};
 
-	ComponentContent.prototype.setConfiguration = function (oConfiguration) {
-		BaseContent.prototype.setConfiguration.apply(this, arguments);
-		oConfiguration = this.getParsedConfiguration();
+	ComponentContent.prototype.applyConfiguration = function () {
+		var oConfiguration = this.getParsedConfiguration();
 
 		if (!oConfiguration) {
 			return;
@@ -86,8 +87,14 @@ sap.ui.define([
 				this.fireEvent("_updated");
 			}.bind(this),
 			componentFailed: function () {
+				var oCard = this.getCardInstance();
+
 				this.fireEvent("_actionContentReady");
-				this.handleError("Card content failed to create component");
+				this.handleError({
+					illustrationType: IllustratedMessageType.ErrorScreen,
+					title: oCard.getTranslatedText("CARD_DATA_LOAD_ERROR"),
+					description: "Card content failed to create component"
+				});
 			}.bind(this)
 		});
 

package/src/sap/ui/integration/cards/Footer.js

@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 * @constructor
 	 * @ui5-restricted

package/src/sap/ui/integration/cards/Header.js

@@ -42,7 +42,7 @@ sap.ui.define([
 	 * @extends sap.f.cards.Header
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 * @constructor
 	 * @private
@@ -51,7 +51,7 @@ sap.ui.define([
 	 */
 	var Header = FHeader.extend("sap.ui.integration.cards.Header", {
 
-		constructor: function (mConfiguration, oActionsToolbar, oIconFormatter) {
+		constructor: function (sId, mConfiguration, oActionsToolbar, oIconFormatter) {
 
 			mConfiguration = mConfiguration || {};
 
@@ -88,7 +88,7 @@ sap.ui.define([
 
 			mSettings.toolbar = oActionsToolbar;
 
-			FHeader.call(this, mSettings);
+			FHeader.call(this, sId, mSettings);
 
 			this._oConfiguration = mConfiguration;
 		},
@@ -166,15 +166,21 @@ sap.ui.define([
 	};
 
 	Header.prototype.isLoading = function () {
-		var oLoadingProvider = this.getAggregation("_loadingProvider"),
-			oCard = this.getCardInstance(),
-			bCardLoading = oCard && oCard.isA("sap.ui.integration.widgets.Card") ? oCard.isLoading() : false;
+		if (!this.isReady()) {
+			return true;
+		}
+
+		if (this._oDataProvider) {
+			return this.getAggregation("_loadingProvider").getLoading();
+		}
+
+		var oCard = this.getCardInstance();
 
-		return !oLoadingProvider.isDataProviderJson() && (oLoadingProvider.getLoading() || bCardLoading);
+		return oCard && oCard.isLoading();
 	};
 
-	Header.prototype._handleError = function (sLogMessage) {
-		this.fireEvent("_error", { logMessage: sLogMessage });
+	Header.prototype._handleError = function (mErrorInfo) {
+		this.fireEvent("_error", { errorInfo: mErrorInfo });
 	};
 
 	/**
@@ -243,8 +249,6 @@ sap.ui.define([
 
 		this._oDataProvider = this._oDataProviderFactory.create(oDataSettings, this._oServiceManager);
 
-		this.getAggregation("_loadingProvider").setDataProvider(this._oDataProvider);
-
 		if (oDataSettings && oDataSettings.name) {
 			oModel = oCard.getModel(oDataSettings.name);
 		} else if (this._oDataProvider) {
@@ -263,7 +267,10 @@ sap.ui.define([
 			}.bind(this));
 
 			this._oDataProvider.attachError(function (oEvent) {
-				this._handleError(oEvent.getParameter("message"));
+				this._handleError({
+					requestErrorParams: oEvent.getParameters(),
+					requestSettings: this._oDataProvider.getSettings()
+				});
 				this.onDataRequestComplete();
 			}.bind(this));
 
@@ -284,7 +291,9 @@ sap.ui.define([
 	 * @ui5-restricted
 	 */
 	Header.prototype.showLoadingPlaceholders = function () {
-		this.getAggregation("_loadingProvider").setLoading(true);
+		if (!this._isDataProviderJson()) {
+			this.getAggregation("_loadingProvider").setLoading(true);
+		}
 	};
 
 	/**
@@ -315,5 +324,9 @@ sap.ui.define([
 		return Core.byId(this.getCard());
 	};
 
+	Header.prototype._isDataProviderJson = function () {
+		return this._oDataProvider && this._oDataProvider.getSettings() && this._oDataProvider.getSettings()["json"];
+	};
+
 	return Header;
 });