@openui5/sap.ui.integration 1.95.0 → 1.96.3

package/src/sap/ui/integration/cards/adaptivecards/elements/UI5InputToggle.js

@@ -16,7 +16,7 @@ sap.ui.define(["sap/ui/integration/thirdparty/adaptivecards"], function (Adaptiv
 	 * <code>ui5-checkbox</code> web component.
 	 *
 	 * @author SAP SE
-	 * @version 1.95.0
+	 * @version 1.96.3
 	 *
 	 * @private
 	 * @since 1.74

package/src/sap/ui/integration/cards/{Filter.js → filters/BaseFilter.js}

@@ -10,9 +10,6 @@ sap.ui.define([
 	"sap/ui/core/Icon",
 	"sap/m/HBox",
 	"sap/m/Text",
-	"sap/m/Select",
-	"sap/ui/core/ListItem",
-	"sap/ui/model/json/JSONModel",
 	"sap/ui/integration/model/ObservableModel",
 	"sap/ui/integration/util/LoadingProvider"
 ], function (
@@ -22,16 +19,13 @@ sap.ui.define([
 	Icon,
 	HBox,
 	Text,
-	Select,
-	ListItem,
-	JSONModel,
 	ObservableModel,
 	LoadingProvider
 ) {
 	"use strict";
 
 	/**
-	 * Constructor for a new <code>Filter</code>.
+	 * Constructor for a new <code>BaseFilter</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
@@ -41,16 +35,17 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.95.0
+	 * @version 1.96.3
 	 *
 	 * @constructor
 	 * @private
-	 * @since 1.84
-	 * @alias sap.ui.integration.cards.Filter
+	 * @since 1.96
+	 * @alias sap.ui.integration.cards.filters.BaseFilter
 	 */
-	var Filter = Control.extend("sap.ui.integration.cards.Filter", {
+	var BaseFilter = Control.extend("sap.ui.integration.cards.filters.BaseFilter", {
 		metadata: {
-
+			"abstract" : true,
+			library: "sap.ui.integration",
 			properties: {
 				/**
 				 * Filter's key as it's defined in the manifest.
@@ -63,23 +58,16 @@ sap.ui.define([
 				config: { type: "object", defaultValue: "null" },
 
 				/**
-				 * The currently selected filter value.
+				 * The value of the filter that can be used in the manifest.
 				 */
-				value: { type: "string", defaultValue: "" }
+				value: { type: "object", defaultValue: null }
 			},
-
 			aggregations: {
-				/**
-				 * The internally used sap.m.Select control instance.
-				 */
-				_select: { type: "sap.m.Select", multiple: false, visibility: "hidden" },
-
 				/**
 				 * The internally used LoadingProvider.
 				 */
 				_loadingProvider: { type: "sap.ui.core.Element", multiple: false, visibility: "hidden" }
 			},
-
 			associations: {
 
 				/**
@@ -89,7 +77,6 @@ sap.ui.define([
 			}
 
 		},
-
 		renderer: {
 			apiVersion: 2,
 			render: function (oRM, oFilter) {
@@ -106,7 +93,7 @@ sap.ui.define([
 				if (oFilter._hasError()) {
 					oRM.renderControl(oFilter._getErrorMessage());
 				} else {
-					oRM.renderControl(oFilter._getSelect());
+					oRM.renderControl(oFilter.getField());
 				}
 
 				oRM.close("div");
@@ -114,7 +101,7 @@ sap.ui.define([
 		}
 	});
 
-	Filter.prototype.init = function () {
+	BaseFilter.prototype.init = function () {
 		this.setAggregation("_loadingProvider", new LoadingProvider());
 
 		this.attachEventOnce("_dataReady", function () {
@@ -122,34 +109,64 @@ sap.ui.define([
 		});
 	};
 
-	Filter.prototype.exit = function () {
+	BaseFilter.prototype.exit = function () {
 		if (this._oDataProvider) {
 			this._oDataProvider.destroy();
 			this._oDataProvider = null;
 		}
 	};
 
-	Filter.prototype.isLoading = function () {
+	BaseFilter.prototype.isLoading = function () {
 		var oLoadingProvider = this.getAggregation("_loadingProvider");
 
 		return !oLoadingProvider.isDataProviderJson() && oLoadingProvider.getLoading();
 	};
 
-	Filter.prototype._getSelect = function () {
-		var oControl = this.getAggregation("_select");
-		if (!oControl) {
-			oControl = this._createSelect();
-			this.setAggregation("_select", oControl);
+	BaseFilter.prototype.getField = function () {
+		return null;
+	};
+
+	/**
+	 * @private
+	 * @ui5-restricted
+	 */
+	BaseFilter.prototype.showLoadingPlaceholders = function () {
+		this.getAggregation("_loadingProvider").setLoading(true);
+	};
+
+	/**
+	 * @private
+	 * @ui5-restricted
+	 */
+	BaseFilter.prototype.hideLoadingPlaceholders = function () {
+		this.getAggregation("_loadingProvider").setLoading(false);
+	};
+
+	BaseFilter.prototype.onDataChanged = function () { };
+
+	BaseFilter.prototype.getValueForModel = function () { };
+
+	BaseFilter.prototype.refreshData = function () {
+		if (this._oDataProvider) {
+			this._oDataProvider.triggerDataUpdate();
 		}
+	};
 
-		return oControl;
+	/**
+	 * Gets the card instance of which this element is part of.
+	 * @ui5-restricted
+	 * @private
+	 * @returns {sap.ui.integration.widgets.Card} The card instance.
+	 */
+	BaseFilter.prototype.getCardInstance = function () {
+		return Core.byId(this.getCard());
 	};
 
-	Filter.prototype._hasError = function () {
+	BaseFilter.prototype._hasError = function () {
 		return !!this._bError;
 	};
 
-	Filter.prototype._getErrorMessage = function () {
+	BaseFilter.prototype._getErrorMessage = function () {
 		var sMessage = "Unable to load the filter.";
 
 		return new HBox({
@@ -162,47 +179,24 @@ sap.ui.define([
 		});
 	};
 
-	Filter.prototype._handleError = function (sLogMessage) {
+	BaseFilter.prototype._handleError = function (sLogMessage) {
 		Log.error(sLogMessage);
 
 		this._bError = true;
 		this.invalidate();
 	};
 
-	Filter.prototype._onDataRequestComplete = function () {
+	BaseFilter.prototype._onDataRequestComplete = function () {
 		this.fireEvent("_dataReady");
 		this.hideLoadingPlaceholders();
 	};
 
-	/**
-	 * @private
-	 * @ui5-restricted
-	 */
-	Filter.prototype.showLoadingPlaceholders = function () {
-		this.getAggregation("_loadingProvider").setLoading(true);
-	};
-
-	/**
-	 * @private
-	 * @ui5-restricted
-	 */
-	Filter.prototype.hideLoadingPlaceholders = function () {
-		this.getAggregation("_loadingProvider").setLoading(false);
-	};
-
-	Filter.prototype._onDataChanged = function () {
-		var oSelect = this._getSelect();
-
-		oSelect.setSelectedKey(this.getValue());
-		this._updateSelected(oSelect.getSelectedItem());
-	};
-
 	/**
 	 * Uses the Card's own DataProvider and the provided oDataConfig object to populate the Filter's data.
 	 * @private
 	 * @param {object} oDataConfig Data configuration
 	 */
-	Filter.prototype._setDataConfiguration = function (oDataConfig) {
+	BaseFilter.prototype._setDataConfiguration = function (oDataConfig) {
 		var oCard = this.getCardInstance(),
 			oModel;
 
@@ -227,7 +221,7 @@ sap.ui.define([
 		}
 
 		oModel.attachEvent("change", function () {
-			this._onDataChanged();
+			this.onDataChanged();
 		}.bind(this));
 
 		this._oDataProvider.attachDataRequested(function () {
@@ -247,77 +241,5 @@ sap.ui.define([
 		this._oDataProvider.triggerDataUpdate();
 	};
 
-	Filter.prototype._updateSelected = function (oSelectedItem) {
-		var oFiltersModel = this.getModel("filters"),
-			sFilterKey = this.getKey();
-
-		oFiltersModel.setProperty("/" + sFilterKey, {
-			"value": oSelectedItem.getKey(),
-			"selectedItem": {
-				"title": oSelectedItem.getText(),
-				"key": oSelectedItem.getKey()
-			}
-		});
-	};
-
-	/**
-	 * Constructs a Select control configured with the Filter's properties.
-	 *
-	 * @private
-	 * @returns {sap.m.Select} configured instance
-	 */
-	Filter.prototype._createSelect = function () {
-		var oSelect = new Select(),
-			sItemTemplateKey,
-			sItemTemplateTitle,
-			sItemsPath = "/",
-			oConfig = this.getConfig();
-
-		oSelect.attachChange(function (oEvent) {
-			var sValue = oEvent.getParameter("selectedItem").getKey();
-			this.setValue(sValue);
-			this._updateSelected(oEvent.getParameter("selectedItem"));
-		}.bind(this));
-
-		if (oConfig && oConfig.item) {
-			sItemsPath = oConfig.item.path || sItemsPath;
-		}
-
-		if (oConfig && oConfig.item && oConfig.item.template) {
-			sItemTemplateKey = oConfig.item.template.key;
-			sItemTemplateTitle = oConfig.item.template.title;
-		}
-
-		if (oConfig && oConfig.items) {
-			sItemTemplateKey = "{key}";
-			sItemTemplateTitle = "{title}";
-			this.setModel(new JSONModel(oConfig.items));
-		}
-
-		oSelect.bindItems({
-			path: sItemsPath,
-			template: new ListItem({ key: sItemTemplateKey, text: sItemTemplateTitle })
-		});
-		oSelect.setSelectedKey(this.getValue());
-
-		return oSelect;
-	};
-
-	Filter.prototype.refreshData = function () {
-		if (this._oDataProvider) {
-			this._oDataProvider.triggerDataUpdate();
-		}
-	};
-
-	/**
-	 * Gets the card instance of which this element is part of.
-	 * @ui5-restricted
-	 * @private
-	 * @returns {sap.ui.integration.widgets.Card} The card instance.
-	 */
-	Filter.prototype.getCardInstance = function () {
-		return Core.byId(this.getCard());
-	};
-
-	return Filter;
+	return BaseFilter;
 });

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

@@ -0,0 +1,232 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"./BaseFilter",
+	"sap/ui/core/library",
+	"sap/m/DynamicDateRange",
+	"sap/m/DynamicDateUtil"
+], function (
+	BaseFilter,
+	coreLibrary,
+	DynamicDateRange,
+	DynamicDateUtil
+) {
+	"use strict";
+
+	var ValueState = coreLibrary.ValueState;
+	var MIN_DATE = new Date(-8640000000000000);
+	var MIN_ODATA_DATE = new Date("1753-01-01");
+	var MAX_DATE = new Date(8640000000000000);
+	var MAX_ODATA_DATE = new Date("9999-12-31");
+
+	/**
+	 * @param {string} sOperator sap.m.StandardDynamicDateRangeKeys operator in upper case
+	 * @returns {string} Operator in camel case
+	 */
+	function operatorToCamelCase(sOperator) {
+		var mOperators = {
+			"DATE": "date",
+			"TODAY": "today",
+			"YESTERDAY": "yesterday",
+			"TOMORROW": "tomorrow",
+
+			"DATERANGE": "dateRange",
+			"FROM": "from",
+			"TO": "to",
+			"YEARTODATE": "yearToDate",
+			"LASTDAYS": "lastDays",
+			"LASTWEEKS": "lastWeeks",
+			"LASTMONTHS": "lastMonths",
+			"LASTQUARTERS": "lastQuarters",
+			"LASTYEARS": "lastYears",
+			"NEXTDAYS": "nextDays",
+			"NEXTWEEKS": "nextWeeks",
+			"NEXTMONTHS": "nextMonths",
+			"NEXTQUARTERS": "nextQuarters",
+			"NEXTYEARS": "nextYears",
+			"TODAYFROMTO": "todayFromTo",
+
+			"THISWEEK": "thisWeek",
+			"LASTWEEK": "lastWeek",
+			"NEXTWEEK": "nextWeek",
+
+			"SPECIFICMONTH": "specificMonth",
+			"THISMONTH": "thisMonth",
+			"LASTMONTH": "lastMonth",
+			"NEXTMONTH": "nextMonth",
+
+			"THISQUARTER": "thisQuarter",
+			"LASTQUARTER": "lastQuarter",
+			"NEXTQUARTER": "nextQuarter",
+			"QUARTER1": "quarter1",
+			"QUARTER2": "quarter2",
+			"QUARTER3": "quarter3",
+			"QUARTER4": "quarter4",
+
+			"THISYEAR": "thisYear",
+			"LASTYEAR": "lastYear",
+			"NEXTYEAR": "nextYear"
+		};
+
+		return mOperators[sOperator];
+	}
+
+	/**
+	 * Constructor for a new <code>DateRangeFilter</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.96.3
+	 *
+	 * @constructor
+	 * @private
+	 * @since 1.96
+	 * @alias sap.ui.integration.cards.filters.DateRangeFilter
+	 */
+	var DateRangeFilter = BaseFilter.extend("sap.ui.integration.cards.filters.DateRangeFilter", {
+		metadata: {
+			library: "sap.ui.integration",
+			aggregations: {
+				/**
+				 * The internally used sap.m.DynamicDateRange control instance.
+				 */
+				_ddr: { type: "sap.m.DynamicDateRange", multiple: false, visibility: "hidden" }
+			}
+		},
+		renderer: {
+			apiVersion: 2
+		}
+	});
+
+	/**
+	 * @override
+	 */
+	DateRangeFilter.prototype.getField = function () {
+		return this._getDdr();
+	};
+
+	/**
+	 * @override
+	 */
+	DateRangeFilter.prototype.getValueForModel = function () {
+		var oDateRangeValue = this._getDdr().getValue();
+		var oValue;
+		var oRange;
+		var oRangeOData;
+
+		if (oDateRangeValue) {
+			oValue = Object.assign({}, oDateRangeValue);
+			var aDates = DynamicDateUtil.toDates(oValue),
+				dStart = aDates[0].getJSDate ? aDates[0].getJSDate() : aDates[0],
+				dEnd = aDates[1].getJSDate ? aDates[1].getJSDate() : aDates[1];
+
+			oRange = {
+				start: dStart.toISOString(),
+				end: dEnd.toISOString()
+			};
+			oRangeOData = {
+				start: dStart.toISOString(),
+				end: dEnd.toISOString()
+			};
+
+			if (oValue.operator === "TO") {
+				oRange.start = MIN_DATE.toISOString();
+				oRangeOData.start = MIN_ODATA_DATE.toISOString();
+			}
+
+			if (oValue.operator === "FROM") {
+				oRange.end = MAX_DATE.toISOString();
+				oRangeOData.end = MAX_ODATA_DATE.toISOString();
+			}
+
+			oValue.operator = operatorToCamelCase(oValue.operator);
+		}
+
+		return {
+			value: oValue,
+			range: oRange,
+			rangeOData: oRangeOData
+		};
+	};
+
+	DateRangeFilter.prototype._getDdr = function () {
+		var oControl = this.getAggregation("_ddr");
+		if (!oControl) {
+			oControl = this._createDdr();
+			this.setAggregation("_ddr", oControl);
+		}
+
+		return oControl;
+	};
+
+	/**
+	 * Constructs a DynamicDateRange control configured with the Filter's properties.
+	 *
+	 * @private
+	 * @returns {sap.m.DynamicDateRange} configured instance
+	 */
+	DateRangeFilter.prototype._createDdr = function () {
+		var oConfig = Object.assign({}, this.getConfig());
+		var oValue;
+
+		if (oConfig.value) {
+			var sOption = oConfig.value.operator.toUpperCase();
+			var aTypes = DynamicDateUtil.getOption(sOption).getValueTypes();
+			oValue = {
+				operator: sOption,
+				values: oConfig.value.values.map(function (vValue, i) {
+					if (aTypes[i] === "date") {
+						return new Date(vValue);
+					}
+					return vValue;
+				})
+			};
+		}
+
+		oConfig.options = oConfig.options || this._getDefaultOptions();
+		oConfig.options = oConfig.options.map(function (sOption) {
+			return sOption.toUpperCase();
+		});
+
+		var oDdr = new DynamicDateRange({
+			value: oValue,
+			options: oConfig.options
+		});
+
+		oDdr.attachChange(function (oEvent) {
+			if (oEvent.getParameter("valid")) {
+				oDdr.setValueState(ValueState.None);
+				this.setValue(this.getValueForModel());
+			} else {
+				oDdr.setValueState(ValueState.Error);
+			}
+		}.bind(this));
+
+		return oDdr;
+	};
+
+	DateRangeFilter.prototype._getDefaultOptions = function () {
+		return [
+			"date",
+			"today",
+			"dateRange",
+			"from",
+			"to",
+			"lastDays",
+			"nextDays",
+			"lastWeeks",
+			"nextWeeks"
+		];
+	};
+
+	return DateRangeFilter;
+});

package/src/sap/ui/integration/{util → cards/filters}/FilterBarFactory.js

@@ -4,15 +4,17 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
+	"./SelectFilter",
+	"./DateRangeFilter",
 	"sap/ui/base/Object",
 	"sap/m/library",
-	"sap/m/HBox",
-	"sap/ui/integration/cards/Filter"
+	"sap/m/HBox"
 ], function (
+	SelectFilter,
+	DateRangeFilter,
 	BaseObject,
 	mLibrary,
-	HBox,
-	Filter
+	HBox
 ) {
 	"use strict";
 
@@ -28,7 +30,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.95.0
+	 * @version 1.96.3
 	 *
 	 * @constructor
 	 * @private
@@ -47,30 +49,38 @@ sap.ui.define([
 	});
 
 	/**
-	 * Creates a new filter bar which holds drop-down menus for filtering. Those drop-down menus are created based on the parameters configuration.
+	 * Creates a new filter bar which holds fields for filtering.
+	 * Each field is bound to the given model.
 	 *
-	 * @param {map} mFiltersConfig A map of the parameters config - the same that is defined in sap.card/configuration/parameters.
-	 * @param {map} mFiltersValues The combined (runtime + manifest) values of the parameters.
+	 * @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.
 	 * @returns {sap.m.HBox} The Filter bar.
 	 */
-	FilterBarFactory.prototype.create = function (mFiltersConfig, mFiltersValues) {
+	FilterBarFactory.prototype.create = function (mFiltersConfig, oModel) {
 		var aFilters = [],
 			aReadyPromises = [],
 			mConfig,
 			sKey,
 			oFilter,
-			oFilterBarStrip;
+			oFilterBarStrip,
+			FilterClass = null;
 
 		for (sKey in mFiltersConfig) {
 			mConfig = mFiltersConfig[sKey];
+			FilterClass = this._getClass(mConfig.type);
 
-			oFilter = new Filter({
+			oFilter = new FilterClass({
 				card: this._oCard,
 				key: sKey,
 				config: mConfig,
-				value: mFiltersValues[sKey] ? mFiltersValues[sKey].value : mConfig.value
+				value: {
+					model: "filters",
+					path: "/" + sKey
+				}
 			});
 
+			oModel.setProperty("/" + sKey, oFilter.getValueForModel());
+
 			this._awaitEvent(aReadyPromises, oFilter, "_ready");
 			oFilter._setDataConfiguration(mConfig.data);
 
@@ -114,5 +124,20 @@ sap.ui.define([
 		}));
 	};
 
+	FilterBarFactory.prototype._getClass = function (sType) {
+		sType = sType || "select";
+
+		switch (sType.toLowerCase()) {
+			case "string": // backwards compatibility
+			case "integer": // backwards compatibility
+			case "select":
+				return SelectFilter;
+			case "daterange":
+				return DateRangeFilter;
+			default:
+				return undefined;
+		}
+	};
+
 	return FilterBarFactory;
 });