@openui5/sap.m 1.120.6 → 1.121.0

package/src/sap/m/p13n/BasePanel.js

@@ -5,6 +5,8 @@
  */
 
 sap.ui.define([
+	"sap/ui/core/Element",
+	"sap/ui/core/Lib",
 	'sap/ui/model/json/JSONModel',
 	'sap/m/VBox',
 	'sap/ui/core/Control',
@@ -23,8 +25,34 @@ sap.ui.define([
 	"sap/base/Log",
 	"sap/ui/Device",
 	"sap/m/library",
+	"sap/ui/core/library",
+	"sap/m/MessageStrip",
 	"sap/ui/core/InvisibleText"
-], function(JSONModel, VBox, Control, Column, Text, Filter, Table, OverflowToolbar, SearchField, ToolbarSpacer, OverflowToolbarButton, OverflowToolbarLayoutData, DragDropInfo, ShortcutHintsMixin, KeyCodes, Log, Device, library, InvisibleText) {
+], (
+	Element,
+	Library,
+	JSONModel,
+	VBox,
+	Control,
+	Column,
+	Text,
+	Filter,
+	Table,
+	OverflowToolbar,
+	SearchField,
+	ToolbarSpacer,
+	OverflowToolbarButton,
+	OverflowToolbarLayoutData,
+	DragDropInfo,
+	ShortcutHintsMixin,
+	KeyCodes,
+	Log,
+	Device,
+	library,
+	coreLibrary,
+	MessageStrip,
+	InvisibleText
+) => {
 	"use strict";
 
 	/**
@@ -52,7 +80,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 *
 	 * @public
 	 * @abstract
@@ -60,7 +88,7 @@ sap.ui.define([
 	 * @since 1.96
 	 * @alias sap.m.p13n.BasePanel
 	 */
-	var BasePanel = Control.extend("sap.m.p13n.BasePanel", {
+	const BasePanel = Control.extend("sap.m.p13n.BasePanel", {
 		metadata: {
 			library: "sap.m",
 			interfaces: [
@@ -99,7 +127,7 @@ sap.ui.define([
 				/**
 				 * Defines an optional message strip to be displayed in the content area.
 				 */
-				 messageStrip: {
+				messageStrip: {
 					type: "sap.m.MessageStrip",
 					multiple: false
 				},
@@ -238,16 +266,27 @@ sap.ui.define([
 	 * @param {boolean} bOnlyActive Determines whether only the present items is included
 	 * @returns {sap.m.p13n.Item[]} An array containing the personalization state that is currently displayed by the <code>BasePanel</code>
 	 */
-	BasePanel.prototype.getP13nData = function (bOnlyActive) {
-		var aItems = this._getP13nModel().getProperty("/items");
+	BasePanel.prototype.getP13nData = function(bOnlyActive) {
+		let aItems = this._getP13nModel().getProperty("/items");
 		if (bOnlyActive) {
-			aItems = aItems.filter(function(oItem){
+			aItems = aItems.filter((oItem) => {
 				return oItem[this.PRESENCE_ATTRIBUTE];
-			}.bind(this));
+			});
 		}
 		return aItems;
 	};
 
+	/**
+	 * Gets the corresponding <code>sap.m.p13n.Item</code> for the provided key.
+	 *
+	 * @public
+	 * @param {string} sName The unique identifier
+	 * @returns {sap.m.p13n.Item|null} The personalization model item
+	 */
+	BasePanel.prototype.getItemByKey = function(sName) {
+		return this.getP13nData().find((oP13nItem) => oP13nItem.name == sName);
+	};
+
 	/**
 	 * Displays a <code>sap.m.MessageStrip</code> instance in the content area of the <code>BasePanel</code>.
 	 *
@@ -255,7 +294,7 @@ sap.ui.define([
 	 * @param {sap.m.MessageStrip} oStrip Instance of a sap.m.MessageStrip
 	 * @returns {sap.m.p13n.BasePanel} The <code>BasePanel</code> instance
 	 */
-	BasePanel.prototype.setMessageStrip = function(oStrip){
+	BasePanel.prototype.setMessageStrip = function(oStrip) {
 		if (!oStrip) {
 			this.getAggregation("_content").removeItem(this._oMessageStrip);
 			this._oMessageStrip = null;
@@ -277,7 +316,7 @@ sap.ui.define([
 	 * @public
 	 * @returns {sap.m.p13n.BasePanel} The BasePanel instance
 	 */
-	BasePanel.prototype.getMessageStrip = function(){
+	BasePanel.prototype.getMessageStrip = function() {
 		return this._oMessageStrip;
 	};
 
@@ -298,7 +337,7 @@ sap.ui.define([
 	 * @returns {sap.m.p13n.BasePanel} The BasePanel instance
 	 */
 	BasePanel.prototype._updateMovement = function(bEnableReorder) {
-		var oTemplate = this.getAggregation("_template");
+		const oTemplate = this.getAggregation("_template");
 		if (bEnableReorder) {
 			this._addHover(oTemplate);
 		} else if (oTemplate && oTemplate.aDelegates && oTemplate.aDelegates.length > 0) {
@@ -332,12 +371,12 @@ sap.ui.define([
 	 * @ui5-restricted
 	 */
 	BasePanel.prototype.onReset = function() {
-		this._getSearchField()?.setValue("");//Reset the searchfield string
-		this._oListControl.getBinding("items")?.filter([]);//Reset the filtering
+		this._getSearchField()?.setValue(""); //Reset the searchfield string
+		this._oListControl.getBinding("items")?.filter([]); //Reset the filtering
 	};
 
 	BasePanel.prototype._getDragDropConfig = function() {
-		if (!this._oDragDropInfo){
+		if (!this._oDragDropInfo) {
 			this._oDragDropInfo = new DragDropInfo({
 				enabled: false,
 				sourceAggregation: "items",
@@ -361,10 +400,9 @@ sap.ui.define([
 			this.addDependent(this._oMoveTopButton);
 
 			ShortcutHintsMixin.addConfig(this._oMoveTopButton, {
-				addAccessibilityLabel: true,
-				message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_TO_TOP_MAC" : "p13n.SHORTCUT_MOVE_TO_TOP") // Cmd+Home or Ctrl+Home
-				},
-				this
+					addAccessibilityLabel: true,
+					message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_TO_TOP_MAC" : "p13n.SHORTCUT_MOVE_TO_TOP") // Cmd+Home or Ctrl+Home
+				}, this
 			);
 		}
 
@@ -383,10 +421,9 @@ sap.ui.define([
 			this.addDependent(this._oMoveUpButton);
 
 			ShortcutHintsMixin.addConfig(this._oMoveUpButton, {
-				addAccessibilityLabel: true,
-				message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_UP_MAC" : "p13n.SHORTCUT_MOVE_UP") // Cmd+CursorUp or Ctrl+CursorUp
-				},
-				this
+					addAccessibilityLabel: true,
+					message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_UP_MAC" : "p13n.SHORTCUT_MOVE_UP") // Cmd+CursorUp or Ctrl+CursorUp
+				}, this
 			);
 
 		}
@@ -406,10 +443,9 @@ sap.ui.define([
 			this.addDependent(this._oMoveDownButton);
 
 			ShortcutHintsMixin.addConfig(this._oMoveDownButton, {
-				addAccessibilityLabel: true,
-				message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_DOWN_MAC" : "p13n.SHORTCUT_MOVE_DOWN") // Cmd+CursorDown or Ctrl+CursorDown
-				},
-				this
+					addAccessibilityLabel: true,
+					message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_DOWN_MAC" : "p13n.SHORTCUT_MOVE_DOWN") // Cmd+CursorDown or Ctrl+CursorDown
+				}, this
 			);
 		}
 
@@ -428,10 +464,9 @@ sap.ui.define([
 			this.addDependent(this._oMoveBottomButton);
 
 			ShortcutHintsMixin.addConfig(this._oMoveBottomButton, {
-				addAccessibilityLabel: true,
-				message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_TO_BOTTOM_MAC" : "p13n.SHORTCUT_MOVE_TO_BOTTOM") // Cmd+End or Ctrl+End
-				},
-				this
+					addAccessibilityLabel: true,
+					message: this._getResourceText(Device.os.macintosh ? "p13n.SHORTCUT_MOVE_TO_BOTTOM_MAC" : "p13n.SHORTCUT_MOVE_TO_BOTTOM") // Cmd+End or Ctrl+End
+				}, this
 			);
 
 		}
@@ -440,7 +475,7 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._onResize = function(aResizeEntity) {
-		var oDomRect = aResizeEntity[0].contentRect;
+		const oDomRect = aResizeEntity[0].contentRect;
 		if (this._oMoveTopButton) {
 			this._oMoveTopButton.setVisible(oDomRect.width > 400);
 		}
@@ -475,7 +510,7 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._keydownHandler = function(oEvent) {
-		if (!this.getEnableReorder()){
+		if (!this.getEnableReorder()) {
 			return;
 		}
 
@@ -485,8 +520,8 @@ sap.ui.define([
 
 		// Log.info("onKeyDown", oEvent.ctrlKey  + " | " + oEvent.which + " | " + oEvent.key);
 
-		if ((oEvent.metaKey || oEvent.ctrlKey )) {
-			var oButton;
+		if ((oEvent.metaKey || oEvent.ctrlKey)) {
+			let oButton;
 			if (oEvent.which === KeyCodes.HOME) {
 				oButton = this._getMoveTopButton();
 			}
@@ -513,12 +548,12 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._focusHandler = function(oEvt) {
-		if (!this.getEnableReorder()){
+		if (!this.getEnableReorder()) {
 			return;
 		}
 
 		//(new) hovered item
-		var oHoveredItem = sap.ui.getCore().byId(oEvt.currentTarget.id);
+		const oHoveredItem = Element.getElementById(oEvt.currentTarget.id);
 		this._handleActivated(oHoveredItem);
 	};
 
@@ -528,12 +563,12 @@ sap.ui.define([
 			return;
 		}
 
-		if (!this.getEnableReorder()){
+		if (!this.getEnableReorder()) {
 			return;
 		}
 
 		//(new) hovered item
-		var oHoveredItem = sap.ui.getCore().byId(oEvt.currentTarget.id);
+		const oHoveredItem = Element.getElementById(oEvt.currentTarget.id);
 
 		this._handleActivated(oHoveredItem);
 	};
@@ -545,7 +580,7 @@ sap.ui.define([
 
 	BasePanel.prototype._getListControlConfig = function() {
 		return {
-			mode:"MultiSelect",
+			mode: "MultiSelect",
 			rememberSelections: true,
 			itemPress: [this._onItemPressed, this],
 			selectionChange: [this._onSelectionChange, this],
@@ -556,7 +591,7 @@ sap.ui.define([
 
 	BasePanel.prototype._getSearchField = function() {
 		if (!this._oSearchField) {
-			this._oSearchField = new SearchField(this.getId() + "-searchField",{
+			this._oSearchField = new SearchField(this.getId() + "-searchField", {
 				liveChange: [this._onSearchFieldLiveChange, this],
 				width: "100%",
 				layoutData: new OverflowToolbarLayoutData({
@@ -581,15 +616,22 @@ sap.ui.define([
 		return this._oSearchField;
 	};
 
+	BasePanel.prototype.setTitle = function(sTitle) {
+		this.setProperty("title", sTitle);
+		this._oInvText?.setText(sTitle);
+
+		return this;
+	};
+
 	BasePanel.prototype._setTemplate = function(oTemplate) {
 		oTemplate.setType("Active");
-		var oCurrentTemplate = this.getAggregation("_template");
+		const oCurrentTemplate = this.getAggregation("_template");
 		if (oCurrentTemplate) {
 			oCurrentTemplate.destroy();
 		}
 		this.setAggregation("_template", oTemplate);
 		if (oTemplate) {
-			if (this.getEnableReorder()){
+			if (this.getEnableReorder()) {
 				this._addHover(oTemplate);
 			}
 			this._oSelectionBindingInfo = oTemplate.getBindingInfo("selected");
@@ -605,7 +647,7 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._setPanelColumns = function(vColumns) {
-		var aColumns;
+		let aColumns;
 		if (vColumns instanceof Array) {
 			aColumns = vColumns;
 		} else {
@@ -621,17 +663,17 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._getResourceText = function(sText, aValue) {
-		this.oResourceBundle = this.oResourceBundle ? this.oResourceBundle : sap.ui.getCore().getLibraryResourceBundle("sap.m");
+		this.oResourceBundle = this.oResourceBundle ? this.oResourceBundle : Library.getResourceBundleFor("sap.m");
 		return sText ? this.oResourceBundle.getText(sText, aValue) : this.oResourceBundle;
 	};
 
 	BasePanel.prototype._addTableColumns = function(aColumns) {
-		var aRemovedColumns = this._oListControl.removeAllColumns();
-		aRemovedColumns.forEach(function(oRemovedColumn){
+		const aRemovedColumns = this._oListControl.removeAllColumns();
+		aRemovedColumns.forEach((oRemovedColumn) => {
 			oRemovedColumn.destroy();
 		});
 		aColumns.forEach(function(vColumn) {
-			var oColumn;
+			let oColumn;
 
 			if (typeof vColumn == "string") {
 				oColumn = new Column({
@@ -648,7 +690,7 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._bindListItems = function(mBindingInfo) {
-		var oTemplate = this.getAggregation("_template");
+		const oTemplate = this.getAggregation("_template");
 		if (oTemplate) {
 			this._oListControl.bindItems(Object.assign({
 				path: this.P13N_MODEL + ">/items",
@@ -661,8 +703,8 @@ sap.ui.define([
 
 	BasePanel.prototype._onSelectionChange = function(oEvent) {
 
-		var aListItems = oEvent.getParameter("listItems");
-		var sSpecialChangeReason = this._checkSpecialChangeReason(oEvent.getParameter("selectAll"), oEvent.getParameter("listItems"));
+		const aListItems = oEvent.getParameter("listItems");
+		const sSpecialChangeReason = this._checkSpecialChangeReason(oEvent.getParameter("selectAll"), oEvent.getParameter("listItems"));
 
 		aListItems.forEach(function(oTableItem) {
 			this._selectTableItem(oTableItem, !!sSpecialChangeReason);
@@ -670,7 +712,7 @@ sap.ui.define([
 
 		if (sSpecialChangeReason) {
 
-			var aModelItems = [];
+			const aModelItems = [];
 			aListItems.forEach(function(oTableItem) {
 				aModelItems.push(this._getModelEntry(oTableItem));
 			}, this);
@@ -691,7 +733,7 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._checkSpecialChangeReason = function(bSelectAll, aListItems) {
-		var sSpecialChangeReason;
+		let sSpecialChangeReason;
 
 		if (bSelectAll) {
 			sSpecialChangeReason = this.CHANGE_REASON_SELECTALL;
@@ -705,11 +747,11 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._onItemPressed = function(oEvent) {
-		var oTableItem = oEvent.getParameter('listItem');
+		const oTableItem = oEvent.getParameter('listItem');
 		this._oSelectedItem = oTableItem;
 
-		var oContext = oTableItem.getBindingContext(this.P13N_MODEL);
-		if (this.getEnableReorder() && oContext && oContext.getProperty(this.PRESENCE_ATTRIBUTE)){
+		const oContext = oTableItem.getBindingContext(this.P13N_MODEL);
+		if (this.getEnableReorder() && oContext && oContext.getProperty(this.PRESENCE_ATTRIBUTE)) {
 			this._handleActivated(oTableItem);
 			this._updateEnableOfMoveButtons(oTableItem, true);
 		}
@@ -732,7 +774,7 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._onPressButtonMoveToBottom = function() {
-		var iIndex = this._oListControl.getItems().length - 1;
+		const iIndex = this._oListControl.getItems().length - 1;
 		this._moveSelectedItem(iIndex);
 	};
 
@@ -751,7 +793,7 @@ sap.ui.define([
 		this._updateEnableOfMoveButtons(oTableItem, bSpecialChangeReason ? false : true);
 		this._oSelectedItem = oTableItem;
 		if (!bSpecialChangeReason) {
-			var oItem = this._getP13nModel().getProperty(this._oSelectedItem.getBindingContext(this.P13N_MODEL).sPath);
+			const oItem = this._getP13nModel().getProperty(this._oSelectedItem.getBindingContext(this.P13N_MODEL).sPath);
 
 			this.fireChange({
 				reason: oItem[this.PRESENCE_ATTRIBUTE] ? this.CHANGE_REASON_ADD : this.CHANGE_REASON_REMOVE,
@@ -761,14 +803,14 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._moveSelectedItem = function(vNewIndex) {
-		var oSelectedItem = this._oSelectedItem;
-		var iSelectedIndex = this._oListControl.indexOfItem(oSelectedItem);
+		const oSelectedItem = this._oSelectedItem;
+		const iSelectedIndex = this._oListControl.indexOfItem(oSelectedItem);
 		if (iSelectedIndex < 0) {
 			return;
 		}
 
 		// determine the new index relative to selected index when "Up" or "Down" is passed as a parameter
-		var iNewIndex = (typeof vNewIndex == "number") ? vNewIndex : iSelectedIndex + (vNewIndex == "Up" ? -1 : 1);
+		const iNewIndex = (typeof vNewIndex == "number") ? vNewIndex : iSelectedIndex + (vNewIndex == "Up" ? -1 : 1);
 		this._moveTableItem(oSelectedItem, iNewIndex);
 
 	};
@@ -778,24 +820,24 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._moveTableItem = function(oItem, iNewIndex) {
-		var aItems = this._oListControl.getItems();
-		var aFields = this._getP13nModel().getProperty("/items");
+		const aItems = this._oListControl.getItems();
+		const aModelItems = this._getP13nModel().getProperty("/items");
 
 		// index of the item in the model not the index in the aggregation
-		var iOldIndex = aFields.indexOf(this._getModelEntry(oItem));
+		const iOldModelIndex = aModelItems.indexOf(this._getModelEntry(oItem));
 
 		// limit the minumum and maximum index
-		iNewIndex = (iNewIndex <= 0) ? 0 : Math.min(iNewIndex, aItems.length - 1);
+		let iNewModelIndex = (iNewIndex <= 0) ? 0 : Math.min(iNewIndex, aItems.length - 1);
 
 		// new index of the item in the model
-		iNewIndex = aFields.indexOf(this._getModelEntry(aItems[iNewIndex]));
-		if (iNewIndex == iOldIndex) {
+		iNewModelIndex = aModelItems.indexOf(this._getModelEntry(aItems[iNewIndex]));
+		if (iNewModelIndex == iOldModelIndex) {
 			return;
 		}
 
 		// remove data from old position and insert it into new position
-		aFields.splice(iNewIndex, 0, aFields.splice(iOldIndex, 1)[0]);
-		this._getP13nModel().setProperty("/items", aFields);
+		aModelItems.splice(iNewModelIndex, 0, aModelItems.splice(iOldModelIndex, 1)[0]);
+		this._getP13nModel().setProperty("/items", aModelItems);
 
 		// store the moved item again due to binding
 		this._oSelectedItem = this._oListControl.getItems()[iNewIndex];
@@ -811,19 +853,24 @@ sap.ui.define([
 	};
 
 	BasePanel.prototype._onRearrange = function(oEvent) {
-		var oDraggedItem = oEvent.getParameter("draggedControl");
-		var oDroppedItem = oEvent.getParameter("droppedControl");
-		var sDropPosition = oEvent.getParameter("dropPosition");
-		var iDraggedIndex = this._oListControl.indexOfItem(oDraggedItem);
-		var iDroppedIndex = this._oListControl.indexOfItem(oDroppedItem);
-		var iActualDroppedIndex = iDroppedIndex + (sDropPosition == "Before" ? 0 : 1) + (iDraggedIndex < iDroppedIndex ? -1 : 0);
+		const oDraggedItem = oEvent.getParameter("draggedControl");
+		if (!oDraggedItem?.getMultiSelectControl()?.getEnabled()) {
+			return;
+		}
+
+		const oDroppedItem = oEvent.getParameter("droppedControl");
+		const sDropPosition = oEvent.getParameter("dropPosition");
+		const iDraggedIndex = this._oListControl.indexOfItem(oDraggedItem);
+		const iDroppedIndex = this._oListControl.indexOfItem(oDroppedItem);
+		const iActualDroppedIndex = iDroppedIndex + (sDropPosition == "Before" ? 0 : 1) + (iDraggedIndex < iDroppedIndex ? -1 : 0);
 
 		this._moveTableItem(oDraggedItem, iActualDroppedIndex);
 	};
 
 	BasePanel.prototype._updateEnableOfMoveButtons = function(oTableItem, bFocus) {
-		var iTableItemPos = this._oListControl.getItems().indexOf(oTableItem);
-		var bUpEnabled = true, bDownEnabled = true;
+		const iTableItemPos = this._oListControl.getItems().indexOf(oTableItem);
+		let bUpEnabled = true,
+			bDownEnabled = true;
 		if (iTableItemPos == 0) {
 			// disable move buttons upwards, if the item is at the top
 			bUpEnabled = false;