@openui5/sap.ui.core 1.93.3 → 1.96.2

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides an abstract property binding.
 sap.ui.define([
 	'./Binding',
@@ -60,8 +60,9 @@ sap.ui.define([
 	 */
 
 	/**
-	 * Sets the value for this binding. A model implementation should check if the current default binding mode permits
-	 * setting the binding value and if so set the new value also in the model.
+	 * Sets the value for this binding. A model implementation should check if the current default
+	 * binding mode permits setting the binding value, and if so, set the new value in the model,
+	 * too.
 	 *
 	 * @function
 	 * @name sap.ui.model.PropertyBinding.prototype.setValue
@@ -71,9 +72,10 @@ sap.ui.define([
 	 */
 
 	/**
-	 * Returns a value, after it has formatted using the given function
+	 * Returns a value formatted using the given function.
 	 *
-	 * @param {function} fnFormat the function to format the value
+	 * @param {function} fnFormat The function to format the value
+	 * @returns {any} The formatted value
 	 *
 	 * @private
 	 */
@@ -85,8 +87,13 @@ sap.ui.define([
 	/**
 	 * Sets a value, after it has been parsed and validated using the given function
 	 *
-	 * @param {any} vValue the value to set for this binding
-	 * @param {function} fnParse the function to parse the value
+	 * @param {any} vValue
+	 *   The value to set for this binding
+	 * @param {function} fnParse
+	 *   The function to parse the value
+	 *
+	 * @returns {Promise|undefined}
+	 *   A promise to set the value; <code>undefined</code> if the binding has no type
 	 *
 	 * @throws sap.ui.model.ParseException
 	 * @throws sap.ui.model.ValidateException
@@ -115,13 +122,16 @@ sap.ui.define([
 		} else {
 			oDataState.setInvalidValue(undefined);
 			that.setValue(vValue);
+			return undefined;
 		}
 	};
 
-	/** Convert raw to external representation
-	 *  @param vValue raw value
-	 * 	@return external value
-	 * 	@private
+	/**
+	 * Convert raw to external representation.
+	 *
+	 * @param {any} vValue Raw value
+	 * @return {any} External value
+	 * @private
 	 */
 	PropertyBinding.prototype._rawToExternal = function(vValue) {
 		if (this.oType) {
@@ -133,10 +143,12 @@ sap.ui.define([
 		return vValue;
 	};
 
-	/** Convert external to raw representation
-	 *  @param vValue external value
-	 * 	@return raw value
-	 * 	@private
+	/**
+	 * Convert external to raw representation.
+	 *
+	 * @param {any} vValue External value
+	 * @return {any} Raw value
+	 * @private
 	 */
 	PropertyBinding.prototype._externalToRaw = function(vValue) {
 		// formatter doesn't support two way binding
@@ -146,10 +158,12 @@ sap.ui.define([
 		return vValue;
 	};
 
-	/** Convert raw to internal representation
-	 *  @param vValue raw value
-	 * 	@return internal value
-	 * 	@private
+	/**
+	 * Convert raw to internal representation.
+	 *
+	 * @param {any} vValue Raw value
+	 * @return {any} Internal value
+	 * @private
 	 */
 	PropertyBinding.prototype._rawToInternal = function(vValue) {
 		var oFormat;
@@ -161,10 +175,11 @@ sap.ui.define([
 		return vValue;
 	};
 
-	/** Convert internal to raw representation
-	 *  @param vValue internal value
-	 * 	@return raw value
-	 * 	@private
+	/**
+	 * Convert internal to raw representation
+	 * @param {any} vValue Internal value
+	 * @return {any} Raw value
+	 * @private
 	 */
 	PropertyBinding.prototype._internalToRaw = function(vValue) {
 		var oFormat;
@@ -177,7 +192,8 @@ sap.ui.define([
 	};
 
 	/**
-	 * Returns the current external value of the bound target which is formatted via a type or formatter function.
+	 * Returns the current external value of the bound target which is formatted via a type or
+	 * formatter function.
 	 *
 	 * @throws sap.ui.model.FormatException
 	 *
@@ -197,12 +213,12 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the value for this binding. The value is parsed and validated against its type and then set to the binding.
-	 * A model implementation should check if the current default binding mode permits
-	 * setting the binding value and if so set the new value also in the model.
+	 * Sets the value for this binding. The value is parsed and validated against its type and then
+	 * set to the binding. A model implementation should check if the current default binding mode
+	 * permits setting the binding value, and if so, set the new value in the model, too.
 	 *
-	 * @param {any} vValue the value to set for this binding
-	 * @return {undefined|Promise} a promise in case of asynchronous type parsing or validation
+	 * @param {any} vValue The value to set for this binding
+	 * @return {undefined|Promise} A promise in case of asynchronous type parsing or validation
 	 * @throws sap.ui.model.ParseException
 	 * @throws sap.ui.model.ValidateException
 	 *
@@ -217,20 +233,24 @@ sap.ui.define([
 			default:
 				if (this.fnFormatter) {
 					Log.warning("Tried to use twoway binding, but a formatter function is used");
-					return;
+					return undefined;
 				}
 				return this._setBoundValue(vValue, this._externalToRaw.bind(this));
 		}
 	};
 
 	/**
-	 * Returns the related JavaScript primitive value of the bound target which is parsed by the {@link sap.ui.model.SimpleType#getModelFormat model format} of this binding's type.
-	 * If this binding doesn't have a type, the original value which is stored in the model is returned.
+	 * Returns the related JavaScript primitive value of the bound target which is parsed by the
+	 * {@link sap.ui.model.SimpleType#getModelFormat model format} of this binding's type. If this
+	 * binding doesn't have a type, the original value which is stored in the model is returned.
 	 *
-	 * This method will be used when targetType if set to "internal" or it's included in a {@link sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have the related
-	 * JavaScript primitive values for its type or formatter.
+	 * This method will be used when targetType is set to "internal" or when it's included in a
+	 * {@link sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have
+	 * the related JavaScript primitive values for its type or formatter.
 	 *
-	 * @return {any} the value which is parsed by the model format of the bound target or the original value in case of no type.
+	 * @return {any}
+	 *   The value which is parsed by the model format of the bound target, or the original value in
+	 *   case of no type.
 	 *
 	 * @public
 	 */
@@ -239,9 +259,14 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the value for this binding with the related JavaScript primitive type. The value is formatted with the {@link sap.ui.model.SimpleType#getModelFormat model format} and validated against its type and then set to the model.
+	 * Sets the value for this binding with the related JavaScript primitive type. The value is
+	 * formatted with the {@link sap.ui.model.SimpleType#getModelFormat model format} and validated
+	 * against its type and then set to the model.
 	 *
-	 * @param {any} vValue the value to set for this binding
+	 * @param {any} vValue
+	 *   The value to set for this binding
+	 * @returns {Promise|undefined}
+	 *   A promise to set the value; <code>undefined</code> if the binding has no type
 	 *
 	 * @throws sap.ui.model.ValidateException
 	 *
@@ -252,12 +277,15 @@ sap.ui.define([
 	};
 
 	/**
-	 * Returns the raw model value, as it exists in the model dataset
+	 * Returns the raw model value, as it exists in the model dataset.
 	 *
-	 * This method will be used when targetType of a binding is set to "raw" or it's included in a {@link sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have the related
-	 * JavaScript primitive values for its type or formatter.
+	 * This method will be used when targetType of a binding is set to "raw" or when it's include
+	 * in a {@link sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to
+	 * have the related JavaScript primitive values for its type or formatter.
 	 *
-	 * @return {any} the value which is parsed by the model format of the bound target or the original value in case of no type.
+	 * @return {any}
+	 *   The value which is parsed by the model format of the bound target, or the original value in
+	 *   case of no type.
 	 *
 	 * @public
 	 */
@@ -271,7 +299,10 @@ sap.ui.define([
 	 * Sets the value for this binding with the raw model value. This setter will perform type
 	 * validation, in case a type is defined on the binding.
 	 *
-	 * @param {any} vValue the value to set for this binding
+	 * @param {any} vValue
+	 *   The value to set for this binding
+	 * @returns {Promise|undefined}
+	 *   A promise to set the value; <code>undefined</code> if the binding has no type
 	 *
 	 * @throws sap.ui.model.ValidateException
 	 *
@@ -284,11 +315,14 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the optional type and internal type for the binding. The type and internal type are used to do the parsing/formatting correctly.
-	 * The internal type is the property type of the element which the value is formatted to.
+	 * Sets the optional type and internal type for the binding. The type and internal type are used
+	 * to do the parsing/formatting correctly. The internal type is the property type of the element
+	 * which the value is formatted to.
 	 *
-	 * @param {sap.ui.model.Type} oType the type for the binding
-	 * @param {string} sInternalType the internal type of the element property which this binding is bound against.
+	 * @param {sap.ui.model.Type} oType
+	 *   The type for the binding
+	 * @param {string} sInternalType
+	 *   The internal type of the element property which this binding is bound against.
 	 *
 	 * @public
 	 */
@@ -298,8 +332,8 @@ sap.ui.define([
 	};
 
 	/**
-	 *  Returns the type if any for the binding.
-	 *  @returns {sap.ui.model.Type} the binding type
+	 *  Returns the type (if any) for the binding.
+	 *  @returns {sap.ui.model.Type} The binding type
 	 *  @public
 	 */
 	PropertyBinding.prototype.getType = function() {
@@ -308,8 +342,8 @@ sap.ui.define([
 
 	/**
 	 * Sets the optional formatter function for the binding.
-
-	 * @param {function} fnFormatter the formatter function for the binding
+	 *
+	 * @param {function} fnFormatter The formatter function for the binding
 	 *
 	 * @public
 	 */
@@ -318,8 +352,8 @@ sap.ui.define([
 	};
 
 	/**
-	 *  Returns the formatter function
-	 *  @returns {Function} the formatter function
+	 *  Returns the formatter function.
+	 *  @returns {Function} The formatter function
 	 *  @public
 	 */
 	PropertyBinding.prototype.getFormatter = function() {
@@ -327,8 +361,8 @@ sap.ui.define([
 	};
 
 	/**
-	 *  Returns the binding mode
-	 *  @returns {sap.ui.model.BindingMode} the binding mode
+	 *  Returns the binding mode.
+	 *  @returns {sap.ui.model.BindingMode} The binding mode
 	 *  @public
 	 */
 	PropertyBinding.prototype.getBindingMode = function() {
@@ -336,8 +370,8 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the binding mode
-	 * @param {sap.ui.model.BindingMode} sBindingMode the binding mode
+	 * Sets the binding mode.
+	 * @param {sap.ui.model.BindingMode} sBindingMode The binding mode
 	 * @protected
 	 */
 	PropertyBinding.prototype.setBindingMode = function(sBindingMode) {
@@ -347,8 +381,8 @@ sap.ui.define([
 	/**
 	 * Resumes the binding update. Change events will be fired again.
 	 *
-	 * When the binding is resumed and the control value was changed in the meantime, the control value will be set to the
-	 * current value from the model and a change event will be fired.
+	 * When the binding is resumed and the control value was changed in the meantime, the control
+	 * value will be set to the current value from the model and a change event will be fired.
 	 * @public
 	 */
 	PropertyBinding.prototype.resume = function() {

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides class sap.ui.model.SelectionModel
 sap.ui.define(['sap/ui/base/EventProvider', "sap/base/assert"],
 	function(EventProvider, assert) {
@@ -20,7 +20,7 @@ sap.ui.define(['sap/ui/base/EventProvider', "sap/base/assert"],
 	 * @extends sap.ui.base.EventProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 *
 	 * @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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides the base implementation for all simple type implementations that are able to format,
 // parse and validate values
 sap.ui.define([
@@ -46,7 +46,7 @@ sap.ui.define([
 	 *
 	 * @extends sap.ui.model.Type
 	 * @public
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 */
 	var SimpleType = Type.extend("sap.ui.model.SimpleType", /** @lends sap.ui.model.SimpleType.prototype */ {
 

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides the concept of a sorter for list bindings
 sap.ui.define(['sap/ui/base/Object', "sap/base/Log"],
 	function(BaseObject, Log) {

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 sap.ui.define(['./Sorter', "sap/base/util/each"],
 	function(Sorter, each) {
 	"use strict";

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides a static binding.
 sap.ui.define([
 	"./ChangeReason",

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides enumeration sap.ui.model.TreeAutoExpandMode
 sap.ui.define([],
 	function() {
@@ -12,7 +12,7 @@ sap.ui.define([],
 	/**
 	 * Different modes for setting the auto expand mode on tree or analytical bindings.
 	 *
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 * @enum {string}
 	 * @alias sap.ui.model.TreeAutoExpandMode
 	 * @protected

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides an abstraction for list bindings
 sap.ui.define(['./Binding', './Filter', './Sorter'],
 	function(Binding, Filter, Sorter) {