@openui5/sap.ui.core 1.115.1 → 1.117.0

package/src/sap/ui/model/CompositeBinding.js

@@ -4,7 +4,7 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 /*eslint-disable max-len */
-// Provides an abstract property binding.
+// Provides an abstract composite binding.
 sap.ui.define([
 	"./BindingMode",
 	"./ChangeReason",
@@ -12,13 +12,12 @@ sap.ui.define([
 	"./CompositeType",
 	"./Context",
 	"./PropertyBinding",
-	"sap/base/assert",
 	"sap/base/Log",
 	"sap/base/util/deepEqual",
 	"sap/ui/base/DataType",
 	"sap/ui/base/SyncPromise"
 ], function(BindingMode, ChangeReason, CompositeDataState, CompositeType, Context, PropertyBinding,
-		assert, Log, deepEqual, DataType, SyncPromise) {
+		Log, deepEqual, DataType, SyncPromise) {
 	"use strict";
 
 
@@ -66,17 +65,30 @@ sap.ui.define([
 			var oModel;
 
 			PropertyBinding.apply(this, [null,""]);
+			// the property bindings for the parts of this composite binding
 			this.aBindings = aBindings;
+			// the values of the parts
 			this.aValues = null;
+			// whether to use raw (= model representation) values of parts
 			this.bRawValues = bRawValues;
+			// whether the binding is not updated in #checkUpdate, as it is currently being initialized, cf. #initialize
 			this.bPreventUpdate = false;
+			// whether to use internal values of parts
 			this.bInternalValues = bInternalValues;
+			// whether parts use multiple models
 			this.bMultipleModels = this.aBindings.some(function (oBinding) {
 				var oCurrentModel = oBinding.getModel();
 
 				oModel = oModel || oCurrentModel;
 				return oModel && oCurrentModel && oCurrentModel !== oModel;
 			});
+			// the original values of the parts retrieved on the last update, cf- #checkUpdate
+			this.aOriginalValues = undefined;
+			// the function attached to the change event on all part bindings, cf. #attachChange, #detachChange
+			this.fnChangeHandler = undefined;
+			// the function attached to the DateStateChange and AggregatedDataStateChange event on all part bindings,
+			// cf. #attachDataStateChange, #detachDataStateChange and respective methods for AggregatedDataStateChange
+			this.fnDataStateChangeHandler = undefined;
 		},
 		metadata : {
 
@@ -94,21 +106,47 @@ sap.ui.define([
 		PropertyBinding.prototype.destroy.apply(this);
 	};
 
+	/**
+	 * Returns <code>null</code> for the path of this binding instance, as a composite binding has no path.
+	 *
+	 * @returns {null} <code>null</code>
+	 * @public
+	 */
+	// @override sap.ui.model.Binding#getPath
 	CompositeBinding.prototype.getPath = function() {
-		assert(null, "Composite Binding has no path!");
 		return null;
 	};
 
+	/**
+	 * Returns <code>null</code> for the model of this binding instance, as a composite binding has no model.
+	 *
+	 * @returns {null} <code>null</code>
+	 * @public
+	 */
+	// @override sap.ui.model.Binding#getModel
 	CompositeBinding.prototype.getModel = function() {
-		assert(null, "Composite Binding has no model!");
 		return null;
 	};
 
+	/**
+	 * Returns <code>null</code> for the context of this binding instance, as a composite binding has no context.
+	 *
+	 * @returns {null} <code>null</code>
+	 * @public
+	 */
+	// @override sap.ui.model.Binding#getContext
 	CompositeBinding.prototype.getContext = function() {
-		assert(null, "Composite Binding has no context!");
 		return null;
 	};
 
+	/**
+	 * Returns whether all binding parts are resolved.
+	 *
+	 * @returns {boolean} Whether all binding parts are resolved
+	 * @public
+	 * @since 1.79.0
+	 */
+	// @override sap.ui.model.Binding#isResolved
 	CompositeBinding.prototype.isResolved = function() {
 		return this.aBindings.every(function(oBinding) {
 			return oBinding.isResolved();
@@ -594,13 +632,13 @@ sap.ui.define([
 	 */
 	CompositeBinding.prototype.attachChange = function(fnFunction, oListener) {
 		var that = this;
-		this.fChangeHandler = function(oEvent) {
+		this.fnChangeHandler = function(oEvent) {
 			if (that.bSuspended) {
 				return;
 			}
 			var oBinding = oEvent.getSource();
 			if (oBinding.getBindingMode() == BindingMode.OneTime) {
-				oBinding.detachChange(that.fChangeHandler);
+				oBinding.detachChange(that.fnChangeHandler);
 			}
 			/*bForceUpdate true gets lost (e.g. checkUpdate(true) on model); But if an embedded binding fires a change we could
 			 * call checkUpdate(true) so we handle both cases: a value change of the binding and a checkUpdate(true)
@@ -610,7 +648,7 @@ sap.ui.define([
 		this.attachEvent("change", fnFunction, oListener);
 		if (this.aBindings) {
 			this.aBindings.forEach(function(oBinding) {
-				oBinding.attachChange(that.fChangeHandler);
+				oBinding.attachChange(that.fnChangeHandler);
 			});
 		}
 	};
@@ -628,7 +666,7 @@ sap.ui.define([
 		this.detachEvent("change", fnFunction, oListener);
 		if (this.aBindings) {
 			this.aBindings.forEach(function(oBinding) {
-				oBinding.detachChange(that.fChangeHandler);
+				oBinding.detachChange(that.fnChangeHandler);
 			});
 		}
 	};
@@ -647,10 +685,10 @@ sap.ui.define([
 	 */
 	CompositeBinding.prototype.attachDataStateChange = function(fnFunction, oListener) {
 		var that = this;
-		this.fDataStateChangeHandler = function(oEvent) {
+		this.fnDataStateChangeHandler = function(oEvent) {
 			var oBinding = oEvent.getSource();
 			if (oBinding.getBindingMode() == BindingMode.OneTime) {
-				oBinding.detachDataStateChange(that.fChangeHandler);
+				oBinding.detachDataStateChange(that.fnChangeHandler);
 			}
 
 			that.checkDataState();
@@ -658,7 +696,7 @@ sap.ui.define([
 		this.attachEvent("DataStateChange", fnFunction, oListener);
 		if (this.aBindings) {
 			this.aBindings.forEach(function(oBinding) {
-				oBinding.attachEvent("DataStateChange", that.fDataStateChangeHandler);
+				oBinding.attachEvent("DataStateChange", that.fnDataStateChangeHandler);
 			});
 		}
 	};
@@ -676,7 +714,7 @@ sap.ui.define([
 		this.detachEvent("DataStateChange", fnFunction, oListener);
 		if (this.aBindings) {
 			this.aBindings.forEach(function(oBinding) {
-				oBinding.detachEvent("DataStateChange", that.fDataStateChangeHandler);
+				oBinding.detachEvent("DataStateChange", that.fnDataStateChangeHandler);
 			});
 		}
 	};
@@ -696,11 +734,11 @@ sap.ui.define([
 	CompositeBinding.prototype.attachAggregatedDataStateChange = function(fnFunction, oListener) {
 		var that = this;
 
-		if (!this.fDataStateChangeHandler) {
-			this.fDataStateChangeHandler = function(oEvent) {
+		if (!this.fnDataStateChangeHandler) {
+			this.fnDataStateChangeHandler = function(oEvent) {
 				var oBinding = oEvent.getSource();
 				if (oBinding.getBindingMode() == BindingMode.OneTime) {
-					oBinding.detachDataStateChange(that.fChangeHandler);
+					oBinding.detachDataStateChange(that.fnChangeHandler);
 				}
 
 				that.checkDataState();
@@ -710,7 +748,7 @@ sap.ui.define([
 		this.attachEvent("AggregatedDataStateChange", fnFunction, oListener);
 		if (this.aBindings) {
 			this.aBindings.forEach(function(oBinding) {
-				oBinding.attachEvent("DataStateChange", that.fDataStateChangeHandler);
+				oBinding.attachEvent("DataStateChange", that.fnDataStateChangeHandler);
 			});
 		}
 	};
@@ -729,7 +767,7 @@ sap.ui.define([
 		this.detachEvent("AggregatedDataStateChange", fnFunction, oListener);
 		if (this.aBindings) {
 			this.aBindings.forEach(function(oBinding) {
-				oBinding.detachEvent("DataStateChange", that.fDataStateChangeHandler);
+				oBinding.detachEvent("DataStateChange", that.fnDataStateChangeHandler);
 			});
 		}
 	};

package/src/sap/ui/model/CompositeDataState.js

@@ -14,7 +14,7 @@ sap.ui.define(['./DataState', "sap/base/util/deepEqual", "sap/base/util/each"],
 	 * @extends sap.ui.model.DataState
 	 *
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 *
 	 * @public
 	 * @alias sap.ui.model.CompositeDataState

package/src/sap/ui/model/CompositeType.js

@@ -39,7 +39,7 @@ sap.ui.define(['./SimpleType'],
 	 *   <code>true</code>.
 	 * @extends sap.ui.model.SimpleType
 	 * @public
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 */
 	var CompositeType = SimpleType.extend("sap.ui.model.CompositeType", /** @lends sap.ui.model.CompositeType.prototype */ {
 

package/src/sap/ui/model/DataState.js

@@ -65,7 +65,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 *
 	 * @public
 	 * @alias sap.ui.model.DataState

package/src/sap/ui/model/ListBinding.js

@@ -43,12 +43,20 @@ sap.ui.define(['./Binding', './Filter', './FilterType', './Sorter', 'sap/base/ut
 		constructor : function(oModel, sPath, oContext, aSorters, aFilters, mParameters){
 			Binding.call(this, oModel, sPath, oContext, mParameters);
 
+			// the binding's sorters
 			this.aSorters = makeArray(aSorters, Sorter);
+			// the binding's control filters
 			this.aFilters = [];
+			// the binding's application filters
 			this.aApplicationFilters = makeArray(aFilters, Filter);
+			// the filter combined from control and application filters
 			this.oCombinedFilter = null;
+			// whether the binding uses extended change detection, cf. #getContexts
 			this.bUseExtendedChangeDetection = false;
+			// whether changes within an entity cause a delete and insert, cf. #enableExtendedChangeDetection
 			this.bDetectUpdates = true;
+			// the configuration for extended change detection, cf. #enableExtendedChangeDetection
+			this.oExtendedChangeDetectionConfig = undefined;
 		},
 
 		metadata : {
@@ -562,7 +570,7 @@ sap.ui.define(['./Binding', './Filter', './FilterType', './Sorter', 'sap/base/ut
 	 * binding in its constructor or in its {@link #filter} method; add filters which you want to
 	 * keep with the "and" conjunction to the resulting filter before calling {@link #filter}.
 	 *
-	 * The implementation of this method is optional for model specific implementations of
+	 * The implementation of this method is optional for model-specific implementations of
 	 * <code>sap.ui.model.ListBinding</code>. Check for existence of this function before calling
 	 * it.
 	 *
@@ -582,5 +590,38 @@ sap.ui.define(['./Binding', './Filter', './FilterType', './Sorter', 'sap/base/ut
 	 * @since 1.77.0
 	 */
 
+	/**
+	 * Returns the string key for the given model context, which is a unique representation of the context's data. This
+	 * key is used in extended change detection to compute the difference between current and previous contexts
+	 * retrieved via {@link sap.ui.model.ListBinding#getContexts}.
+	 *
+	 * The implementation of this method is optional for model-specific implementations of
+	 * <code>sap.ui.model.ListBinding</code>.
+	 *
+	 * @abstract
+	 * @function
+	 * @name sap.ui.model.ListBinding.prototype.getEntryKey
+	 * @param {sap.ui.model.Context} oContext
+	 *   The context for which the key is to be computed
+	 * @returns {string}
+	 *   The key for the given context
+	 *
+	 * @protected
+	 */
+
+	/**
+	 * Update the list and apply sorting and filtering. Called after creation of the list binding
+	 * on enabling extended change detection, see {@link sap.ui.model.ListBinding#enableExtendedChangeDetection}.
+	 *
+	 * The implementation of this method is optional for model-specific implementations of
+	 * <code>sap.ui.model.ListBinding</code>.
+	 *
+	 * @abstract
+	 * @function
+	 * @name sap.ui.model.ListBinding.prototype.update
+	 *
+	 * @protected
+	 */
+
 	return ListBinding;
 });

package/src/sap/ui/model/MetaModel.js

@@ -16,7 +16,7 @@ sap.ui.define(['./Model'],
 	 * @extends sap.ui.model.Model
 	 *
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 *
 	 * @public
 	 * @alias sap.ui.model.MetaModel

package/src/sap/ui/model/Model.js

@@ -51,7 +51,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.message.MessageProcessor
 	 *
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 *
 	 * @public
 	 * @alias sap.ui.model.Model
@@ -951,9 +951,10 @@ sap.ui.define([
 			for (var sKey in this.mMessages) {
 				aMessages = aMessages.concat(this.mMessages[sKey]);
 			}
-			this.fireMessageChange({
-				oldMessages: aMessages
-			});
+			var MessageManager = sap.ui.require("sap/ui/core/message/MessageManager");
+			if (MessageManager) {
+				MessageManager.updateMessages(aMessages, []);
+			}
 		}
 	};
 

package/src/sap/ui/model/PropertyBinding.js

@@ -37,6 +37,16 @@ sap.ui.define([
 
 		constructor : function (oModel, sPath, oContext, mParameters) {
 			Binding.apply(this, arguments);
+			// The formatter providing the external representation of this binding's value
+			this.fnFormatter = undefined;
+			// The internal type of this binding, cf. #setType and
+			// sap.ui.base.ManagedObject.PropertyBindingInfo.targetType
+			this.sInternalType = undefined;
+			// The binding's sap.ui.model.BindingMode, cf. #setBindingMode and
+			// sap.ui.base.ManagedObject.PropertyBindingInfo.mode
+			this.sMode = undefined;
+			// The binding's sap.ui.model.SimpleType, cf. #setType
+			this.oType = undefined;
 		},
 		metadata : {
 			"abstract" : true,

package/src/sap/ui/model/SelectionModel.js

@@ -20,7 +20,7 @@ sap.ui.define(['sap/ui/base/EventProvider', "sap/base/assert"],
 	 * @extends sap.ui.base.EventProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 *
 	 * @param {int} iSelectionMode <code>sap.ui.model.SelectionModel.SINGLE_SELECTION</code> or <code>sap.ui.model.SelectionModel.MULTI_SELECTION</code>
 	 *

package/src/sap/ui/model/SimpleType.js

@@ -46,12 +46,15 @@ sap.ui.define([
 	 *
 	 * @extends sap.ui.model.Type
 	 * @public
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 */
 	var SimpleType = Type.extend("sap.ui.model.SimpleType", /** @lends sap.ui.model.SimpleType.prototype */ {
 
 		constructor : function (oFormatOptions, oConstraints) {
 			Type.apply(this, arguments);
+			// The formatter to convert between the value in internal and model representation, cf. #getModelFormat
+			//   setFormatOptions may be overwritten by subclasses and set an own oInputFormat => must be set before
+			this.oInputFormat = undefined;
 			this.setFormatOptions(oFormatOptions || {});
 			this.setConstraints(oConstraints || {});
 			this.sName = "SimpleType";

package/src/sap/ui/model/TreeAutoExpandMode.js

@@ -12,7 +12,7 @@ sap.ui.define([],
 	/**
 	 * Different modes for setting the auto expand mode on tree or analytical bindings.
 	 *
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 * @enum {string}
 	 * @alias sap.ui.model.TreeAutoExpandMode
 	 * @protected

package/src/sap/ui/model/Type.js

@@ -19,7 +19,7 @@ sap.ui.define(['sap/ui/base/Object'],
 	 *
 	 * @extends sap.ui.base.Object
 	 * @public
-	 * @version 1.115.1
+	 * @version 1.117.0
 	 */
 	var Type = BaseObject.extend("sap.ui.model.Type", /** @lends sap.ui.model.Type.prototype */ {