@openui5/sap.ui.mdc 1.93.3 → 1.96.2

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

@@ -0,0 +1,147 @@
+/*
+ * ! OpenUI5
+ * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+// ---------------------------------------------------------------------------------------
+// Helper class used to execute model specific logic in ValueHelp
+// ---------------------------------------------------------------------------------------
+
+sap.ui.define([
+	"sap/ui/mdc/BaseDelegate",
+	"sap/ui/model/FilterType"
+], function(
+	BaseDelegate,
+	FilterType
+) {
+	"use strict";
+
+	/**
+	 * @class Delegate class for {@link sap.ui.mdc.ValueHelp ValueHelp}.<br>
+	 * <b>Note:</b> The class is experimental and the API/behavior is not finalized and hence this should not be used for productive usage.
+	 *
+	 * @author SAP SE
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 * @experimental As of version 1.95
+	 * @since 1.95.0
+	 * @alias sap.ui.mdc.ValueHelpDelegate
+	 */
+	var ValueHelpDelegate = Object.assign({}, BaseDelegate);
+
+	/**
+	 * Requests the content of the value help.
+	 *
+	 * This function is called when the value help is opened or a key or description is requested.
+	 *
+	 * So, depending on the value help content used, all content controls and data need to be assigned.
+	 * Once they are assigned and the data is set, the returned <code>Promise</code> needs to be resolved.
+	 * Only then does the value help continue opening or reading data.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.mdc.valuehelp.base.Container} oContainer Container instance
+	 * @returns {Promise} Promise that is resolved if all content is available
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	ValueHelpDelegate.retrieveContent = function (oPayload, oContainer) {
+		return Promise.resolve();
+	};
+
+	/**
+	 * Checks if a <code>ListBinding</code> supports $Search.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding ListBinding
+	 * @returns {boolean} true if $search is supported
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
+	ValueHelpDelegate.isSearchSupported = function(oPayload, oListBinding) {
+		return false;
+	};
+
+	/**
+	 * Executes a search in a <code>ListBinding</code>.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding ListBinding
+	 * @param {string} sSearch Search string
+	 * @returns {Promise} Promise that is resolved if search is executed
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
+	ValueHelpDelegate.executeSearch = function(oPayload, oListBinding, sSearch) {
+		return Promise.resolve();
+	};
+
+	/**
+	 * Executes a filter in a <code>ListBinding</code>.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding List binding
+	 * @param {sap.ui.model.Filter} oFilter Filter
+	 * @param {int} iRequestedItems Number of requested items
+	 * @returns {Promise<sap.ui.model.ListBinding>} Promise that is resolved if search is executed
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
+	ValueHelpDelegate.executeFilter = function(oPayload, oListBinding, oFilter, iRequestedItems) {
+
+		if (oListBinding.isA("sap.ui.model.json.JSONListBinding")) { // TODO: find way unique for all ListBindings
+			oListBinding.filter(oFilter, FilterType.Application);
+			return Promise.resolve(oListBinding);
+		} else { // oData V2
+			var fnResolve;
+			var fnCallback = function() {
+				fnResolve(oListBinding);
+			};
+			oListBinding.attachEventOnce("dataReceived", fnCallback);
+			oListBinding.initialize();
+			oListBinding.filter(oFilter, FilterType.Application);
+			oListBinding.getContexts(0, iRequestedItems); // trigger request. not all entries needed, we only need to know if there is one, none or more
+			return new Promise(function(fResolve, fReject) {
+				fnResolve = fResolve;
+			});
+		}
+
+	};
+
+	/**
+	 * Checks if at least one <code>PropertyBinding</code> is waiting for an update.
+	 * As long as the value has not been set for <code>PropertyBinding</code>,
+	 * <code>ValueHelp</code> needs to wait.
+	 *
+	 * This check is used when selecting the description for a key if in parameters are used.
+	 * The description can only be determined if the values of the in parameters are known.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.PropertyBinding[]} aBindings <code>PropertyBinding</code> array to check
+	 * @returns {null|Promise} <code>Promise</code> that is resolved once every <code>PropertyBinding</code> has been updated
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
+	ValueHelpDelegate.checkBindingsPending = function(oPayload, aBindings) {
+		return null;
+	};
+
+	/**
+	 * Checks if the <code>ListBinding</code> is waiting for an update.
+	 * As long as the context has not been set for <code>ListBinding</code>,
+	 * <code>FieldValueHelp</code> needs to wait.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding <code>ListBinding</code> to check
+	 * @param {object} oListBindingInfo <code>ListBindingInfo</code> to check
+	 * @returns {boolean|Promise<boolean>} <code>Promise</code> that is resolved once <code>ListBinding</code> has been updated
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
+	ValueHelpDelegate.checkListBindingPending = function(oPayload, oListBinding, oListBindingInfo) {
+		return false;
+	};
+
+	return ValueHelpDelegate;
+});

package/src/sap/ui/mdc/actiontoolbar/ActionToolbarAction.js

@@ -5,13 +5,31 @@
  */
 sap.ui.define([
     "sap/ui/core/Control",
-    "sap/m/ToolbarSeparator",
-    "sap/ui/base/ManagedObjectObserver",
     "sap/ui/mdc/actiontoolbar/ActionToolbarActionRenderer",
     "sap/ui/mdc/enum/ActionToolbarActionAlignment"
-], function(Control, ToolbarSeparator, ManagedObjectObserver, ActionToolbarActionRenderer, ActionToolbarActionAlignment) {
+], function(Control, ActionToolbarActionRenderer, ActionToolbarActionAlignment) {
     "use strict";
 
+	/**
+	 * Constructor for a new ActionToolbarAction.<br>
+	 * <b>Note:</b><br>
+	 * The control is experimental and the API / behavior is not finalized. It should only be used internally in other mdc controls (e.g.
+	 * chart/table).<br>
+	 *
+	 * @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 The action for an {@link sap.ui.mdc.ActionToolbar ActionToolbar}) control
+	 * @extends sap.ui.core.Control
+	 * @author SAP SE
+	 * @version 1.96.2
+	 * @constructor
+	 * @private
+	 * @since 1.58
+	 * @experimental As of version 1.58
+	 * @ui5-restricted sap.ui.mdc
+	 * @alias sap.ui.mdc.actiontoolbar.ActionToolbarAction
+	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
+	 */
     var ActionToolbarAction = Control.extend("sap.ui.mdc.actiontoolbar.ActionToolbarAction", {
         metadata: {
             library: "sap.ui.mdc",
@@ -19,6 +37,9 @@ sap.ui.define([
 				"sap.m.IOverflowToolbarContent"
 			],
             properties: {
+                /**
+                 * Layout information
+                 */
                 layoutInformation: {
                     type: "object",
                     defaultValue: {
@@ -30,113 +51,18 @@ sap.ui.define([
             },
             defaultAggregation: "action",
             aggregations: {
+                /**
+                 * Action
+                 */
                 action: {
                     type: "sap.ui.core.Control",
 					multiple: false
                 }
             },
-            associations: {
-                separators: {
-                    type: "sap.m.ToolbarSeparator",
-                    multiple: true
-                }
-            },
             renderer: ActionToolbarActionRenderer
         }
     });
 
-    ActionToolbarAction.prototype.init = function() {
-        this._bSeparatorBeforeIsVisible = false;
-        this._bSeparatorAfterIsVisible = false;
-        this._oSeparatorBefore = new ToolbarSeparator({
-            visible: this._bSeparatorBeforeIsVisible
-        });
-        this._oSeparatorAfter = new ToolbarSeparator({
-            visible: this._bSeparatorAfterIsVisible
-        });
-        this.addAssociation("separators", this._oSeparatorBefore);
-        this.addAssociation("separators", this._oSeparatorAfter);
-
-        this._oObserver = new ManagedObjectObserver(this._observeChanges.bind(this));
-        this._oObserver.observe(this, {
-			parent: true,
-            properties: ["visible"]
-		});
-    };
-
-    ActionToolbarAction.prototype.exit = function() {
-        if (this._oSeparatorBefore) {
-            this._oSeparatorBefore.destroy();
-            this._oSeparatorBefore = undefined;
-        }
-        if (this._oSeparatorAfter) {
-            this._oSeparatorAfter.destroy();
-            this._oSeparatorAfter = undefined;
-        }
-        this._bSeparatorBeforeIsVisible = undefined;
-        this._bSeparatorAfterIsVisible = undefined;
-    };
-
-    ActionToolbarAction.prototype.updateSeparators = function() {
-        var sAlignment = this.getLayoutInformation().alignment;
-        var sAggregationName = this.getLayoutInformation().aggregationName;
-        var oActionToolbar = this.getParent();
-        var oActionToolbarAggregation = oActionToolbar.getAggregation(sAggregationName);
-
-        var aControlsInAggregation = oActionToolbarAggregation.filter(function(oControl) {
-            return !oControl.isA("sap.ui.mdc.actiontoolbar.ActionToolbarAction") && oControl !== this && oControl !== this._oSeparatorBefore && oControl !== this._oSeparatorAfter;
-        }.bind(this));
-
-        var aControlsInAggregationAfter = aControlsInAggregation.filter(function(oControl) {
-            return oActionToolbarAggregation.indexOf(oControl) > oActionToolbarAggregation.indexOf(this) && oControl.getVisible();
-        }.bind(this));
-
-        var aControlsInAggregationBefore = aControlsInAggregation.filter(function(oControl) {
-            return oActionToolbarAggregation.indexOf(oControl) < oActionToolbarAggregation.indexOf(this) && oControl.getVisible();
-        }.bind(this));
-
-        var bSeparatorBeforeVisible = sAlignment === ActionToolbarActionAlignment.End &&
-            !oActionToolbar._aggregationContainsActionSeparatorBefore(sAggregationName) &&
-            aControlsInAggregationBefore.length > 0;
-
-        var bSeparatorAfterVisible = sAlignment === ActionToolbarActionAlignment.Begin &&
-            !oActionToolbar._aggregationContainsActionSeparatorAfter(sAggregationName) &&
-            aControlsInAggregationAfter.length > 0;
-
-        this._oSeparatorBefore.setVisible(this.getAction() && this.getAction().getVisible() && bSeparatorBeforeVisible);
-        this._oSeparatorAfter.setVisible(this.getAction() && this.getAction().getVisible() && bSeparatorAfterVisible);
-    };
-
-    ActionToolbarAction.prototype.getSeparatorBefore = function() {
-        return this._oSeparatorBefore;
-    };
-
-    ActionToolbarAction.prototype.getSeparatorAfter = function() {
-        return this._oSeparatorAfter;
-    };
-
-    ActionToolbarAction.prototype._observeChanges = function(oChanges) {
-        if (oChanges.type === "parent" && oChanges.mutation === "unset") {
-            this.destroy();
-        }
-
-        if (oChanges.name === "property" && oChanges.name === "visible") {
-            this.updateSeparators();
-        }
-    };
-
-    ActionToolbarAction.prototype._onBeforeEnterOverflow = function() {
-        this._bSeparatorBeforeIsVisible = this._oSeparatorBefore.getVisible();
-        this._bSeparatorAfterIsVisible = this._oSeparatorAfter.getVisible();
-        this._oSeparatorBefore.setVisible(false);
-        this._oSeparatorAfter.setVisible(false);
-    };
-
-    ActionToolbarAction.prototype._onAfterExitOverflow = function() {
-        this._oSeparatorBefore.setVisible(this._bSeparatorBeforeIsVisible);
-        this._oSeparatorAfter.setVisible(this._bSeparatorAfterIsVisible);
-    };
-
     /**
 	 * Sets the behavior of the <code>ActionToolbarAction</code> inside an <code>OverflowToolbar</code> configuration.
 	 *
@@ -147,13 +73,32 @@ sap.ui.define([
         var oConfig = {
 			canOverflow: true
 		};
-
-		oConfig.onBeforeEnterOverflow = this._onBeforeEnterOverflow.bind(this);
-
+        oConfig.onBeforeEnterOverflow = this._onBeforeEnterOverflow.bind(this);
         oConfig.onAfterExitOverflow = this._onAfterExitOverflow.bind(this);
 
 		return oConfig;
     };
 
+    ActionToolbarAction.prototype._onBeforeEnterOverflow = function() {
+        if (this.getParent()) {
+            this.getParent()._updateSeparators();
+        }
+    };
+
+    ActionToolbarAction.prototype._onAfterExitOverflow = function() {
+        if (this.getParent()) {
+            this.getParent()._updateSeparators();
+        }
+    };
+
+    /**
+     *
+     * @returns {String} a text defining the label of this <code>ActionToolbarAction</code> defined by the inner action.
+     */
+    ActionToolbarAction.prototype.getLabel = function() {
+        var oAction = this.getAction();
+        return oAction && oAction.getText ? oAction.getText() : this.getId();
+    };
+
     return ActionToolbarAction;
 });

package/src/sap/ui/mdc/chart/DimensionItem.js

@@ -27,14 +27,14 @@ sap.ui.define([
 	 *        The control is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
 	 * @extends sap.ui.mdc.chart.Item
 	 * @author SAP SE
-	 * @constructor The API/behaviour is not finalised and hence this control should not be used for productive usage.
 	 * @private
-	 * @experimental
+	 * @experimental As of version 1.61
+	 * @ui5-restricted sap.ui.mdc
 	 * @since 1.61
 	 * @alias sap.ui.mdc.chart.DimensionItem
 	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
 	 */
-	var DimensionItem = Item.extend("sap.ui.mdc.chart.DimensionItem", /** @lends sap.ui.mdc.chart.Item.prototype */
+	var DimensionItem = Item.extend("sap.ui.mdc.chart.DimensionItem", /** @lends sap.ui.mdc.chart.DimensionItem.prototype */
 	{
 		metadata: {
 			"abstract": true,

package/src/sap/ui/mdc/chart/Item.js

@@ -8,7 +8,6 @@ sap.ui.define([
 ], function(Element) {
 	"use strict";
 
-	// Provides the Item class.
 	/**
 	 * Constructor for a new Item.
 	 *
@@ -20,10 +19,10 @@ sap.ui.define([
 	 *        The control is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
 	 * @extends sap.ui.core.Element
 	 * @author SAP SE
-	 * @constructor The API/behaviour is not finalised and hence this control should not be used for productive usage.
 	 * @private
-	 * @experimental
+	 * @ui5-restricted sap.ui.mdc
 	 * @since 1.61
+	 * @experimental As of version 1.61
 	 * @alias sap.ui.mdc.chart.Item
 	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
 	 */

package/src/sap/ui/mdc/chart/MeasureItem.js

@@ -23,9 +23,9 @@ sap.ui.define([
 	 *        The control is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
 	 * @extends sap.ui.mdc.chart.Item
 	 * @author SAP SE
-	 * @constructor The API/behaviour is not finalised and hence this control should not be used for productive usage.
 	 * @private
-	 * @experimental
+	 * @experimental As of version 1.61
+	 * @ui5-restricted sap.ui.mdc
 	 * @since 1.61
 	 * @alias sap.ui.mdc.chart.MeasureItem
 	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel

package/src/sap/ui/mdc/chart/SelectionDetailsActions.js

@@ -8,8 +8,27 @@ sap.ui.define([
 ], function(Element) {
 	"use strict";
 
-	// The aggregation to feed details actions for dapaoint selection in the mdc chart
-	var SelectionDetailsActions = Element.extend("sap.ui.mdc.chart.SelectionDetailsActions", {
+	/**
+ 	 * The aggregation to feed details actions for dapaoint selection in the mdc chart
+	 *
+	 * @param {string} [sId] Optional ID for the new element; generated automatically if no non-empty ID is given
+	 *      Note: this can be omitted, no matter whether <code>mSettings</code> will be given or not!
+	 * @param {object} [mSettings] Object with initial settings for the new control
+	 *
+	 * @class The aggregation to feed details actions for dapaoint selection in the mdc chart
+	 *
+	 * @extends sap.ui.mdc.Element
+	 * @abstract
+	 * @author SAP SE
+	 * @version 1.96.2
+	 * @alias sap.ui.mdc.chart.SelectionDetailsActions
+	 *
+	 * @private
+	 * @since 1.61
+	 * @experimental As of version 1.61
+	 * @ui5-restricted sap.ui.mdc
+	 */
+	 var SelectionDetailsActions = Element.extend("sap.ui.mdc.chart.SelectionDetailsActions", {
 
 		metadata: {
 			library: "sap.ui.mdc",