@openui5/sap.ui.dt 1.96.5 → 1.99.0

package/src/sap/ui/dt/ElementDesignTimeMetadata.js

@@ -9,8 +9,7 @@ sap.ui.define([
 	"sap/ui/dt/DesignTimeMetadata",
 	"sap/ui/dt/AggregationDesignTimeMetadata",
 	"sap/ui/dt/ElementUtil"
-],
-function(
+], function(
 	DesignTimeMetadata,
 	AggregationDesignTimeMetadata,
 	ElementUtil
@@ -28,7 +27,7 @@ function(
 	 * @extends sap.ui.dt.DesignTimeMetadata
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @constructor
 	 * @private
@@ -234,8 +233,8 @@ function(
 
 	/**
 	 * Returns property "ignore" of aggregation DT metadata
-	 * @param {Object} oElement Element whose aggregation has to be checked
-	 * @param {String} sAggregationName Name of the Aggregation
+	 * @param {sap.ui.core.Element} oElement Element whose aggregation has to be checked
+	 * @param {string} sAggregationName Name of the Aggregation
 	 * @return {boolean} if ignored
 	 * @public
 	 */
@@ -252,6 +251,9 @@ function(
 	/**
 	 * Returns the scroll containers or an empty array
 	 *
+	 * @param {object} oElement - Element
+	 * @param {boolean} bInvalidate - Indicates if the scroll container should be invalidated first
+	 * @param {function} fnUpdateFunction - Function to be called for update
 	 * @return {array} scrollContainers or empty array
 	 * @public
 	 */

package/src/sap/ui/dt/ElementOverlay.js

@@ -55,7 +55,7 @@ sap.ui.define([
 	 * @extends sap.ui.dt.Overlay
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @constructor
 	 * @private
@@ -421,6 +421,7 @@ sap.ui.define([
 
 	/**
 	 * Sorts children DOM Nodes in their visual order
+	 * @param {object} oContainer - Container object whose children should be sorted
 	 * @private
 	 */
 	ElementOverlay.prototype._sortChildren = function(oContainer) {
@@ -573,7 +574,8 @@ sap.ui.define([
 
 	/**
 	 * Gets information about scroll containers from DesignTime metadata
-	 * @returns {object[]} - returns an array with scroll containers description
+	 * @param {boolean} bInvalidate - Indicates if the scroll container should be invalidated first
+	 * @returns {object[]} Array with the scroll container's description
 	 */
 	ElementOverlay.prototype.getScrollContainers = function (bInvalidate) {
 		return this.getDesignTimeMetadata().getScrollContainers(this.getElement(), bInvalidate, this._updateScrollContainer.bind(this));
@@ -704,6 +706,7 @@ sap.ui.define([
 						} else if (!bLastStackEntry) {
 							highlightTemplateCloneElements(mAggregationBindingInfo, oChildElementOverlay, iStackIndex - 1);
 						}
+						return undefined;
 					});
 				}
 			});
@@ -876,6 +879,7 @@ sap.ui.define([
 		if (oParentAggregationOverlay) {
 			return oParentAggregationOverlay.getParent();
 		}
+		return undefined;
 	};
 
 	/**

package/src/sap/ui/dt/ElementUtil.js

@@ -14,8 +14,7 @@ sap.ui.define([
 	"sap/ui/core/Component",
 	"sap/base/util/isPlainObject",
 	"sap/ui/core/UIArea"
-],
-function(
+], function(
 	jQuery,
 	BaseObject,
 	Util,
@@ -33,7 +32,7 @@ function(
 	 * @class Utility functionality to work with elements, e.g. iterate through aggregations, find parents, ...
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @private
 	 * @static
@@ -57,9 +56,6 @@ function(
 		}, this);
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.getElementInstance = function(vElement) {
 		if (typeof vElement === "string") {
 			var oElement = sap.ui.getCore().byId(vElement);
@@ -68,9 +64,6 @@ function(
 		return vElement;
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.hasAncestor = function(oElement, oAncestor) {
 		oAncestor = this.fixComponentContainerElement(oAncestor);
 		var oFixedParent;
@@ -88,17 +81,11 @@ function(
 		return !!oElement;
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.getClosestElementForNode = function(oNode) {
 		var $ClosestElement = jQuery(oNode).closest("[data-sap-ui]");
 		return $ClosestElement.length ? sap.ui.getCore().byId($ClosestElement.attr("data-sap-ui")) : undefined;
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.fixComponentParent = function(oElement) {
 		if (BaseObject.isA(oElement, "sap.ui.core.UIComponent")) {
 			var oComponentContainer = oElement.oContainer;
@@ -110,9 +97,6 @@ function(
 		}
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.fixComponentContainerElement = function(oElement) {
 		if (BaseObject.isA(oElement, "sap.ui.core.ComponentContainer")) {
 			// This happens when the compontentContainer has not been rendered yet
@@ -124,9 +108,6 @@ function(
 		return oElement;
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.getDomRef = function(oElement) {
 		if (oElement) {
 			var oDomRef;
@@ -140,9 +121,6 @@ function(
 		}
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.findAllSiblingsInContainer = function(oElement, oContainer) {
 		var oParent = oElement && oElement.getParent();
 		if (!oParent) {
@@ -211,9 +189,6 @@ function(
 		return this.getAggregation(oParent, sAggregationName).indexOf(oElement);
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.addAggregation = function(oParent, sAggregationName, oElement) {
 		if (this.hasAncestor(oParent, oElement)) {
 			throw new Error("Trying to add an element to itself or its successors");
@@ -226,9 +201,6 @@ function(
 		}
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.removeAggregation = function(oParent, sAggregationName, oElement, bSuppressInvalidate) {
 		var sAggregationRemoveMutator = this.getAggregationAccessors(oParent, sAggregationName).remove;
 		if (sAggregationRemoveMutator) {
@@ -238,9 +210,6 @@ function(
 		}
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.insertAggregation = function(oParent, sAggregationName, oElement, iIndex) {
 		if (this.hasAncestor(oParent, oElement)) {
 			throw new Error("Trying to add an element to itself or its successors");
@@ -265,9 +234,6 @@ function(
 		}
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.isValidForAggregation = function(oParent, sAggregationName, oElement) {
 		var oAggregationMetadata = oParent.getMetadata().getAggregation(sAggregationName);
 
@@ -329,9 +295,6 @@ function(
 			}, this);
 	};
 
-	/**
-	 *
-	 */
 	ElementUtil.hasInterface = function(oElement, sInterface) {
 		var aInterfaces = oElement.getMetadata().getInterfaces();
 		return aInterfaces.indexOf(sInterface) !== -1;
@@ -408,8 +371,8 @@ function(
 	 * Extract potential label part from the passed managed object instance
 	 *
 	 * @param {sap.ui.base.ManagedObject} oElement - managed object class instance for which label has to be extracted
-	 * @param {Function} [fnFunction] - custom function for retrieving label
-	 * @return {String|undefined} label string or undefined when no label can be extracted
+	 * @param {function} [fnFunction] - custom function for retrieving label
+	 * @return {string|undefined} label string or undefined when no label can be extracted
 	 */
 	ElementUtil.getLabelForElement = function(oElement, fnFunction) {
 		if (!ElementUtil.isElementValid(oElement)) {
@@ -474,7 +437,7 @@ function(
 	/**
 	 * The AggregationBindingStack contains element id and aggregation name of the bound control together with a stack containing
 	 * information about the traversed elements for an Overlay which is part of an aggregation binding.
-	 * @typedef {Object} sap.ui.dt.ElementUtil.AggregationBindingStack
+	 * @typedef {object} sap.ui.dt.ElementUtil.AggregationBindingStack
 	 * @property {string} elementId - id of the bound control.
 	 * @property {string} aggregation - name of the bound aggregation.
 	 * @property {string} templateId - id of the binding template.

package/src/sap/ui/dt/ManagedObjectObserver.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @class The ManagedObjectObserver observes changes of a ManagedObject and propagates them via events.
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @constructor
 	 * @private
 	 * @since 1.30
@@ -588,6 +588,7 @@ sap.ui.define([
 	/**
 	 * Stops observing the target object. Override this method in classes which extend ManagedObjectObserver.
 	 *
+	 * @param {object} oTarget - Target object
 	 * @protected
 	 */
 	ManagedObjectObserver.prototype.unobserve = function(oTarget) {

package/src/sap/ui/dt/MetadataPropagationUtil.js

@@ -9,8 +9,7 @@ sap.ui.define([
 	"sap/ui/dt/Util",
 	"sap/base/util/merge",
 	"sap/base/util/isEmptyObject"
-],
-function(
+], function(
 	Util,
 	merge,
 	isEmptyObject
@@ -22,7 +21,7 @@ function(
 	 *
 	 * @class Functionality to propagate DesignTime and RelevantContainer
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @private
 	 * @static
 	 * @since 1.54
@@ -99,9 +98,10 @@ function(
 	 * Extend the passed aggregationOverlay metadata with propagated aggregationOverlay metadata from parent
 	 * and metadata to propagte from passed elementOverlay metadata.
 	 *
-	 * @param {object} mOriginalMetadata - aggregation designtime metadata data map to be extended with propagation data
-	 * @param {sap.ui.core.Element} oElement - element may be used as relevant container
-	 * @return {object} Returns extended data part of the element designtime metadata.
+	 * @param {object} mOriginalMetadata - Aggregation design time metadata data map to be extended with propagation data
+	 * @param {sap.ui.core.Element} oElement - Element may be used as relevant container
+	 * @param {object} mParentAggregationMetadata - Aggregation design time metadata of the parent
+	 * @return {object} Extended data part of the element design time metadata.
 	 */
 	MetadataPropagationUtil.propagateMetadataToAggregationOverlay = function(mOriginalMetadata, oElement, mParentAggregationMetadata) {
 		var mNewPropagationInfo;

package/src/sap/ui/dt/MutationObserver.js

@@ -30,7 +30,7 @@ sap.ui.define([
 	 * @class The MutationObserver observes changes of a ManagedObject and propagates them via events.
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @constructor
 	 * @private
 	 * @since 1.30

package/src/sap/ui/dt/Overlay.js

@@ -4,7 +4,6 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
-/* global Map */
 sap.ui.define([
 	"sap/ui/thirdparty/jquery",
 	"sap/ui/core/Element",
@@ -16,8 +15,7 @@ sap.ui.define([
 	"sap/ui/dt/Util",
 	"sap/base/Log",
 	"sap/ui/dt/util/ZIndexManager"
-],
-function (
+], function (
 	jQuery,
 	Element,
 	MutationObserver,
@@ -46,7 +44,7 @@ function (
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @constructor
 	 * @private
@@ -312,6 +310,7 @@ function (
 
 	/**
 	 * Creates and/or returns mutation observer instance
+	 * @returns {object} Mutation observer
 	 * @static
 	 */
 	Overlay.getMutationObserver = function() {
@@ -342,7 +341,7 @@ function (
 
 	/**
 	 * Returns set of attributes for DOM Node of overlay
-	 * @returns {{id: string, "data-sap-ui": string, class: string, tabindex: *}}
+	 * @returns {{id: string, "data-sap-ui": string, class: string, tabindex: *}} Object with attributes
 	 * @protected
 	 */
 	Overlay.prototype._getAttributes = function () {
@@ -539,7 +538,6 @@ function (
 	/**
 	 * Sets whether the overlay can get the browser focus (tabindex)
 	 * @param {boolean} bFocusable - true if the overlay is focusable
-	 * @returns {sap.ui.dt.Overlay} returns this
 	 * @public
 	 */
 	Overlay.prototype.setFocusable = function(bFocusable) {
@@ -562,7 +560,7 @@ function (
 
 	/**
 	 * Returns valuable parent node that has dimensions and certain position.
-	 * @returns {jQuery|null}
+	 * @returns {jQuery|null} Parent jQuery object or null, if there is none
 	 * @protected
 	 */
 	Overlay.prototype._getRenderingParent = function () {
@@ -574,6 +572,7 @@ function (
 	 * The calculation is based on original associated DOM state and parent overlays
 	 * This method also calls "applyStyles" method for every child Overlay of this Overlay (cascade)
 	 * @param {boolean} bForceScrollbarSync - `true` to force a scrollbars synchronisation if there are any
+	 * @returns {Promise} Resolves as soon as <code>applyStyles</code> is done
 	 * @public
 	 */
 	Overlay.prototype.applyStyles = function (bForceScrollbarSync) {
@@ -660,7 +659,7 @@ function (
 	 * then ZIndexManager is used to calculate a z-index value lower than open popups and higher than other controls.
 	 * @see sap.ui.core.util.ZIndexManager
 	 * @param {object} oGeometry - Geometry object to get reference z-index from
-	 * @param {jQuery} $overlayDomRef - DOM Element to receive the z-index
+	 * @param {jQuery} $overlayDomRef - DOM element to receive the z-index
 	 */
 	Overlay.prototype._setZIndex = function (oGeometry, $overlayDomRef) {
 		var oOriginalDomRef = oGeometry.domRef;
@@ -675,7 +674,7 @@ function (
 
 	/**
 	 * Sets size to specified DOM Element
-	 * @param {jQuery} $Target - DOM Element which will receive new size
+	 * @param {jQuery} $Target - DOM element which will receive new size
 	 * @param {object} oGeometry - Geometry object to get new dimensions from
 	 * @protected
 	 */
@@ -691,8 +690,8 @@ function (
 	};
 
 	/**
-	 * Sets position of specified DOM Element
-	 * @param {jQuery} $Target - DOM Element which will receive new position
+	 * Sets position of specified DOM element
+	 * @param {jQuery} $Target - DOM element which will receive new position
 	 * @param {object} oGeometry - Geometry object to get positioning from
 	 * @param {jQuery} $Parent - Offset element for position calculation
 	 * @protected
@@ -735,9 +734,10 @@ function (
 	 * Note: listeners are only removed, if the same combination of event type, callback function
 	 * and context object is given as in the call to <code>attachBrowserEvent</code>.
 	 *
-	 * @param {string} [sEventType] A string containing one or more JavaScript event types, such as "click" or "blur".
-	 * @param {function} [fnHandler] The function that is to be no longer executed.
-	 * @param {object} [oListener] The context object that was given in the call to <code>attachBrowserEvent</code>.
+	 * @param {string} [sEventType] - String containing one or more JavaScript event types, such as "click" or "blur".
+	 * @param {function} [fnHandler] - Function that is to be no longer executed.
+	 * @param {object} [oListener] - Context object that was given in the call to <code>attachBrowserEvent</code>.
+	 * @returns {sap.ui.dt.Overlay} <code>this</code> object
 	 * @public
 	 */
 	Overlay.prototype.detachBrowserEvent = function(sEventType, fnHandler, oListener) {
@@ -767,8 +767,7 @@ function (
 	/**
 	 * Cleans up when scrolling is no longer needed in the overlay
 	 * @param {jQuery} $TargetDomRef - DOM reference to the element where dummy container is located
-	 * @param {sap.ui.dt.ElementOverlay} [oTargetOverlay]
-	 *        Overlay which holds scrollbar padding via CSS classes. In case of root overlay, the target is undefined.
+	 * @param {sap.ui.dt.ElementOverlay} [oTargetOverlay] - Overlay which holds scrollbar padding via CSS classes. In case of root overlay, the target is undefined.
 	 *
 	 * @private
 	 */
@@ -866,6 +865,7 @@ function (
 	 * The geometry is calculated based on the associated element's DOM reference, if it exists or based on it's public children
 	 * Object may contain following fields: position - absolute position of Element in DOM; size - absolute size of Element in DOM
 	 * Object may contain domRef field, when the associated Element's DOM can be found
+	 * @param {boolean} bForceCalculation - Forces the recalculation of the geometry
 	 * @return {object} geometry object describing the DOM of the Element associated with this Overlay
 	 * @public
 	 */
@@ -900,7 +900,6 @@ function (
 	/**
 	 * Sets whether the Overlay is visible
 	 * @param {boolean} bVisible if the Overlay is visible
-	 * @returns {sap.ui.dt.Overlay} returns this
 	 * @public
 	 */
 	Overlay.prototype.setVisible = function(bVisible) {

package/src/sap/ui/dt/OverlayRegistry.js

@@ -25,7 +25,7 @@ function(
 	 * Static registry for Overlays
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @private
 	 * @static
@@ -64,8 +64,7 @@ function(
 
 	/**
 	 * Registers an overlay for the element or element's id
-	 * @param {string|sap.ui.core.Element} vElementOrId element instance or id
-	 * @param {sap.ui.dt.Overlay} oOverlay overlay to register
+	 * @param {sap.ui.dt.Overlay} oOverlay - Overlay to register
 	 * @public
 	 */
 	OverlayRegistry.register = function(oOverlay) {

package/src/sap/ui/dt/OverlayUtil.js

@@ -22,7 +22,7 @@ function(
 	 *
 	 * @class Utility functionality to work with overlays
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @private
 	 * @static
 	 * @since 1.30
@@ -420,9 +420,9 @@ function(
 					return aFlattenedArray.concat(oCurrentValue);
 				}, []);
 			} else {
-				aRelevantOverlays = oOverlay.getParentElementOverlay()
-										.getAggregationOverlay(oOverlay.getParentAggregationOverlay().getAggregationName())
-										.getChildren();
+				var sAggregationName = oOverlay.getParentAggregationOverlay().getAggregationName();
+				var oAggregationOverlay = oParentOverlay.getAggregationOverlay(sAggregationName);
+				aRelevantOverlays = (oAggregationOverlay && oAggregationOverlay.getChildren()) || [];
 			}
 		}
 
@@ -644,7 +644,7 @@ function(
 	/**
 	 * The AggregationBindingInfo contains the overlay ID and the aggregation name of the bound control together with stack containing
 	 * information about the traversed elements for an overlay which is part of an aggregation binding.
-	 * @typedef {Object} sap.ui.dt.OverlayUtil.AggregationBindingInfo
+	 * @typedef {object} sap.ui.dt.OverlayUtil.AggregationBindingInfo
 	 * @property {string} overlayId - ID of the bound overlay that contains binding aggregation template overlays
 	 * @property {string} aggregation - Name of the bound aggregation
 	 * @property {Object[]} stack - Array of objects containing element, element type, aggregation name, and index of the element in

package/src/sap/ui/dt/Plugin.js

@@ -26,7 +26,7 @@ function(
 	 * @extends sap.ui.base.ManagedObject
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @constructor
 	 * @private
@@ -64,6 +64,8 @@ function(
 
 	Plugin.prototype._bProcessingCounter = 0;
 
+	Plugin.prototype._oBusyPromise = {};
+
 	/**
 	 * Called when the Plugin is initialized
 	 * @protected
@@ -236,6 +238,33 @@ function(
 	 */
 	Plugin.prototype.isBusy = Plugin.prototype.getBusy;
 
+	/**
+	 * Setter for the busy property. Sets a promise internally to be able to wait for a busy plugin
+	 *
+	 * @param {boolean} bBusy - Value for the busy state
+	 * @returns {this} Returns <code>this</code>
+	 */
+	Plugin.prototype.setBusy = function(bBusy) {
+		if (bBusy && !this.getBusy()) {
+			this._oBusyPromise.promise = new Promise(function(resolve) {
+				this._oBusyPromise.resolveFunction = resolve;
+			}.bind(this));
+		} else if (!bBusy && this.getBusy() && this._oBusyPromise.resolveFunction) {
+			this._oBusyPromise.resolveFunction();
+		}
+		this.setProperty("busy", bBusy);
+		return this;
+	};
+
+	/**
+	 * Waits for the busy promise and resolves as soon as the plugin is not busy anymore
+	 *
+	 * @returns {Promise<undefined>} Resolves with undefined
+	 */
+	Plugin.prototype.waitForBusyAction = function() {
+		return this._oBusyPromise.promise || Promise.resolve();
+	};
+
 	/**
 	 * @param {boolean} bProcessing - processing state to set
 	 */

package/src/sap/ui/dt/ScrollbarSynchronizer.js

@@ -24,7 +24,7 @@ function(
 	 * @extends sap.ui.base.ManagedObject
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @constructor
 	 * @private
@@ -116,7 +116,7 @@ function(
 	/**
 	 * Check if a Dom Node is a target for this Scrollbar Synchronizer
 	 * @param  {Element}  oDomNode Element to be checked
-	 * @return {Boolean}          Returns true if the node is a target
+	 * @return {boolean}          Returns true if the node is a target
 	 */
 	ScrollbarSynchronizer.prototype.hasTarget = function (oDomNode) {
 		return this.getTargets().indexOf(oDomNode) > -1;

package/src/sap/ui/dt/SelectionManager.js

@@ -34,7 +34,7 @@ function (
 	 * @extends sap.ui.base.ManagedObject
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/dt/SelectionMode.js

@@ -16,7 +16,7 @@ sap.ui.define(function() {
 	 * @namespace
 	 * @name sap.ui.dt.SelectionMode
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 * @experimental This class is experimental and provides only limited functionality. Also the API might be changed in future.
 	 * @private
 	 */