@openui5/sap.ui.table 1.105.1 → 1.107.0

package/src/sap/ui/table/extensions/Keyboard.js

@@ -267,7 +267,7 @@ sap.ui.define([
 	 * @class Extension for sap.ui.table.Table which handles keyboard related things.
 	 * @extends sap.ui.table.extensions.ExtensionBase
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @constructor
 	 * @private
 	 * @alias sap.ui.table.extensions.Keyboard

package/src/sap/ui/table/extensions/KeyboardDelegate.js

@@ -11,8 +11,9 @@ sap.ui.define([
 	"sap/ui/base/Object",
 	"sap/ui/Device",
 	"sap/ui/events/KeyCodes",
-	"sap/ui/thirdparty/jquery"
-], function(TableUtils, library, BaseObject, Device, KeyCodes, jQuery) {
+	"sap/ui/thirdparty/jquery",
+	"sap/ui/core/Configuration"
+], function(TableUtils, library, BaseObject, Device, KeyCodes, jQuery, Configuration) {
 	"use strict";
 
 	// Shortcuts
@@ -64,7 +65,7 @@ sap.ui.define([
 	 *
 	 * @extends sap.ui.base.Object
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @constructor
 	 * @private
 	 * @alias sap.ui.table.extensions.KeyboardDelegate
@@ -249,7 +250,7 @@ sap.ui.define([
 		}
 
 		var oCellInfo = TableUtils.getCellInfo(TableUtils.getCell(oTable, oEvent.target));
-		var bIsRTL = sap.ui.getCore().getConfiguration().getRTL();
+		var bIsRTL = Configuration.getRTL();
 
 		if (!oCellInfo.isOfType(CellType.COLUMNHEADER) || !bIsRTL) {
 			return;
@@ -1555,7 +1556,7 @@ sap.ui.define([
 		}
 
 		var oCellInfo = TableUtils.getCellInfo(oEvent.target);
-		var bIsRTL = sap.ui.getCore().getConfiguration().getRTL();
+		var bIsRTL = Configuration.getRTL();
 
 		if (KeyboardDelegate._isKeyCombination(oEvent, null, ModKey.SHIFT)) {
 
@@ -1634,7 +1635,7 @@ sap.ui.define([
 		}
 
 		var oCellInfo = TableUtils.getCellInfo(oEvent.target);
-		var bIsRTL = sap.ui.getCore().getConfiguration().getRTL();
+		var bIsRTL = Configuration.getRTL();
 
 		if (KeyboardDelegate._isKeyCombination(oEvent, null, ModKey.SHIFT)) {
 			/* Range Selection */

package/src/sap/ui/table/extensions/Pointer.js

@@ -723,7 +723,9 @@ sap.ui.define([
 
 			if (oCellInfo.isOfType(TableUtils.CELLTYPE.COLUMNHEADER)) {
 				var oPointerExtension = this._getPointerExtension();
-				if (oPointerExtension._bShowMenu) {
+				var oColumn = this.getColumns()[oCellInfo.columnIndex];
+
+				if (oPointerExtension._bShowMenu && !oColumn._isMenuOpen()) {
 					TableUtils.Menu.openContextMenu(this, oEvent.target);
 					delete oPointerExtension._bShowMenu;
 				}
@@ -796,7 +798,7 @@ sap.ui.define([
 	 * @class Extension for sap.ui.table.Table which handles mouse and touch related things.
 	 * @extends sap.ui.table.extensions.ExtensionBase
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @constructor
 	 * @private
 	 * @alias sap.ui.table.extensions.Pointer

package/src/sap/ui/table/extensions/Scrolling.js

@@ -2256,7 +2256,7 @@ sap.ui.define([
 	 * @class Extension for sap.ui.table.Table which handles scrolling.
 	 * @extends sap.ui.table.extensions.ExtensionBase
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @constructor
 	 * @private
 	 * @alias sap.ui.table.extensions.Scrolling

package/src/sap/ui/table/extensions/ScrollingIOS.js

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * @class Extension for sap.ui.table.Table which handles the scrollbar on iOS.
 	 * @extends sap.ui.table.extensions.ExtensionBase
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @constructor
 	 * @private
 	 * @alias sap.ui.table.extensions.ScrollingIOS

package/src/sap/ui/table/extensions/Synchronization.js

@@ -45,12 +45,50 @@ sap.ui.define([
 
 		addVerticalScrollingListener: function(mConfig) {
 			var oTable = this.getTable();
+			var oSyncExtension = oTable._getSyncExtension();
 			var oScrollExtension = oTable._getScrollExtension();
-			var ScrollDirection = oScrollExtension.constructor.ScrollDirection;
+			var mOptions = {scrollDirection: oScrollExtension.constructor.ScrollDirection.VERTICAL};
 
-			if (mConfig) {
-				oScrollExtension.registerForMouseWheel(mConfig.wheelAreas, {scrollDirection: ScrollDirection.VERTICAL});
-				oScrollExtension.registerForTouch(mConfig.touchAreas, {scrollDirection: ScrollDirection.VERTICAL});
+			ExtensionHelper.removeVerticalScrollingListener.call(this);
+
+			if (!mConfig) {
+				return;
+			}
+
+			if (mConfig.wheelAreas) {
+				oSyncExtension._mMouseWheelEventListener = oScrollExtension.registerForMouseWheel(mConfig.wheelAreas, mOptions);
+				oSyncExtension._mMouseWheelEventListener.areas = mConfig.wheelAreas;
+			}
+
+			if (mConfig.touchAreas) {
+				oSyncExtension._mTouchEventListener = oScrollExtension.registerForTouch(mConfig.touchAreas, mOptions);
+				oSyncExtension._mTouchEventListener.areas = mConfig.touchAreas;
+			}
+		},
+
+		removeVerticalScrollingListener: function() {
+			var oTable = this.getTable();
+			var oSyncExtension = oTable._getSyncExtension();
+
+			function removeEventListener(aTargets, mEventListenerMap) {
+				for (var sEventName in mEventListenerMap) {
+					var fnListener = mEventListenerMap[sEventName];
+					if (fnListener) {
+						for (var i = 0; i < aTargets.length; i++) {
+							aTargets[i].removeEventListener(sEventName, fnListener);
+						}
+					}
+				}
+			}
+
+			if (oSyncExtension._mMouseWheelEventListener) {
+				removeEventListener(oSyncExtension._mMouseWheelEventListener.areas, oSyncExtension._mMouseWheelEventListener);
+				delete oSyncExtension._mMouseWheelEventListener;
+			}
+
+			if (oSyncExtension._mTouchEventListener) {
+				removeEventListener(oSyncExtension._mTouchEventListener.areas, oSyncExtension._mTouchEventListener);
+				delete oSyncExtension._mTouchEventListener;
 			}
 		},
 
@@ -142,7 +180,7 @@ sap.ui.define([
 	 * @class Extension for sap.ui.table.Table that allows synchronization with a table.
 	 * @extends sap.ui.table.extensions.ExtensionBase
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @constructor
 	 * @private
 	 * @alias sap.ui.table.extensions.Synchronization
@@ -160,6 +198,7 @@ sap.ui.define([
 				syncRowSelection: ExtensionHelper.setRowSelection.bind(this),
 				syncRowHover: ExtensionHelper.setRowHover.bind(this),
 				registerVerticalScrolling: ExtensionHelper.addVerticalScrollingListener.bind(this),
+				deregisterVerticalScrolling: ExtensionHelper.removeVerticalScrollingListener.bind(this),
 				placeVerticalScrollbarAt: ExtensionHelper.placeVerticalScrollbarAt.bind(this),
 				renderHorizontalScrollbar: ExtensionHelper.renderHorizontalScrollbar.bind(this)
 			};
@@ -180,6 +219,7 @@ sap.ui.define([
 				oTable.removeEventDelegate(this._delegate);
 			}
 
+			ExtensionHelper.removeVerticalScrollingListener.call(this);
 			this._delegate = null;
 			this._oPublicInterface = null;
 
@@ -278,6 +318,7 @@ sap.ui.define([
 	 *   <li>syncRowSelection: function(index:int, selected:boolean):void</li>
 	 *   <li>syncRowHover: function(index:int, selected:boolean):void</li>
 	 *   <li>registerVerticalScrolling: function({wheelAreas:HTMLElement[], touchAreas:HTMLElement[]}):void</li>
+	 *   <li>deregisterVerticalScrolling: function():void</li>
 	 *   <li>placeVerticalScrollbarAt: function(container:HTMLElement):void</li>
 	 *   <li>renderHorizontalScrollbar: function(renderManager:sap.ui.core.RenderManager, id:string, scrollWidth:int):void</li>
 	 * </ul>
@@ -289,8 +330,6 @@ sap.ui.define([
 	 * The <code>Synchronization</code> extension has no mechanisms to avoid infinite synchronization loops. This means that the
 	 * <code>Synchronization</code> extension can also call the corresponding hook if a synchronization method of this interface is used. It is the
 	 * responsibility of the user of the synchronization interface to avoid endless loops.
-	 * Registering HTMLElements for event handling by the table (e.g. via <code>registerVerticalScrolling</code>) can cause memory leaks. To avoid
-	 * this, make sure to avoid registering the same elements multiple times.
 	 *
 	 * @example
 	 * // Add a row selection hook.

package/src/sap/ui/table/library.js

@@ -20,13 +20,13 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	 * @namespace
 	 * @alias sap.ui.table
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @since 0.8
 	 * @public
 	 */
 	var thisLib = sap.ui.getCore().initLibrary({
 		name : "sap.ui.table",
-		version: "1.105.1",
+		version: "1.107.0",
 		dependencies : ["sap.ui.core","sap.ui.unified"],
 		designtime: "sap/ui/table/designtime/library.designtime",
 		types: [
@@ -80,10 +80,9 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	/**
 	 * Navigation mode of the table
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @enum {string}
 	 * @public
-	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	thisLib.NavigationMode = {
 
@@ -108,10 +107,9 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	/**
 	 * Row Action types.
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @enum {string}
 	 * @public
-	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	thisLib.RowActionType = {
 
@@ -139,10 +137,9 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	/**
 	 * Selection behavior of the table
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @enum {string}
 	 * @public
-	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	thisLib.SelectionBehavior = {
 
@@ -170,10 +167,9 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	/**
 	 * Selection mode of the table
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @enum {string}
 	 * @public
-	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	thisLib.SelectionMode = {
 
@@ -208,10 +204,9 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	/**
 	 * Sort order of a column
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @enum {string}
 	 * @public
-	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	thisLib.SortOrder = {
 
@@ -233,10 +228,9 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	/**
 	 * VisibleRowCountMode of the table
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @enum {string}
 	 * @public
-	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	thisLib.VisibleRowCountMode = {
 
@@ -265,7 +259,7 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	 *
 	 * Contains IDs of shared DOM references, which should be accessible to inheriting controls via getDomRef() function.
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @enum {string}
 	 * @public
 	 */
@@ -363,7 +357,7 @@ sap.ui.define(['sap/ui/core/Core', 'sap/ui/model/TreeAutoExpandMode',
 	 *
 	 * This is an alias for {@link sap.ui.model.TreeAutoExpandMode} and kept for compatibility reasons.
 	 *
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @typedef {sap.ui.model.TreeAutoExpandMode}
 	 * @public
 	 */

package/src/sap/ui/table/menus/ColumnHeaderMenuAdapter.js

@@ -0,0 +1,224 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"../utils/TableUtils",
+	"sap/ui/base/Object",
+	"sap/ui/base/EventProvider",
+	"sap/ui/base/ManagedObjectObserver"
+], function(
+	TableUtils,
+	BaseObject,
+	EventProvider,
+	ManagedObjectObserver
+) {
+	"use strict";
+
+	var oAdapterRegistry = new window.Map();
+	var mAdapterMapping = {
+		"sap.m.table.columnmenu.Menu": "MobileColumnHeaderMenuAdapter"
+	};
+
+	/**
+	 * Constructor for a new ColumnHeaderMenuAdapter.
+	 *
+	 * @class
+	 * Base class that provides methods to map and reuse the column menu instance between multiple columns.
+	 *
+	 * @extends sap.ui.base.Object
+	 * @author SAP SE
+	 * @version 1.107.0
+	 * @private
+	 * @alias sap.ui.table.menus.ColumnHeaderMenuAdapter
+	 */
+	var ColumnHeaderMenuAdapter = BaseObject.extend("sap.ui.table.menus.ColumnHeaderMenuAdapter", /** @lends sap.ui.table.menus.ColumnHeaderMenuAdapter.prototype */ {
+		constructor: function() {
+			BaseObject.apply(this, arguments);
+
+			this._mInjectionTarget = null;
+
+			// The menu is just associated with the column. There is no automatic notification about the destruction of the menu.
+			this._oColumnHeaderMenuObserver = new ManagedObjectObserver(function(oChange) {
+				this.onAfterMenuDestroyed(oChange.object);
+			}.bind(this));
+		}
+	});
+
+	/**
+	 * Activates an adapter for the column and links them, if there is an adapter for the menu type the column is associated with. The adapter adds
+	 * items to the menu based on the column configuration. Should be called before the menu is opened. The menu should then be opened after the
+	 * returned <code>Promise</code> resolves, to make sure it already contains all items.
+	 * Activation is required again before opening the menu, if the column is associated with a menu of a different type, or the column
+	 * configuration that affects the added menu items is changed. In other cases, a repeated activation is not required, but possible. However,
+	 * depending on the concrete adapter implementation this might cause unnecessary overhead.
+	 *
+	 * @see sap.ui.table.menus.ColumnHeaderMenuAdapter.unlink
+	 * @param {sap.ui.table.Column} oColumn The column for which to activate an adapter
+	 * @returns {Promise} A promise that resolves once the adapter is activated and the menu items are modified
+	 */
+	ColumnHeaderMenuAdapter.activateFor = function(oColumn) {
+		var oColumnHeaderMenu = oColumn.getHeaderMenuInstance();
+		var sAdapterName = getAdapterName(oColumnHeaderMenu);
+		var mRegistryData;
+
+		if (!sAdapterName || !oColumn._getTable()) {
+			return Promise.resolve();
+		}
+
+		// Unlink column from other adapters. Can be necessary if the column is associated with a different menu of another type.
+		oAdapterRegistry.forEach(function(_mRegistryData, _sAdapterName) {
+			if (_sAdapterName !== sAdapterName) {
+				unlink(oColumn, _sAdapterName);
+			}
+		});
+
+		if (!oAdapterRegistry.has(sAdapterName)) {
+			mRegistryData = {
+				adapter: requireAdapter(sAdapterName).then(function(Adapter) {
+					mRegistryData = oAdapterRegistry.get(sAdapterName);
+					mRegistryData.adapter = new Adapter();
+					mRegistryData.adapter._injectMenuItems(mRegistryData.activeFor.getHeaderMenuInstance(), mRegistryData.activeFor);
+				}),
+				columns: [oColumn],
+				activeFor: oColumn
+			};
+			oAdapterRegistry.set(sAdapterName, mRegistryData);
+		} else {
+			mRegistryData = oAdapterRegistry.get(sAdapterName);
+			mRegistryData.activeFor = oColumn;
+
+			if (!mRegistryData.columns.includes(oColumn)) {
+				mRegistryData.columns.push(oColumn);
+			}
+		}
+
+		if (mRegistryData.adapter instanceof Promise) {
+			return mRegistryData.adapter;
+		}
+
+		mRegistryData.adapter._injectMenuItems(oColumnHeaderMenu, oColumn);
+
+		return Promise.resolve();
+	};
+
+	/**
+	 * Unlinks the column from the adapter. If a column does no longer need an adapter, for example because it is destroyed, it needs to be unlinked
+	 * for proper cleanup.
+	 *
+	 * @param {sap.ui.table.Column} oColumn The column for the mapping to be removed
+	 */
+	ColumnHeaderMenuAdapter.unlink = function(oColumn) {
+		unlink(oColumn);
+	};
+
+	ColumnHeaderMenuAdapter.prototype._injectMenuItems = function(oColumnHeaderMenu, oColumn) {
+		this._removeMenuItems();
+		this._oColumnHeaderMenuObserver.observe(oColumnHeaderMenu, {destroy: true});
+		this.injectMenuItems(oColumnHeaderMenu, oColumn);
+		this._mInjectionTarget = {
+			column: oColumn,
+			menu: oColumnHeaderMenu
+		};
+	};
+
+	ColumnHeaderMenuAdapter.prototype._removeMenuItems = function() {
+		if (!this._mInjectionTarget) {
+			return;
+		}
+
+		this.removeMenuItems(this._mInjectionTarget.menu);
+		this._mInjectionTarget = null;
+	};
+
+	/**
+	 * This hook is called when menu items should be added to the column menu.
+	 *
+	 * @param {sap.ui.core.IColumnHeaderMenu} oColumnHeaderMenu Instance of the column menu
+	 * @param {sap.ui.table.Column} oColumn Instance of the column
+	 */
+	ColumnHeaderMenuAdapter.prototype.injectMenuItems = function(oColumnHeaderMenu, oColumn) {};
+
+	/**
+	 * This hook is called when menu items should be removed from the column menu.
+	 *
+	 * @param {sap.ui.core.IColumnHeaderMenu} oColumnHeaderMenu
+	 */
+	ColumnHeaderMenuAdapter.prototype.removeMenuItems = function(oColumnHeaderMenu) {};
+
+	/**
+	 * This hook is called after the column menu and injected menu items are destroyed.
+	 *
+	 * @param {sap.ui.core.IColumnHeaderMenu} oColumnHeaderMenu
+	 */
+	ColumnHeaderMenuAdapter.prototype.onAfterMenuDestroyed = function(oColumnHeaderMenu) {};
+
+	/**
+	 * Destroys the instance of the <code>ColumnHeaderMenuAdapter</code> and the change observer
+	 */
+	ColumnHeaderMenuAdapter.prototype.destroy = function() {
+		BaseObject.prototype.destroy.apply(this, arguments);
+		this._removeMenuItems();
+		this._oColumnHeaderMenuObserver.disconnect();
+		delete this._oColumnHeaderMenuObserver;
+	};
+
+	function requireAdapter(sAdapterName) {
+		return new Promise(function(resolve, reject) {
+			sap.ui.require(["sap/ui/table/menus/" + sAdapterName], function(Module) {
+				resolve(Module);
+			}, function(oError) {
+				reject(oError);
+			});
+		});
+	}
+
+	function getAdapterName(oColumnHeaderMenu) {
+		for (var sMenuType in mAdapterMapping) {
+			if (TableUtils.isA(oColumnHeaderMenu, sMenuType)) {
+				return mAdapterMapping[sMenuType];
+			}
+		}
+
+		return "";
+	}
+
+	function unlink(oColumn, sAdapterName) {
+		var mRegistryData;
+
+		if (sAdapterName) {
+			mRegistryData = oAdapterRegistry.get(sAdapterName);
+		} else {
+			oAdapterRegistry.forEach(function(_mRegistryData, _sAdapterName) {
+				if (_mRegistryData.columns.includes(oColumn)) {
+					mRegistryData = _mRegistryData;
+					sAdapterName = _sAdapterName;
+				}
+			});
+		}
+
+
+		if (!mRegistryData) {
+			return;
+		}
+
+		if (mRegistryData.adapter instanceof Promise) {
+			mRegistryData.adapter.then(function() {
+				unlink(oColumn, sAdapterName);
+			});
+		} else {
+			if (mRegistryData.columns.includes(oColumn)) {
+				mRegistryData.columns.splice(mRegistryData.columns.indexOf(oColumn), 1);
+			}
+
+			if (mRegistryData.columns.length === 0) {
+				mRegistryData.adapter.destroy();
+				oAdapterRegistry.delete(sAdapterName);
+			}
+		}
+	}
+
+	return ColumnHeaderMenuAdapter;
+});