@openui5/sap.ui.integration 1.120.7 → 1.121.0

package/src/sap/ui/integration/cards/filters/BaseFilter.js

@@ -5,22 +5,24 @@
  */
 sap.ui.define([
 	"sap/ui/core/Control",
-	"sap/ui/core/Core",
+	"sap/ui/core/Element",
 	"sap/ui/core/InvisibleText",
 	"sap/base/Log",
 	"sap/ui/core/Icon",
 	"sap/m/HBox",
 	"sap/m/Text",
+	"sap/ui/core/Lib",
 	"sap/ui/integration/model/ObservableModel",
 	"sap/ui/integration/util/LoadingProvider"
-], function (
+], function(
 	Control,
-	Core,
+	Element,
 	InvisibleText,
 	Log,
 	Icon,
 	HBox,
 	Text,
+	Library,
 	ObservableModel,
 	LoadingProvider
 ) {
@@ -37,7 +39,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.120.7
+	 * @version 1.121.0
 	 *
 	 * @constructor
 	 * @private
@@ -73,7 +75,9 @@ sap.ui.define([
 				/**
 				 * The hidden label for this control
 				 */
-				_label: { type: "sap.ui.core.InvisibleText", multiple: false, visibility: "hidden" }
+				_label: { type: "sap.ui.core.InvisibleText", multiple: false, visibility: "hidden" },
+
+				_error: { type: "sap.m.HBox", multiple: false, visibility: "hidden" }
 			},
 			associations: {
 
@@ -81,24 +85,32 @@ sap.ui.define([
 				 * Association with the parent Card that contains this filter.
 				 */
 				card: { type: "sap.ui.integration.widgets.Card", multiple: false }
+			},
+			events: {
+				change: {
+					parameters: {
+						key: { type: "string"},
+						value: { type: "string"}
+					}
+				}
 			}
 
 		},
 		renderer: {
 			apiVersion: 2,
 			render: function (oRM, oFilter) {
-				var bLoading = oFilter.isLoading();
+				const oError = oFilter.getAggregation("_error");
 
 				oRM.openStart("div", oFilter).class("sapFCardFilter");
 
-				if (bLoading) {
+				if (oFilter.isLoading()) {
 					oRM.class("sapFCardFilterLoading");
 				}
 
 				oRM.openEnd();
 
-				if (oFilter._hasError()) {
-					oRM.renderControl(oFilter._getErrorMessage());
+				if (oError) {
+					oRM.renderControl(oError);
 				} else {
 					oRM.renderControl(oFilter.getField());
 				}
@@ -185,31 +197,26 @@ sap.ui.define([
 	 * @returns {sap.ui.integration.widgets.Card} The card instance.
 	 */
 	BaseFilter.prototype.getCardInstance = function () {
-		return Core.byId(this.getCard());
-	};
-
-	BaseFilter.prototype._hasError = function () {
-		return !!this._bError;
+		return Element.getElementById(this.getCard());
 	};
 
-	BaseFilter.prototype._getErrorMessage = function () {
-		var sMessage = Core.getLibraryResourceBundle("sap.ui.integration").getText("CARD_FILTER_DATA_LOAD_ERROR");
+	BaseFilter.prototype._showError = function () {
+		var sMessage = Library.getResourceBundleFor("sap.ui.integration").getText("CARD_FILTER_DATA_LOAD_ERROR");
 
-		return new HBox({
+		this.destroyAggregation("_error");
+		this.setAggregation("_error", new HBox({
 			justifyContent: "Center",
 			alignItems: "Center",
 			items: [
 				new Icon({ src: "sap-icon://message-error", size: "1rem" }).addStyleClass("sapUiTinyMargin"),
 				new Text({ text: sMessage })
 			]
-		});
+		}));
 	};
 
 	BaseFilter.prototype._handleError = function (sLogMessage) {
 		Log.error(sLogMessage);
-
-		this._bError = true;
-		this.invalidate();
+		this._showError();
 	};
 
 	BaseFilter.prototype._onDataRequestComplete = function () {
@@ -276,19 +283,13 @@ sap.ui.define([
 	};
 
 	BaseFilter.prototype._syncValue = function () {
-		var oValueForModel = this.getValueForModel(),
-			oCard = this.getCardInstance(),
-			mParams = {},
-			sManifestKey;
+		const oValueForModel = this.getValueForModel();
 
 		this.setValue(oValueForModel);
-
-		if (oCard) {
-			sManifestKey = "/sap.card/configuration/filters/" + this.getKey() + "/value";
-			mParams[sManifestKey] = oValueForModel.value;
-			oCard._fireConfigurationChange(mParams);
-			oCard.resetPaginator();
-		}
+		this.fireChange({
+			key: this.getKey(),
+			value: oValueForModel.value
+		});
 	};
 
 	BaseFilter.prototype._isDataProviderJson = function () {

package/src/sap/ui/integration/cards/filters/ComboBoxFilter.js

@@ -0,0 +1,254 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"./BaseFilter",
+	"sap/m/ComboBox",
+	"sap/ui/core/ListItem",
+	"sap/ui/model/json/JSONModel",
+	"sap/ui/integration/util/BindingResolver",
+	"sap/ui/integration/util/ComboBoxHelper",
+	"sap/base/util/merge"
+], function (
+	BaseFilter,
+	ComboBox,
+	ListItem,
+	JSONModel,
+	BindingResolver,
+	ComboBoxHelper,
+	merge
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new <code>ComboBoxFilter</code>.
+	 *
+	 * @param {string} [sId] ID for the new control, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new control
+	 *
+	 * @class
+	 *
+	 * @extends sap.ui.integration.cards.filters.BaseFilter
+	 *
+	 * @author SAP SE
+	 * @version 1.121.0
+	 *
+	 * @constructor
+	 * @private
+	 * @since 1.121
+	 * @alias sap.ui.integration.cards.filters.ComboBoxFilter
+	 */
+	const ComboBoxFilter = BaseFilter.extend("sap.ui.integration.cards.filters.ComboBoxFilter", {
+		metadata: {
+			library: "sap.ui.integration",
+			aggregations: {
+				/**
+				 * The internally used sap.m.ComboBox control instance.
+				 */
+				_comboBox: {
+					type: "sap.m.ComboBox",
+					multiple: false,
+					visibility: "hidden"
+				}
+			}
+		},
+		renderer: {
+			apiVersion: 2
+		}
+	});
+
+	ComboBoxFilter.prototype.exit = function () {
+		BaseFilter.prototype.exit.apply(this, arguments);
+
+		if (this._oItemTemplate) {
+			this._oItemTemplate.destroy();
+		}
+	};
+
+	/**
+	 * @override
+	 */
+	ComboBoxFilter.prototype.getField = function () {
+		return this._getComboBox();
+	};
+
+	/**
+	 * @override
+	 */
+	ComboBoxFilter.prototype.onDataChanged = function () {
+		const oComboBox = this._getComboBox();
+
+		ComboBoxHelper.setValueAndKey(
+			oComboBox,
+			oComboBox.getSelectedKey(),
+			oComboBox.getValue()
+		);
+
+		this._syncValue();
+	};
+
+	/**
+	 * @override
+	 */
+	ComboBoxFilter.prototype.getValueForModel = function () {
+		const oSelectedItem = this._getComboBox().getSelectedItem();
+
+		if (oSelectedItem) {
+			return {
+				value: this._getComboBox().getValue(),
+				selectedItem: {
+					title: oSelectedItem.getText(),
+					key: oSelectedItem.getKey(),
+					additionalText: oSelectedItem.getAdditionalText()
+				}
+			};
+		}
+
+		return {
+			value: this._getComboBox().getValue()
+		};
+	};
+
+	/**
+	 * @override
+	 * @param {Object} oValue The new value for the filter.
+	 * @param {string} oValue.value The value of the Combo Box.
+	 * @param {string} oValue.selectedKey If selectedKey is given - this will be used for selectedKey of the ComboBox and "value" will be ignored.
+	 */
+	ComboBoxFilter.prototype.setValueFromOutside = function (oValue) {
+		const oResolvedValue = BindingResolver.resolveValue(oValue, this.getCardInstance());
+
+		ComboBoxHelper.setValueAndKey(this._getComboBox(), oResolvedValue?.selectedKey, oResolvedValue?.value);
+
+		this._syncValue();
+	};
+
+	/**
+	 * @returns {object} Filter configuration with static items
+	 */
+	ComboBoxFilter.prototype.getStaticConfiguration = function () {
+		const oConfiguration = this.getConfig();
+		let sPath = "/";
+		let aResolvedItems = [];
+		let oResolvedItemTemplate;
+
+		if (oConfiguration.item && oConfiguration.item.path) {
+			sPath = oConfiguration.item.path;
+		}
+
+		const aItems = this.getModel().getProperty(sPath);
+
+		if (oConfiguration.item && oConfiguration.item.template) {
+			oResolvedItemTemplate = oConfiguration.item.template;
+			aResolvedItems = aItems.map(function (oItem, i) {
+				const sBindingPath = sPath === "/" ? sPath + i : sPath + "/" + i;
+				return BindingResolver.resolveValue(oResolvedItemTemplate, this, sBindingPath);
+			}.bind(this));
+		} else {
+			aResolvedItems = aItems;
+		}
+
+		aResolvedItems = aResolvedItems.map((oItem) => {
+			return {
+				key: oItem.key && oItem.key.toString(),
+				title: oItem.title && oItem.title.toString(),
+				additionalText: oItem.additionalText && oItem.additionalText.toString()
+			};
+		});
+
+		const oStaticConfiguration = merge({}, oConfiguration);
+		delete oStaticConfiguration.item;
+		oStaticConfiguration.items = aResolvedItems;
+
+		const oValueForModel = this.getValueForModel();
+		oStaticConfiguration.value = oValueForModel.value;
+		oStaticConfiguration.selectedKey = oValueForModel.selectedItem?.key;
+
+		return oStaticConfiguration;
+	};
+
+	ComboBoxFilter.prototype._getComboBox = function () {
+		let oControl = this.getAggregation("_comboBox");
+		if (!oControl) {
+			oControl = this._createComboBox();
+			this.setAggregation("_comboBox", oControl);
+		}
+
+		return oControl;
+	};
+
+	/**
+	 * Constructs a ComboBox control configured with the Filter's properties.
+	 *
+	 * @private
+	 * @returns {sap.m.ComboBox} configured instance
+	 */
+	ComboBoxFilter.prototype._createComboBox = function () {
+		const oConfig = this.getConfig();
+
+		const oComboBox = new ComboBox({
+			placeholder: oConfig.placeholder,
+			showSecondaryValues: true,
+			filterSecondaryValues: true
+		});
+
+		let sItemTemplateKey,
+			sItemTemplateText,
+			sItemTemplateAdditionalText,
+			sItemsPath = "/";
+
+		oComboBox.attachChange((oEvent) => {
+			this._syncValue();
+		});
+
+		if (oConfig && oConfig.item) {
+			sItemsPath = oConfig.item.path || sItemsPath;
+		}
+
+		if (oConfig && oConfig.item && oConfig.item.template) {
+			sItemTemplateKey = oConfig.item.template.key;
+			sItemTemplateText = oConfig.item.template.title;
+			sItemTemplateAdditionalText = oConfig.item.template.additionalText;
+		}
+
+		const oCard = this.getCardInstance();
+		if (oConfig && oConfig.items) {
+			sItemTemplateKey = "{key}";
+			sItemTemplateText = "{title}";
+			sItemTemplateAdditionalText = "{additionalText}";
+
+			const oModel = new JSONModel(oConfig.items);
+			oModel.setSizeLimit(oCard.getModelSizeLimit());
+
+			this.setModel(oModel);
+		}
+
+		this._oItemTemplate = new ListItem({
+			key: sItemTemplateKey,
+			text: sItemTemplateText,
+			additionalText: sItemTemplateAdditionalText
+		});
+
+		oComboBox.bindItems({
+			path: sItemsPath,
+			template: this._oItemTemplate
+		});
+
+		ComboBoxHelper.setValueAndKey(
+			oComboBox,
+			BindingResolver.resolveValue(oConfig.selectedKey, oCard),
+			BindingResolver.resolveValue(oConfig.value, oCard)
+		);
+
+		const oLabel = this.createLabel(oConfig);
+		if (oLabel) {
+			oComboBox.addAriaLabelledBy(oLabel);
+		}
+
+		return oComboBox;
+	};
+
+	return ComboBoxFilter;
+});

package/src/sap/ui/integration/cards/filters/DateRangeFilter.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.cards.filters.BaseFilter
 	 *
 	 * @author SAP SE
-	 * @version 1.120.7
+	 * @version 1.121.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/cards/filters/FilterBar.js

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.120.7
+	 * @version 1.121.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/cards/filters/FilterBarFactory.js

@@ -7,6 +7,7 @@ sap.ui.define([
 	"./FilterBar",
 	"./SearchFilter",
 	"./SelectFilter",
+	"./ComboBoxFilter",
 	"./DateRangeFilter",
 	"sap/ui/base/Object",
 	"sap/m/library",
@@ -16,6 +17,7 @@ sap.ui.define([
 	FilterBar,
 	SearchFilter,
 	SelectFilter,
+	ComboBoxFilter,
 	DateRangeFilter,
 	BaseObject,
 	mLibrary,
@@ -36,7 +38,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.120.7
+	 * @version 1.121.0
 	 *
 	 * @constructor
 	 * @private
@@ -60,9 +62,10 @@ sap.ui.define([
 	 *
 	 * @param {map} mFiltersConfig A map of the parameters config - the same that is defined in sap.card/configuration/filters.
 	 * @param {sap.ui.model.json.JSONModel} oModel The model for filters.
+	 * @param {function} fnOnChange Handler for filter value change.
 	 * @returns {sap.ui.integration.cards.filters.FilterBar|null} The Filter bar.
 	 */
-	FilterBarFactory.prototype.create = function (mFiltersConfig, oModel) {
+	FilterBarFactory.prototype.create = function (mFiltersConfig, oModel, fnOnChange) {
 		var aFilters = [],
 			aReadyPromises = [],
 			mConfig,
@@ -83,7 +86,8 @@ sap.ui.define([
 					model: "filters",
 					path: "/" + sKey
 				},
-				visible: mConfig.visible
+				visible: mConfig.visible,
+				change: fnOnChange
 			});
 
 			oModel.setProperty("/" + sKey, oFilter.getValueForModel());
@@ -156,6 +160,8 @@ sap.ui.define([
 				return DateRangeFilter;
 			case "search":
 				return SearchFilter;
+			case "combobox":
+				return ComboBoxFilter;
 			default:
 				return undefined;
 		}

package/src/sap/ui/integration/cards/filters/SearchFilter.js

@@ -5,10 +5,12 @@
  */
 sap.ui.define([
 	"./BaseFilter",
-	"sap/m/SearchField"
+	"sap/m/SearchField",
+	"sap/base/util/merge"
 ], function (
 	BaseFilter,
-	SearchField
+	SearchField,
+	merge
 ) {
 	"use strict";
 
@@ -23,7 +25,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.cards.filters.BaseFilter
 	 *
 	 * @author SAP SE
-	 * @version 1.120.7
+	 * @version 1.121.0
 	 *
 	 * @constructor
 	 * @private
@@ -69,6 +71,17 @@ sap.ui.define([
 		};
 	};
 
+	/**
+	 * @returns {object} Filter configuration with static items
+	 */
+	SearchFilter.prototype.getStaticConfiguration = function () {
+		const oStaticConfiguration = merge({}, this.getConfig());
+
+		oStaticConfiguration.value = this.getValueForModel().value;
+
+		return oStaticConfiguration;
+	};
+
 	SearchFilter.prototype._getSearchField = function () {
 		var oControl = this.getAggregation("_searchField");
 		if (!oControl) {

package/src/sap/ui/integration/cards/filters/SelectFilter.js

@@ -31,7 +31,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.cards.filters.BaseFilter
 	 *
 	 * @author SAP SE
-	 * @version 1.120.7
+	 * @version 1.121.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/cards/list/MicrochartsResizeHelper.js

@@ -22,7 +22,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.120.7
+	 * @version 1.121.0
 	 *
 	 * @constructor
 	 * @private