@openui5/sap.ui.table 1.138.0 → 1.140.0

package/src/sap/ui/table/plugins/MultiSelectionPlugin.js

@@ -49,10 +49,14 @@ sap.ui.define([
 	 * This plugin is intended for server-side models and multi-selection mode. Range selections, including Select All, only work properly if the
 	 * count is known. Make sure the model/binding is configured to request the count from the service.
 	 * For ease of use, client-side models and single selection are also supported.
+	 *
+	 * With ODataV4, use the {@link sap.ui.table.plugins.ODataV4MultiSelection ODataV4MultiSelection} plugin or the
+	 * {@link sap.ui.table.plugins.ODataV4SingleSelection ODataV4SingleSelection} plugin instead of this one.
+	 *
 	 * @extends sap.ui.table.plugins.SelectionPlugin
 	 *
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.140.0
 	 *
 	 * @public
 	 * @since 1.64
@@ -140,6 +144,7 @@ sap.ui.define([
 	MultiSelectionPlugin.prototype.onActivate = function(oTable) {
 		SelectionPlugin.prototype.onActivate.apply(this, arguments);
 		this.oInnerSelectionPlugin = createInnerSelectionPlugin(oTable);
+		this.oInnerSelectionPlugin.setSelectionMode(this.getSelectionMode());
 		this.oInnerSelectionPlugin.attachSelectionChange(this._onSelectionChange, this);
 		attachToBinding(this, oTable.getBinding());
 		oTable.addAggregation("_hiddenDependents", this.oInnerSelectionPlugin);
@@ -161,7 +166,7 @@ sap.ui.define([
 	 */
 	MultiSelectionPlugin.prototype.onDeactivate = function(oTable) {
 		SelectionPlugin.prototype.onDeactivate.apply(this, arguments);
-		oTable.setProperty("selectionMode", SelectionMode.None);
+		oTable.setProperty("selectionMode", library.SelectionMode.None);
 		detachFromBinding(this, oTable.getBinding());
 		this.oInnerSelectionPlugin?.destroy();
 		delete this.oInnerSelectionPlugin;
@@ -261,18 +266,14 @@ sap.ui.define([
 	}
 
 	MultiSelectionPlugin.prototype.setSelectionMode = function(sSelectionMode) {
-		const oTable = this.getParent();
+		this.setProperty("selectionMode", sSelectionMode, true);
 
-		if (oTable) {
-			oTable.setProperty("selectionMode", sSelectionMode, true);
-		}
-
-		if (this.oInnerSelectionPlugin) {
-			this.oInnerSelectionPlugin.setSelectionMode(sSelectionMode);
+		if (!this.isActive()) {
+			return this;
 		}
 
-		this.setProperty("selectionMode", sSelectionMode);
-
+		this.getControl().setProperty("selectionMode", sSelectionMode);
+		this.oInnerSelectionPlugin.setSelectionMode(sSelectionMode);
 		updateHeaderSelectorIcon(this);
 
 		return this;
@@ -325,6 +326,10 @@ sap.ui.define([
 	 * @public
 	 */
 	MultiSelectionPlugin.prototype.selectAll = function(oEventPayload) {
+		if (!this.isActive()) {
+			return Promise.reject(new Error("Plugin is disabled"));
+		}
+
 		if (!this._bLimitDisabled) {
 			return Promise.reject(new Error("Not possible if the limit is enabled"));
 		}
@@ -418,6 +423,10 @@ sap.ui.define([
 		const oTable = this.getControl();
 		const sSelectionMode = this.getSelectionMode();
 
+		if (!this.isActive()) {
+			return Promise.reject(new Error("Plugin is disabled"));
+		}
+
 		if (sSelectionMode === SelectionMode.None) {
 			return Promise.reject(new Error("SelectionMode is '" + SelectionMode.None + "'"));
 		}
@@ -477,6 +486,10 @@ sap.ui.define([
 		const oTable = this.getControl();
 		const sSelectionMode = this.getSelectionMode();
 
+		if (!this.isActive()) {
+			return Promise.reject(new Error("Plugin is disabled"));
+		}
+
 		if (sSelectionMode === SelectionMode.None) {
 			return Promise.reject(new Error("SelectionMode is '" + SelectionMode.None + "'"));
 		}

package/src/sap/ui/table/plugins/{V4Aggregation.js → ODataV4Aggregation.js}

@@ -4,9 +4,11 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
+	"./ODataV4MultiLevel",
 	"./PluginBase",
 	"../utils/TableUtils"
 ], function(
+	ODataV4MultiLevel,
 	PluginBase,
 	TableUtils
 ) {
@@ -14,22 +16,24 @@ sap.ui.define([
 
 	/**
 	 * @class
-	 * Integrates the aggregation information of the {@link sap.ui.model.odata.v4.ODataListBinding} and the table. The table is enabled to visualize
-	 * group levels and sums according to that information. See {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation} for details.
+	 * Integrates the information about the data structure of the {@link sap.ui.model.odata.v4.ODataListBinding} and the table. The table is enabled
+	 * to visualize grouped data with summary rows. Works only in combination with a {@link sap.ui.model.odata.v4.ODataModel}.
+	 *
+	 * For details about data aggregation, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
 	 *
-	 * This plugin only works in combination with a <code>sap.ui.model.odata.v4.ODataModel</code>. Do not add it to a table that is bound to another
-	 * model.
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.140.0
 	 *
-	 * @private
-	 * @alias sap.ui.table.plugins.V4Aggregation
+	 * @public
+	 * @since 1.140
+	 * @alias sap.ui.table.plugins.ODataV4Aggregation
+	 * @see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 OData V4: Data Aggregation and Recursive Hierarchy}
 	 *
 	 * @borrows sap.ui.table.plugins.PluginBase.findOn as findOn
 	 */
-	const V4Aggregation = PluginBase.extend("sap.ui.table.plugins.V4Aggregation", /** @lends sap.ui.table.plugins.V4Aggregation.prototype */ {
+	const ODataV4Aggregation = ODataV4MultiLevel.extend("sap.ui.table.plugins.ODataV4Aggregation", {
 		metadata: {
 			library: "sap.ui.table",
 			properties: {
@@ -39,57 +43,63 @@ sap.ui.define([
 				enabled: {type: "boolean", defaultValue: true}, // TODO: Inherited from private PluginBase. Remove once PluginBase is public.
 
 				/**
-				 * Provide a custom group header title.
+				 * Provides a custom group header title.
+				 *
+				 * This function is called for each group header row in the table. It receives the binding context of the row and the group level
+				 * property path according to <code>groupLevels</code> in {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
+				 * The function must return a string that is used as the title of the group header row.
+				 *
+				 * Function signature: <code>groupHeaderFormatter(oContext: sap.ui.model.odata.v4.Context, sPropertyPath: string): string</code>
 				 *
-				 * Parameters: Binding context (sap.ui.model.Context), Name of the grouped property (string)
-				 * Returns: The group header title
+				 * @example
+				 * groupHeaderFormatter: function(oContext, sPropertyPath) {
+				 *     // Get the value of the group header property
+				 *     const sGroupHeaderValue = oContext.getProperty(sPropertyPath);
+				 *     // Format the value as a string
+				 *     return `Group: ${sGroupHeaderValue}`;
+				 * }
 				 */
 				groupHeaderFormatter: {type: "function"}
 			}
 		}
 	});
 
-	V4Aggregation.findOn = PluginBase.findOn;
+	ODataV4Aggregation.findOn = PluginBase.findOn;
 
 	/**
 	 * @override
 	 * @inheritDoc
 	 */
-	V4Aggregation.prototype.isApplicable = function(oControl) {
-		return PluginBase.prototype.isApplicable.apply(this, arguments) && oControl.getMetadata().getName() === "sap.ui.table.Table";
-	};
-
-	/**
-	 * @override
-	 * @inheritDoc
-	 */
-	V4Aggregation.prototype.onActivate = function(oTable) {
-		validateBinding(oTable.getBinding());
-		updateTableHierarchyMode(oTable);
-		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Table.RowsBound, validateBinding);
-		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Table.RefreshRows, onTableRefreshRows, this);
+	ODataV4Aggregation.prototype.onActivate = function(oTable) {
+		ODataV4MultiLevel.prototype.onActivate.apply(this, arguments);
+		validateBinding.call(this);
+		TableUtils.Grouping.setHierarchyMode(oTable, TableUtils.Grouping.HierarchyMode.Group);
 		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Row.UpdateState, updateRowState, this);
-		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Row.Expand, expandRow, this);
-		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Row.Collapse, collapseRow, this);
+		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Table.RefreshRows, validateBinding, this);
 	};
 
 	/**
 	 * @override
 	 * @inheritDoc
 	 */
-	V4Aggregation.prototype.onDeactivate = function(oTable) {
+	ODataV4Aggregation.prototype.onDeactivate = function(oTable) {
+		ODataV4MultiLevel.prototype.onDeactivate.apply(this, arguments);
 		for (const oColumn of oTable.getColumns()) {
 			oColumn._setCellContentVisibilitySettings();
 		}
-		TableUtils.Grouping.setHierarchyMode(oTable, TableUtils.Grouping.HierarchyMode.Flat);
-		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Table.RowsBound, validateBinding);
-		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Table.RefreshRows, onTableRefreshRows, this);
 		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Row.UpdateState, updateRowState, this);
-		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Row.Expand, expandRow, this);
-		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Row.Collapse, collapseRow, this);
+		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Table.RefreshRows, validateBinding, this);
 	};
 
-	V4Aggregation.prototype.declareColumnsHavingTotals = function(aColumnsWithTotals) {
+	/**
+	 * Declares the columns that have totals. Columns with totals show the data in the group header row and the summary row. Columns without totals
+	 * do not show the data in the group header row and the summary row.
+	 *
+	 * @param {Array} aColumnsWithTotals The columns that display totals
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.odata.v4.TableDelegate
+	 */
+	ODataV4Aggregation.prototype.declareColumnsHavingTotals = function(aColumnsWithTotals) {
 		const aColumns = this.getControl()?.getColumns() ?? [];
 
 		for (const oColumn of aColumns) {
@@ -102,25 +112,12 @@ sap.ui.define([
 		}
 	};
 
-	function validateBinding(oBinding) {
-		if (!oBinding) {
-			return;
-		}
-
-		if (!oBinding.getModel().isA("sap.ui.model.odata.v4.ODataModel")) {
-			throw new Error("Model must be sap.ui.model.odata.v4.ODataModel");
-		}
-	}
-
-	function onTableRefreshRows() {
-		updateTableHierarchyMode(this.getControl());
-	}
+	function validateBinding() {
+		const oBinding = this.getControl()?.getBinding();
+		const mAggregation = oBinding?.getAggregation();
 
-	function updateTableHierarchyMode(oTable) {
-		if ("hierarchyQualifier" in (oTable.getBinding()?.getAggregation() || {})) {
-			TableUtils.Grouping.setHierarchyMode(oTable, TableUtils.Grouping.HierarchyMode.Tree);
-		} else {
-			TableUtils.Grouping.setHierarchyMode(oTable, TableUtils.Grouping.HierarchyMode.Group);
+		if (oBinding && (!mAggregation || "hierarchyQualifier" in mAggregation)) {
+			throw new Error("Only data aggregation is supported");
 		}
 	}
 
@@ -141,7 +138,7 @@ sap.ui.define([
 			oState.level = iLevel + 1; // In the binding context, summary rows are one level higher than needed in the table.
 			oState.expandable = false; // In the binding context, the total summary (grand total) is expanded.
 		} else if (bIsGroupHeader) {
-			oState.type = oState.Type.GroupHeader; // In tree mode, the row type GroupHeader is ignored and treated like row type Standard.
+			oState.type = oState.Type.GroupHeader;
 			setGroupHeaderTitle(oState, this.getGroupHeaderFormatter());
 		}
 	}
@@ -168,21 +165,5 @@ sap.ui.define([
 		}
 	}
 
-	function expandRow(oRow) {
-		const oBindingContext = TableUtils.getBindingContextOfRow(oRow);
-
-		if (oBindingContext) {
-			oBindingContext.expand();
-		}
-	}
-
-	function collapseRow(oRow) {
-		const oBindingContext = TableUtils.getBindingContextOfRow(oRow);
-
-		if (oBindingContext) {
-			oBindingContext.collapse();
-		}
-	}
-
-	return V4Aggregation;
+	return ODataV4Aggregation;
 });

package/src/sap/ui/table/plugins/ODataV4Hierarchy.js

@@ -0,0 +1,91 @@
+/*
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"./ODataV4MultiLevel",
+	"./PluginBase",
+	"../utils/TableUtils"
+], function(
+	ODataV4MultiLevel,
+	PluginBase,
+	TableUtils
+) {
+	"use strict";
+
+	/**
+	 * @class
+	 * Integrates the information about the data structure of the {@link sap.ui.model.odata.v4.ODataListBinding} and the table. The table is enabled
+	 * to visualize hierarchical data. Works only in combination with a {@link sap.ui.model.odata.v4.ODataModel}.
+	 *
+	 * For details about hierarchies, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
+	 *
+	 * @extends sap.ui.core.Element
+	 *
+	 * @author SAP SE
+	 * @version 1.140.0
+	 *
+	 * @public
+	 * @since 1.140
+	 * @alias sap.ui.table.plugins.ODataV4Hierarchy
+	 * @see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 OData V4: Data Aggregation and Recursive Hierarchy}
+	 *
+	 * @borrows sap.ui.table.plugins.PluginBase.findOn as findOn
+	 */
+	const ODataV4Hierarchy = ODataV4MultiLevel.extend("sap.ui.table.plugins.ODataV4Hierarchy", {
+		metadata: {
+			library: "sap.ui.table",
+			properties: {
+				/**
+				 * Indicates whether this plugin is enabled.
+				 */
+				enabled: {type: "boolean", defaultValue: true} // TODO: Inherited from private PluginBase. Remove once PluginBase is public.
+			}
+		}
+	});
+
+	ODataV4Hierarchy.findOn = PluginBase.findOn;
+
+	/**
+	 * @override
+	 * @inheritDoc
+	 */
+	ODataV4Hierarchy.prototype.onActivate = function(oTable) {
+		ODataV4MultiLevel.prototype.onActivate.apply(this, arguments);
+		validateBinding.call(this);
+		TableUtils.Grouping.setHierarchyMode(oTable, TableUtils.Grouping.HierarchyMode.Tree);
+		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Row.UpdateState, updateRowState, this);
+		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Table.RefreshRows, validateBinding, this);
+	};
+
+	/**
+	 * @override
+	 * @inheritDoc
+	 */
+	ODataV4Hierarchy.prototype.onDeactivate = function(oTable) {
+		ODataV4MultiLevel.prototype.onDeactivate.apply(this, arguments);
+		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Row.UpdateState, updateRowState, this);
+		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Table.RefreshRows, validateBinding, this);
+	};
+
+	function validateBinding() {
+		const oBinding = this.getControl()?.getBinding();
+		const mAggregation = oBinding?.getAggregation();
+
+		if (oBinding && (!mAggregation || !("hierarchyQualifier" in mAggregation))) {
+			throw new Error("Only data aggregation is supported");
+		}
+	}
+
+	function updateRowState(oState) {
+		const vIsExpanded = oState.context.getProperty("@$ui5.node.isExpanded");
+		const bIsNode = vIsExpanded !== undefined;
+
+		oState.level = oState.context.getProperty("@$ui5.node.level") ?? 1;
+		oState.expandable = bIsNode;
+		oState.expanded = vIsExpanded;
+	}
+
+	return ODataV4Hierarchy;
+});

package/src/sap/ui/table/plugins/ODataV4MultiLevel.js

@@ -0,0 +1,100 @@
+/*
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"./PluginBase",
+	"../utils/TableUtils"
+], function(
+	PluginBase,
+	TableUtils
+) {
+	"use strict";
+
+	/**
+	 * @abstract
+	 * @class
+	 * Base class for OData V4 plugins that integrate the table with the bindings aggregation and hierarchy features. Works only in combination with
+	 * a {@link sap.ui.model.odata.v4.ODataModel}.
+	 *
+	 * @extends sap.ui.table.plugins.PluginBase
+	 *
+	 * @author SAP SE
+	 * @version 1.140.0
+	 *
+	 * @private
+	 * @alias sap.ui.table.plugins.ODataV4MultiLevel
+	 * @see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 OData V4: Data Aggregation and Recursive Hierarchy}
+	 *
+	 * @borrows sap.ui.table.plugins.PluginBase.findOn as findOn
+	 */
+	const ODataV4MultiLevel = PluginBase.extend("sap.ui.table.plugins.ODataV4MultiLevel", {
+		metadata: {
+			"abstract": true,
+			library: "sap.ui.table"
+		}
+	});
+
+	ODataV4MultiLevel.findOn = PluginBase.findOn;
+
+	/**
+	 * @override
+	 * @inheritDoc
+	 */
+	ODataV4MultiLevel.prototype.isApplicable = function(oControl) {
+		return PluginBase.prototype.isApplicable.apply(this, arguments) && oControl.getMetadata().getName() === "sap.ui.table.Table";
+	};
+
+	/**
+	 * @override
+	 * @inheritDoc
+	 */
+	ODataV4MultiLevel.prototype.onActivate = function(oTable) {
+		PluginBase.prototype.onActivate.apply(this, arguments);
+		validateBinding(oTable.getBinding());
+		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Table.RowsBound, validateBinding);
+		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Row.Expand, expandRow, this);
+		TableUtils.Hook.register(oTable, TableUtils.Hook.Keys.Row.Collapse, collapseRow, this);
+	};
+
+	/**
+	 * @override
+	 * @inheritDoc
+	 */
+	ODataV4MultiLevel.prototype.onDeactivate = function(oTable) {
+		PluginBase.prototype.onDeactivate.apply(this, arguments);
+		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Table.RowsBound, validateBinding);
+		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Row.Expand, expandRow, this);
+		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Row.Collapse, collapseRow, this);
+		TableUtils.Grouping.setHierarchyMode(oTable, TableUtils.Grouping.HierarchyMode.Flat);
+	};
+
+	function validateBinding(oBinding) {
+		if (!oBinding) {
+			return;
+		}
+
+		if (!oBinding.getModel().isA("sap.ui.model.odata.v4.ODataModel")) {
+			throw new Error("Model must be sap.ui.model.odata.v4.ODataModel");
+		}
+	}
+
+	function expandRow(oRow) {
+		const oBindingContext = TableUtils.getBindingContextOfRow(oRow);
+
+		if (oBindingContext) {
+			oBindingContext.expand();
+		}
+	}
+
+	function collapseRow(oRow) {
+		const oBindingContext = TableUtils.getBindingContextOfRow(oRow);
+
+		if (oBindingContext) {
+			oBindingContext.collapse();
+		}
+	}
+
+	return ODataV4MultiLevel;
+});