@openui5/sap.m 1.120.6 → 1.121.0

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

@@ -6,11 +6,24 @@
 sap.ui.define([
 	"sap/ui/layout/Grid", "./BasePanel", "sap/ui/core/ListItem", "sap/m/CustomListItem", "sap/m/ComboBox", "sap/m/List", "sap/m/HBox", "sap/m/library", "sap/m/Button", "sap/base/util/merge", "sap/ui/core/library", "sap/ui/core/InvisibleMessage"
 
-], function (Grid, BasePanel, Item, CustomListItem, ComboBox, List, HBox, mLibrary, Button, merge, coreLibrary, InvisibleMessage) {
+], (
+	Grid,
+	BasePanel,
+	Item,
+	CustomListItem,
+	ComboBox,
+	List,
+	HBox,
+	mLibrary,
+	Button,
+	merge,
+	coreLibrary,
+	InvisibleMessage
+) => {
 	"use strict";
 
 
-	var ValueState = coreLibrary.ValueState;
+	const ValueState = coreLibrary.ValueState;
 
 	/**
 	 * Constructor for a new <code>QueryPanel</code>.
@@ -24,18 +37,20 @@ sap.ui.define([
 	 * @extends sap.m.p13n.BasePanel
 	 *
 	 * @author SAP SE
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 *
-	 * @private
-	 * @ui5-restricted sap.m, sap.ui.mdc
+	 * @public
 	 *
 	 * @since 1.96
 	 * @alias sap.m.p13n.QueryPanel
 	 */
-	var QueryPanel = BasePanel.extend("sap.m.p13n.QueryPanel", {
+	const QueryPanel = BasePanel.extend("sap.m.p13n.QueryPanel", {
 		metadata: {
 			library: "sap.m",
 			properties: {
+				/**
+				 * The limit for the number of queries that can be created by the user. By default, no query limit is provided.
+				 */
 				queryLimit: {
 					type: "int",
 					defaultValue: -1 //unlimited queries
@@ -48,24 +63,31 @@ sap.ui.define([
 	});
 
 	// shortcut for sap.m.ListType
-	var ListItemType = mLibrary.ListType;
+	const ListItemType = mLibrary.ListType;
 
 	// shortcut for sap.m.FlexJustifyContent
-	var FlexJustifyContent = mLibrary.FlexJustifyContent;
+	const FlexJustifyContent = mLibrary.FlexJustifyContent;
 
 	// shortcut for sap.m.ListKeyboardMode
-	var ListKeyboardMode = mLibrary.ListKeyboardMode;
+	const ListKeyboardMode = mLibrary.ListKeyboardMode;
 
 	// shortcut for sap.m.ButtonType
-	var ButtonType = mLibrary.ButtonType;
+	const ButtonType = mLibrary.ButtonType;
 
-	QueryPanel.prototype.init = function () {
+	QueryPanel.prototype.init = function() {
 		BasePanel.prototype.init.apply(this, arguments);
 		this._bFocusOnRearrange = false;
 		this.setEnableReorder(true);
 		this.addStyleClass("sapMP13nQueryPanel");
 	};
 
+	/**
+	 * Sets the personalization state of the panel instance.
+	 *
+	 * @public
+	 * @param {sap.m.p13n.Item[]} aP13nData An array containing the personalization state that is represented by the <code>QueryPanel</code>
+	 * @returns {this} The <code>QueryPanel</code> instance
+	 */
 	QueryPanel.prototype.setP13nData = function(aP13nData) {
 		BasePanel.prototype.setP13nData.apply(this, arguments);
 
@@ -73,11 +95,11 @@ sap.ui.define([
 
 		//Add rows for grouped items
 		if (aP13nData instanceof Array) {
-			aP13nData.forEach(function (oItem) {
+			aP13nData.forEach((oItem) => {
 				if (oItem[this.PRESENCE_ATTRIBUTE]) {
 					this._addQueryRow(oItem);
 				}
-			}.bind(this));
+			});
 
 			this._addQueryRow();
 		}
@@ -85,20 +107,20 @@ sap.ui.define([
 		return this;
 	};
 
-	QueryPanel.prototype.getP13nData = function (bOnlyActive) {
-		var aItems = [];
-		this._oListControl.getItems().forEach(function (oItem) {
-			var sKey = this._getControlFromRow(oItem)._key;
+	QueryPanel.prototype.getP13nData = function(bOnlyActive) {
+		const aItems = [];
+		this._oListControl.getItems().forEach((oItem) => {
+			const sKey = this._getControlFromRow(oItem)._key;
 			if (sKey) {
-				var oField = this._getP13nModel().getProperty("/items").find(function (o) {
+				const oField = this._getP13nModel().getProperty("/items").find((o) => {
 					return o.name == sKey;
 				});
 				aItems.push(oField);
 			}
-		}.bind(this));
+		});
 
 		if (!bOnlyActive) {
-			this._getP13nModel().getProperty("/items").forEach(function(oItem){
+			this._getP13nModel().getProperty("/items").forEach((oItem) => {
 				if (aItems.indexOf(oItem) === -1) {
 					aItems.push(oItem);
 				}
@@ -112,10 +134,10 @@ sap.ui.define([
 		return this.getP13nData().length === this.getP13nData(true).length;
 	};
 
-	QueryPanel.prototype._moveTableItem = function (oItem, iNewIndex) {
-		var iCurrentIndex = this._oListControl.getItems().indexOf(oItem);
-		var iMaxListLength = this._oListControl.getItems().length - 1;
-		var iQueryLimit = this.getQueryLimit();
+	QueryPanel.prototype._moveTableItem = function(oItem, iNewIndex) {
+		const iCurrentIndex = this._oListControl.getItems().indexOf(oItem);
+		const iMaxListLength = this._oListControl.getItems().length - 1;
+		const iQueryLimit = this.getQueryLimit();
 
 		// Rules for the movement:
 		// 1) The row is not the template row
@@ -147,8 +169,8 @@ sap.ui.define([
 		}
 	};
 
-	QueryPanel.prototype._createInnerListControl = function () {
-		var oList = new List(this.getId() + "-innerP13nList", {
+	QueryPanel.prototype._createInnerListControl = function() {
+		const oList = new List(this.getId() + "-innerP13nList", {
 			itemPress: [this._onItemPressed, this],
 			dragDropConfig: this._getDragDropConfig()
 		});
@@ -157,55 +179,57 @@ sap.ui.define([
 	};
 
 	QueryPanel.prototype._getModelEntry = function(oRow) {
-		var sKey = this._getControlFromRow(oRow)._key;
-		var oField = this._getP13nModel().getProperty("/items").find(function (o) {
+		const sKey = this._getControlFromRow(oRow)._key;
+		const oField = this._getP13nModel().getProperty("/items").find((o) => {
 			return o.name == sKey;
 		});
 		return oField;
 	};
 
-	QueryPanel.prototype._getAvailableItems = function (sKey) {
-		var aItems = this._getP13nModel().getProperty("/items");
+	QueryPanel.prototype._getAvailableItems = function(sKey) {
+		const aItems = this._getP13nModel().getProperty("/items");
 
-		var aAvailableItems = [];
+		const aAvailableItems = [];
 
-		aItems.forEach(function (oNonPresent, iIndex) {
+		aItems.forEach((oNonPresent, iIndex) => {
 			aAvailableItems.push(new Item({
 				key: oNonPresent.name,
 				text: oNonPresent.label,
 				enabled: {
 					path: this.P13N_MODEL + ">/items/" + iIndex + "/" + this.PRESENCE_ATTRIBUTE,
 					formatter: function(bQueried) {
-						var oComboBox = this.getParent();
-						var selItem =  oComboBox.getSelectedItem();
-						var selItemIndex = selItem && oComboBox.getItems().indexOf(selItem);
+						const oComboBox = this.getParent();
+						const selItem = oComboBox.getSelectedItem();
+						const selItemIndex = selItem && oComboBox.getItems().indexOf(selItem);
 
-						var sPath = this.getBindingPath("enabled");
-						var pathIndex = parseInt(sPath.split("/")[2]);
+						const sPath = this.getBindingPath("enabled");
+						const pathIndex = parseInt(sPath.split("/")[2]);
 
 						return !bQueried || selItemIndex === pathIndex; //Only enable the selection in case there is not yet a query present or the item is the selected item
 					}
 				}
 			}));
-		}.bind(this));
+		});
 
 		return aAvailableItems;
 	};
 
-	QueryPanel.prototype._addQueryRow = function (oItem) {
+	QueryPanel.prototype._addQueryRow = function(oItem) {
 
-		var bLimitedQueries = this.getQueryLimit() > -1;
-		var bQueryLimitReached = this.getQueryLimit() <= this._oListControl.getItems().length;
+		const bLimitedQueries = this.getQueryLimit() > -1;
+		const bQueryLimitReached = this.getQueryLimit() <= this._oListControl.getItems().length;
 
 		if ((bLimitedQueries && bQueryLimitReached && !oItem) || this._allEntriesUsed()) {
 			return;
 		}
 
-		oItem = oItem ? oItem : {name: null};
+		oItem = oItem ? oItem : {
+			name: null
+		};
 
-		var oQueryRowGrid = this._createQueryRowGrid(oItem);
+		const oQueryRowGrid = this._createQueryRowGrid(oItem);
 
-		var oRow = new CustomListItem({
+		const oRow = new CustomListItem({
 			type: ListItemType.Active,
 			content: [
 				oQueryRowGrid
@@ -219,7 +243,7 @@ sap.ui.define([
 		if (
 			this.getEnableReorder() &&
 			(this.getQueryLimit() === -1 || (this.getQueryLimit() > 1 && this._oListControl.getItems().length < this.getQueryLimit()))
-		){
+		) {
 			this._addHover(oRow);
 		}
 
@@ -227,15 +251,15 @@ sap.ui.define([
 
 		this._oListControl.addItem(oRow);
 
-		var bShowRemoveBtn = !!oItem.name;
-		var oRemoveButton = this._createRemoveButton(bShowRemoveBtn);
+		const bShowRemoveBtn = !!oItem.name;
+		const oRemoveButton = this._createRemoveButton(bShowRemoveBtn);
 		oRow.getContent()[0].addContent(oRemoveButton);
 
 		return oRow;
 	};
 
 	QueryPanel.prototype._createQueryRowGrid = function(oItem) {
-		var oSelect = this._createKeySelect(oItem.name);
+		const oSelect = this._createKeySelect(oItem.name);
 		return new Grid({
 			containerQuery: true,
 			defaultSpan: "XL6 L6 M6 S6",
@@ -246,9 +270,9 @@ sap.ui.define([
 	};
 
 	QueryPanel.prototype._handleActivated = function(oHoveredItem) {
-		var oQueryRow = oHoveredItem.getContent()[0];
+		const oQueryRow = oHoveredItem.getContent()[0];
 		if (oQueryRow) {
-			var oButtonBox = this._getControlFromRow(oHoveredItem, -1);
+			const oButtonBox = this._getControlFromRow(oHoveredItem, -1);
 
 			//Only add the buttons if 1) an hovered item is provided 2) the buttons are not already there
 			if (oHoveredItem && oButtonBox.getItems().length < 2) {
@@ -259,27 +283,27 @@ sap.ui.define([
 		}
 	};
 
-	QueryPanel.prototype._getPlaceholderText = function () {
+	QueryPanel.prototype._getPlaceholderText = () => {
 		return "";
 	};
 
-	QueryPanel.prototype._getRemoveButtonTooltipText = function () {
+	QueryPanel.prototype._getRemoveButtonTooltipText = () => {
 		return "";
 	};
 
-	QueryPanel.prototype._getRemoveButtonAnnouncementText = function () {
+	QueryPanel.prototype._getRemoveButtonAnnouncementText = () => {
 		return "";
 	};
 
-	QueryPanel.prototype._announce = function (sMessage) {
-		var InvisibleMessageMode = coreLibrary.InvisibleMessageMode;
-		var oInvisibleMessage = InvisibleMessage.getInstance();
+	QueryPanel.prototype._announce = (sMessage) => {
+		const InvisibleMessageMode = coreLibrary.InvisibleMessageMode;
+		const oInvisibleMessage = InvisibleMessage.getInstance();
 		oInvisibleMessage.announce(sMessage, InvisibleMessageMode.Assertive);
 	};
 
-	QueryPanel.prototype._createKeySelect = function (sKey) {
-		var that = this;
-		var oKeySelect = new ComboBox({
+	QueryPanel.prototype._createKeySelect = function(sKey) {
+		const that = this;
+		const oKeySelect = new ComboBox({
 			width: "14rem",
 			enabled: {
 				path: this.P13N_MODEL + ">/items/",
@@ -289,43 +313,43 @@ sap.ui.define([
 						return true;
 					}
 
-					var aPresentKeys = that.getP13nData(true).map(function(oItem){
+					const aPresentKeys = that.getP13nData(true).map((oItem) => {
 						return oItem.name;
 					});
-					var sKey = this._key; //'this' is the select control passed by the formatter
-					var iPositon = aPresentKeys.indexOf(sKey) + 1;
+					const sKey = this._key; //'this' is the select control passed by the formatter
+					const iPositon = aPresentKeys.indexOf(sKey) + 1;
 					return iPositon <= that.getQueryLimit();
 				}
 			},
 			items: this._getAvailableItems(sKey),
 			selectedKey: sKey,
 			placeholder: this._getPlaceholderText(),
-			selectionChange: function(oEvt) {
-				var oComboBox =  oEvt.getSource();
-				var oSelItem = oComboBox.getSelectedItem();
+			selectionChange: (oEvt) => {
+				const oComboBox = oEvt.getSource();
+				const oSelItem = oComboBox.getSelectedItem();
 				// var sNewKey = oComboBox.getSelectedKey();
 				if (!oSelItem) {
 					this._selectKey(oComboBox);
 				}
-			}.bind(this),
-			change: function(oEvt) {
-				var oComboBox = oEvt.getSource();
-				var newValue = oEvt.getParameter("newValue");
+			},
+			change: (oEvt) => {
+				const oComboBox = oEvt.getSource();
+				const newValue = oEvt.getParameter("newValue");
 				this._selectKey(oComboBox);
-				oComboBox.setValueState( newValue && !oComboBox.getSelectedItem() ? ValueState.Error : ValueState.None);
-			}.bind(this)
+				oComboBox.setValueState(newValue && !oComboBox.getSelectedItem() ? ValueState.Error : ValueState.None);
+			}
 		});
 
 		return oKeySelect;
 	};
 
 	QueryPanel.prototype._selectKey = function(oComboBox) {
-		var sNewKey = oComboBox.getSelectedKey();
-		var sOldKey = oComboBox._key;
-		var oListItem = oComboBox.getParent().getParent();
-		var bIsLastRow = this._oListControl.getItems().length - 1 == this._oListControl.getItems().indexOf(oListItem);
+		const sNewKey = oComboBox.getSelectedKey();
+		const sOldKey = oComboBox._key;
+		const oListItem = oComboBox.getParent().getParent();
+		const bIsLastRow = this._oListControl.getItems().length - 1 == this._oListControl.getItems().indexOf(oListItem);
 
-		var oBtnContainer = this._getControlFromRow(oListItem, -1);
+		const oBtnContainer = this._getControlFromRow(oListItem, -1);
 		oBtnContainer.setVisible(!(bIsLastRow && sNewKey == ""));
 
 		//Remove previous
@@ -345,8 +369,8 @@ sap.ui.define([
 		}
 	};
 
-	QueryPanel.prototype._createRemoveButton = function (bVisible) {
-		var oRemoveBox = new HBox({
+	QueryPanel.prototype._createRemoveButton = function(bVisible) {
+		const oRemoveBox = new HBox({
 			justifyContent: FlexJustifyContent.End,
 			width: "100%",
 			visible: bVisible,
@@ -354,13 +378,13 @@ sap.ui.define([
 				new Button({
 					type: ButtonType.Transparent,
 					icon: "sap-icon://decline",
-					press: function (oEvt) {
-						var oRow = oEvt.getSource().getParent().getParent().getParent();
+					press: (oEvt) => {
+						const oRow = oEvt.getSource().getParent().getParent().getParent();
 
-						var iQueries = this._oListControl.getItems().length;
+						const iQueries = this._oListControl.getItems().length;
 						//A new row with (none) needs to be created if either no row is left, or if the last potential row
 						//has been removed, as no row will be created if every possible key has been used
-						var bNewRowRequired = iQueries === 1 || iQueries == this.getP13nData(true).length;
+						const bNewRowRequired = iQueries === 1 || iQueries == this.getP13nData(true).length;
 
 						this._oListControl.removeItem(oRow);
 						this._updatePresence(this._getControlFromRow(oRow)._key, false, undefined);
@@ -372,15 +396,15 @@ sap.ui.define([
 
 						//In case an item has been removed, focus the Select control of the new 'none' row
 						//Needs timeout because the new queryRow and control might not be rendered
-						setTimeout(function() {
+						setTimeout(() => {
 							if (!this.bIsDestroyed) {
 								this.getInitialFocusedControl().focus();
 							}
-						}.bind(this), 0);
+						}, 0);
 
 						this._getP13nModel().checkUpdate(true);
 
-					}.bind(this)
+					}
 				})
 			]
 		});
@@ -392,14 +416,14 @@ sap.ui.define([
 		return oRemoveBox;
 	};
 
-	QueryPanel.prototype._moveSelectedItem = function(){
+	QueryPanel.prototype._moveSelectedItem = function() {
 		this._oSelectedItem = this._getMoveUpButton().getParent().getParent().getParent();
 		BasePanel.prototype._moveSelectedItem.apply(this, arguments);
 	};
 
-	QueryPanel.prototype._updatePresence = function (sKey, bAdd, iNewIndex) {
-		var aItems = merge([], this._getP13nModel().getProperty("/items"));
-		var aRelevant = aItems.filter(function (oItem) {
+	QueryPanel.prototype._updatePresence = function(sKey, bAdd, iNewIndex) {
+		const aItems = merge([], this._getP13nModel().getProperty("/items"));
+		const aRelevant = aItems.filter((oItem) => {
 			return oItem.name === sKey;
 		});
 
@@ -416,20 +440,20 @@ sap.ui.define([
 	};
 
 	QueryPanel.prototype.getInitialFocusedControl = function() {
-		var oRow = this._getRow(-1);
+		const oRow = this._getRow(-1);
 		return this._getControlFromRow(oRow);
 	};
 
 	QueryPanel.prototype._getRow = function(iIndex) {
-		var aItems = this._oListControl.getItems();
+		const aItems = this._oListControl.getItems();
 		if (iIndex < 0) {
 			iIndex = aItems.length + iIndex;
 		}
 		return aItems[iIndex];
 	};
 
-	QueryPanel.prototype._getControlFromRow = function(oRow, iIndex) {
-		var aContent = oRow.getContent()[0].getContent();
+	QueryPanel.prototype._getControlFromRow = (oRow, iIndex) => {
+		const aContent = oRow.getContent()[0].getContent();
 		if (iIndex === undefined) {
 			iIndex = 0;
 		}