@openui5/sap.m 1.96.2 → 1.97.0

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

@@ -22,12 +22,12 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.97.0
 	 *
 	 * @constructor
 	 * @alias sap.m.p13n.AbstractContainer
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.97.0
 	 * @since 1.96.0
 	 *
 	 * @private
@@ -98,6 +98,40 @@ sap.ui.define([
 					multiple: false,
 					hidden: true
 				}
+			},
+			events: {
+				/**
+				 * This event will be fired before a view is switched.
+				 */
+				beforeViewSwitch: {
+					allowPreventDefault: true,
+					parameters: {
+						/**
+						 * This parameter is the current view.
+						 */
+						 source: {type: "string"},
+						 /**
+						  * This parameter is the target view.
+						  */
+						 target: {type: "string"}
+					}
+				},
+				/**
+				 * This event will be fired after a view is switched.
+				 */
+				afterViewSwitch: {
+					allowPreventDefault: true,
+					parameters: {
+						/**
+						 * This parameter is the current view.
+						 */
+						source: {type: "string"},
+						/**
+						 * This parameter is the target view.
+						 */
+						target: {type: "string"}
+					}
+				}
 			}
 		},
 		renderer: {
@@ -114,6 +148,7 @@ sap.ui.define([
 
 	AbstractContainer.prototype.init = function() {
 		Control.prototype.init.apply(this, arguments);
+		this.addStyleClass("sapMAbstractContainer");
 		this._initializeContent();
 	};
 
@@ -187,9 +222,7 @@ sap.ui.define([
 	 * @param {string} sKey The key of the ContainerItem whose content should be visible up next
 	 */
 	AbstractContainer.prototype.switchView = function(sKey) {
-
 		var oNewView = this.getView(sKey);
-
 		if (!oNewView) {
 			oNewView = this.getViews()[0];
 			if (!oNewView) {
@@ -197,10 +230,20 @@ sap.ui.define([
 			}
 		}
 
+		if (!this.fireBeforeViewSwitch({source: sCurrentViewKey, target: sKey})) {
+			this._bPrevented = true;
+			return; // view switch event was prevented by event handler.
+		}
+
+		this._bPrevented = false;
+		var sCurrentViewKey = this.getCurrentViewKey();
+
 		this._sCurrentView = oNewView.getKey();
 
 		this.oLayout.removeAllContent();
 		this.oLayout.addContent(oNewView.getContent());
+
+		this.fireAfterViewSwitch({source: sCurrentViewKey, target: sKey});
 	};
 
 	/**

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

@@ -4,91 +4,91 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
-sap.ui.define(['sap/ui/core/Element'],
-	function(Element) {
-	"use strict";
+sap.ui.define(['sap/ui/core/Element', "sap/ui/core/Control"],
+	function (Element, Control) {
+		"use strict";
 
-    /**
-	 * Constructor for a new <code>AbstractContainerItem</code>.
-	 *
-	 * @param {string} [sId] ID for the new control, generated automatically if no ID is given
-	 * @param {object} [mSettings] Initial settings for the new control
-	 *
-	 * @class
-	 * A <code>AbstractContainerItem</code> element which defines a unique key for a content.
-	 *
-	 * @extends sap.ui.core.Element
-	 *
-	 * @author SAP SE
-	 * @version 1.96.2
-	 *
-	 * @constructor
-	 * @alias sap.m.p13n.AbstractContainerItem
-	 * @author SAP SE
-	 * @version 1.96.2
-	 * @since 1.96.0
-	 *
-	 * @private
-	 * @experimental
-	 */
-    var AbstractContainerItem = Element.extend("sap.m.p13n.AbstractContainerItem", {
-        metadata : {
-		library : "sap.m",
-		defaultAggregation: "content",
-		properties : {
-			/**
-			 * Unique key to identify a container item.
-			 */
-            key: {
-                type: "string",
-                defaultValue : null
-			},
-			/**
-			 * Text describing the provided content.
-			 */
-			text: {
-                type: "string",
-                defaultValue : null
-			},
-			/**
-			 * Additional icon for the content.
-			 */
-			icon: {
-				type: "string",
-				defaultValue : null
+		/**
+		 * Constructor for a new <code>AbstractContainerItem</code>.
+		 *
+		 * @param {string} [sId] ID for the new control, generated automatically if no ID is given
+		 * @param {object} [mSettings] Initial settings for the new control
+		 *
+		 * @class
+		 * A <code>AbstractContainerItem</code> element which defines a unique key for a content.
+		 *
+		 * @extends sap.ui.core.Element
+		 *
+		 * @author SAP SE
+		 * @version 1.97.0
+		 *
+		 * @constructor
+		 * @alias sap.m.AbstractContainerItem
+		 * @author SAP SE
+		 * @version 1.97.0
+		 * @since 1.96.0
+		 *
+		 * @private
+		 * @experimental
+		 */
+		var AbstractContainerItem = Element.extend("sap.m.p13n.AbstractContainerItem", {
+			metadata: {
+				library: "sap.m",
+				defaultAggregation: "content",
+				properties: {
+					/**
+					 * Unique key to identify a container item.
+					 */
+					key: {
+						type: "string",
+						defaultValue: null
+					},
+					/**
+					 * Text describing the provided content.
+					 */
+					text: {
+						type: "string",
+						defaultValue: null
+					},
+					/**
+					 * Additional icon for the content.
+					 */
+					icon: {
+						type: "string",
+						defaultValue: null
+					}
+				},
+				aggregations: {
+					/**
+					 * Dynamic content to be displayed as container item.
+					 */
+					content: {
+						type: "sap.ui.core.Control",
+						multiple: false
+					}
+				}
 			}
-		},
-		aggregations: {
-            /**
-             * Dynamic content to be displayed as container item.
-             */
-            content: {
-                type: "sap.ui.core.Control",
-                multiple: false
-            }
-		}
-	}});
+		});
 
-	AbstractContainerItem.prototype.setContent = function(oContent) {
-		this.setAggregation("content", oContent);
-		if (oContent) {
-			this._oContent = oContent;
-		}
-		return this;
-	};
-
-	AbstractContainerItem.prototype.getContent = function() {
-		return this._oContent;
-	};
+		AbstractContainerItem.prototype.exit = function () {
+			Element.prototype.exit.apply(this, arguments);
+			if (this._oContent) {
+				this._oContent.destroy();
+				this._oContent = null;
+			}
+		};
 
-	AbstractContainerItem.prototype.destroy = function() {
-		Element.prototype.destroy.apply(this, arguments);
-		if (this._oContent) {
-			this._oContent.destroy();
-			this._oContent = null;
-		}
-	};
+		AbstractContainerItem.prototype.setContent = function(oContent) {
+			this.setAggregation("content", oContent);
+			if (oContent) {
+				this._oContent = oContent;
+			}
+			return this;
+		};
 
-	return AbstractContainerItem;
+		AbstractContainerItem.prototype.getContent = function() {
+			return this._oContent;
+		};
 
-});
+		return AbstractContainerItem;
+	});

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

@@ -19,10 +19,10 @@ sap.ui.define([
 	 * This control serves as base class for personalization implementations.
 	 * This base class is faceless and should be inherited to implement control specific personalization panels.
 	 *
-	 * @extends sap.ui.core.Control
+	 * @extends sap.m.p13n.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.97.0
 	 *
 	 * @private
 	 * @ui5-restricted
@@ -34,8 +34,18 @@ sap.ui.define([
 	var BasePanel = Control.extend("sap.m.p13n.BasePanel", {
 		metadata: {
 			library: "sap.m",
+			interfaces: [
+				"sap.m.p13n.IContent"
+			],
 			associations: {},
 			properties: {
+				/**
+				 * A short text describing the panel.
+				 * <b>Note:</b> This text will only be displayed in case the panel is being used in a <code>sap.m.p13n.Popup</code>.
+				 */
+				title: {
+					type: "string"
+				},
 				/**
 				 * Determines whether the reordering of personalization items should be enabled.
 				 */
@@ -109,6 +119,8 @@ sap.ui.define([
 	BasePanel.prototype.CHANGE_REASON_ADD = "Add";
 	BasePanel.prototype.CHANGE_REASON_REMOVE = "Remove";
 	BasePanel.prototype.CHANGE_REASON_MOVE = "Move";
+	BasePanel.prototype.CHANGE_REASON_SELECTALL = "SelectAll";
+	BasePanel.prototype.CHANGE_REASON_DESELECTALL = "DeselectAll";
 
 	//defines the name of the attribute describing the presence/active state
 	BasePanel.prototype.PRESENCE_ATTRIBUTE = "visible";
@@ -120,9 +132,12 @@ sap.ui.define([
 		this._oP13nModel.setSizeLimit(10000);
 		this.setModel(this._oP13nModel, this.P13N_MODEL);
 
-	   // list is necessary to set the template + model on
+	    // list is necessary to set the template + model on
 		this._oListControl = this._createInnerListControl();
 
+		// Determines whether the rearranged item should be focused
+		this._bFocusOnRearrange = true;
+
 		this._setInnerLayout();
 
 		// disable 'select all'
@@ -238,12 +253,7 @@ sap.ui.define([
 				tooltip: this._getResourceText("p13n.MOVE_TO_TOP"),
 				icon: "sap-icon://collapse-group",
 				press: [this._onPressButtonMoveToTop, this],
-				visible: false,
-				layoutData: new OverflowToolbarLayoutData({
-					moveToOverflow: true,
-					priority: "Low",
-					group: 2
-				})
+				visible: false
 			});
 			this.addDependent(this._oMoveTopBtn);
 		}
@@ -258,12 +268,7 @@ sap.ui.define([
 				tooltip: this._getResourceText("p13n.MOVE_UP"),
 				icon: "sap-icon://navigation-up-arrow",
 				press: [this._onPressButtonMoveUp, this],
-				visible: false,
-				layoutData: new OverflowToolbarLayoutData({
-					moveToOverflow: true,
-					priority: "High",
-					group: 1
-				})
+				visible: false
 			});
 			this.addDependent(this._oMoveUpButton);
 		}
@@ -278,12 +283,7 @@ sap.ui.define([
 				tooltip: this._getResourceText("p13n.MOVE_DOWN"),
 				icon: "sap-icon://navigation-down-arrow",
 				press: [this._onPressButtonMoveDown, this],
-				visible: false,
-				layoutData: new OverflowToolbarLayoutData({
-					moveToOverflow: true,
-					priority: "High",
-					group: 1
-				})
+				visible: false
 			});
 			this.addDependent(this._oMoveDownButton);
 		}
@@ -298,12 +298,7 @@ sap.ui.define([
 				tooltip: this._getResourceText("p13n.MOVE_TO_BOTTOM"),
 				icon: "sap-icon://expand-group",
 				press: [this._onPressButtonMoveToBottom, this],
-				visible: false,
-				layoutData: new OverflowToolbarLayoutData({
-					moveToOverflow: true,
-					priority: "Low",
-					group: 2
-				})
+				visible: false
 			});
 			this.addDependent(this._oMoveBottomButton);
 		}
@@ -478,9 +473,13 @@ sap.ui.define([
 		}, this);
 
 		if (bSelectAll || bDeSelectAll) {
-			this.fireChange();
+			this.fireChange({
+				reason: bSelectAll ? this.CHANGE_REASON_SELECTALL : this.CHANGE_REASON_DESELECTALL,
+				item: undefined //No direct item is affected
+			});
 		}
 
+
 		// in case of 'deselect all', the move buttons for positioning are going to be disabled
 		if (bDeSelectAll) {
 			this._getMoveTopButton().setEnabled(false);
@@ -586,13 +585,13 @@ sap.ui.define([
 		// store the moved item again due to binding
 		this._oSelectedItem = this._oListControl.getItems()[iNewIndex];
 
-		this._updateEnableOfMoveButtons(this._oSelectedItem, true);
+		this._updateEnableOfMoveButtons(this._oSelectedItem, this._bFocusOnRearrange);
 
 		this._handleActivated(this._oSelectedItem);
 
 		this.fireChange({
 			reason: this.CHANGE_REASON_MOVE,
-			item: undefined
+			item: this._getModelEntry(oItem)
 		});
 	};
 
@@ -629,6 +628,8 @@ sap.ui.define([
 
 	BasePanel.prototype.exit = function() {
 		Control.prototype.exit.apply(this, arguments);
+		this._bFocusOnRearrange = null;
+		this._oHoveredItem = null;
 		this._oSelectionBindingInfo = null;
 		this._oSelectedItem = null;
 		this._oListControl = null;

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

@@ -13,8 +13,10 @@ sap.ui.define([
 	"sap/m/p13n/AbstractContainerItem",
 	"sap/ui/Device",
 	"sap/m/library",
-	"sap/m/StandardListItem"
-], function (AbstractContainer, Bar, Button, List, IconTabBar, IconTabFilter, ContainerItem, Device, mLibrary, StandardListItem) {
+	"sap/m/StandardListItem",
+	"sap/m/CustomListItem",
+	"sap/ui/core/Control"
+], function (AbstractContainer, Bar, Button, List, IconTabBar, IconTabFilter, ContainerItem, Device, mLibrary, StandardListItem, CustomListItem, Control) {
 	"use strict";
 
 	// shortcut for sap.m.ButtonType
@@ -41,7 +43,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.AbstractContainer
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.97.0
 	 *
 	 * @private
 	 * @ui5-restricted
@@ -55,7 +57,7 @@ sap.ui.define([
 			library: "sap.m",
 			properties: {
 				listLayout: {
-					type: "Boolean",
+					type: "boolean",
 					defaultValue: false
 				}
 			}
@@ -128,15 +130,28 @@ sap.ui.define([
 	 */
 	Container.prototype.switchView = function (sKey) {
 		AbstractContainer.prototype.switchView.apply(this, arguments);
+		if (this._bPrevented) {
+			return;
+		}
 		var oParent = this.getParent();
 		if (oParent && oParent.isA("sap.ui.core.Control")){
 			oParent.focus();
 			oParent.invalidate();
+
+			// invalidate dependents as well
+			var aDependents = oParent.getDependents();
+			if (aDependents) {
+				aDependents.forEach(function (oDependent) {
+					if (oDependent && oDependent.isA("sap.ui.core.Control")) {
+						oDependent.invalidate();
+					}
+				});
+			}
 		}
 		this.oLayout.setShowHeader(sKey !== this.DEFAULT_KEY); //Don't show header in default view (avoid empty space),
 		this._getTabBar().setSelectedKey(sKey);
 		this._getNavBackBtn().setVisible(sKey !== this.DEFAULT_KEY);
-		this._getNavBackBtn().setText(sKey);
+		this._getNavBackBtn().setText((this.getView(sKey) && this.getView(sKey).getText()) || sKey);
 	};
 
 	/**
@@ -148,6 +163,32 @@ sap.ui.define([
 		return this;
 	};
 
+	/**
+	* @override
+	*/
+	Container.prototype.removeView = function (oContainerItem) {
+		AbstractContainer.prototype.removeView.apply(this, arguments);
+		this._removeFromNavigator(oContainerItem);
+	};
+
+	/*
+	 * This method can be used to add a separator line to the last added item.
+	 * This will only take effect in the "list" mode.
+	 *
+	 * @returns {sap.m.p13n.Container} The Container instance
+	 */
+	Container.prototype.addSeparator = function () {
+		if (!this.getProperty("listLayout")) {
+			return;
+		}
+
+		var oItems = this._getNavigationList().getItems();
+		var oLastItem = oItems[oItems.length - 1];
+		oLastItem.addStyleClass("sapMMenuDivider");
+
+		return this;
+	};
+
 	Container.prototype._getTabBar = function () {
 		if (!this._oTabBar) {
 			this._oTabBar = new IconTabBar({
@@ -221,6 +262,27 @@ sap.ui.define([
 		}
 	};
 
+	Container.prototype._removeFromNavigator = function (oContainerItem) {
+
+		var sKey = oContainerItem.getKey();
+
+		if (sKey == this.DEFAULT_KEY) {
+			return;
+		}
+
+		if (this.getListLayout()) {
+			var oItem = this._getNavigationList().getItems().find(function(oListItem){
+				return oListItem._key === sKey;
+			});
+			this._getNavigationList().removeItem(oItem);
+		} else {
+			var oTab = this._getTabBar().getItems().find(function(oTab){
+				return oTab.getKey() === sKey;
+			});
+			this._getTabBar().removeItem(oTab);
+		}
+	};
+
 	Container.prototype.exit = function () {
 		AbstractContainer.prototype.exit.apply(this, arguments);
 		if (this._oTabBar) {

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

@@ -21,7 +21,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.QueryPanel
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.97.0
 	 *
 	 * @private
 	 * @ui5-restricted
@@ -39,7 +39,9 @@ sap.ui.define([
 				}
 			}
 		},
-		renderer: {}
+		renderer: {
+			apiVersion: 2
+		}
 	});
 
 	GroupPanel.prototype.PRESENCE_ATTRIBUTE = "grouped";