@openui5/sap.ui.integration 1.93.3 → 1.96.2

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.2
+	 *
+	 * @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.93.3
+	 * @version 1.96.2
 	 *
 	 * @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;
 });

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

@@ -0,0 +1,157 @@
+/*!
+ * 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/m/Select",
+	"sap/ui/core/ListItem",
+	"sap/ui/model/json/JSONModel"
+], function (
+	BaseFilter,
+	Select,
+	ListItem,
+	JSONModel
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new <code>SelectFilter</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.2
+	 *
+	 * @constructor
+	 * @private
+	 * @since 1.84
+	 * @alias sap.ui.integration.cards.filters.SelectFilter
+	 */
+	var SelectFilter = BaseFilter.extend("sap.ui.integration.cards.filters.SelectFilter", {
+		metadata: {
+			library: "sap.ui.integration",
+			aggregations: {
+				/**
+				 * The internally used sap.m.Select control instance.
+				 */
+				_select: { type: "sap.m.Select", multiple: false, visibility: "hidden" }
+			}
+		},
+		renderer: {
+			apiVersion: 2
+		}
+	});
+
+	SelectFilter.prototype.exit = function () {
+		BaseFilter.prototype.exit.apply(this, arguments);
+
+		if (this._oItemTemplate) {
+			this._oItemTemplate.destroy();
+		}
+	};
+
+	/**
+	 * @override
+	 */
+	SelectFilter.prototype.getField = function () {
+		return this._getSelect();
+	};
+
+	/**
+	 * @override
+	 */
+	SelectFilter.prototype.onDataChanged = function () {
+		var oSelect = this._getSelect();
+
+		oSelect.setSelectedKey(this.getValue().value);
+	};
+
+	/**
+	 * @override
+	 */
+	SelectFilter.prototype.getValueForModel = function () {
+		var oSelectedItem = this._getSelect().getSelectedItem();
+
+		if (oSelectedItem) {
+			return {
+				value: oSelectedItem.getKey(),
+				selectedItem: {
+					title: oSelectedItem.getText(),
+					key: oSelectedItem.getKey()
+				}
+			};
+		}
+
+		return {
+			value: this.getConfig().value
+		};
+	};
+
+	SelectFilter.prototype._getSelect = function () {
+		var oControl = this.getAggregation("_select");
+		if (!oControl) {
+			oControl = this._createSelect();
+			this.setAggregation("_select", oControl);
+		}
+
+		return oControl;
+	};
+
+	/**
+	 * Constructs a Select control configured with the Filter's properties.
+	 *
+	 * @private
+	 * @returns {sap.m.Select} configured instance
+	 */
+	SelectFilter.prototype._createSelect = function () {
+		var oSelect = new Select(),
+			sItemTemplateKey,
+			sItemTemplateTitle,
+			sItemsPath = "/",
+			oConfig = this.getConfig();
+
+		oSelect.attachChange(function (oEvent) {
+			this.setValue(this.getValueForModel());
+
+			var sManifestKey = "/sap.card/configuration/filters/" + this.getKey() + "/value",
+				oParams = {};
+			oParams[sManifestKey] = oEvent.getParameter("selectedItem").getKey();
+			this.getCardInstance()._fireConfigurationChange(oParams);
+		}.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));
+		}
+
+		this._oItemTemplate = new ListItem({ key: sItemTemplateKey, text: sItemTemplateTitle });
+
+		oSelect.bindItems({
+			path: sItemsPath,
+			template: this._oItemTemplate
+		});
+
+		oSelect.setSelectedKey(oConfig.value);
+
+		return oSelect;
+	};
+
+	return SelectFilter;
+});

package/src/sap/ui/integration/controls/ActionsStrip.js

@@ -46,7 +46,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 *
 	 * @constructor
 	 * @private
@@ -140,7 +140,6 @@ sap.ui.define([
 					tooltip: mConfig.tooltip || mConfig.text,
 					type: mConfig.buttonType,
 					ariaHasPopup: mConfig.ariaHasPopup,
-					enabled: mConfig.enabled,
 					visible: mConfig.visible
 				});
 			} else {
@@ -149,7 +148,6 @@ sap.ui.define([
 					tooltip: mConfig.tooltip,
 					type: mConfig.buttonType,
 					ariaHasPopup: mConfig.ariaHasPopup,
-					enabled: mConfig.enabled,
 					visible: mConfig.visible
 				});
 			}

package/src/sap/ui/integration/controls/ActionsToolbar.js

@@ -76,7 +76,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/controls/ListContentItem.js

@@ -5,12 +5,14 @@
 */
 
 sap.ui.define([
+	"sap/ui/integration/library",
 	"./ListContentItemRenderer",
 	"sap/m/Avatar",
 	"sap/m/AvatarShape",
 	"sap/m/AvatarSize",
 	"sap/m/StandardListItem"
 ], function (
+	library,
 	ListContentItemRenderer,
 	Avatar,
 	AvatarShape,
@@ -19,6 +21,8 @@ sap.ui.define([
 ) {
 	"use strict";
 
+	var AttributesLayoutType = library.AttributesLayoutType;
+
 	/**
 	 * Constructor for a new ListContentItem.
 	 *
@@ -30,7 +34,7 @@ sap.ui.define([
 	 * @extends sap.m.StandardListItem
 	 *
 	 * @author SAP SE
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 *
 	 * @constructor
 	 * @private
@@ -68,13 +72,20 @@ sap.ui.define([
 				 * Defines the background color of the icon.
 				 * @since 1.83
 				 */
-				iconBackgroundColor: { type: "sap.m.AvatarColor" }
+				iconBackgroundColor: { type: "sap.m.AvatarColor" },
+
+				/**
+				 * Defines the layout type of the attributes.
+				 */
+				attributesLayoutType: { type: "sap.ui.integration.AttributesLayoutType", defaultValue: AttributesLayoutType.TwoColumns }
 			},
 			aggregations: {
 				microchart: { type: "sap.ui.integration.controls.Microchart", multiple: false },
 
 				actionsStrip: { type: "sap.ui.integration.controls.ActionsStrip", multiple: false },
 
+				attributes: { type: "sap.m.ObjectStatus", multiple: true },
+
 				/**
 				 * Defines the inner avatar control.
 				 */

package/src/sap/ui/integration/controls/ListContentItemRenderer.js

@@ -5,11 +5,13 @@
  */
 
 sap.ui.define([
+	"sap/ui/integration/library",
 	"sap/ui/core/Renderer",
 	"sap/ui/core/Core",
 	"sap/ui/Device",
 	"sap/m/StandardListItemRenderer"
-], function(Renderer,
+], function(library,
+			Renderer,
 			Core,
 			Device,
 			StandardListItemRenderer) {
@@ -22,6 +24,8 @@ sap.ui.define([
 	var ListContentItemRenderer = Renderer.extend(StandardListItemRenderer);
 	ListContentItemRenderer.apiVersion = 2;
 
+	var AttributesLayoutType = library.AttributesLayoutType;
+
 	/**
 	 * @override
 	 */
@@ -37,6 +41,14 @@ sap.ui.define([
 		if (oLI.getMicrochart()) {
 			rm.class("sapUiIntLCIWithChart");
 		}
+
+		if (oLI.getActionsStrip()) {
+			rm.class("sapUiIntLCIWithActionsStrip");
+		}
+
+		if (oLI.getAttributes().length) {
+			rm.class("sapUiIntLCIWithAttributes");
+		}
 	};
 
 	/**
@@ -55,7 +67,8 @@ sap.ui.define([
 			rm.renderControl(oLI._getAvatar());
 		}
 
-		rm.openStart("div").class("sapMSLIDiv");
+		rm.openStart("div")
+			.class("sapMSLIDiv");
 
 		// if bShouldRenderInfoWithoutTitle=true then adapt the style class to have flex-direction: row
 		if ((!sDescription && bAdaptTitleSize && sInfo) || bShouldRenderInfoWithoutTitle) {
@@ -136,11 +149,61 @@ sap.ui.define([
 		this.renderLIContentWrapper(rm, oLI);
 		this.renderContentLatter(rm, oLI);
 
+		this.renderItemAttributes(rm, oLI);
+
 		this.renderFooter(rm, oLI);
 
 		this.closeItemTag(rm, oLI);
 	};
 
+	ListContentItemRenderer.renderItemAttributes = function(rm, oLI) {
+		var aAttrs = oLI.getAttributes(),
+			sLayoutType = oLI.getAttributesLayoutType(),
+			iLength = aAttrs.length,
+			i;
+
+		if (!iLength) {
+			return;
+		}
+
+		rm.openStart("div")
+			.class("sapUiIntLCIAttrs")
+			.openEnd();
+
+		for (i = 0; i < iLength; i++) {
+			rm.openStart("div")
+				.class("sapUiIntLCIAttrRow")
+				.openEnd();
+
+			rm.openStart("span")
+				.class("sapUiIntLCIAttrCell")
+				.openEnd();
+
+			rm.renderControl(aAttrs[i]);
+
+			rm.close("span");
+
+			if (sLayoutType === AttributesLayoutType.TwoColumns) {
+				i++;
+
+				if (aAttrs[i]) {
+					rm.openStart("span")
+						.class("sapUiIntLCIAttrCell")
+						.class("sapUiIntLCIAttrSecondCell")
+						.openEnd();
+
+					rm.renderControl(aAttrs[i]);
+
+					rm.close("span");
+				}
+			}
+
+			rm.close("div");
+		}
+
+		rm.close("div");
+	};
+
 	ListContentItemRenderer.renderFooter = function(rm, oLI) {
 
 		var oMicrochart = oLI.getMicrochart(),

package/src/sap/ui/integration/controls/Microchart.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/controls/MicrochartLegend.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 *
 	 * @constructor
 	 * @private