@openui5/sap.ui.table 1.112.2 → 1.114.0

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

@@ -4,10 +4,10 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	'sap/ui/model/SelectionModel',
-	'./SelectionPlugin',
+	"sap/ui/model/SelectionModel",
+	"./SelectionPlugin",
 	"../utils/TableUtils",
-	'../library'
+	"../library"
 ], function(
 	SelectionModel,
 	SelectionPlugin,
@@ -23,7 +23,7 @@ sap.ui.define([
 	 *
 	 * @class Implements the selection methods for a Table
 	 * @extends sap.ui.table.plugins.SelectionPlugin
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 * @constructor
 	 * @private
 	 * @alias sap.ui.table.plugins.SelectionModelSelection
@@ -31,6 +31,9 @@ sap.ui.define([
 	var SelectionModelSelection = SelectionPlugin.extend("sap.ui.table.plugins.SelectionModelSelection", {
 		metadata: {
 			library: "sap.ui.table",
+			properties: {
+				selectionMode: {type: "sap.ui.table.SelectionMode", group: "Behavior", defaultValue: SelectionMode.MultiToggle}
+			},
 			events: {
 				/**
 				 * This event is fired when the selection is changed.
@@ -57,7 +60,7 @@ sap.ui.define([
 	 */
 	SelectionModelSelection.prototype.init = function() {
 		SelectionPlugin.prototype.init.apply(this, arguments);
-		this.oSelectionModel = new SelectionModel(this._getSelectionMode);
+		this.oSelectionModel = new SelectionModel(getSelectionModelSelectionMode(this.getSelectionMode()));
 	};
 
 	/**
@@ -93,6 +96,28 @@ sap.ui.define([
 		TableUtils.Hook.deregister(oTable, TableUtils.Hook.Keys.Table.TotalRowCountChanged, onTotalRowCountChanged, this);
 	};
 
+	SelectionModelSelection.prototype.setSelected = function(oRow, bSelected, mConfig) {
+		if (!this.isIndexSelectable(oRow.getIndex())) {
+			return;
+		}
+
+		if (mConfig && mConfig.range) {
+			var iLastSelectedIndex = this.getSelectedIndex();
+
+			if (iLastSelectedIndex >= 0) {
+				this.addSelectionInterval(iLastSelectedIndex, oRow.getIndex());
+			}
+		} else if (bSelected) {
+			this.addSelectionInterval(oRow.getIndex(), oRow.getIndex());
+		} else {
+			this.removeSelectionInterval(oRow.getIndex(), oRow.getIndex());
+		}
+	};
+
+	SelectionModelSelection.prototype.isSelected = function(oRow) {
+		return this.isIndexSelected(oRow.getIndex());
+	};
+
 	/**
 	 * @inheritDoc
 	 */
@@ -100,11 +125,28 @@ sap.ui.define([
 		return {
 			headerSelector: {
 				type: "toggle",
-				visible: TableUtils.hasSelectAll(this.getTable())
+				visible: TableUtils.hasSelectAll(this.getTable()),
+				selected: this.getSelectableCount() > 0 && this.getSelectableCount() === this.getSelectedCount()
 			}
 		};
 	};
 
+	function toggleSelectAll(oPlugin) {
+		var oTable = oPlugin.getTable();
+
+		// in order to fire the rowSelectionChanged event, the SourceRowIndex mus be set to -1
+		// to indicate that the selection was changed by user interaction
+		if (oPlugin.getSelectableCount() > oPlugin.getSelectedCount()) {
+			oTable._iSourceRowIndex = 0;
+			oPlugin.selectAll();
+		} else {
+			oTable._iSourceRowIndex = -1;
+			oPlugin.clearSelection();
+		}
+
+		oTable._iSourceRowIndex = undefined;
+	}
+
 	/**
 	 * This hook is called by the table when the header selector is pressed.
 	 *
@@ -112,7 +154,7 @@ sap.ui.define([
 	 */
 	SelectionModelSelection.prototype.onHeaderSelectorPress = function() {
 		if (this.getRenderConfig().headerSelector.visible) {
-			this.getTable()._toggleSelectAll();
+			toggleSelectAll(this);
 		}
 	};
 
@@ -124,7 +166,7 @@ sap.ui.define([
 	 */
 	SelectionModelSelection.prototype.onKeyboardShortcut = function(sType) {
 		if (sType === "toggle") {
-			this.getTable()._toggleSelectAll();
+			toggleSelectAll(this);
 		} else if (sType === "clear") {
 			this.clearSelection();
 		}
@@ -135,7 +177,7 @@ sap.ui.define([
 	 * @inheritDoc
 	 */
 	SelectionModelSelection.prototype.addSelectionInterval = function(iIndexFrom, iIndexTo) {
-		if (!this.oSelectionModel || this._getSelectionMode() === SelectionMode.None) {
+		if (!this.oSelectionModel || this.getSelectionMode() === SelectionMode.None) {
 			return;
 		}
 		this.oSelectionModel.addSelectionInterval(iIndexFrom, iIndexTo);
@@ -221,7 +263,7 @@ sap.ui.define([
 	 * @inheritDoc
 	 */
 	SelectionModelSelection.prototype.selectAll = function() {
-		if (!this.oSelectionModel || this._getSelectionMode() === SelectionMode.None) {
+		if (!this.oSelectionModel || this.getSelectionMode() !== SelectionMode.MultiToggle) {
 			return;
 		}
 		this.oSelectionModel.selectAll(this._getHighestSelectableIndex());
@@ -232,7 +274,7 @@ sap.ui.define([
 	 * @inheritDoc
 	 */
 	SelectionModelSelection.prototype.setSelectedIndex = function(iIndex) {
-		if (this._getSelectionMode() === SelectionMode.None) {
+		if (this.getSelectionMode() === SelectionMode.None) {
 			return;
 		}
 		if (iIndex === -1) {
@@ -248,7 +290,7 @@ sap.ui.define([
 	 * @inheritDoc
 	 */
 	SelectionModelSelection.prototype.setSelectionInterval = function(iIndexFrom, iIndexTo) {
-		if (!this.oSelectionModel || this._getSelectionMode() === SelectionMode.None) {
+		if (!this.oSelectionModel || this.getSelectionMode() === SelectionMode.None) {
 			return;
 		}
 		this.oSelectionModel.setSelectionInterval(iIndexFrom, iIndexTo);
@@ -262,22 +304,25 @@ sap.ui.define([
 	 * @public
 	 */
 	SelectionModelSelection.prototype.setSelectionMode = function(sSelectionMode) {
-		var sOldSelectionMode = this._getSelectionMode();
+		var sOldSelectionMode = this.getSelectionMode();
 
-		SelectionPlugin.prototype._setSelectionMode.apply(this, arguments);
+		this.setProperty("selectionMode", sSelectionMode);
 
-		if (this._getSelectionMode() !== sOldSelectionMode) {
+		if (this.getSelectionMode() !== sOldSelectionMode) {
 			this.clearSelection();
 		}
 
 		if (this.oSelectionModel) {
-			var iSelectionMode = (sSelectionMode === SelectionMode.MultiToggle ? SelectionModel.MULTI_SELECTION : SelectionModel.SINGLE_SELECTION);
-			this.oSelectionModel.setSelectionMode(iSelectionMode);
+			this.oSelectionModel.setSelectionMode(getSelectionModelSelectionMode(this.getSelectionMode()));
 		}
 
 		return this;
 	};
 
+	function getSelectionModelSelectionMode(sSelectionMode) {
+		return sSelectionMode === SelectionMode.MultiToggle ? SelectionModel.MULTI_SELECTION : SelectionModel.SINGLE_SELECTION;
+	}
+
 	/**
 	 * Returns the highest index that can be selected. Returns -1 if there is nothing to select.
 	 *
@@ -302,20 +347,22 @@ sap.ui.define([
 	 */
 	SelectionModelSelection.prototype.onTableUnbindRows = function() {
 		SelectionPlugin.prototype.onTableUnbindRows.apply(this, arguments);
-		this._suspend();
+		this._bSuppressSelectionChangeEvent = true;
 		this.clearSelection();
-		this._resume();
+		delete this._bSuppressSelectionChangeEvent;
 	};
 
 	function onSelectionChange(oEvent) {
 		var aRowIndices = oEvent.getParameter("rowIndices");
 		var bSelectAll = oEvent.getParameter("selectAll");
 
-		this.fireSelectionChange({
-			rowIndices: aRowIndices,
-			selectAll: bSelectAll,
-			_internalTrigger: this._bInternalTrigger
-		});
+		if (!this._bSuppressSelectionChangeEvent) {
+			this.fireSelectionChange({
+				rowIndices: aRowIndices,
+				selectAll: bSelectAll,
+				_internalTrigger: this._bInternalTrigger
+			});
+		}
 	}
 
 	function attachToBinding(oPlugin, oBinding) {

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

@@ -5,18 +5,14 @@
  */
 sap.ui.define([
 	"sap/ui/core/Element",
-	"./PluginBase",
-	"../library"
+	"./PluginBase"
 ], function(
 	Element,
-	PluginBase,
-	library
+	PluginBase
 ) {
 
 	"use strict";
 
-	var SelectionMode = library.SelectionMode;
-
 	/**
 	 * Constructs an instance of sap.ui.table.plugins.SelectionPlugin
 	 *
@@ -29,7 +25,7 @@ sap.ui.define([
 	 * @class Implements the selection methods for a table.
 	 * @extends sap.ui.core.Element
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 * @public
 	 * @since 1.64
 	 * @experimental As of version 1.64
@@ -40,10 +36,9 @@ sap.ui.define([
 		library: "sap.ui.table",
 		properties: {
 			/**
-			 * Defines whether single or multiple items can be selected.
-			 * @private
+			 * Indicates whether this plugin is enabled.
 			 */
-			selectionMode: {type: "sap.ui.table.SelectionMode", defaultValue: SelectionMode.MultiToggle, visibility: "hidden"}
+			enabled: {type: "boolean", defaultValue: true} // TODO: Should be in PluginBase, which is still private for the time being
 		},
 		events: {
 			/**
@@ -63,195 +58,87 @@ sap.ui.define([
 		}
 	}
 
-	/**
-	 * Sets up the initial values.
-	 */
-	SelectionPlugin.prototype.init = function() {
-		PluginBase.prototype.init.apply(this, arguments);
-		this._bSuspended = false;
-	};
-
-	SelectionPlugin.prototype.getRenderConfig = function() {
-		return {
-			headerSelector: {
-				type: "none"
-			}
-		};
-	};
+	SelectionPlugin.prototype.setEnabled = function(bEnabled) {
+		this.setProperty("enabled", bEnabled, true);
 
-	/**
-	 * Adds the given selection interval to the selection.
-	 *
-	 * @param {int} iIndexFrom Index from which the selection starts
-	 * @param {int} iIndexTo Index up to which to select
-	 * @private
-	 * @abstract
-	 */
-	SelectionPlugin.prototype.addSelectionInterval = function(iIndexFrom, iIndexTo) {
-	};
-
-	/**
-	 * Removes the complete selection.
-	 *
-	 * @private
-	 * @abstract
- 	 */
-	SelectionPlugin.prototype.clearSelection = function() {
-	};
+		if (this.getEnabled()) {
+			this.activate();
+		} else {
+			this.deactivate();
+		}
 
-	/**
-	 * Retrieves the lead selection index.
-	 *
-	 * @returns {int}
-	 * @private
-	 * @abstract
-	 */
-	SelectionPlugin.prototype.getSelectedIndex = function() {
-		return -1;
+		return this;
 	};
 
 	/**
-	 * Zero-based indices of selected items, wrapped in an array. An empty array means nothing has been selected.
-	 *
-	 * @returns {int[]} An array containing all selected indices
-	 * @private
-	 * @abstract
-	 */
-	SelectionPlugin.prototype.getSelectedIndices = function() {
-		return [];
-    };
-
-	/**
-	 * Returns the number of items that can be selected.
+	 * TODO: Historically grown and hard to understand possible combinations of settings. Refactor!
 	 *
-	 * @returns {int} Number of items that can be selected
+	 * @returns {{headerSelector: {type: string, bla: blub}}}
 	 * @private
-	 * @abstract
 	 */
-	SelectionPlugin.prototype.getSelectableCount = function() {
-		return 0;
+	SelectionPlugin.prototype.getRenderConfig = function() {
+		return {
+			headerSelector: {
+				type: "none"
+			}
+		};
 	};
 
 	/**
-	 * Returns the number of selected items.
+	 * This hook is called when the header selector is pressed.
+	 * TODO: Also provide the event object?
 	 *
-	 * @returns {int} Number of selected items
 	 * @private
-	 * @abstract
 	 */
-	SelectionPlugin.prototype.getSelectedCount = function() {
-		return 0;
-	};
+	SelectionPlugin.prototype.onHeaderSelectorPress = function() {};
 
 	/**
-	 * Checks whether an index is selectable.
+	 * This hook is called when a keyboard shortcut relevant for selection is pressed.
+	 * TODO: Document parameter to that possible values are clear
+	 * TODO: Also provide the event object?
 	 *
-	 * @param {int} iIndex The index to be checked
-	 * @returns {boolean} <code>true</code> if the index is selectable, <code>false</code> otherwise
+	 * @param {string} sType Type of the keyboard shortcut.
 	 * @private
-	 * @abstract
 	 */
-	SelectionPlugin.prototype.isIndexSelectable = function(iIndex) {
-		return false;
-	};
+	SelectionPlugin.prototype.onKeyboardShortcut = function(sType) {};
 
 	/**
-	 * Returns the information whether the given index is selected.
+	 * Changes the selection state of a row.
 	 *
-	 * @param {int} iIndex The index for which the selection state is retrieved.
-	 * @returns {boolean} <code>true</code> if the index is selected, <code>false</code> otherwise
-	 * @private
+	 * @param {sap.ui.table.Row} oRow Instance of the row
+	 * @param {boolean} bSelected The new selection state
+	 * @param {object} [mConfig]
+	 * @param {boolean} [mConfig.range=false]
+	 *     Whether to change the selection of the range from the last changed row to this one. The table's preferred selection status of the range is
+	 *     indicated with the <code>bSelected</code> parameter, but the plugin may decide otherwise.
 	 * @abstract
-	 */
-	SelectionPlugin.prototype.isIndexSelected = function(iIndex) {
-		return false;
-	};
-
-	/**
-	 * Removes the given selection interval from the selection. In case of a single selection, only <code>iIndexTo</code> is removed from the selection.
-	 *
-	 * @param {int} iIndexFrom Index from which the deselection starts
-	 * @param {int} iIndexTo Index up to which to deselect
 	 * @private
-	 * @abstract
 	 */
-	SelectionPlugin.prototype.removeSelectionInterval = function(iIndexFrom, iIndexTo) {
+	SelectionPlugin.prototype.setSelected = function(oRow, bSelected, mConfig) {
+		throw new Error(this + " does not implement #setSelected");
 	};
 
 	/**
-	 * Selects all indices.
+	 * Checks whether a row is selected.
 	 *
-	 * @private
+	 * @param {sap.ui.table.Row} oRow Instance of the row
+	 * @returns {boolean} Whether the row is selected
 	 * @abstract
-	 */
-	SelectionPlugin.prototype.selectAll = function() {
-	};
-
-	/**
-	 * Sets the selected index.
-	 *
-	 * @param {int} iIndex The index which is selected (if existing)
 	 * @private
-	 * @abstract
 	 */
-	SelectionPlugin.prototype.setSelectedIndex = function(iIndex) {
+	SelectionPlugin.prototype.isSelected = function(oRow) {
+		throw new Error(this + " does not implement #isSelected");
 	};
 
 	/**
-	 * Sets the given selection interval as a selection. In case of a single selection, only <code>iIndexTo</code> is selected.
+	 * Returns the number of selected rows.
 	 *
-	 * @param {int} iIndexFrom Index from which the selection starts
-	 * @param {int} iIndexTo Index up to which to select
-	 * @private
+	 * @returns {int} The number of selected rows
 	 * @abstract
-	 */
-	SelectionPlugin.prototype.setSelectionInterval = function(iIndexFrom, iIndexTo) {
-	};
-
-	SelectionPlugin.prototype.fireSelectionChange = function(mArguments) {
-		if (!this._isSuspended()) {
-			this.fireEvent("selectionChange", mArguments);
-		}
-	};
-
-	SelectionPlugin.prototype._setSelectionMode = function(sSelectionMode) {
-		this.setProperty("selectionMode", sSelectionMode);
-	};
-
-	SelectionPlugin.prototype._getSelectionMode = function() {
-		return this.getProperty("selectionMode");
-	};
-
-	/**
-	 * Suspends the selectionChange event
-	 *
-	 * When _bSuspended is true, the selectionChange event is not being fired.
-	 *
-	 * @private
-	 */
-	SelectionPlugin.prototype._suspend = function() {
-		this._bSuspended = true;
-	};
-
-	/**
-	 * Resumes the selectionChange event
-	 *
-	 * When _bSuspended is false, the selectionChange event is being fired
-	 *
 	 * @private
 	 */
-	SelectionPlugin.prototype._resume = function() {
-		this._bSuspended = false;
-	};
-
-	/**
-	 * Checks if the selectionChange event is suspended.
-	 *
-	 * @return {boolean}
-	 * @private
-	 */
-	SelectionPlugin.prototype._isSuspended = function() {
-		return this._bSuspended;
+	SelectionPlugin.prototype.getSelectedCount = function() {
+		throw new Error(this + " does not implement #getSelectedCount");
 	};
 
 	return SelectionPlugin;

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

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @class TODO (don't forget to document fixed row count restrictions because fixed rows are set by this plugin)
 	 * @extends sap.ui.table.plugins.PluginBase
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 * @private
 	 * @since 1.76
 	 * @experimental
@@ -360,11 +360,13 @@ sap.ui.define([
 			this._aGroupLevels = [];
 			if (oAggregateInfo.groupLevels) {
 				oAggregateInfo.groupLevels.forEach(function(sGroupLevelName) {
-					var oProperty = this.findPropertyInfo(sGroupLevelName);
-					this._aGroupLevels.push({
-						property: oProperty,
-						textProperty: this.findPropertyInfo(oProperty.text)
-					});
+					var oGroupedPropertyInfo = this.findPropertyInfo(sGroupLevelName);
+					if (oGroupedPropertyInfo) {
+						this._aGroupLevels.push({
+							property: oGroupedPropertyInfo,
+							textProperty: this.findPropertyInfo(oGroupedPropertyInfo.text)
+						});
+					}
 				}.bind(this));
 			}
 

package/src/sap/ui/table/rowmodes/AutoRowMode.js

@@ -35,7 +35,7 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.mdc
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 */
 	var AutoRowMode = RowMode.extend("sap.ui.table.rowmodes.AutoRowMode", /** @lends sap.ui.table.rowmodes.AutoRowMode.prototype */ {
 		metadata: {

package/src/sap/ui/table/rowmodes/FixedRowMode.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.mdc
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 */
 	var FixedRowMode = RowMode.extend("sap.ui.table.rowmodes.FixedRowMode", /** @lends sap.ui.table.rowmodes.FixedRowMode.prototype */ {

package/src/sap/ui/table/rowmodes/InteractiveRowMode.js

@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.mdc
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 */
 	var InteractiveRowMode = RowMode.extend("sap.ui.table.rowmodes.InteractiveRowMode", /** @lends sap.ui.table.rowmodes.InteractiveRowMode.prototype */ {

package/src/sap/ui/table/rowmodes/RowMode.js

@@ -34,7 +34,7 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.mdc
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 */
 	var RowMode = Element.extend("sap.ui.table.rowmodes.RowMode", /** @lends sap.ui.table.rowmodes.RowMode.prototype */ {
 		metadata: {

package/src/sap/ui/table/rowmodes/VariableRowMode.js

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @extends sap.ui.table.rowmodes.RowMode
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/table/rules/Accessibility.support.js

@@ -15,7 +15,7 @@ sap.ui.define([
 	var MessageType = CoreLibrary.MessageType;
 
 	/*
-	 * Validates whether title or aria-labelledby is correctly set
+	 * Validates whether aria-labelledby is correctly set
 	 */
 	var oAccessibleLabel = SupportHelper.normalizeRule({
 		id: "AccessibleLabel",
@@ -23,7 +23,7 @@ sap.ui.define([
 		categories: [Categories.Accessibility],
 		title: "Accessible Label",
 		description: "Checks whether 'sap.ui.table.Table' controls have an accessible label.",
-		resolution: "Use the 'title' aggregation or the 'ariaLabelledBy' association of the 'sap.ui.table.Table' control "
+		resolution: "Use the 'ariaLabelledBy' association of the 'sap.ui.table.Table' control "
 					+ "to define a proper accessible labeling.",
 		check: function(oIssueManager, oCoreFacade, oScope) {
 			var aTables = SupportHelper.find(oScope, true, "sap.ui.table.Table");