@openui5/sap.ui.mdc 1.96.2 → 1.98.0

package/src/sap/ui/mdc/p13n/subcontroller/LinkPanelController.js

@@ -0,0 +1,173 @@
+/*
+ * ! 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/ui/mdc/p13n/P13nBuilder",
+	"./BaseController",
+    "sap/ui/mdc/p13n/panels/LinkSelectionPanel",
+    "sap/m/library",
+    "sap/m/MessageBox"
+], function (P13nBuilder, BaseController, SelectionPanel, library, MessageBox) {
+    "use strict";
+
+    var oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
+
+    var MultiSelectMode = library.MultiSelectMode;
+    var LinkPanelController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.LinkPanelController", {
+        constructor: function() {
+			BaseController.apply(this, arguments);
+			this._bResetEnabled = true;
+		}
+    });
+
+    LinkPanelController.prototype.getUISettings = function() {
+        return {
+            contentWidth: "28rem",
+            contentHeight: "35rem",
+            reset: {
+                warningText: oResourceBundle.getText("info.SELECTION_DIALOG_RESET_WARNING")
+            },
+            title: oResourceBundle.getText("info.SELECTION_DIALOG_ALIGNEDTITLE")
+        };
+    };
+
+    LinkPanelController.prototype.getSelectorForReset = function() {
+        return this.getAdaptationControl().getItems().concat(this.getAdaptationControl());
+    };
+
+    LinkPanelController.prototype.getAdaptationUI = function(oPropertyHelper) {
+        var oSelectionPanel = new SelectionPanel({
+            fieldColumn: oResourceBundle.getText("info.SELECTION_DIALOG_COLUMNHEADER_WITHOUT_COUNT"),
+            enableCount: true,
+            linkPressed: this._onLinkPressed.bind(this)
+        });
+        var oAdaptationData = this.mixInfoAndState(oPropertyHelper);
+        oSelectionPanel.setP13nData(oAdaptationData.items);
+        oSelectionPanel.setEnableReorder(false);
+        oSelectionPanel.setMultiSelectMode(MultiSelectMode.Default);
+        this._oPanel = oSelectionPanel;
+        return Promise.resolve(oSelectionPanel);
+    };
+
+    LinkPanelController.prototype._onLinkPressed = function(oEvent) {
+        var oSource = oEvent.getParameter("oSource");
+        var sTarget = oSource.getTarget();
+
+        if (sTarget !== "_blank") {
+            oEvent.preventDefault();
+
+            var oPanel = this.getAdaptationControl();
+            var sHref = oSource.getHref();
+
+            if (oPanel.getBeforeNavigationCallback) {
+                oPanel.getBeforeNavigationCallback()(oEvent).then(function (bNavigate) {
+                    if (bNavigate) {
+                        oPanel.navigate(sHref);
+                    }
+                });
+            } else {
+                MessageBox.show(sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc").getText("info.SELECTION_DIALOG_LINK_VALIDATION_QUESTION"), {
+                    icon: MessageBox.Icon.WARNING,
+                    title: sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc").getText("info.SELECTION_DIALOG_LINK_VALIDATION_TITLE"),
+                    actions: [
+                        MessageBox.Action.YES, MessageBox.Action.NO
+                    ],
+                    onClose: function (oAction) {
+                        if (oAction === MessageBox.Action.YES) {
+                            oPanel.navigate(sHref);
+                        }
+                    },
+                    styleClass: this.$().closest(".sapUiSizeCompact").length ? "sapUiSizeCompact" : ""
+                });
+            }
+        }
+    };
+
+    LinkPanelController.prototype._createAddRemoveChange = function(oControl, vOperations, oContent) {
+        var sLinkItemId = oContent.name;
+
+        var oLinkItem = sap.ui.getCore().byId(sLinkItemId);
+
+        var aChanges = [];
+
+        if (!oLinkItem) {
+            aChanges.push({
+                selectorElement: oControl,
+                changeSpecificData: {
+                    changeType: "createItem",
+                    content: {
+                        selector: sLinkItemId
+                    }
+                }
+            });
+        } else {
+            aChanges.push({
+                selectorElement: oLinkItem,
+                changeSpecificData: {
+                    changeType: vOperations === "hideItem" ? "hideItem" : "revealItem",
+                    content: {}
+                }
+            });
+        }
+
+        return aChanges;
+    };
+
+    LinkPanelController.prototype.mixInfoAndState = function(oPropertyHelper) {
+
+        var aItemState = this.getCurrentState();
+        var mExistingLinkItems = P13nBuilder.arrayToMap(aItemState);
+
+        var oP13nData = P13nBuilder.prepareAdaptationData(oPropertyHelper, function(mItem, oProperty){
+
+            var oExistingLinkItem = mExistingLinkItems[oProperty.name];
+            mItem.visible = oExistingLinkItem ? true : false;
+            mItem.position = oExistingLinkItem ? oExistingLinkItem.position : -1;
+            mItem.href = oProperty.href;
+            mItem.description = oProperty.description;
+            mItem.target = oProperty.target;
+            mItem.text = oProperty.text;
+            //mItem.icon = oProperty.icon;
+
+            return true;
+        });
+
+        P13nBuilder.sortP13nData({
+            visible: "visible",
+            position: "position"
+        }, oP13nData.items);
+
+        oP13nData.presenceAttribute = this._getPresenceAttribute();
+
+        oP13nData.items.forEach(function(oItem){delete oItem.position;});
+
+        return oP13nData;
+    };
+
+    LinkPanelController.prototype._createMoveChange = function(sId, sPropertyName, iNewIndex, sMoveOperation, oControl, bPersistId) {
+        return {
+            selectorElement: oControl,
+            changeSpecificData: {
+                changeType: sMoveOperation,
+                content: {
+                    index: iNewIndex,
+                    name: sPropertyName
+                }
+            }
+        };
+    };
+
+    LinkPanelController.prototype.getChangeOperations = function() {
+        return {
+            add: ["createItem", "revealItem"],
+            remove: "hideItem",
+            move: "moveItem"
+        };
+    };
+
+	return LinkPanelController;
+
+});

package/src/sap/ui/mdc/p13n/subcontroller/SortController.js

@@ -1,6 +1,6 @@
 /*
  * ! OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -9,16 +9,17 @@ sap.ui.define([
 ], function (BaseController, P13nBuilder, SortPanelOld, SortPanel) {
 	"use strict";
 
-    var SortController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.SortController");
+    var SortController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.SortController", {
+        constructor: function() {
+			BaseController.apply(this, arguments);
+			this._bResetEnabled = true;
+		}
+    });
 
     SortController.prototype.getCurrentState = function() {
         return this.getAdaptationControl().getCurrentState().sorters;
     };
 
-    SortController.prototype.getResetEnabled = function() {
-        return true;
-    };
-
     SortController.prototype.getUISettings = function() {
         return {
             tabText: sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc").getText("p13nDialog.TAB_Sort"),
@@ -33,20 +34,12 @@ sap.ui.define([
 
     SortController.prototype.getAdaptationUI = function(oPropertyHelper){
 
-        var oAdaptationControl = this.getAdaptationControl();
         var oSortPanel;
 
-        //TODO: remove this condition once 'ChartNew' migration has been merged
-        if (oAdaptationControl.isA("sap.ui.mdc.Chart") && !oAdaptationControl._bNewP13n) {
-            oSortPanel = new SortPanelOld();
-            var oAdaptationModel = this._getP13nModel(oPropertyHelper);
-            oSortPanel.setP13nModel(oAdaptationModel);
-        } else {
-            oSortPanel = new SortPanel();
-            var oAdaptationData = this.mixInfoAndState(oPropertyHelper);
-            oSortPanel.setP13nData(oAdaptationData.items);
-            this._oPanel = oSortPanel;
-        }
+        oSortPanel = new SortPanel();
+        var oAdaptationData = this.mixInfoAndState(oPropertyHelper);
+        oSortPanel.setP13nData(oAdaptationData.items);
+        this._oPanel = oSortPanel;
 
         return Promise.resolve(oSortPanel);
     };

package/src/sap/ui/mdc/table/Column.js

@@ -1,6 +1,6 @@
 /*
  * ! OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -10,17 +10,17 @@ sap.ui.define([
 	"use strict";
 
 	/**
-	 * Constructor for a new Column.
+	 * Constructor for a new <code>Column</column>.
 	 *
-	 * @param {string} [sId] ID for the new control, generated automatically if no ID is given
+	 * @param {string} [sId] Optional ID for the new object; generated automatically if no non-empty ID is given
 	 * @param {object} [mSettings] initial settings for the new control
-	 * @class The column for the metadata driven table, that hold the template to be shown when the rows has data.
-	 *        <h3><b>Note:</b></h3>
-	 *        The control is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
+	 * @class The column for the metadata-driven table with the template, which is shown if the rows have data.
 	 * @extends sap.ui.core.Element
 	 * @author SAP SE
 	 * @private
 	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * MDC_PUBLIC_CANDIDATE
 	 * @since 1.58
 	 * @alias sap.ui.mdc.table.Column
 	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
@@ -31,21 +31,30 @@ sap.ui.define([
 			library: "sap.ui.mdc",
 			defaultAggregation: "template",
 			properties: {
+				/**
+				 * Width of the column.
+				 */
 				width: {
 					type: "sap.ui.core.CSSSize",
 					group: "Dimension",
 					defaultValue: null
 				},
+				/**
+				 * Minimum width of the column.
+				 */
 				minWidth: {
 					type: "float",
 					group: "Behavior",
 					defaultValue: 8
 				},
+				/**
+				 * The column header text.
+				 */
 				header: {
 					type: "string"
 				},
 				/**
-				 * Defines whether the column header is visible
+				 * Defines whether the column header is visible.
 				 * @since 1.78
 				 */
 				headerVisible: {
@@ -53,10 +62,16 @@ sap.ui.define([
 					group: "Misc",
 					defaultValue: true
 				},
+				/**
+				 * Horizontal alignment of the content.
+				 */
 				hAlign: {
 					type: "sap.ui.core.HorizontalAlign",
 					defaultValue: "Begin"
 				},
+				/**
+				 * Importance of the column. It is used to show or hide the column based on the <code>Table</code> configuration.
+				 */
 				importance: {
 					type: "sap.ui.core.Priority",
 					group: "Behavior",
@@ -70,16 +85,26 @@ sap.ui.define([
 					type: "int",
 					defaultValue: -1
 				},
+				/**
+				 * The data property related to the column.
+				 */
 				dataProperty: {
 					type: "string"
 				}
 			},
 			events: {},
 			aggregations: {
+				/**
+				 * Template for the column.
+				 */
 				template: {
 					type: "sap.ui.core.Control",
 					multiple: false
 				},
+				/**
+				 * <code>CreationRow</code> template.
+				 * <b>Note:</b> Once the binding supports creating transient records, this aggregation will be removed.
+				 */
 				creationTemplate: {
 					type: "sap.ui.core.Control",
 					multiple: false
@@ -215,10 +240,10 @@ sap.ui.define([
 
 	/**
 	 * Creates and returns the column header control.
-	 * If <code>headerVisible=false</code> then, <code>width=0px</code> is applied to the sap.m.Label control for accessibility purpose.
-	 * @param {boolean} bMobileTable - indicates the type of the table
-	 * @param {boolean} bResizing - indicates whether the column is resizable
-	 * @returns {object} column header control
+	 * If <code>headerVisible=false</code> then <code>width=0px</code> is applied to the <code>sap.m.Label</code> control for accessibility purposes.
+	 * @param {boolean} bMobileTable The type of the table
+	 * @param {boolean} bResizing Indicates whether the column is resizable
+	 * @returns {object} The column header control
 	 * @private
 	 */
 	Column.prototype.getColumnHeaderControl = function(bMobileTable, bResizing) {

package/src/sap/ui/mdc/table/CreationRow.js

@@ -1,6 +1,6 @@
 /*
  * ! OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -12,20 +12,20 @@ sap.ui.define([
 	var TableType = Library.TableType;
 
 	/**
-	 * Constructor for a new CreationRow.
+	 * Constructor for a new <code>CreationRow</code>.
 	 *
-	 * @param {string} [sId] ID for the new control, generated automatically if no ID is given
+	 * @param {string} [sId] Optional ID for the new object; generated automatically if no non-empty ID is given
 	 * @param {object} [mSettings] Initial settings for the new control
-	 * @class Allows to enter data in a row shaped form, if the table's {@link sap.ui.mdc.TableType TableType} is "<code>Table</code>". The form
-	 *        elements are aligned with the columns of the table, and are created automatically based on the
-	 *        {@link sap.ui.mdc.table.Column#getCreationTemplate creationTemplate} aggregation of the {@link sap.ui.mdc.table.Column}. <b>Note:</b> This control
-	 *        is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
+	 * @class Row that allows the user to enter data in a row-shaped form if the {@link sap.ui.mdc.TableType TableType} is "<code>Table</code>".
+	 * The form elements are aligned with the columns of the table and are created automatically based on the
+	 * {@link sap.ui.mdc.table.Column#getCreationTemplate creationTemplate} aggregation of the {@link sap.ui.mdc.table.Column}.
 	 * @extends sap.ui.core.Element
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 * @constructor
-	 * @private
 	 * @experimental
+	 * @private
+	 * @ui5-restricted sap.fe
 	 * @since 1.65
 	 * @alias sap.ui.mdc.table.CreationRow
 	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
@@ -52,7 +52,7 @@ sap.ui.define([
 					defaultValue: false
 				},
 				/**
-				 * Visibility of this control.
+				 * Visibility of the <code>CreationRow</code>.
 				 */
 				visible: {
 					type: "boolean",
@@ -62,7 +62,7 @@ sap.ui.define([
 			},
 			events: {
 				/**
-				 * Fired when the corresponding keyboard shortcut or the apply button of the toolbar are pressed.
+				 * The event is fired when the corresponding keyboard shortcut or the apply button of the toolbar are pressed.
 				 */
 				apply: {
 					allowPreventDefault: true
@@ -91,6 +91,7 @@ sap.ui.define([
 	 *
 	 * @param {boolean} bBusy Busy state that is applied to the inner control
 	 * @returns {this}  Returns <code>this</code> to allow method chaining
+	 * @private
 	 */
 	CreationRow.prototype.setBusy = function(bBusy) {
 		this.setProperty('busy', bBusy, true);
@@ -144,10 +145,10 @@ sap.ui.define([
 	};
 
 	/**
-	 * Updates the row based on the configuration of the table this row is inside.
+	 * Updates the row based on the configuration of the table.
 	 *
+	 * @returns {Promise} <code>Promise</code> that resolves once the inner <code>CreationRow</code> control is updated
 	 * @private
-	 * @returns {Promise} Promise that resolves once the inner <code>CreationRow</code> control is updated
 	 */
 	CreationRow.prototype.update = function() {
 		return this._updateInnerCreationRow();
@@ -230,7 +231,7 @@ sap.ui.define([
 	}
 
 	/**
-	 * Gets the table this row is inside.
+	 * Gets the table in which this row is located.
 	 *
 	 * @return {sap.ui.mdc.Table|null} The instance of the table or <code>null</code>, if this row is not inside a table.
 	 * @private

package/src/sap/ui/mdc/table/GridTableType.js

@@ -1,6 +1,6 @@
 /*
  * ! OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -14,17 +14,17 @@ sap.ui.define([
 	var RowAction = library.RowAction;
 
 	/**
-	 * Constructor for a new GridTableType.
+	 * Constructor for a new <code>GridTableType</code>.
 	 *
-	 * @param {string} [sId] ID for the new object, generated automatically if no ID is given
-	 * @param {object} [mSettings] initial settings for the new object
-	 * @class The table type info base class for the metadata driven table.
-	 *        <h3><b>Note:</b></h3>
-	 *        The control is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
+	 * @param {string} [sId] Optional ID for the new object; generated automatically if no non-empty ID is given
+	 * @param {object} [mSettings] Initial settings for the new object
+	 * @class The table type info class for the metadata-driven table.
 	 * @extends sap.ui.mdc.table.TableTypeBase
 	 * @author SAP SE
 	 * @private
 	 * @experimental
+	 * @ui5-restricted sap.fe
+	 * MDC_PUBLIC_CANDIDATE
 	 * @since 1.65
 	 * @alias sap.ui.mdc.table.GridTableType
 	 * @ui5-metamodel This element also will be described in the UI5 (legacy) designtime metamodel
@@ -35,17 +35,16 @@ sap.ui.define([
 			library: "sap.ui.mdc",
 			properties: {
 				/**
-				 * See sap.ui.mdc.RowCountMode for the options.<br>
-				 * Defaults to Auto --> meaning table adjusts it's height based on the parent container
+				 * Defines how the table handles the row count.
 				 */
 				rowCountMode: {
 					type: "sap.ui.mdc.RowCountMode",
 					defaultValue: RowCountMode.Auto
 				},
 				/**
-				 * RowCount of the inner table.<br>
-				 * When sap.ui.mdc.RowCountMode.Auto is used - this property specifies the minAutoRowCount.<br>
-				 * When sap.ui.mdc.RowCountMode.Fixed is used - this property specifies the visibleRowCount.
+				 * Row count of the inner table.<br>
+				 * This property specifies the minimum row count if <code>sap.ui.mdc.RowCountMode.Auto</code> is used.<br>
+				 * This property specifies the row count if <code>sap.ui.mdc.RowCountMode.Fixed</code> is used.
 				 */
 				rowCount: {
 					type: "int",
@@ -53,14 +52,15 @@ sap.ui.define([
 				},
 				/**
 				 * Number of indices which can be selected in a range.
-				 * Accepts positive integer values. If set to 0, the selection limit is disabled, and the Select All checkbox appears instead of the Deselect All button.
+				 * Accepts positive integer values. If set to 0, the selection limit is disabled, and the Select All checkbox appears instead of the
+				 * Deselect All button.
 				 */
 				selectionLimit : {
 					type : "int",
 					defaultValue : 200
 				},
 				/**
-				 * Show header selector.
+				 * Determines whether the header selector is shown.
 				 */
 				showHeaderSelector : {
 					type : "boolean",