@openui5/sap.m 1.100.0 → 1.102.1

package/src/sap/m/upload/UploadSet.js

@@ -26,9 +26,10 @@ sap.ui.define([
 	"sap/m/upload/UploaderHttpRequestMethod",
 	"sap/ui/core/dnd/DragDropInfo",
 	"sap/ui/core/dnd/DropInfo",
-	"sap/m/library"
+	"sap/m/library",
+	"sap/m/upload/UploadSetToolbarPlaceholder"
 ], function (Control, Icon, KeyCodes, Log, deepEqual, MobileLibrary, Button, Dialog, List, MessageBox, OverflowToolbar,
-			 StandardListItem, Text, ToolbarSpacer, FileUploader, UploadSetItem, Uploader, Renderer, UploaderHttpRequestMethod, DragDropInfo, DropInfo, Library) {
+			 StandardListItem, Text, ToolbarSpacer, FileUploader, UploadSetItem, Uploader, Renderer, UploaderHttpRequestMethod, DragDropInfo, DropInfo, Library, UploadSetToolbarPlaceholder) {
 	"use strict";
 
 	/**
@@ -42,7 +43,7 @@ sap.ui.define([
 	 * and requests, unified behavior of instant and deferred uploads, as well as improved progress indication.
 	 * @extends sap.ui.core.Control
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @constructor
 	 * @public
 	 * @since 1.63
@@ -474,18 +475,41 @@ sap.ui.define([
 		this._$Body = null;
 		this._$DragDropArea = null;
 		this._oLastEnteredTarget = null;
+
+		this._aGroupHeadersAdded = [];
+		this._iFileUploaderPH = null;
+		this._oItemToUpdate = null;
 	};
 
 	UploadSet.prototype.exit = function () {
 		this._oNoDataIcon.destroy();
 		this._oNoDataIcon = null;
+		if (this._oList) {
+			this._oList.destroy();
+			this._oList = null;
+		}
+		if (this._oToolbar) {
+			this._oToolbar.destroy();
+			this._oToolbar = null;
+		}
+		if (this._oFileUploader) {
+			this._oFileUploader.destroy();
+			this._oFileUploader = null;
+		}
+		if (this._oUploader) {
+			this._oUploader.destroy();
+			this._oUploader = null;
+		}
 	};
 
 	/* ===================== */
 	/* Overriden API methods */
 	/* ===================== */
 
-	UploadSet.prototype.onBeforeRendering = function () {
+	UploadSet.prototype.onBeforeRendering = function (oEvent) {
+		this._aGroupHeadersAdded = [];
+		this._clearGroupHeaders();
+		this._fillListWithUploadSetItems(this.getItems());
 	};
 
 	UploadSet.prototype.onAfterRendering = function () {
@@ -555,9 +579,15 @@ sap.ui.define([
 				this._oToolbar = new OverflowToolbar(this.getId() + "-toolbar", {
 					content: [this._oNumberOfAttachmentsTitle, new ToolbarSpacer(), this.getDefaultFileUploader()]
 				});
+				this._iFileUploaderPH = 2;
 				this.addDependent(this._oToolbar);
 			} else {
-				this._oToolbar.addContent(this.getDefaultFileUploader());
+				this._iFileUploaderPH = this._getFileUploaderPlaceHolderPosition(this._oToolbar);
+				if (this._oToolbar && this._iFileUploaderPH > -1) {
+					this._setFileUploaderInToolbar(this.getDefaultFileUploader());
+				} else if (this._oToolbar) {
+					this._oToolbar.insertContent(this.getDefaultFileUploader());
+				}
 			}
 		}
 
@@ -585,7 +615,7 @@ sap.ui.define([
 
 	UploadSet.prototype.addAggregation = function (sAggregationName, oObject, bSuppressInvalidate) {
 		Control.prototype.addAggregation.call(this, sAggregationName, oObject, bSuppressInvalidate);
-		if (oObject && (sAggregationName === "items" || sAggregationName === "incompleteItems")) {
+		if (oObject && (sAggregationName === 'items' || sAggregationName === "incompleteItems")) {
 			this._projectToNewListItem(oObject);
 			this._refreshInnerListStyle();
 		}
@@ -593,7 +623,7 @@ sap.ui.define([
 
 	UploadSet.prototype.insertAggregation = function (sAggregationName, oObject, iIndex, bSuppressInvalidate) {
 		Control.prototype.insertAggregation.call(this, sAggregationName, oObject, iIndex, bSuppressInvalidate);
-		if (oObject && (sAggregationName === "items" || sAggregationName === "incompleteItems")) {
+		if (oObject && (sAggregationName === 'items' || sAggregationName === 'incompleteItems')) {
 			this._projectToNewListItem(oObject, iIndex || 0);
 			this._refreshInnerListStyle();
 		}
@@ -607,12 +637,14 @@ sap.ui.define([
 				oItems = this.getItems();
 				oListItem = oItems[oObject];
 			} else if (typeof oObject === 'object') { // the object itself is given or has just been retrieved
-				oListItem = oObject._getListItem();
+				if (this.getList() && this.getList().getItems().length) {
+					oListItem = oObject._getListItem();
+				}
 			}
             var oItem = this.getList().removeAggregation("items", oListItem, bSuppressInvalidate);
             if (oItem && oObject) {
-                oObject.destroy();
                 oItem.destroy();
+				oObject.destroy();
             }
             this._refreshInnerListStyle();
         }
@@ -621,11 +653,15 @@ sap.ui.define([
 	UploadSet.prototype.removeAllAggregation = function (sAggregationName, bSuppressInvalidate) {
 		if (sAggregationName === "items") {
 			this.getItems().forEach(function (oItem) {
-				this.getList().removeAggregation("items", oItem._getListItem(), bSuppressInvalidate);
+				if (this._oList) {
+					this._oList.removeAggregation("items", oItem._getListItem(), bSuppressInvalidate);
+				}
 			}.bind(this));
 		} else if (sAggregationName === "incompleteItems") {
 			this.getIncompleteItems().forEach(function (oItem) {
-				this.getList().removeAggregation("items", oItem._getListItem(), bSuppressInvalidate);
+				if (this._oList) {
+					this._oList.removeAggregation("items", oItem._getListItem(), bSuppressInvalidate);
+				}
 			}.bind(this));
 		}
 		Control.prototype.removeAllAggregation.call(this, sAggregationName, bSuppressInvalidate);
@@ -635,8 +671,8 @@ sap.ui.define([
 		if (sAggregationName === "items" || sAggregationName === "incompleteItems") {
 			this.removeAllAggregation(sAggregationName, bSuppressInvalidate);
 		}
-		if (this.getList().getItems().length === 0) {
-			this.getList().destroyAggregation("items", bSuppressInvalidate);
+		if (this._oList && this._oList.getItems().length === 0) {
+			this._oList.destroyAggregation("items", bSuppressInvalidate);
 		}
 		Control.prototype.destroyAggregation.call(this, sAggregationName, bSuppressInvalidate);
 	};
@@ -907,7 +943,7 @@ sap.ui.define([
 
 	/**
 	 * Returns an array containing the selected UploadSetItems.
-	 * @returns {sap.m.UploadSetItem[]} Array of all selected items
+	 * @returns {sap.m.upload.UploadSetItem[]} Array of all selected items
 	 * @public
 	 * @since 1.100.0
 	 */
@@ -918,7 +954,7 @@ sap.ui.define([
 
 	/**
 	 * Retrieves the currently selected UploadSetItem.
-	 * @returns {sap.m.UploadSetItem | null} The currently selected item or null
+	 * @returns {sap.m.upload.UploadSetItem | null} The currently selected item or null
 	 * @public
 	 * @since 1.100.0
 	 */
@@ -946,7 +982,7 @@ sap.ui.define([
 
 	/**
 	 * Selects or deselects the given list item.
-	 * @param {sap.m.UploadSetItem} uploadSetItem The item whose selection is to be changed. This parameter is mandatory.
+	 * @param {sap.m.upload.UploadSetItem} uploadSetItem The item whose selection is to be changed. This parameter is mandatory.
 	 * @param {boolean} [select=true] The selection state of the item.
 	 * @returns {this} this to allow method chaining
 	 * @public
@@ -971,6 +1007,28 @@ sap.ui.define([
 		return this;
 	};
 
+	/**
+	 * Opens the FileUploader dialog. When an UploadSetItem is provided, this method can be used to update a file with a new version.
+	 * @param {sap.m.UploadSetItem} item The UploadSetItem to update with a new version. This parameter is mandatory.
+	 * @returns {this} this to allow method chaining
+	 * @public
+	 */
+	 UploadSet.prototype.openFileDialog = function(item) {
+		if (this._oFileUploader) {
+			if (item) {
+				if (!this._oFileUploader.getMultiple()) {
+					this._oItemToUpdate = item;
+					this._oFileUploader.$().find("input[type=file]").trigger("click");
+				} else {
+					Log.warning("Version Upload cannot be used in multiple upload mode");
+				}
+			} else {
+				this._oFileUploader.$().find("input[type=file]").trigger("click");
+			}
+		}
+		return this;
+	};
+
 	/* ============== */
 	/* Event handlers */
 	/* ============== */
@@ -1008,8 +1066,12 @@ sap.ui.define([
 			"headers": oResponseXHRParams.headers
 		};
 		oItem.setProgress(100);
+		if (this._oItemToUpdate && this.getInstantUpload()) {
+			this.removeAggregation('items', this._oItemToUpdate, false);
+		}
 		this.insertItem(oItem, 0);
 		oItem.setUploadState(UploadState.Complete);
+		this._oItemToUpdate = null;
 		this.fireUploadCompleted(oXhrParams);
 	};
 
@@ -1334,7 +1396,11 @@ sap.ui.define([
 	UploadSet.prototype._projectToNewListItem = function (oItem, iIndex) {
 		var oListItem = oItem._getListItem();
 		this._mListItemIdToItemMap[oListItem.getId()] = oItem; // TODO: Probably unnecessary
-		if (iIndex || iIndex === 0) {
+		if (oItem.sParentAggregationName === 'items') {
+			// maps groups for each item if group configuration provided
+			this._mapGroupForItem(oItem);
+		}
+		if (iIndex === 0) {
 			this.getList().insertAggregation("items", oListItem, iIndex, true);
 		} else {
 			this.getList().addAggregation("items", oListItem, true);
@@ -1488,5 +1554,84 @@ sap.ui.define([
 		return null;
 	};
 
+	/**
+	 * Destroy the items in the List.
+	 * @private
+	 */
+	 UploadSet.prototype._clearGroupHeaders = function() {
+		this.getList().getItems().forEach(function(oItem) {
+			if (oItem.isGroupHeader()) {
+				oItem.destroy(false);
+			}
+		});
+	};
+
+	/**
+	 * Map group for item.
+	 * @param {sap.m.UploadSetItem} item The UploadSetItem to map group
+	 * @private
+	 */
+	 UploadSet.prototype._mapGroupForItem = function(item) {
+		var oItemsBinding = this.getBinding("items"),
+			sModelName = this.getBindingInfo("items") ? this.getBindingInfo("items").oModel : undefined,
+			fnGroupHeader = this.getBindingInfo("items") ? this.getBindingInfo("items").groupHeaderFactory : null;
+		var fnGroup = function(oItem) {
+			//Added sModelName to consider named model cases if empty default model is picked without checking model bind to items.
+			return oItem.getBindingContext(sModelName) ? oItemsBinding.getGroup(oItem.getBindingContext(sModelName)) : null;
+		};
+		var fnGroupKey = function(item) {
+			return fnGroup(item) && fnGroup(item).key;
+		};
+
+		if (oItemsBinding && oItemsBinding.isGrouped() && item) {
+			if ( !this._aGroupHeadersAdded.some( function(group){ return group === fnGroupKey(item);} ) ) {
+				if (fnGroupHeader) {
+					this.getList().addItemGroup(fnGroup(item), fnGroupHeader(fnGroup(item)), true);
+				} else if (fnGroup(item)) {
+					this.getList().addItemGroup(fnGroup(item), null, true);
+				}
+				this._aGroupHeadersAdded.push(fnGroupKey(item));
+			}
+		}
+	};
+
+	/**
+	 * Fills list with uploadSet items.
+	 * @param {sap.m.UploadSetItem[]} aItems The UploadSetItems the internal list is to be filled with
+	 * @private
+	 */
+	UploadSet.prototype._fillListWithUploadSetItems = function (aItems){
+		var that = this;
+		aItems.forEach(function(item, index) {
+			item._reset();
+			that._projectToNewListItem(item, true);
+			that._refreshInnerListStyle();
+		});
+	};
+
+	/**
+	 * Provides the position of the placeholder for the FileUploader, that every toolbar must have if it is provided by the application.
+	 * @param {sap.m.OverflowToolbar} toolbar Toolbar where the placeholder can be found.
+	 * @return {int} The position of the placeholder or -1 if there's no placeholder.
+	 * @private
+	 */
+	 UploadSet.prototype._getFileUploaderPlaceHolderPosition = function(toolbar) {
+		for (var i = 0; i < toolbar.getContent().length; i++) {
+			if (toolbar.getContent()[i] instanceof UploadSetToolbarPlaceholder) {
+				return i;
+			}
+		}
+		return -1;
+	};
+
+	/**
+	 * Inserts the given FileUploader object into the current Toolbar at the position of the placeholder.
+	 * @param {sap.ui.unified.FileUploader} fileUploader The FileUploader object to insert into the Toolbar
+	 * @private
+	 */
+	 UploadSet.prototype._setFileUploaderInToolbar = function(fileUploader) {
+		this._oToolbar.getContent()[this._iFileUploaderPH].setVisible(false);
+		this._oToolbar.insertContent(fileUploader, this._iFileUploaderPH);
+	};
 	return UploadSet;
 });

package/src/sap/m/upload/UploadSetItem.js

@@ -36,7 +36,7 @@ sap.ui.define([
 	 * @class Item that represents one file to be uploaded using the {@link sap.m.upload.UploadSet} control.
 	 * @extends sap.ui.core.Element
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @constructor
 	 * @public
 	 * @since 1.63
@@ -1047,5 +1047,28 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * Resets item flags to initial state, that can be used to recreate the item
+	 * @private
+	 */
+	UploadSetItem.prototype._reset = function() {
+		if (this._oListItem) {
+			this._oListItem.destroy();
+			this._oListItem = null;
+		}
+		this._oListItem = null;
+		if (this._oIcon) {
+			this.removeDependent(this._oIcon);
+			this._oIcon.destroy();
+			this._oIcon = null;
+		}
+		if (this._oFileNameLink) {
+			this.removeDependent(this._oFileNameLink);
+			this._oFileNameLink.destroy();
+			this._oFileNameLink = null;
+		}
+		this._oDynamicContent = null;
+	};
+
 	return UploadSetItem;
 });

package/src/sap/m/upload/UploadSetToolbarPlaceholder.js

@@ -0,0 +1,45 @@
+/*!
+ * 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([
+	"sap/m/library",
+	"sap/ui/core/Control"
+], function(library, Control) {
+	"use strict";
+
+	/**
+	 * Constructor for a new UploadSetToolbarPlaceholder.
+	 *
+	 * @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
+	 * Used to create a customizable toolbar for the UploadSet.
+	 * A FileUploader instance is required in the toolbar and it is placed by the application.
+	 * @extends sap.ui.core.Control
+	 *
+	 * @author SAP SE
+	 * @version 1.102.1
+	 *
+	 * @constructor
+	 * @public
+	 * @alias sap.m.upload.UploadSetToolbarPlaceholder
+	 */
+
+	var UploadSetToolbarPlaceholder = Control.extend("sap.m.upload.UploadSetToolbarPlaceholder", {
+		metadata: {
+			library: "sap.m",
+			properties: {}
+		},
+		renderer: {
+			apiVersion: 2,
+			render: function(oRm, oControl) {}
+		}
+	});
+
+	return UploadSetToolbarPlaceholder;
+
+});