@openui5/sap.ui.mdc 1.100.0 → 1.102.1

package/src/sap/ui/mdc/valuehelp/base/Container.js

@@ -20,11 +20,11 @@ sap.ui.define([
 	/**
 	 * Constructor for a new <code>Container</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 Container for the <code>ValueHelp</code> element.
+	 * @param {string} [sId] ID for the new element, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new element
+	 * @class Container for the {@link sap.ui.mdc.ValueHelp ValueHelp} element.
 	 * @extends sap.ui.core.Element
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @constructor
 	 * @abstract
 	 * @private
@@ -112,7 +112,10 @@ sap.ui.define([
 				 */
 				requestDelegateContent: {
 					parameters: {
-						container: { type: "sap.ui.mdc.valuehelp.base.Container" }
+						/**
+						 * Content wrapper id for which contents are requested
+						 */
+						contentId: { type: "string" }
 					}
 				},
 				/**
@@ -127,7 +130,7 @@ sap.ui.define([
 						/**
 						 * True if the focus should be set back to the field.
 						 */
-						bLeaveFocus: { type: "boolean" },
+						leaveFocus: { type: "boolean" },
 						/**
 						 * Navigated condition.
 						 *
@@ -155,44 +158,50 @@ sap.ui.define([
 		if (oChanges.name === "content") {
 			var oContent = oChanges.child;
 			if (oChanges.mutation === "remove") {
-				oContent.unbindProperty("filterValue");
-				oContent.unbindProperty("conditions");
-				oContent.unbindProperty("config");
-				oContent.detachConfirm(this._handleConfirmed, this);
-				oContent.detachCancel(this._handleCanceled, this);
-				oContent.detachSelect(this._handleSelect, this);
-				oContent.detachRequestDelegateContent(this._handleRequestDelegateContent, this);
-
-				if (oContent.detachNavigated) {
-					oContent.detachNavigated(this._handleNavigated, this);
-				}
-
-				if (oContent.detachRequestSwitchToDialog) {
-					oContent.detachRequestSwitchToDialog(this._handleRequestSwitchToDialog, this);
-				}
+				this._unbindContent(oContent);
 
 			} else {
-				oContent.bindProperty("filterValue", { path: "/filterValue", model: "$valueHelp", mode: BindingMode.OneWay}); // inherit from ValueHelp
-				var oBindingOptions = { path: "/conditions", model: "$valueHelp", mode: BindingMode.OneWay};
-				if (oContent._formatConditions) {
-					oBindingOptions.formatter = oContent._formatConditions.bind(oContent);
-				}
-				oContent.bindProperty("conditions", oBindingOptions); // inherit from ValueHelp
-				oContent.bindProperty("config", { path: "/_config", model: "$valueHelp", mode: BindingMode.OneWay}); // inherit from ValueHelp
+				this._bindContent(oContent);
+			}
+		}
+	};
 
-				oContent.attachConfirm(this._handleConfirmed, this);
-				oContent.attachCancel(this._handleCanceled, this);
-				oContent.attachSelect(this._handleSelect, this);
-				oContent.attachRequestDelegateContent(this._handleRequestDelegateContent, this);
+	Container.prototype._bindContent = function (oContent) {
+		oContent.bindProperty("filterValue", { path: "/filterValue", model: "$valueHelp", mode: BindingMode.OneWay}); // inherit from ValueHelp
+		var oBindingOptions = { path: "/conditions", model: "$valueHelp", mode: BindingMode.OneWay};
+		if (oContent._formatConditions) {
+			oBindingOptions.formatter = oContent._formatConditions.bind(oContent);
+		}
+		oContent.bindProperty("conditions", oBindingOptions); // inherit from ValueHelp
+		oContent.bindProperty("config", { path: "/_config", model: "$valueHelp", mode: BindingMode.OneWay}); // inherit from ValueHelp
 
-				if (oContent.attachNavigated) {
-					oContent.attachNavigated(this._handleNavigated, this);
-				}
+		oContent.attachConfirm(this._handleConfirmed, this);
+		oContent.attachCancel(this._handleCanceled, this);
+		oContent.attachSelect(this._handleSelect, this);
 
-				if (oContent.attachRequestSwitchToDialog) {
-					oContent.attachRequestSwitchToDialog(this._handleRequestSwitchToDialog, this);
-				}
-			}
+		if (oContent.attachNavigated) {
+			oContent.attachNavigated(this._handleNavigated, this);
+		}
+
+		if (oContent.attachRequestSwitchToDialog) {
+			oContent.attachRequestSwitchToDialog(this._handleRequestSwitchToDialog, this);
+		}
+	};
+
+	Container.prototype._unbindContent = function (oContent) {
+		oContent.unbindProperty("filterValue");
+		oContent.unbindProperty("conditions");
+		oContent.unbindProperty("config");
+		oContent.detachConfirm(this._handleConfirmed, this);
+		oContent.detachCancel(this._handleCanceled, this);
+		oContent.detachSelect(this._handleSelect, this);
+
+		if (oContent.detachNavigated) {
+			oContent.detachNavigated(this._handleNavigated, this);
+		}
+
+		if (oContent.detachRequestSwitchToDialog) {
+			oContent.detachRequestSwitchToDialog(this._handleRequestSwitchToDialog, this);
 		}
 	};
 
@@ -305,10 +314,6 @@ sap.ui.define([
 		this.fireCancel();
 	};
 
-	Container.prototype._handleRequestDelegateContent = function (oEvent) {
-		this.fireRequestDelegateContent({container: this});
-	};
-
 	Container.prototype._handleSelect = function (oEvent) {
 		this.fireSelect({type: oEvent.getParameter("type"), conditions: oEvent.getParameter("conditions")});
 	};
@@ -355,15 +360,18 @@ sap.ui.define([
 	 * @param {object} oConfig Configuration
 	 * @param {any} oConfig.value Value as entered by user
 	 * @param {any} [oConfig.parsedValue] Value parsed by type to fit the data type of the key
-	 * @param {object} [oConfig.inParameters] In parameters for the key (as a key must not be unique.)
-	 * @param {object} [oConfig.outParameters] Out parameters for the key (as a key must not be unique.)
+	 * @param {object} [oConfig.context] Contextual information provided by condition payload or inParameters/outParameters. This is only filled if the description needs to be determined for an existing condition.
+	 * @param {object} [oConfig.context.inParameter] inParameters of the current condition
+	 * @param {object} [oConfig.context.ouParameter] outParameters of the current condition
+	 * @param {object} [oConfig.context.payload] payload of the current condition
 	 * @param {sap.ui.model.Context} [oConfig.bindingContext] <code>BindingContext</code> of the checked field. Inside a table the <code>ValueHelp</code> element might be connected to a different row.
-	 * @param {boolean} [oConfig.checkKeyFirst] If set, the container checks first if the value fits a key // TODO: not longer needed?
-	 * @param {boolean} oConfig.checkKey If set, the container checks only if there is an item with the given key. This is set to <code>false</code> if the value cannot be a valid key because of type validation.
-	 * @param {boolean} oConfig.checkDescription If set, the container checks only if there is an item with the given description. This is set to <code>false</code> if only the key is used in the field.
+	 * @param {boolean} [oConfig.checkKeyFirst] If set, the value help checks first if the value fits a key // TODO: not longer needed?
+	 * @param {boolean} oConfig.checkKey If set, the value help checks only if there is an item with the given key. This is set to <code>false</code> if the value cannot be a valid key because of type validation.
+	 * @param {boolean} oConfig.checkDescription If set, the value help checks only if there is an item with the given description. This is set to <code>false</code> if only the key is used in the field.
 	 * @param {sap.ui.mdc.condition.ConditionModel} [oConfig.conditionModel] <code>ConditionModel</code>, in case of <code>FilterField</code>
 	 * @param {string} [oConfig.conditionModelName] Name of the <code>ConditionModel</code>, in case of <code>FilterField</code>
 	 * @param {boolean} [oConfig.caseSensitive] If set, the check is done case sensitive
+	 * @param {sap.ui.core.Control} oConfig.control Instance of the calling control
 	 * @returns {Promise<sap.ui.mdc.field.FieldHelpItem>} Promise returning object containing description, key, in and out parameters.
 	 * @throws {sap.ui.model.FormatException|sap.ui.model.ParseException} if entry is not found or not unique
 	 *
@@ -456,7 +464,7 @@ sap.ui.define([
 
 	/**
 	 * Determines if the container provides a own scroll functionality.
-	 * If not, the <code>Content</code> needs to provide a scrolling solution like a <code>ScrollContainer</code>.
+	 * If not, the <code>Content</code> needs to provide a scrolling solution like a {@link sap.m.ScrollContainer ScrollContainer}.
 	 *
 	 * <b>Note:</b> This function is used by the container and content and must not be used from outside
 	 *
@@ -475,7 +483,7 @@ sap.ui.define([
 	 *
 	 * <b>Note:</b> This function is used by the container and content and must not be used from outside
 	 *
-	 * @returns {sap.ui.mdc.BaseDelegate} <code>typeUtil</code> made available by a delegate module
+	 * @returns {sap.ui.mdc.BaseDelegate} <code>Delegate</code> module
 	 * @throws Throws an error if the delegate module is not available
 	 *
 	 * @private
@@ -508,7 +516,7 @@ sap.ui.define([
 	 *
 	 * <b>Note:</b> This function is used by the container and content and must not be used from outside
 	 *
-	 * @returns {Promise} Returns a <code>Promise</code> reflecting the delegate initialization
+	 * @returns {Promise} <code>Promise</code> reflecting the delegate initialization
 	 * @throws Throws an error if the delegate module is not available
 	 *
 	 * @private
@@ -568,7 +576,7 @@ sap.ui.define([
 	/**
 	 * Returns the aria attributes the field needs from the value help
 	 *
-	 * @param {int} iMaxConditions maximal conditions allowed (as FieldHelp might not be connected to a field)
+	 * @param {int} iMaxConditions maximal conditions allowed (as <code>ValueHelp</code> might not be connected to a field)
 	 * @returns {object} object with the aria-attibutes
 	 * @private
 	 * @ui5-restricted sap.ui.mdc.ValueHelp
@@ -662,6 +670,17 @@ sap.ui.define([
 		return oResult;
 	};
 
+
+	Container.prototype._getRetrieveDelegateContentPromise = function () {
+		var oValueHelp = this.getParent();
+		return 	oValueHelp && oValueHelp._retrievePromise("delegateContent");
+	};
+
+	Container.prototype.getSelectedContent = function () {
+		var oContent = this.getContent();
+		return oContent && oContent[0];
+	};
+
 	Container.prototype.exit = function() {
 		this._oObserver.disconnect();
 		this._oObserver = undefined;

package/src/sap/ui/mdc/valuehelp/base/Content.js

@@ -28,11 +28,11 @@ sap.ui.define([
 	/**
 	 * Constructor for a new <code>Content</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 Content for the <code>sap.ui.mdc.valuehelp.base.Container</code> element.
+	 * @param {string} [sId] ID for the new element, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new element
+	 * @class Content for the {@link sap.ui.mdc.valuehelp.base.Container Container} element.
 	 * @extends sap.ui.core.Element
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @constructor
 	 * @abstract
 	 * @private
@@ -95,6 +95,14 @@ sap.ui.define([
 					type: "object",
 					defaultValue: {}//,
 //					visibility: "hidden"
+				},
+				 /**
+				 * Hide content temporary.
+				 */
+				visible: {
+					type: "boolean",
+					group : "Appearance",
+					defaultValue: true
 				}
 
 			},
@@ -144,10 +152,7 @@ sap.ui.define([
 				 * Fired if the change is cancelled.
 				 */
 				cancel: {},
-				/**
-				 * Fired if the content requests the delegate content.
-				 */
-				requestDelegateContent: {},
+
 				/**
 				 * Fired if the value help should switch to dialog mode.
 				 */
@@ -160,7 +165,7 @@ sap.ui.define([
 						/**
 						 * True if the focus should be set back to the field.
 						 */
-						bLeaveFocus: { type: "boolean" },
+						leaveFocus: { type: "boolean" },
 						/**
 						 * Navigated condition.
 						 *
@@ -244,6 +249,16 @@ sap.ui.define([
 
 	};
 
+	/**
+	 * Finalize content before it is shown
+	 *
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.valuehelp.base.Container
+	 */
+	Content.prototype.onBeforeShow = function () {
+
+	};
+
 	/**
 	 * Called if the content will be shown.
 	 *
@@ -276,15 +291,18 @@ sap.ui.define([
 	 * @param {object} oConfig Configuration
 	 * @param {any} oConfig.value Value as entered by user
 	 * @param {any} [oConfig.parsedValue] Value parsed by type to fit the data type of the key
-	 * @param {object} [oConfig.inParameters] In parameters for the key (as a key must not be unique.)
-	 * @param {object} [oConfig.outParameters] Out parameters for the key (as a key must not be unique.)
+	 * @param {object} [oConfig.context] Contextual information provided by condition payload or inParameters/outParameters. This is only filled if the description needs to be determined for an existing condition.
+	 * @param {object} [oConfig.context.inParameter] inParameters of the current condition
+	 * @param {object} [oConfig.context.ouParameter] outParameters of the current condition
+	 * @param {object} [oConfig.context.payload] payload of the current condition
 	 * @param {sap.ui.model.Context} [oConfig.bindingContext] <code>BindingContext</code> of the checked field. Inside a table the <code>ValueHelp</code> element might be connected to a different row.
-	 * @param {boolean} [oConfig.checkKeyFirst] If set, the content checks first if the value fits a key // TODO: not longer needed?
-	 * @param {boolean} oConfig.checkKey If set, the content checks only if there is an item with the given key. This is set to <code>false</code> if the value cannot be a valid key because of type validation.
-	 * @param {boolean} oConfig.checkDescription If set, the content checks only if there is an item with the given description. This is set to <code>false</code> if only the key is used in the field.
+	 * @param {boolean} [oConfig.checkKeyFirst] If set, the value help checks first if the value fits a key // TODO: not longer needed?
+	 * @param {boolean} oConfig.checkKey If set, the value help checks only if there is an item with the given key. This is set to <code>false</code> if the value cannot be a valid key because of type validation.
+	 * @param {boolean} oConfig.checkDescription If set, the value help checks only if there is an item with the given description. This is set to <code>false</code> if only the key is used in the field.
 	 * @param {sap.ui.mdc.condition.ConditionModel} [oConfig.conditionModel] <code>ConditionModel</code>, in case of <code>FilterField</code>
 	 * @param {string} [oConfig.conditionModelName] Name of the <code>ConditionModel</code>, in case of <code>FilterField</code>
 	 * @param {boolean} [oConfig.caseSensitive] If set, the check is done case sensitive
+	 * @param {sap.ui.core.Control} oConfig.control Instance of the calling control
 	 * @returns {Promise<sap.ui.mdc.field.FieldHelpItem>} Promise returning object containing description, key, in and out parameters.
 	 * @throws {sap.ui.model.FormatException|sap.ui.model.ParseException} if entry is not found or not unique
 	 *
@@ -339,16 +357,15 @@ sap.ui.define([
 	/**
 	 * Creates a condition based on the used operator.
 	 *
-	 * @param {string} vValue Value of the condition. For item conditions this must be the key.
+	 * @param {any} vValue Value of the condition. For item conditions this must be the key.
 	 * @param {string} [sDescription] Description of the operator
-	 * @param {object} [oInParameters] In parameters of the condition
-	 * @param {object} [oOutParameters] Out parameters of the condition
+	 * @param {object} [oPayload] payload
 	 * @returns {sap.ui.mdc.condition.ConditionObject} The new condition object with the maintained operator along with <code>sKey</code> and <code>sDescription</code> as <code>aValues</code>
 	 * @private
-	 * @ui5-restricted FieldHelp subclasses
+	 * @ui5-restricted ValueHelp subclasses
 	 * @ui5-metamodel This method also will be described in the UI5 (legacy) designtime metamodel
 	 */
-	Content.prototype._createCondition = function(vValue, sDescription, oInParameters, oOutParameters) {
+	Content.prototype._createCondition = function(vValue, sDescription, oPayload) {
 
 		var oOperator = _getOperator.call(this);
 
@@ -358,8 +375,7 @@ sap.ui.define([
 			aValues.push(sDescription);
 		}
 
-		return Condition.createCondition(oOperator.name, aValues, oInParameters, oOutParameters, ConditionValidated.Validated); // Conditions from help are always validated
-
+		return Condition.createCondition(oOperator.name, aValues, undefined, undefined, ConditionValidated.Validated, oPayload); // Conditions from help are always validated
 	};
 
 	/**
@@ -435,7 +451,7 @@ sap.ui.define([
 
 	/**
 	 * Determines if the the content needs to provide a scrolling mechanism like a
-	 * <code>ScrollContainer</code>
+	 * {@link sap.m.ScrollContainer ScrollContainer}
 	 *
 	 * <b>Note:</b> This function is used by the content and must not be used from outside
 	 *
@@ -479,6 +495,11 @@ sap.ui.define([
 		return oContainer && oContainer.isValueHelpDelegateInitialized();
 	};
 
+	Content.prototype._getControl = function () {
+		var oContainer = this.getParent();
+		return oContainer && oContainer._getControl();
+	};
+
 	Content.prototype.getCount = function (aConditions) {
 		return 0;
 	};
@@ -488,7 +509,7 @@ sap.ui.define([
 	 *
 	 * <b>Note</b> This function needs only to be implemented for <code>Content</code>
 	 * implementing the <code>sap.ui.mdc.valuehelp.Popover</code> container.
-	 * On dialogs the <code>Dialog</code> container defines the icon, as it could have multiple contents.
+	 * On dialogs the <code>sap.ui.mdc.valuehelp.Dialog</code> container defines the icon, as it could have multiple contents.
 	 *
 	 * @returns {string} Name of the icon
 	 * @private
@@ -582,6 +603,18 @@ sap.ui.define([
 
 	};
 
+	/**
+	 * Determines if quick selection is supported.
+	 *
+	 * @returns {boolean} if true, quick-selection is supported.
+	 *
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.valuehelp.base.Container
+	 * @ui5-metamodel This method also will be described in the UI5 (legacy) designtime metamodel
+	 */
+	Content.prototype.isQuickSelectSupported = function() {
+		return false;
+	};
 
 	/**
 	 * Determines if value help dialog should show the tokenizer for the content.
@@ -610,7 +643,7 @@ sap.ui.define([
 	}
 
 	/**
-	 * Determines the title used in the TabBar of the dialog.
+	 * Determines the title used in the <code>TabBar</code> of the dialog.
 	 *
 	 * <b>Note:</b> This function is used by the container and must not be used from outside
 	 *

package/src/sap/ui/mdc/valuehelp/base/DialogTab.js

@@ -20,7 +20,7 @@ sap.ui.define([
 	 * @param {object} [mSettings] Initial settings for the new control
 	 * @class Content for the <code>sap.ui.mdc.valuehelp.content.Dialog</code> element.
 	 * @extends sap.ui.core.Control
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @constructor
 	 * @abstract
 	 * @private