@openui5/sap.ui.mdc 1.110.0 → 1.111.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/sap.ui.mdc",
-  "version": "1.110.0",
+  "version": "1.111.0",
   "description": "OpenUI5 UI Library sap.ui.mdc",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -14,8 +14,8 @@
     "url": "https://github.com/SAP/openui5.git"
   },
   "dependencies": {
-    "@openui5/sap.m": "1.110.0",
-    "@openui5/sap.ui.core": "1.110.0",
-    "@openui5/sap.ui.layout": "1.110.0"
+    "@openui5/sap.m": "1.111.0",
+    "@openui5/sap.ui.core": "1.111.0",
+    "@openui5/sap.ui.layout": "1.111.0"
   }
 }

package/src/sap/ui/mdc/.library

@@ -6,7 +6,7 @@
 	<copyright>OpenUI5
  * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.</copyright>
-	<version>1.110.0</version>
+	<version>1.111.0</version>
 
 	<documentation>UI5 library: sap.ui.mdc</documentation>
 

package/src/sap/ui/mdc/ActionToolbar.js

@@ -31,7 +31,7 @@ sap.ui.define([
 	 * @class The column for the metadata driven table, that hold the template to be shown when the rows has data.
 	 * @extends sap.m.OverflowToolbar
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @constructor
 	 * @private
 	 * @since 1.58

package/src/sap/ui/mdc/AggregationBaseDelegate.js

@@ -85,7 +85,6 @@ sap.ui.define(['sap/ui/mdc/BaseDelegate', 'sap/ui/core/library'], function (Base
 		 *
 		 * @param {sap.ui.mdc.Control} oControl Instance of a <code>sap.ui.mdc.Control</code>
 		 * @param {Object} oState The theoretical external state representation of an MDC control. The representation of this format is similar as processed by {@link sap.ui.mdc.p13n.StateUtil StateUtil}
-		 *
 		 * @returns {Object} An object that must contain at least the <code>validation</code> attribute {@link sap.ui.core.MessageType MessageType}.
 		 * If <code>warning</code> or <code>error</code> state types have been provided, the <code>message</code> is shown in addition.
 		 */
@@ -109,8 +108,27 @@ sap.ui.define(['sap/ui/mdc/BaseDelegate', 'sap/ui/core/library'], function (Base
 		 */
 		onAfterXMLChangeProcessing: function(oControl, mPropertyBag) {
 			//Neccessary cleanups can be implemented here
-		}
+		},
 
+		/**
+		 * A validator to evaluate the state of a MDC control.
+		 *
+		 * @param {Object<sap.ui.mdc.Control>} oControl Instance of a MDC control
+		 * @param {map} [mValidation] Object Describing the validation result
+
+		 */
+		determineValidationState: function(oControl) {
+            return oControl.checkValidationState ? oControl.checkValidationState() : -1;
+		},
+
+		/**
+		 * Visualizes the validation state of a MDC control.
+		 *
+		 * @param {Object<sap.ui.mdc.Control>} oControl Instance of a MDC control
+		 * @returns {map} mValidation Describes the validation result.
+		 */
+	    visualizeValidationState: function(oControl, mValidation) {
+		}
 	});
 
 	return AggregationBaseDelegate;

package/src/sap/ui/mdc/Chart.js

@@ -24,7 +24,11 @@ sap.ui.define([
         "sap/ui/base/ManagedObjectObserver",
         "sap/ui/mdc/chart/DrillBreadcrumbs",
         "sap/ui/mdc/actiontoolbar/ActionToolbarAction",
-        "sap/ui/core/library"
+        "sap/ui/core/library",
+        "sap/ui/events/KeyCodes",
+        "sap/ui/mdc/util/InfoBar",
+        "sap/m/Label",
+        "sap/ui/core/format/ListFormat"
     ],
     function (
         Core,
@@ -46,7 +50,11 @@ sap.ui.define([
         ManagedObjectObserver,
         Breadcrumbs,
         ActionToolbarAction,
-        coreLibrary
+        coreLibrary,
+        KeyCodes,
+        InfoBar,
+        Label,
+        ListFormat
     ) {
         "use strict";
 
@@ -61,7 +69,7 @@ sap.ui.define([
          * @class The Chart control creates a chart based on metadata and the configuration specified.
          * @extends sap.ui.mdc.Control
          * @author SAP SE
-         * @version 1.110.0
+         * @version 1.111.0
          * @constructor
          * @experimental As of version 1.88
          * @private
@@ -252,6 +260,17 @@ sap.ui.define([
                         type: "sap.ui.core.TitleLevel",
                         group: "Appearance",
                         defaultValue: TitleLevel.Auto
+                    },
+                    /**
+                     * Determines whether the header text is shown in the chart. Regardless of its value, the given header text is used to label the chart
+                     * correctly for accessibility purposes.
+                     *
+                     * @since 1.111
+                     */
+                    headerVisible : {
+                        type: "boolean",
+                        group: "Misc",
+                        defaultValue: true
                     }
                 },
                 aggregations: {
@@ -294,6 +313,11 @@ sap.ui.define([
                         type: "sap.ui.mdc.chart.SelectionDetailsActions",
                         multiple: false
                     },
+                    _infoToolbar: {
+                        type: "sap.ui.mdc.util.InfoBar",
+                        multiple: false,
+                        visibility: "hidden"
+                    },
                     /**
                      * Reference to a {@link sap.ui.fl.variants.VariantManagement} control for the chart.
                      */
@@ -466,6 +490,8 @@ sap.ui.define([
                 oP13nFilter.setFilterConditions(mConditions);
             }
 
+            this._updateInfoToolbar();
+
             return this;
         };
 
@@ -554,6 +580,11 @@ sap.ui.define([
                 }
 
                 this.setAggregation("_innerChart", oInnerChart);
+
+                if (this.getP13nMode().includes("Filter")){
+                    this._initInfoToolbar();
+                }
+
                 this._bInnerChartReady = true;
                 this._fnResolveInitialized();
                 this.invalidate();
@@ -566,6 +597,60 @@ sap.ui.define([
             this._getToolbar().createToolbarContent(this);
         };
 
+        Chart.prototype._initInfoToolbar = function() {
+            this.setAggregation("_infoToolbar", new InfoBar(this.getId() + "--infoToolbar", {infoText: this._getFilterInfoText(),
+                press: function() {
+                    this.finalizePropertyHelper().then(function(){
+                       return ChartSettings.showPanel(this, "Filter");
+                    }.bind(this)).then(function(oP13nDialog) {
+
+                        oP13nDialog.attachEventOnce("afterClose", function() {
+
+                            var aConditions = this.getFilterConditions();
+                            var bNoConditions = !Object.keys(aConditions).find(function(oKey) {
+                                return aConditions[oKey] && aConditions[oKey].length > 0;
+                            });
+
+                            if (bNoConditions && this.getAggregation("_toolbar")) {
+                                    this.getAggregation("_toolbar").getSettingsButton().focus();
+                            }
+
+                        }.bind(this));
+                    }.bind(this));
+                }.bind(this)}));
+
+            if (this.getDomRef()) {
+                this.getDomRef().setAttribute("aria-labelledby", this.getAggregation("_infoToolbar").getACCTextId());
+            }
+        };
+
+        Chart.prototype._updateInfoToolbar = function() {
+            if (this.getP13nMode().includes("Filter") && this.getAggregation("_infoToolbar")){
+                this.getAggregation("_infoToolbar").setInfoText(this._getFilterInfoText());
+            }
+        };
+
+        Chart.prototype._getFilterInfoText = function() {
+            if (this.getInbuiltFilter()) {
+                var sText;
+                var aFilterNames = this._getLabelsFromFilterConditions();
+                var oListFormat = ListFormat.getInstance();
+
+                if (aFilterNames.length > 0) {
+
+                    if (aFilterNames.length > 1) {
+                        sText = MDCRb.getText("chart.MULTIPLE_FILTERS_ACTIVE", [aFilterNames.length, oListFormat.format(aFilterNames)]);
+                    } else {
+                        sText = MDCRb.getText("chart.ONE_FILTER_ACTIVE", aFilterNames[0]);
+                    }
+                }
+
+                return sText;
+            }
+
+            return undefined;
+        };
+
         /**
          * Creates the content for the inner chart from properties.
          * The properties are given via the PropertyHelper which is initialized here.
@@ -1063,6 +1148,14 @@ sap.ui.define([
             return this;
         };
 
+        Chart.prototype.setHeaderVisible = function(bVisible) {
+            this.setProperty("headerVisible", bVisible, true);
+            if (this.getAggregation("_toolbar")) {
+                this.getAggregation("_toolbar").setHeaderVisible(bVisible);
+            }
+            return this;
+        };
+
         /**
          * Gets the managed object model.
          * @returns {sap.ui.model.base.ManagedObjectModel} the managed object model
@@ -1285,5 +1378,30 @@ sap.ui.define([
             return this;
         };
 
+        Chart.prototype.getVariant = function() {
+            var oToolbar = this.getAggregation("_toolbar");
+            return oToolbar  ? oToolbar._getVariantReference() : this.getAggregation("variant");
+        };
+
+        Chart.prototype.onkeydown = function(oEvent) {
+            if (oEvent.isMarked()) {
+                return;
+            }
+
+            if ((oEvent.metaKey || oEvent.ctrlKey) && oEvent.which === KeyCodes.COMMA) {
+                // CTRL (or Cmd) + COMMA key combination to open the table personalisation dialog
+                var oSettingsBtn = this._getToolbar()._oSettingsBtn;
+                if (oSettingsBtn && oSettingsBtn.getVisible() && oSettingsBtn.getEnabled()) {
+                    oSettingsBtn.firePress();
+
+                    // Mark the event to ensure that parent handlers (e.g. FLP) can skip their processing if needed. Also prevent potential browser defaults
+                    // (e.g. Cmd+, opens browser settings on Mac).
+                    oEvent.setMarked();
+                    oEvent.preventDefault();
+                }
+            }
+
+        };
+
         return Chart;
     });

package/src/sap/ui/mdc/ChartRenderer.js

@@ -42,9 +42,12 @@ sap.ui.define(['./library'],
                 oRm.style("min-height", oMDCChart.getMinHeight());
                 oRm.style("min-width", oMDCChart.getMinWidth());
                 oRm.openEnd();
-                this.renderToolbar(oRm, oMDCChart.getAggregation("_toolbar"));
+                    oRm.openStart("div");
+                    oRm.openEnd();
+                    this.renderToolbar(oRm, oMDCChart.getAggregation("_toolbar"));
+                    this.renderInfoToolbar(oRm, oMDCChart.getAggregation("_infoToolbar"));
+                    oRm.close("div");
                 this.renderBreadcrumbs(oRm, oMDCChart.getAggregation("_breadcrumbs"));
-                //this.renderInnerChart(oRm, oMDCChart._getInnerChart());
                 this.renderInnerStructure(oRm, oMDCChart.getAggregation("_innerChart"));
                 oRm.close("div");
         };
@@ -77,12 +80,12 @@ sap.ui.define(['./library'],
             }
         };
 
-        ChartRenderer.renderInnerChart = function(oRm, oInnerChart) {
-
-            if (oInnerChart) {
-                oRm.renderControl(oInnerChart);
+        ChartRenderer.renderInfoToolbar = function(oRm, oInfoToolbar) {
+            if (oInfoToolbar) {
+                oRm.renderControl(oInfoToolbar);
             }
         };
+
         ChartRenderer.renderInnerStructure = function (oRm, oInnerStructure){
             oRm.renderControl(oInnerStructure);
         };

package/src/sap/ui/mdc/Control.js

@@ -20,7 +20,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 * @abstract
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @alias sap.ui.mdc.Control
 	 *
 	 * @borrows sap.ui.mdc.mixin.DelegateMixin.awaitControlDelegate as awaitControlDelegate

package/src/sap/ui/mdc/Element.js

@@ -20,7 +20,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Element
 	 * @abstract
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @alias sap.ui.mdc.Element
 	 *
 	 * @borrows sap.ui.mdc.mixin.DelegateMixin.awaitControlDelegate as awaitControlDelegate

package/src/sap/ui/mdc/Field.js

@@ -42,12 +42,12 @@ sap.ui.define([
 	 * @implements sap.ui.core.IFormContent
 	 *
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 *
 	 * @constructor
 	 * @alias sap.ui.mdc.Field
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @since 1.54.0
 	 * @experimental As of version 1.54
 	 *

package/src/sap/ui/mdc/FilterBar.js

@@ -21,7 +21,7 @@ sap.ui.define([
 	 * The metadata information is provided via the {@link sap.ui.mdc.FilterBarDelegate FilterBarDelegate} implementation. This implementation has to be provided by the application.
 	 * @extends sap.ui.mdc.filterbar.FilterBarBase
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @constructor
 	 * @experimental As of version 1.61
 	 * @private

package/src/sap/ui/mdc/FilterBarDelegate.js

@@ -8,7 +8,7 @@
 // Delegate class used to help create content in the filterbar and fill relevant metadata
 // ---------------------------------------------------------------------------------------
 // ---------------------------------------------------------------------------------------
-sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDelegate) {
+sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate", "sap/ui/mdc/enum/FilterBarValidationStatus"], function(AggregationBaseDelegate, FilterBarValidationStatus) {
 	"use strict";
 	/**
 	 * @class Base Delegate for {@link sap.ui.mdc.FilterBar FilterBar}. Extend this object in your project to use all functionalites of the {@link sap.ui.mdc.FilterBar FilterBar}.
@@ -39,7 +39,10 @@ sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDe
 	 * This method always requires a return value once it has been called. If an item for a given property <code>sPropertyName</code>
 	 * has already been created, it is required to either return the existing instance or create a new instance.
 	 *
-	 * @public
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 */
 	FilterBarDelegate.addItem = function(sPropertyName, oControl, mPropertyBag) {
 		return AggregationBaseDelegate.addItem(sPropertyName, oControl, mPropertyBag);
@@ -58,7 +61,10 @@ sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDe
 	 * @param {Object} [mPropertyBag] Instance of property bag from SAPUI5 flexibility
 	 *
 	 * @returns {Promise} Promise that resolved with <code>true</code>, <code>false</code> to allow/prevent default behavior of the change
-	 * @public
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 */
 	FilterBarDelegate.removeItem = function(oItem, oControl, mPropertyBag) {
 		// return true within the Promise for default behavior
@@ -73,6 +79,11 @@ sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDe
 	 * @param {sap.ui.mdc.Control} oControl - The instance of a filter bar
 	 * @param {Object} mPropertyBag Instance of a property bag from the SAPUI5 flexibility change API
 	 * @returns {Promise} Promise that is resolved once the propertyInfo property has been updated
+	 *
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 */
 	FilterBarDelegate.addCondition = function(sPropertyName, oControl, mPropertyBag) {
 		return Promise.resolve();
@@ -86,6 +97,11 @@ sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDe
 	 * @param {sap.ui.mdc.Control} oControl - The instance of a filter bar
 	 * @param {Object} mPropertyBag Instance of a property bag from the SAPUI5 flexibility change API
 	 * @returns {Promise} Promise that is resolved once the propertyInfo property has been updated
+	 *
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 */
 	FilterBarDelegate.removeCondition = function(sPropertyName, oControl, mPropertyBag) {
 		return Promise.resolve();
@@ -123,6 +139,10 @@ sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDe
 	 * @property {int} maxConditions
 	 *   Defines if the filter supports multiple values <code>-1</code> or single values <code>1</code>
 	 *
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 */
 
 	/**
@@ -130,6 +150,11 @@ sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDe
 	 *
 	 * @param {sap.ui.mdc.Control} oControl Instance of an <code>sap.ui.mdc.Control</code>
 	 * @returns {Promise<sap.ui.mdc.filterbar.PropertyInfo[]>} Once resolved, an array of property info objects is returned
+	 *
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 */
 	FilterBarDelegate.fetchProperties = function(oControl) {
 		return AggregationBaseDelegate.fetchProperties(oControl);
@@ -139,11 +164,78 @@ sap.ui.define(["sap/ui/mdc/AggregationBaseDelegate"], function(AggregationBaseDe
 	 * This method is called when the 'Clear' button was pressed.
 	 *
 	 * @param {sap.ui.mdc.Control} oControl - The instance of a filter bar
-	 * @returns {Promise} Promise that is resolved once the action completes.
+	 * @returns {Promise} Promise that is resolved once the action completes
+	 *
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 */
 	FilterBarDelegate.clearFilters = function(oControl) {
 		return Promise.resolve();
     };
 
+	/**
+	 * A validator to evaluate the filter bar state.
+	 *
+	 * @param {sap.ui.mdc.FilterBar} oFilterBar Instance of a <code>sap.ui.mdc.FilterBar</code>
+	 * @param {map} [mValidation] Object describing the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
+	 * @param {string} [mValidation.status] Status of the validation {@link sap.ui.mdc.enum.FilterBarValidationStatus}
+	 * @returns {sap.ui.mdc.enum.FilterBarValidationStatus} The inner filter bar state
+	 *
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+    FilterBarDelegate.determineValidationState = function(oFilterBar) {
+		 return oFilterBar.checkFilters();
+	};
+
+	/**
+	 * Visualizes the filter bar validation state.
+	 *
+	 * @param {sap.ui.mdc.FilterBar} oFilterBar Instance of a <code>sap.ui.mdc.FilterBar</code>
+	 * @param {map} mValidation Describes the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
+	 * @param {sap.ui.mdc.enum.FilterBarValidationStatus} mValidation.status of the validation as returned via {@link sap.ui.mdc.filterbar.FilterBarBase#checkValidationState checkValidationState}
+	 *
+	 * @private
+	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+    FilterBarDelegate.visualizeValidationState = function(oFilterBar, mValidation) {
+		 var sErrorMessage;
+
+		 if (mValidation.status === FilterBarValidationStatus.NoError) {
+			 return;
+		 }
+
+		 if (mValidation.status === FilterBarValidationStatus.RequiredHasNoValue) {
+			 sErrorMessage = oFilterBar.getText("filterbar.REQUIRED_CONDITION_MISSING");
+		 } else if (mValidation.status === FilterBarValidationStatus.FieldInErrorState ) {
+			 sErrorMessage = oFilterBar.getText("filterbar.VALIDATION_ERROR");
+		 }
+
+		 if (oFilterBar.getShowMessages() && !oFilterBar._isLiveMode()) {
+
+			 sap.ui.require(["sap/m/MessageBox", "sap/base/Log"], function (MessageBox, Log) {
+				 try {
+
+					 if (oFilterBar._bIsBeingDestroyed) {
+						 return;
+					 }
+					 MessageBox.error(sErrorMessage, {
+						 styleClass: (this.$() && this.$().closest(".sapUiSizeCompact").length) ? "sapUiSizeCompact" : "",
+						 onClose: oFilterBar.setFocusOnFirstErroneousField.bind(oFilterBar)
+					 });
+				 } catch (x) {
+					 Log.error(x.message);
+				 }
+			 });
+		 }
+	};
+
+
 	return FilterBarDelegate;
 });

package/src/sap/ui/mdc/FilterField.js

@@ -33,12 +33,12 @@ sap.ui.define([
 	 * @extends sap.ui.mdc.field.FieldBase
 	 *
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 *
 	 * @constructor
 	 * @alias sap.ui.mdc.FilterField
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @since 1.48.0
 	 *
 	 * @experimental As of version 1.48

package/src/sap/ui/mdc/Link.js

@@ -45,7 +45,7 @@ sap.ui.define([
 	 * @extends sap.ui.mdc.field.FieldInfoBase
 	 *
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 *
 	 * @constructor
 	 * @alias sap.ui.mdc.Link
@@ -136,6 +136,9 @@ sap.ui.define([
 	 */
 	Link.prototype.isTriggerable = function() {
 		return this.retrieveLinkType().then(function(oLinkTypeObject) {
+			if (!oLinkTypeObject) {
+				return false;
+			}
 			var oRuntimeLinkTypePromise = oLinkTypeObject.runtimeType;
 			var oInitialLinkType = oLinkTypeObject.initialType ? oLinkTypeObject.initialType : oLinkTypeObject;
 
@@ -188,6 +191,10 @@ sap.ui.define([
 	 */
 	Link.prototype._retrieveDirectLinkItem = function() {
 		return this.retrieveLinkType().then(function(oLinkTypeObject) {
+			if (!oLinkTypeObject) {
+				return null;
+			}
+
 			if (this._linkTypeHasDirectLink(this._oLinkType)) {
 				return this._oLinkType.directLink;
 			}
@@ -515,7 +522,7 @@ sap.ui.define([
 		if (this.awaitControlDelegate()) {
 			return this.awaitControlDelegate().then(function() {
 				var oPayload = Object.assign({}, this.getPayload());
-				return this.getControlDelegate().fetchLinkType(oPayload, this);
+				return this._bIsBeingDestroyed ? Promise.resolve() : this.getControlDelegate().fetchLinkType(oPayload, this);
 			}.bind(this));
 		}
 		SapBaseLog.error("mdc.Link retrieveLinkType: control delegate is not set - could not load LinkType from delegate.");

package/src/sap/ui/mdc/MultiValueField.js

@@ -35,7 +35,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.mdc.MultiValueField
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @since 1.93.0
 	 *
 	 * @private