@openui5/sap.m 1.108.25 → 1.108.26

package/src/sap/m/VisibleItem.js

@@ -21,7 +21,7 @@ sap.ui.define(['./library', 'sap/ui/core/Item', "sap/ui/thirdparty/jquery"],
 		 * @extends sap.ui.core.Item
 		 *
 		 * @author SAP SE
-		 * @version 1.108.25
+		 * @version 1.108.26
 		 *
 		 * @constructor
 		 * @private

package/src/sap/m/WheelSlider.js

@@ -29,7 +29,7 @@ sap.ui.define([
 		 * @extends sap.ui.core.Control
 		 *
 		 * @author SAP SE
-		 * @version 1.108.25
+		 * @version 1.108.26
 		 *
 		 * @constructor
 		 * @public

package/src/sap/m/WheelSliderContainer.js

@@ -31,7 +31,7 @@ sap.ui.define([
 		 * @extends sap.ui.core.Control
 		 *
 		 * @author SAP SE
-		 * @version 1.108.25
+		 * @version 1.108.26
 		 *
 		 * @constructor
 		 * @public

package/src/sap/m/Wizard.js

@@ -95,7 +95,7 @@ sap.ui.define([
 		 *
 		 * @extends sap.ui.core.Control
 		 * @author SAP SE
-		 * @version 1.108.25
+		 * @version 1.108.26
 		 *
 		 * @constructor
 		 * @public

package/src/sap/m/WizardProgressNavigator.js

@@ -43,7 +43,7 @@ function(
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @constructor
 	 * @private

package/src/sap/m/WizardStep.js

@@ -36,7 +36,7 @@ sap.ui.define([
 	 * <li>If the execution needs to branch after a given step, you should set all possible next steps in the <code>subsequentSteps</code> aggregation.
 	 * @extends sap.ui.core.Control
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @constructor
 	 * @public

package/src/sap/m/changeHandler/AddTableColumn.js

@@ -43,7 +43,7 @@ sap.ui.define([
 	 *
 	 * @author SAP SE
 	 *
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @experimental Since 1.51.0 This class is experimental and provides only limited functionality.
 	 * Also the API might be changed in future.

package/src/sap/m/changeHandler/ChangeLinkTarget.js

@@ -12,7 +12,7 @@ sap.ui.define(function () {
 	 *
 	 * @alias sap.m.changeHandler.ChangeLinkTarget
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @experimental Since 1.71
 	 */
 	var ChangeLinkTarget = {};

package/src/sap/m/changeHandler/CombineButtons.js

@@ -18,7 +18,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.m.changeHandler.CombineButtons
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @experimental Since 1.48
 	 */
 	var CombineButtons = {};

package/src/sap/m/changeHandler/MoveTableColumns.js

@@ -13,7 +13,7 @@ sap.ui.define(["sap/base/Log"], function(Log) {
 	 *
 	 * @alias sap.m.changeHandler.MoveTableColumns
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @experimental Since 1.48
 	 */
 	var MoveTableColumns = {};

package/src/sap/m/changeHandler/SelectIconTabBarFilter.js

@@ -14,7 +14,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.m.changeHandler.SelectIconTabBarFilter
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @experimental Since 1.96
 	 */
 	var SelectIconTabBarFilter = {};

package/src/sap/m/changeHandler/SplitMenuButton.js

@@ -20,7 +20,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.m.changeHandler.SplitMenuButton
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @experimental Since 1.48
 	 */
 	var SplitMenuButton = {};

package/src/sap/m/library.js

@@ -70,13 +70,13 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.m
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @since 1.4
 	 * @public
 	 */
 	var thisLib = sap.ui.getCore().initLibrary({
 		name : "sap.m",
-		version: "1.108.25",
+		version: "1.108.26",
 		dependencies : ["sap.ui.core"],
 		designtime: "sap/m/designtime/library.designtime",
 		types: [

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

@@ -22,12 +22,12 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @constructor
 	 * @alias sap.m.p13n.AbstractContainer
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @experimental Since 1.96.
 	 * @since 1.96
 	 *

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

@@ -20,12 +20,12 @@ sap.ui.define(['sap/ui/core/Element'],
 		 * @extends sap.ui.core.Element
 		 *
 		 * @author SAP SE
-		 * @version 1.108.25
+		 * @version 1.108.26
 		 *
 		 * @constructor
 		 * @alias sap.m.p13n.AbstractContainerItem
 		 * @author SAP SE
-		 * @version 1.108.25
+		 * @version 1.108.26
 		 * @experimental Since 1.96.
 	 	 * @since 1.96
 		 * @ui5-restricted

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

@@ -22,7 +22,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @public
 	 * @abstract

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

@@ -37,7 +37,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.AbstractContainer
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @private
 	 * @ui5-restricted

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

@@ -61,7 +61,7 @@ sap.ui.define([
 	 * @alias sap.m.p13n.Engine
 	 * @extends sap.m.p13n.AdaptationProvider
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @public
 	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!
 	 * @since 1.104
@@ -1204,8 +1204,7 @@ sap.ui.define([
 	};
 
 	/**
-	 * @private
-	 * @ui5-restricted sap.m
+	 * @public
 	 *
 	 * This method is the central point of access to the Engine Singleton.
 	 * @returns {sap.m.p13n.Engine} The Engine instance

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

@@ -8,12 +8,22 @@ sap.ui.define([
 ], function (BaseController, GroupPanel, xConfigAPI) {
     "use strict";
 
+    /**
+	 * Personalization <code>GroupState</code> object type. This object describes the state processed by this controller when accessing it through the {@link sap.m.p13n.Engine Engine}.
+	 *
+	 * @public
+	 * @typedef {object} sap.m.p13n.GroupState
+	 * @property {string} key The key for the group state
+	 * @property {boolean} [grouped] Defines whether the item is grouped (if a group state is provided, it's grouped automatically)
+	 * @property {int} [index] Describes the index of the grouping
+	 *
+	 */
+
      /**
 	 * Constructor for a new <code>GroupController</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
-     * @param {sap.ui.core.Control} mSettings.control The control instance that is personalized by this controller
+	 * @param {object} mSettings Initial settings for the new controller
+	 * @param {sap.ui.core.Control} mSettings.control The control instance that is personalized by this controller
 	 *
 	 * @class
 	 * The <code>GroupController</code> entity serves as a base class to create group-specific personalization implementations.
@@ -21,7 +31,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 * @public
 	 * @experimental
 	 * @since 1.104

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

@@ -21,7 +21,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.QueryPanel
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @public
 	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!

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

@@ -5,38 +5,83 @@
  */
 
 sap.ui.define([
-    "sap/ui/base/Object"
-], function (BaseObject) {
+	"sap/ui/base/Object"
+], function(BaseObject) {
 	"use strict";
 
-    /**
-     * The <code>MetadataHelper</code> entity offers utility functionality for providing service metadata during the <code>Engine#register</code> process.
-     *
+	/**
+	 * Personalization <code>MetadataObject</code> type.
+	 *
+	 * @public
+	 * @experimental Since 1.104.
+	 * @typedef {object} sap.m.p13n.MetadataObject
+	 * @property {string} key The unique key for the p13n metadata object
+	 * @property {string} label Defines the text that will be displayed in the personalization popup
+	 * @property {string} path Defines the technical path to apply binding-related updates
+	 * @property {boolean} [sortable] Defines whether the metadata object is sortable
+	 * @property {boolean} [groupable] Defines whether the metadata object is groupable
+	 * @property {boolean} [visible] Defines whether the metadata object is visible for selection
+	 *
+	 */
+
+	/**
 	 * @author SAP SE
 	 * @public
-     * @experimental Since 1.104.
 	 * @alias sap.m.p13n.MetadataHelper
-     */
-    var MetadataHelper = BaseObject.extend("sap.m.p13n.MetadataHelper", {
-        constructor: function(aProperties) {
+	 * @class
+	 * The <code>MetadataHelper</code> entity offers utility functionality for service metadata during the <code>Engine#register</code> process.
+	 *
+	 * @see {@link topic:75c08fdebf784575947927e052712bab Personalization}
+	 *
+	 * @constructor
+	 * @param {sap.m.p13n.MetadataObject[]} aProperties Array of objects defining available items for personalization
+	 * @example
+	 *   [
+	 *      {key: country, label: Country, path: modelPath/to/country},
+	 *      {key: region, label: Region, path: modelPath/to/region},
+	 *      {key: city, label: City, path: modelPath/to/city}
+	 * ]
+	 */
+	var MetadataHelper = BaseObject.extend("sap.m.p13n.MetadataHelper", {
+		constructor: function(aProperties) {
 			BaseObject.apply(this, arguments);
 			this._aProperties = aProperties;
 		}
-    });
+	});
 
-    MetadataHelper.prototype.getProperties = function() {
-        return this._aProperties;
-    };
+	/**
+	 * Gets the array of properties.
+	 *
+	 * @public
+	 * @returns {sap.m.p13n.MetadataObject[]} Array of properties
+	 */
+	MetadataHelper.prototype.getProperties = function() {
+		return this._aProperties;
+	};
 
-    MetadataHelper.prototype.getProperty = function(sKey) {
-        return this._aProperties.find(function(oProp){
-            return oProp.key === sKey;
-        });
-    };
+	/**
+	 * Gets a single property.
+	 *
+	 * @public
+	 * @param {string} sKey The property key identifying a property entry
+	 * @returns {sap.m.p13n.MetadataObject} A single property
+	 */
+	MetadataHelper.prototype.getProperty = function(sKey) {
+		return this._aProperties.find(function(oProp){
+			return oProp.key === sKey;
+		});
+	};
 
-    MetadataHelper.prototype.getPath = function(sKey) {
-        return this.getProperty(sKey).path;
-    };
+	/**
+	 * Gets a property path based on its key.
+	 *
+	 * @public
+	 * @param {string} sKey The property key identifying a property entry
+	 * @returns {string} The property path based on its key
+	 */
+	MetadataHelper.prototype.getPath = function(sKey) {
+		return this.getProperty(sKey).path;
+	};
 
 	return MetadataHelper;
 

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

@@ -34,7 +34,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @public
 	 * @experimental Since 1.97.

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

@@ -24,7 +24,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.BasePanel
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @private
 	 * @ui5-restricted

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

@@ -15,13 +15,26 @@ sap.ui.define([
 ], function (diff, BaseObject, merge, deepEqual, SelectionPanel, xConfigAPI, Configuration) {
 	"use strict";
 
+	/**
+	 * Personalization <code>SelectionState</code> object type. This object describes the state processed by this controller when accessing it through the {@link sap.m.p13n.Engine Engine}.
+	 *
+	 * @public
+	 * @typedef {object} sap.m.p13n.SelectionState
+	 * @property {string} key The key for the group state
+	 * @property {boolean} [visible] Defines whether the item is selected (if a selection state is provided, it's selected automatically)
+	 * @property {int} [index] Describes the index of the selection item
+	 *
+	 */
+
     /**
 	 * Constructor for a new <code>SelectionController</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
-     * @param {sap.ui.core.Control} mSettings.control The control instance that is personalized by this controller
-     * @param {string} mSettings.targetAggregation The name of the aggregation that is now managed by this controller
+	 * @param {object} mSettings Initial settings for the new controller
+	 * @param {sap.ui.core.Control} mSettings.control The control instance that is personalized by this controller
+	 * @param {function} [mSettings.getKeyForItem] By default the SelectionController tries to identify the existing item through the
+	 * key by checking if there is an existing item with this id. This behaviour can be overruled by implementing this method which will
+	 * provide the according item of the <code>targetAggregation</code> to return the according key associated to this item.
+	 * @param {string} mSettings.targetAggregation The name of the aggregation that is now managed by this controller
 	 *
 	 * @class
 	 * The <code>SelectionController</code> entity serves as a base class to create control-specific personalization implementations.
@@ -29,7 +42,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @public
 	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!

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

@@ -48,7 +48,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.BasePanel
 	 *
 	 * @author SAP SE
-	 * @version 1.108.25
+	 * @version 1.108.26
 	 *
 	 * @public
 	 * @experimental Since 1.96.