@openui5/sap.ui.core 1.93.3 → 1.96.2

package/src/sap/ui/model/TreeBindingAdapter.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.odata.TreeBindingAdapter
 sap.ui.define([
 	'sap/ui/model/TreeBinding',
@@ -78,30 +78,34 @@ sap.ui.define([
 
 		/**
 		 * Returns a tree state handle to encapsulate the actual tree state.
-		 * TODO: Encode the list to avoid conflicts with delimiters in the flat expanded list? Re-Check this when back-end support is implemented.
+		 * TODO: Encode the list to avoid conflicts with delimiters in the flat expanded list?
+		 *       Re-Check this when back-end support is implemented.
 		 *
-		 * This function is exposed in the sub-classes/adapters (e.g. ODataTreeBindingAdapter) if necessary/possible.
+		 * This function is exposed in the sub-classes/adapters (e.g. ODataTreeBindingAdapter) if
+		 * necessary/possible.
 		 *
+		 * @returns {object} The current tree state
 		 * @private
 		 */
 		TreeBindingAdapter.prototype.getCurrentTreeState = function () {
-			var sDelimiter = ";";
+			var sDelimiter = ";",
+				sGroupID;
 
 			//expanded
 			var mExpandedEntriesGroupIDs = {};
-			for (var sGroupID in this._mTreeState.expanded) {
+			for (sGroupID in this._mTreeState.expanded) {
 				mExpandedEntriesGroupIDs[sGroupID] = true;
 			}
 
 			//collapsed
 			var mCollapsedEntriesGroupIDs = {};
-			for (var sGroupID in this._mTreeState.collapsed) {
+			for (sGroupID in this._mTreeState.collapsed) {
 				mCollapsedEntriesGroupIDs[sGroupID] = true;
 			}
 
 			//selected
 			var mSelectedEntriesGroupIDs = {};
-			for (var sGroupID in this._mTreeState.selected) {
+			for (sGroupID in this._mTreeState.selected) {
 				mSelectedEntriesGroupIDs[sGroupID] = true;
 			}
 
@@ -132,7 +136,8 @@ sap.ui.define([
 		/**
 		 * Sets the given as a start point for the tree.
 		 * Only in OperationMode.Client.
-		 * @param oTreeState Only valid tree states from the same binding are accepted
+		 *
+		 * @param {object} oTreeState Only valid tree states from the same binding are accepted
 		 * @private
 		 */
 		TreeBindingAdapter.prototype.setTreeState = function (oTreeState) {
@@ -140,15 +145,19 @@ sap.ui.define([
 		};
 
 		/**
-		 * Sets the AutoExpand Mode for this Adapter. Default is "Bundled".
-		 * @param {sap.ui.model.TreeAutoExpandMode} sAutoExpandMode
+		 * Sets the auto expand mode for this Adapter. Default is "Bundled".
+		 *
+		 * @param {sap.ui.model.TreeAutoExpandMode} sAutoExpandMode The new auto expand mode to set
 		 */
 		TreeBindingAdapter.prototype.setAutoExpandMode = function (sAutoExpandMode) {
 			this._autoExpandMode = sAutoExpandMode;
 		};
 
 		/**
-		 * @see sap.ui.model.ListBinding#getLength
+		 * Returns the number of entries in the tree.
+		 *
+		 * @return {number} Returns the number of entries in the tree
+		 * @public
 		 */
 		TreeBindingAdapter.prototype.getLength = function() {
 			if (!this._oRootNode) {
@@ -159,10 +168,20 @@ sap.ui.define([
 			return this._oRootNode.magnitude;
 		};
 
+		/**
+		 * Gets the context of the node at the given index.
+		 *
+		 * @param {number} iIndex
+		 *   The index of the node
+		 *
+		 * @returns {sap.ui.model.Context|undefined}
+		 *   The context of the node at the given index or <code>undefined</code> if the binding is
+		 *   initial or no node was found at the given index
+		 */
 		TreeBindingAdapter.prototype.getContextByIndex = function (iIndex) {
 			//step out if the binding is initial (as long as the metadata is not yet loaded)
 			if (this.isInitial()) {
-				return;
+				return undefined;
 			}
 
 			var oNode = this.findNode(iIndex);
@@ -172,7 +191,7 @@ sap.ui.define([
 		TreeBindingAdapter.prototype.getNodeByIndex = function(iIndex) {
 			//step out if the binding is initial (as long as the metadata is not yet loaded)
 			if (this.isInitial()) {
-				return;
+				return undefined;
 			}
 
 			// if the requested index is bigger than the magnitude of the tree, the index can never
@@ -185,32 +204,40 @@ sap.ui.define([
 		};
 
 		/**
-		 * Find node retrieves an actual tree nodes.
-		 * However if there are sum rows cached (meaning, they are currently displayed), these will also be returned.
+		 * Gets the tree node matching the given search parameters. However, if there are sum rows
+		 * cached (meaning, they are currently displayed), these will also be returned.
+		 *
+		 * @param {number} iRowIndex
+		 *   The row index of the node
+		 *
+		 * @returns {object|undefined}
+		 *   The found node or <code>undefined</code> if the binding is initial or no node is found
 		 */
-		TreeBindingAdapter.prototype.findNode = function (vParam) {
+		TreeBindingAdapter.prototype.findNode = function (iRowIndex) {
 
 			//step out if the binding is initial (as long as the metadata is not yet loaded)
 			if (this.isInitial()) {
-				return;
+				return undefined;
 			}
 
-			var sParameterType = typeof vParam;
+			var sParameterType = typeof iRowIndex;
 			var oFoundNode;
 
 			var aSearchResult = [];
 
 			//if the parameter is an index -> first check the cache, and then search the tree if necessary
 			if (sParameterType === "number") {
-				oFoundNode = this._aRowIndexMap[vParam];
+				oFoundNode = this._aRowIndexMap[iRowIndex];
 
 				if (!oFoundNode) {
 					var iIndexCounter = -1;
 					this._match(this._oRootNode, aSearchResult, 1, function (oNodeToCheck) {
-						if (iIndexCounter === vParam) {
+						if (iIndexCounter === iRowIndex) {
 							return true;
 						}
 						iIndexCounter += 1;
+
+						return false;
 					});
 
 					oFoundNode = aSearchResult[0];
@@ -265,10 +292,20 @@ sap.ui.define([
 			return oNodeStateInSource;
 		};
 
+
+		/**
+		 * Creates a new node state using supplied parameters.
+		 *
+		 * @param {object} mParameters
+		 *   Parameters for the new node state
+		 *
+		 * @returns {object|undefined}
+		 *   The created node state or <code>undefined</code> if no group id is given
+		 */
 		TreeBindingAdapter.prototype._createNodeState = function (mParameters) {
 			if (!mParameters.groupID) {
 				assert(false, "To create a node state a group ID is mandatory!");
-				return;
+				return undefined;
 			}
 
 			// check if the tree has an initial expansion state for the given groupID
@@ -316,23 +353,31 @@ sap.ui.define([
 
 		/**
 		 * Merges the new section with all currently known sections.
-		 * Makes sure, that only non overlapping sections are kept.
+		 * Makes sure that only non overlapping sections are kept.
+		 *
+		 * @param {string} sGroupID
+		 *   The group ID of the node below which the new section should be merged
+		 * @param {object} oNewSection
+		 *   The new section to merge
+		 *
+		 * @returns {object|undefined}
+		 *   The merged sections
 		 */
 		TreeBindingAdapter.prototype._updateNodeSections = function (sGroupID, oNewSection) {
 			var oNodeState = this._getNodeState(sGroupID);
 
 			if (!oNodeState) {
 				assert(false, "No Node State for Group ID '" + sGroupID + "' found!");
-				return;
+				return undefined;
 			} else if (!oNewSection) {
 				assert(false, "No Section given!");
-				return;
+				return undefined;
 			} else if (oNewSection.length <= 0) {
 				assert(false, "The length of the given section must be positive greater than 0.");
-				return;
+				return undefined;
 			} else if (oNewSection.startIndex < 0) {
 				assert(false, "The sections start index must be greater/equal to 0.");
-				return;
+				return undefined;
 			}
 
 			// Iterate over all known/loaded sections of the node
@@ -372,6 +417,10 @@ sap.ui.define([
 		/**
 		 * Calculates the maximum possible group-size for a given node.
 		 * Not the same as the direct number of children.
+		 *
+		 * @param {object} oNode The node to calculate the group-size for
+		 *
+		 * @returns {number} The maximum possible group-size
 		 */
 		TreeBindingAdapter.prototype._getMaxGroupSize = function (oNode) {
 			var iMaxGroupSize = 0;
@@ -429,6 +478,10 @@ sap.ui.define([
 		 */
 		TreeBindingAdapter.prototype._getContextsOrNodes = function (bReturnNodes, iStartIndex,
 				iLength, iThreshold) {
+			var mMissingSections, oNode,
+				aContexts = [],
+				aNodes = [];
+
 			if (!this.isResolved() || this.isInitial()) {
 				return [];
 			}
@@ -455,7 +508,6 @@ sap.ui.define([
 			this._buildTree(iStartIndex, iLength);
 
 			// retrieve the requested section of nodes from the tree
-			var aNodes = [];
 			if (this._oRootNode) {
 				aNodes = this._retrieveNodeSection(this._oRootNode, iStartIndex, iLength);
 			}
@@ -464,10 +516,8 @@ sap.ui.define([
 			this._updateRowIndexMap(aNodes, iStartIndex);
 
 			//find missing sections
-			var aContexts = [];
-			var mMissingSections;
 			for (var i = 0; i < aNodes.length; i++) {
-				var oNode = aNodes[i];
+				oNode = aNodes[i];
 				// we found a gap because the node is empty (context is undefined)
 				if (!oNode.context) {
 					mMissingSections = mMissingSections || {};
@@ -498,7 +548,7 @@ sap.ui.define([
 				// try to fill gaps in our return array if we already have new data (thanks to thresholding)
 				aContexts = [];
 				for (var j = 0; j < aNodes.length; j++) {
-					var oNode = aNodes[j];
+					oNode = aNodes[j];
 					aContexts.push(oNode.context);
 				}
 			}
@@ -530,7 +580,10 @@ sap.ui.define([
 		};
 
 		/**
-		 * Synchronize a node section from the tree with our RowIndex Mapping table.
+		 * Updates a node section from the tree with our RowIndex Mapping table.
+		 *
+		 * @param {object[]} aNodes The nodes to update
+		 * @param {number} iStartIndex The position where the update should start
 		 */
 		TreeBindingAdapter.prototype._updateRowIndexMap = function (aNodes, iStartIndex) {
 			//throw away the old mapping index
@@ -542,15 +595,21 @@ sap.ui.define([
 		};
 
 		/**
-		 * Depth-First traversal of a sub-tree object structure starting with the given node as the root.
-		 * Retrieves all found nodes (including gaps). Gaps will be filled with placeholder nodes.
-		 * These placeholders are later used to automatically update the tree after invalidating and refreshing the
-		 * sub-tree(s) containing the gaps.
-		 * @param {object} oNode the root node of the sub-tree for which the section will be retrieved
-		 * @param {int} iStartIndex the start of the tree section which should be retrieved
-		 * @param {int} iLength the start of the tree section which should be retrieved
-		 * @return {object[]} an array containing all collected nodes, for which the absolute node index is greater than iStartIndex
-		 *                    the length of the array will be iLength (or less if the tree does not have that many nodes).
+		 * Depth-First traversal of a sub-tree object structure starting with the given node as the
+		 * root. Retrieves all found nodes (including gaps). Gaps will be filled with placeholder
+		 * nodes. These placeholders are later used to automatically update the tree after
+		 * invalidating and refreshing the sub-tree(s) containing the gaps.
+		 *
+		 * @param {object} oNode
+		 *   Ignored; the root node is always used as starting point
+		 * @param {number} iStartIndex
+		 *   The start of the tree section which should be retrieved
+		 * @param {number} iLength
+		 *   The length of the tree section which should be retrieved
+		 *
+		 * @return {object[]} An array containing all collected nodes, for which the absolute node
+		 *   index is greater than iStartIndex; the length of the array will be iLength (or less if
+		 *   the tree does not have that many nodes).
 		 * @private
 		 */
 		TreeBindingAdapter.prototype._retrieveNodeSection = function (oNode, iStartIndex, iLength) {
@@ -573,13 +632,16 @@ sap.ui.define([
 					aNodes.push(oNode);
 					return true;
 				}
+
+				return false;
 			});
 
 			return aNodes;
 		};
 
 		/**
-		 * Builds the tree from start index with the specified number of nodes
+		 * Builds the tree from start index with the specified number of nodes.
+		 *
 		 * @param {int} iStartIndex Index from which the tree shall be built
 		 * @param {int} iLength Number of Nodes
 		 */
@@ -597,7 +659,7 @@ sap.ui.define([
 			// create root node state if none exists
 			if (!oRootNodeState) {
 
-				var oRootNodeState = this._createNodeState({
+				oRootNodeState = this._createNodeState({
 					groupID: sRootGroupID,
 					sum: true,
 					sections: [{
@@ -637,13 +699,18 @@ sap.ui.define([
 		};
 
 		/**
-		 * Calculate the request length based on the given information
+		 * Calculate the request length based on the given information.
+		 *
+		 * @param {number} iMaxGroupSize The maximum group size
+		 * @param {object} oSection The information of the current section
+		 *
+		 * @returns {number} The calculated request length
 		 *
-		 * @param {int} iMaxGroupSize the maximum group size
-		 * @param {object} oSection the information of the current section
 		 * @protected
-		 * @deprecated since version 1.52. This method is marked as 'protected' which was meant to be overwritten
-		 *  by its subclasses. It may be renamed or deleted and should only be called from this class or its subclasses.
+		 * @deprecated
+		 *   since version 1.52. This method is marked as 'protected' which was meant to
+		 *   be overwritten by its subclasses. It may be renamed or deleted and should only be
+		 *   called from this class or its subclasses.
 		 */
 		TreeBindingAdapter.prototype._calculateRequestLength = function(iMaxGroupSize, oSection) {
 			var iRequestedLength;
@@ -799,6 +866,8 @@ sap.ui.define([
 		/**
 		 * Returns if the Binding is grouped, default is true.
 		 * AnalyticalBindings might differ.
+		 *
+		 * @returns {boolean} true
 		 */
 		TreeBindingAdapter.prototype.isGrouped = function () {
 			return true;
@@ -808,7 +877,6 @@ sap.ui.define([
 		 * Hook which needs to be implemented by subclasses
 		 * Calculates a unique group ID for a given node
 		 * @param {Object} oNode Node of which the group ID shall be calculated
-		 * @returns {string} Group ID for oNode
 		 */
 		TreeBindingAdapter.prototype._calculateGroupID = function (oNode) {
 			Log.error("TreeBindingAdapter#_calculateGroupID: Not implemented. Needs to be implemented in respective sub-classes.");
@@ -885,7 +953,10 @@ sap.ui.define([
 
 		/**
 		 * Retrieves the expanded state of the row sitting at the given index.
-		 * @param {int} iIndex the index for which the expansion state should be retrieved
+		 *
+		 * @param {number} iIndex The index for which the expansion state should be retrieved
+		 *
+		 * @returns {boolean} Whether the node at the given index is expanded
 		 */
 		TreeBindingAdapter.prototype.isExpanded = function (iIndex) {
 			var oNode = this.findNode(iIndex);
@@ -1026,15 +1097,27 @@ sap.ui.define([
 
 		/**
 		 * Calls the given matching function on every child node in the sub tree with root "oNode".
-		 * Inside the map function "this" is bound to the TreeBindingAdapter instance.
-		 * The matching function must return "true" if the node should be collected as a match, and false otherwise.
-		 *
-		 * @param {object} oNode the starting node of the sub-tree which will be traversed, handed to the fnMatchFunction
-		 * @param {array} aResults the collected nodes for which the matching function returns true
-		 * @param {int} iMaxNumberOfMatches the maximum number of matched nodes, _match() will stopp if this boundary is reached
-		 * @param {function} fnMatchFunction the match function is called for every traversed nodes
-		 * @param {int} [iPositionInParent] the relative position of the oNode parameter to its parent nodes children array, handed to the fnMatchFunction
-		 * @param {object} [oParentNode] the parent node of the oNode parameter, handed to the fnMatchFunction
+		 * Inside the map function "this" is bound to the TreeBindingAdapter instance. The matching
+		 * function must return "true" if the node should be collected as a match, and false
+		 * otherwise.
+		 *
+		 * @param {object} oNode
+		 *   The starting node of the sub-tree which will be traversed, handed to the
+		 *   fnMatchFunction
+		 * @param {array} aResults
+		 *   The collected nodes for which the matching function returns true
+		 * @param {number} iMaxNumberOfMatches
+		 *   The maximum number of matched nodes, _match() will stopp if this boundary is reached
+		 * @param {function} fnMatchFunction
+		 *   The match function is called for every traversed nodes
+		 * @param {number} [iPositionInParent]
+		 *   The relative position of the oNode parameter to its parent nodes children array, handed
+		 *   to the fnMatchFunction
+		 * @param {object} [oParentNode]
+		 *   The parent node of the oNode parameter, handed to the fnMatchFunction
+		 *
+		 * @returns {boolean}
+		 *   Whether the <code>iMaxNumberOfMatches</code> has been reached
 		 */
 		TreeBindingAdapter.prototype._match = function (oNode, aResults, iMaxNumberOfMatches, fnMatchFunction, iPositionInParent, oParentNode) {
 
@@ -1090,6 +1173,10 @@ sap.ui.define([
 
 		/**
 		 * A group ID starts and ends with a "/".
+		 *
+		 * @param {string} sGroupID The group ID to get the level from
+		 *
+		 * @returns {number} The level of the group ID
 		 */
 		TreeBindingAdapter.prototype._getGroupIdLevel = function (sGroupID) {
 			if (sGroupID == null) {
@@ -1100,7 +1187,11 @@ sap.ui.define([
 		};
 
 		/**
-		 * Determines the size of a group
+		 * Determines the size of a group.
+		 *
+		 * @param {object} oNode The node to determine the size of
+		 *
+		 * @returns {number} The child count of the given node
 		 */
 		TreeBindingAdapter.prototype._getGroupSize = function (oNode) {
 			return this.getChildCount(oNode.context);
@@ -1136,7 +1227,10 @@ sap.ui.define([
 
 		/**
 		 * Returns the selection state for the node at the given index.
-		 * @param {int} iRowIndex the row index to check for selection state
+		 *
+		 * @param {number} iRowIndex The row index to check for selection state
+		 *
+		 * @returns {boolean} Whether the node at the given index is selected
 		 */
 		TreeBindingAdapter.prototype.isIndexSelected = function (iRowIndex) {
 			var oNode = this.getNodeByIndex(iRowIndex);
@@ -1144,9 +1238,12 @@ sap.ui.define([
 		};
 
 		/**
-		 * Returns if the node at the given index is selectable.
+		 * Returns whether the node at the given index is selectable.
 		 * In the AnalyticalTable only nodes with isLeaf = true are selectable.
-		 * @param {int} iRowIndex the row index which should be checked for "selectability"
+		 *
+		 * @param {number} iRowIndex The row index which should be checked for "selectability"
+		 *
+		 * @returns {boolean} Whether the node at the given index is selectable
 		 */
 		TreeBindingAdapter.prototype.isIndexSelectable = function (iRowIndex) {
 			var oNode = this.getNodeByIndex(iRowIndex);
@@ -1154,7 +1251,12 @@ sap.ui.define([
 		};
 
 		/**
-		 * Checks if the given node can be selected. Always true for TreeTable controls, except the node is not defined.
+		 * Checks if the given node can be selected. Always true for TreeTable controls, except when
+		 * the node is not defined.
+		 *
+		 * @param {object} oNode The node to check
+		 *
+		 * @returns {boolean} Whether the node can be selected
 		 */
 		TreeBindingAdapter.prototype._isNodeSelectable = function (oNode) {
 			return !!oNode && !oNode.isArtificial;
@@ -1194,9 +1296,9 @@ sap.ui.define([
 		};
 
 		/**
-		 * Retrieves the "Lead-Selection-Index"
-		 * Normally this is the last selected node/table row.
-		 * @return {int} returns the lead selection index or -1 if none is set
+		 * Retrieves the "Lead-Selection-Index". Normally this is the last selected node/table row.
+		 *
+		 * @return {number} Returns the lead selection index or -1 if none is set
 		 */
 		TreeBindingAdapter.prototype.getSelectedIndex = function () {
 			//if we have no nodes selected, the lead selection index is -1
@@ -1215,9 +1317,12 @@ sap.ui.define([
 				if (oNode) {
 					if (oNode.groupID === this._sLeadSelectionGroupID) {
 						nodeFound = true;
+
 						return true;
 					}
 				}
+
+				return false;
 			};
 			this._match(this._oRootNode, [], 1, fnMatchFunction);
 
@@ -1263,6 +1368,8 @@ sap.ui.define([
 						return true;
 					}
 				}
+
+				return false;
 			};
 
 			this._match(this._oRootNode, [], iNumberOfNodesToSelect, fnMatchFunction);
@@ -1271,7 +1378,9 @@ sap.ui.define([
 		};
 
 		/**
-		 * Returns the number of selected nodes (including not-yet loaded)
+		 * Returns the number of selected nodes (including not-yet loaded).
+		 *
+		 * @returns {number} The count of selected nodes
 		 * @private
 		 */
 		TreeBindingAdapter.prototype.getSelectedNodesCount = function () {
@@ -1336,7 +1445,11 @@ sap.ui.define([
 		};
 
 		/**
-		 * Returns the number of currently selectable nodes (with respect to the current expand/collapse state).
+		 * Returns the number of currently selectable nodes (with respect to the current
+		 * expand/collapse state).
+		 *
+		 * @param {object} [oNode] The node to get the selectable nodes count from
+		 *
 		 * @returns {int} Number of currently selectable nodes
 		 */
 		TreeBindingAdapter.prototype._getSelectableNodesCount = function (oNode) {
@@ -1348,8 +1461,11 @@ sap.ui.define([
 		};
 
 		/**
-		 * Returns an array containing all selected contexts, ordered by their appearance in the tree.
-		 * @return {sap.ui.model.Context[]} an array containing the binding contexts for all selected nodes
+		 * Returns an array containing all selected contexts, ordered by their appearance in the
+		 * tree.
+		 *
+		 * @return {sap.ui.model.Context[]}
+		 *   An array containing the binding contexts for all selected nodes
 		 */
 		TreeBindingAdapter.prototype.getSelectedContexts = function () {
 			var aResultContexts = [];
@@ -1375,9 +1491,12 @@ sap.ui.define([
 						aResultContexts.push(oNode.context);
 						// cache the selected node for subsequent findNode/getContextByIndex calls
 						that._aRowIndexMap[iNodeCounter] = oNode;
+
 						return true;
 					}
 				}
+
+				return false;
 			};
 
 			this._match(this._oRootNode, [], iNumberOfNodesToSelect, fnMatchFunction);
@@ -1387,22 +1506,25 @@ sap.ui.define([
 
 		/**
 		 * Sets the selection to the range from iFromIndex to iToIndex (including boundaries).
-		 * e.g. setSelectionInterval(1,3) marks the rows 1,2 and 3.
-		 * All currently selected rows will be deselected in the process.
-		 * A selectionChanged event is fired
+		 * e.g. <code>setSelectionInterval(1,3)</code> marks the rows 1,2 and 3. All currently
+		 * selected rows will be deselected in the process. A <code>selectionChanged</code> event is
+		 * fired.
+		 *
+		 * @param {number} iFromIndex The first index to select
+		 * @param {number} iToIndex The last index to select
 		 */
 		TreeBindingAdapter.prototype.setSelectionInterval = function (iFromIndex, iToIndex) {
-			// clears the selection but suppresses the selection change event
-			var mClearParams = this._clearSelection();
-			// the addSelectionInterval function takes care of the selection change event
-			var mSetParams = this._setSelectionInterval(iFromIndex, iToIndex, true);
-
-			var mIndicesFound = {};
-			var aRowIndices = [];
+			var i, iIndex,
+				// clears the selection but suppresses the selection change event
+				mClearParams = this._clearSelection(),
+				mIndicesFound = {},
+				aRowIndices = [],
+				// the addSelectionInterval function takes care of the selection change event
+				mSetParams = this._setSelectionInterval(iFromIndex, iToIndex, true);
 
 			// flag all cleared indices as changed
-			for (var i = 0; i < mClearParams.rowIndices.length; i++) {
-				var iIndex = mClearParams.rowIndices[i];
+			for (i = 0; i < mClearParams.rowIndices.length; i++) {
+				iIndex = mClearParams.rowIndices[i];
 				mIndicesFound[iIndex] = true;
 			}
 
@@ -1433,11 +1555,19 @@ sap.ui.define([
 		};
 
 		/**
-		 * Sets the value inside the given range to the value given with 'bSelectionValue'
+		 * Sets the value inside the given range to the value given with 'bSelectionValue'.
+		 *
+		 * @param {number} iFromIndex
+		 *   The starting index of the selection range
+		 * @param {number} iToIndex
+		 *   The end index of the selection range, which will be included in the selection
+		 * @param {boolean} bSelectionValue
+		 *   The selection state which should be applied to all indices between 'from' and 'to'
+		 *   index
+		 *
+		 * @returns {object}
+		 *   A map containing info about the changed selection
 		 * @private
-		 * @param {int} iFromIndex the starting index of the selection range
-		 * @param {int} iToIndex the end index of the selection range
-		 * @param {boolean} bSelectionValue the selection state which should be applied to all indices between 'from' and 'to' index
 		 */
 		TreeBindingAdapter.prototype._setSelectionInterval = function (iFromIndex, iToIndex, bSelectionValue) {
 			//make sure the "From" Index is always lower than the "To" Index
@@ -1485,6 +1615,7 @@ sap.ui.define([
 					}
 				}
 
+				return false;
 			};
 
 			this._match(this._oRootNode, aNewlySelectedNodes, iNumberOfNodesToSelect, fnMatchFunction);
@@ -1507,10 +1638,14 @@ sap.ui.define([
 		};
 
 		/**
-		 * Marks a range of tree nodes as selected/deselected, starting with iFromIndex going to iToIndex.
-		 * The TreeNodes are referenced via their absolute row index.
-		 * Please be aware, that the absolute row index only applies to the tree which is visualized by the TreeTable.
-		 * Invisible nodes (collapsed child nodes) will not be regarded.
+		 * Marks a range of tree nodes as selected/deselected, starting with <code>iFromIndex</code>
+		 * going to <code>iToIndex</code>. The TreeNodes are referenced via their absolute row
+		 * index. Please be aware, that the absolute row index only applies to the tree which is
+		 * visualized by the TreeTable. Invisible nodes (collapsed child nodes) will not be
+		 * regarded.
+		 *
+		 * @param {number} iFromIndex The first index to mark
+		 * @param {number} iToIndex The last index to mark
 		 */
 		TreeBindingAdapter.prototype.addSelectionInterval = function (iFromIndex, iToIndex) {
 			var mParams = this._setSelectionInterval(iFromIndex, iToIndex, true);
@@ -1518,7 +1653,10 @@ sap.ui.define([
 		};
 
 		/**
-		 * Removes the selections inside the given range (including boundaries)
+		 * Removes the selections inside the given range (including boundaries).
+		 *
+		 * @param {number} iFromIndex The first index to remove the selection from
+		 * @param {number} iToIndex The last index to remove the selection from
 		 */
 		TreeBindingAdapter.prototype.removeSelectionInterval = function (iFromIndex, iToIndex) {
 			var mParams = this._setSelectionInterval(iFromIndex, iToIndex, false);
@@ -1579,7 +1717,9 @@ sap.ui.define([
 		};
 
 		/**
-		 * Removes the selection from all nodes
+		 * Removes the selection from all nodes.
+		 *
+		 * @returns {object} An object containing information about the new selection state
 		 * @private
 		 */
 		TreeBindingAdapter.prototype._clearSelection = function () {
@@ -1633,6 +1773,8 @@ sap.ui.define([
 						return true;
 					}
 				}
+
+				return false;
 			};
 
 			this._match(this._oRootNode, [], iMaxNumberOfMatches, fnMatch);
@@ -1650,20 +1792,25 @@ sap.ui.define([
 		};
 		/**
 		 * Removes the complete selection.
-		 * @param {boolean} bSuppressSelectionChangeEvent if this is set to true, no selectionChange event will be fired
+		 *
+		 * @param {boolean} bSuppressSelectionChangeEvent
+		 *   Whether to suppress the <code>selectionChange</code> event
 		 */
-		TreeBindingAdapter.prototype.clearSelection = function (bSuppresSelectionChangeEvent) {
+		TreeBindingAdapter.prototype.clearSelection = function (bSuppressSelectionChangeEvent) {
 			var oChanges = this._clearSelection();
 
 			// check if the selection change event should be suppressed
-			if (!bSuppresSelectionChangeEvent) {
+			if (!bSuppressSelectionChangeEvent) {
 				this._publishSelectionChanges(oChanges);
 			}
 		};
 
 		/**
-		 * Fires a "selectionChanged" event with the given parameters.
-		 * Also performs a sanity check on the parameters.
+		 * Fires a <code>selectionChanged</code> event with the given parameters. Also performs a
+		 * sanity check on the parameters.
+		 *
+		 * @param {object} mParams
+		 *   An object containing information about selection change
 		 */
 		TreeBindingAdapter.prototype._publishSelectionChanges = function (mParams) {
 
@@ -1694,8 +1841,10 @@ sap.ui.define([
 		};
 
 		/**
-		 * Sets the node hierarchy to collapse recursive. When set to true, all child nodes will get collapsed as well.
-		 * @param {boolean} bCollapseRecursive
+		 * Sets the node hierarchy to collapse recursive. When set to true, all child nodes will be
+		 * collapsed as well.
+		 *
+		 * @param {boolean} bCollapseRecursive Whether to enable the recursive collapsing
 		 */
 		TreeBindingAdapter.prototype.setCollapseRecursive = function (bCollapseRecursive) {
 			this.bCollapseRecursive = !!bCollapseRecursive;
@@ -1703,6 +1852,8 @@ sap.ui.define([
 
 		/**
 		 * Gets the collapsing behavior when parent nodes are collapsed.
+		 *
+		 * @returns {boolean} Whether recursive collapsing is enabled
 		 */
 		TreeBindingAdapter.prototype.getCollapseRecursive = function () {
 			return this.bCollapseRecursive;