@openui5/sap.ui.support 1.108.0 → 1.109.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/THIRDPARTY.txt CHANGED
@@ -478,7 +478,7 @@ License: Apache-2.0
478
478
  License Text: https://github.com/SAP/openui5/blob/master/LICENSES/Apache-2.0.txt
479
479
  Contained in: lib/jsdoc/ui5/plugin.js
480
480
 
481
- Component: SAP Theming Base Content, version: 11.1.40
481
+ Component: SAP Theming Base Content, version: 11.1.44
482
482
  Copyright: SAP SE or an SAP affiliate company and Theming Base Content contributors
483
483
  License: Apache-2.0
484
484
  License Text: https://github.com/SAP/openui5/blob/master/LICENSES/Apache-2.0.txt
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/sap.ui.support",
3
- "version": "1.108.0",
3
+ "version": "1.109.0",
4
4
  "description": "OpenUI5 UI Library sap.ui.support",
5
5
  "author": "SAP SE (https://www.sap.com)",
6
6
  "license": "Apache-2.0",
@@ -14,10 +14,10 @@
14
14
  "url": "https://github.com/SAP/openui5.git"
15
15
  },
16
16
  "dependencies": {
17
- "@openui5/sap.m": "1.108.0",
18
- "@openui5/sap.ui.codeeditor": "1.108.0",
19
- "@openui5/sap.ui.core": "1.108.0",
20
- "@openui5/sap.ui.fl": "1.108.0",
21
- "@openui5/sap.ui.layout": "1.108.0"
17
+ "@openui5/sap.m": "1.109.0",
18
+ "@openui5/sap.ui.codeeditor": "1.109.0",
19
+ "@openui5/sap.ui.core": "1.109.0",
20
+ "@openui5/sap.ui.fl": "1.109.0",
21
+ "@openui5/sap.ui.layout": "1.109.0"
22
22
  }
23
23
  }
@@ -6,7 +6,7 @@
6
6
  <copyright>OpenUI5
7
7
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
8
8
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.</copyright>
9
- <version>1.108.0</version>
9
+ <version>1.109.0</version>
10
10
 
11
11
  <documentation>UI5 library: sap.ui.support</documentation>
12
12
 
@@ -32,7 +32,7 @@ sap.ui.define([
32
32
  * @namespace
33
33
  * @alias sap.ui.support.RuleAnalyzer
34
34
  * @author SAP SE
35
- * @version 1.108.0
35
+ * @version 1.109.0
36
36
  * @public
37
37
  */
38
38
  var RuleAnalyzer = {
@@ -43,7 +43,6 @@ sap.ui.define([
43
43
  * Allows to choose a particular execution scope - desired part of the UI
44
44
  * to be checked and a flexible way to specify the list of rules to be used.
45
45
  *
46
- * @memberof sap.ui.support.RuleAnalyzer
47
46
  * @public
48
47
  * @param {object} [oExecutionScope] The execution scope of the analysis (see {@link topic:e15067d976f24b11907f4c262bd749a0 Execution Scope}).
49
48
  * @param {string} [oExecutionScope.type=global] Possible values are <code>global</code>, <code>subtree</code> or <code>components</code>.
@@ -82,7 +81,6 @@ sap.ui.define([
82
81
 
83
82
  /**
84
83
  * Returns the result of the last analysis performed.
85
- * @memberof sap.ui.support.RuleAnalyzer
86
84
  * @public
87
85
  * @returns {sap.ui.support.AnalysisResult} Last analysis history.
88
86
  */
@@ -93,7 +91,6 @@ sap.ui.define([
93
91
  /**
94
92
  * Returns the history of all executed analyses.
95
93
  *
96
- * @memberof sap.ui.support.RuleAnalyzer
97
94
  * @public
98
95
  * @returns {sap.ui.support.AnalysisResult[]} Array of history objects in the order of analyses performed. The results of the last analysis are contained in the last element in the array.
99
96
  */
@@ -104,7 +101,6 @@ sap.ui.define([
104
101
  /**
105
102
  * Returns the history of all executed analyses into formatted output depending on the passed format.
106
103
  *
107
- * @memberof sap.ui.support.RuleAnalyzer
108
104
  * @public
109
105
  * @param {sap.ui.support.HistoryFormats} [sFormat=sap.ui.support.HistoryFormats.String] The format into which the history object will be converted. Possible values are listed in sap.ui.support.HistoryFormats.
110
106
  * @returns {*} All analysis history objects in the correct format.
@@ -116,7 +112,6 @@ sap.ui.define([
116
112
  /**
117
113
  * Adds new temporary rule when in silent mode
118
114
  *
119
- * @memberof sap.ui.support.RuleAnalyzer
120
115
  * @public
121
116
  * @since 1.60
122
117
  * @param {object} oRule Settings for the new rule. For detailed information about its properties see {@link topic:eaeea19a991d46f29e6d8d8827317d0e Rule Property Values}
@@ -33,9 +33,8 @@ sap.ui.define(["sap/ui/thirdparty/jquery",
33
33
  *
34
34
  * @namespace
35
35
  * @deprecated Since version 1.60.0. Please use sap/ui/support/RuleAnalyzer instead.
36
- * @alias jQuery.sap.support
37
36
  * @author SAP SE
38
- * @version 1.108.0
37
+ * @version 1.109.0
39
38
  * @public
40
39
  */
41
40
  jQuery.sap.support = {
@@ -46,7 +45,6 @@ sap.ui.define(["sap/ui/thirdparty/jquery",
46
45
  * Allows to choose a particular execution scope - desired part of the UI
47
46
  * to be checked and a flexible way to specify the list of rules to be used.
48
47
  *
49
- * @memberof jQuery.sap.support
50
48
  * @deprecated Since version 1.60.0. Please use sap/ui/support/RuleAnalyzer instead.
51
49
  * @public
52
50
  * @param {object} [oExecutionScope] The execution scope of the analysis (see {@link topic:e15067d976f24b11907f4c262bd749a0 Execution Scopes}).
@@ -74,7 +72,6 @@ sap.ui.define(["sap/ui/thirdparty/jquery",
74
72
 
75
73
  /**
76
74
  * Returns the result of the last analysis performed.
77
- * @memberof jQuery.sap.support
78
75
  * @deprecated Since version 1.60.0. Please use sap/ui/support/RuleAnalyzer instead.
79
76
  * @public
80
77
  * @returns {Object} Last analysis history.
@@ -86,7 +83,6 @@ sap.ui.define(["sap/ui/thirdparty/jquery",
86
83
  /**
87
84
  * Returns the history of all executed analyses.
88
85
  *
89
- * @memberof jQuery.sap.support
90
86
  * @deprecated Since version 1.60.0. Please use sap/ui/support/RuleAnalyzer instead.
91
87
  * @public
92
88
  * @returns {Object[]} Array of history objects in the order of analyses performed. The results of the last analysis are contained in the last element in the array.
@@ -98,7 +94,6 @@ sap.ui.define(["sap/ui/thirdparty/jquery",
98
94
  /**
99
95
  * Returns the history of all executed analyses into formatted output depending on the passed format.
100
96
  *
101
- * @memberof jQuery.sap.support
102
97
  * @deprecated Since version 1.60.0. Please use sap/ui/support/RuleAnalyzer instead.
103
98
  * @public
104
99
  * @param {sap.ui.support.HistoryFormats} [sFormat=sap.ui.support.HistoryFormats.String] The format into which the history object will be converted. Possible values are listed in sap.ui.support.HistoryFormats.
@@ -111,7 +106,6 @@ sap.ui.define(["sap/ui/thirdparty/jquery",
111
106
  /**
112
107
  * Adds new temporary rule when in silent mode
113
108
  *
114
- * @memberof jQuery.sap.support
115
109
  * @deprecated Since version 1.60.0. Please use sap/ui/support/RuleAnalyzer instead.
116
110
  * @public
117
111
  * @since 1.60
@@ -23,7 +23,7 @@ sap.ui.define(["sap/ui/core/library"],
23
23
  * @namespace
24
24
  * @alias sap.ui.support
25
25
  * @author SAP SE
26
- * @version 1.108.0
26
+ * @version 1.109.0
27
27
  * @since 1.50
28
28
  * @public
29
29
  */
@@ -37,7 +37,7 @@ sap.ui.define(["sap/ui/core/library"],
37
37
  controls: [],
38
38
  elements: [],
39
39
  noLibraryCSS: true,
40
- version: "1.108.0",
40
+ version: "1.109.0",
41
41
  extensions: {
42
42
  //Configuration used for rule loading of Support Assistant
43
43
  "sap.ui.support": {
@@ -14,15 +14,18 @@ sap.ui.define(["sap/base/Log", "sap/ui/support/supportRules/IssueManager","sap/u
14
14
  "use strict";
15
15
 
16
16
  /**
17
- * @classdesc
17
+ * @class
18
+ *
18
19
  * <h3>Overview</h3>
19
20
  * Analyzer class that runs tasks. A Task runs a function for every entry in its object array.
20
21
  * The Analyzer counts the task objects and calculates the percentages.
22
+ *
21
23
  * <h3>Usage</h3>
22
24
  * With the start, restart, stop and pause methods the analyzer can be controlled.
23
25
  * While running it asynchronously, it selects objects from the list of each task and completes them.
26
+ *
24
27
  * @private
25
- * @class sap.ui.support.Analyzer
28
+ * @alias sap.ui.support.Analyzer
26
29
  */
27
30
  var Analyzer = function () {
28
31
  this.dStartedAt = null;
@@ -8,16 +8,13 @@ sap.ui.define([],
8
8
  "use strict";
9
9
 
10
10
  /**
11
- * Constants used in the Support Assistant
12
- * @enum {string}
11
+ * Constants used in the Support Assistant.
13
12
  * @private
14
13
  * @author SAP SE
15
14
  * @namespace
16
15
  * @name sap.ui.support.Constants
17
- * @alias sap.ui.support.AssistantConstants
18
- * @returns {Object} Object that contains all the constants.
19
16
  */
20
- return {
17
+ return /** @lends sap.ui.support.Constants */ {
21
18
  /*
22
19
  * The following constants are used to store rules and user data in the local storage.
23
20
  */
@@ -17,11 +17,14 @@ sap.ui.define([
17
17
  var coreInstance = null;
18
18
 
19
19
  /**
20
- * @classdesc
20
+ * @class
21
+ *
21
22
  * <h3>Overview</h3>
22
23
  * The CoreFacade interface gives access to the Metadata, Models, UI areas and Components of the Core object.
24
+ *
23
25
  * <h3>Usage</h3>
24
26
  * The CoreFacade is passed to all rule check functions as an object. This helps rule developers to access the core state.
27
+ *
25
28
  * @name sap.ui.support.CoreFacade
26
29
  * @param {object} oCore Core object as available in core plugins
27
30
  * @returns {object} Instance of the <code>CoreFacade</code>
@@ -30,11 +33,10 @@ sap.ui.define([
30
33
  function CoreFacade(oCore) {
31
34
  coreInstance = oCore;
32
35
 
33
- return {
36
+ return /** @lends sap.ui.support.CoreFacade.prototype */ {
34
37
  /**
35
38
  * Gets the Metadata from the Core object.
36
39
  * @public
37
- * @name sap.ui.support.CoreFacade.getMetadata
38
40
  */
39
41
  getMetadata: function () {
40
42
  return coreInstance.getMetadata();
@@ -42,7 +44,6 @@ sap.ui.define([
42
44
  /**
43
45
  * Gets the UI areas from the Core object.
44
46
  * @public
45
- * @name sap.ui.support.CoreFacade.getUIAreas
46
47
  */
47
48
  getUIAreas: function () {
48
49
  return UIArea.registry.all();
@@ -4,29 +4,6 @@
4
4
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
5
5
  */
6
6
 
7
- /**
8
- * @class
9
- * Allows to select the scope of analysis on an application.
10
- *
11
- * <h3>Overview</h3>
12
- *
13
- * <code>ExecutionScope</code> is the third parameter of a rule check function.
14
- * It provides access to internal UI5 objects available for inspection.
15
- * The <code>getElements</code> API method allows the user to select a specific subset of
16
- * elements valid for their case. It accepts one query object argument.
17
- *
18
- * <h3>Usage</h3>
19
- *
20
- * When a rule is executed, three parameters are passed: <code>oIssueManager</code>,
21
- * <code>oCoreFacade</code> and <code>oScope</code>.
22
- *
23
- * An <code>ExecutionScope</code> instance is passed to every call of a rule check function.
24
- * When you analyze your application, available objects are collected depending on the settings
25
- * passed to the Support Assistant at the moment when you start it.
26
- * @public
27
- * @since 1.48
28
- * @class sap.ui.support.ExecutionScope
29
- */
30
7
  sap.ui.define(
31
8
  ["sap/base/Log", "sap/ui/core/Component", "sap/ui/core/Element", "sap/ui/core/UIArea"],
32
9
  function (Log, Component, Element, UIArea) {
@@ -153,13 +130,37 @@ sap.ui.define(
153
130
  return res;
154
131
  }
155
132
 
133
+ /**
134
+ * @class
135
+ * Allows to select the scope of analysis on an application.
136
+ *
137
+ * <h3>Overview</h3>
138
+ *
139
+ * <code>ExecutionScope</code> is the third parameter of a rule check function.
140
+ * It provides access to internal UI5 objects available for inspection.
141
+ * The <code>getElements</code> API method allows the user to select a specific subset of
142
+ * elements valid for their case. It accepts one query object argument.
143
+ *
144
+ * <h3>Usage</h3>
145
+ *
146
+ * When a rule is executed, three parameters are passed: <code>oIssueManager</code>,
147
+ * <code>oCoreFacade</code> and <code>oScope</code>.
148
+ *
149
+ * An <code>ExecutionScope</code> instance is passed to every call of a rule check function.
150
+ * When you analyze your application, available objects are collected depending on the settings
151
+ * passed to the Support Assistant at the moment when you start it.
152
+ *
153
+ * @public
154
+ * @since 1.48
155
+ * @alias sap.ui.support.ExecutionScope
156
+ */
156
157
  function ExecutionScope(core, context) {
157
158
  elements = [];
158
159
  _context = context;
159
160
 
160
161
  contextTypes[_context.type].setScope();
161
162
 
162
- return {
163
+ return /** @lends sap.ui.support.ExecutionScope.prototype */ {
163
164
  /**
164
165
  * @param {object} oConfig Object with specific filtering options
165
166
  * @param {string} oConfig.type Type name to filter by type
@@ -168,9 +169,7 @@ sap.ui.define(
168
169
  * @param {boolean} oConfig.cloned Option to exclude elements that are
169
170
  * clones of list bindings
170
171
  * @public
171
- * @function
172
172
  * @returns {Array} Array of matched elements
173
- * @alias sap.ui.support.ExecutionScope.getElements
174
173
  */
175
174
  getElements: function (oConfig) {
176
175
  var that = this;
@@ -240,9 +239,7 @@ sap.ui.define(
240
239
  * Returns all public elements, i.e. elements that are part of public API
241
240
  * aggregations
242
241
  * @public
243
- * @function
244
242
  * @returns {Array} Array of matched elements
245
- * @alias sap.ui.support.ExecutionScope.getPublicElements
246
243
  */
247
244
  getPublicElements: function () {
248
245
  var aPublicElements = [];
@@ -265,11 +262,9 @@ sap.ui.define(
265
262
  /**
266
263
  * Gets elements by their type
267
264
  * @public
268
- * @function
269
265
  * @param {string|function} classNameSelector Either string or function
270
266
  * to be used when selecting a subset of elements
271
267
  * @returns {Array} Array of matched elements
272
- * @alias sap.ui.support.ExecutionScope.getElementsByClassName
273
268
  */
274
269
  getElementsByClassName: function (classNameSelector) {
275
270
  if (typeof classNameSelector === "string") {
@@ -287,10 +282,8 @@ sap.ui.define(
287
282
  /**
288
283
  * Gets the logged objects by object type
289
284
  * @public
290
- * @function
291
285
  * @param {any} type Type of logged objects
292
286
  * @returns {Array} Array of logged objects
293
- * @alias sap.ui.support.ExecutionScope.getLoggedObjects
294
287
  */
295
288
  getLoggedObjects: function (type) {
296
289
  var log = Log.getLogEntries(),
@@ -334,9 +327,7 @@ sap.ui.define(
334
327
  /**
335
328
  * Gets the type of the execution scope
336
329
  * @public
337
- * @function
338
330
  * @returns {string} The type of the execution scope. Possible values are <code>global</code>, <code>subtree</code> or <code>components</code>.
339
- * @alias sap.ui.support.ExecutionScope.getType
340
331
  */
341
332
  getType: function () {
342
333
  return _context.type;
@@ -106,7 +106,6 @@ function (library, IssueManager, RuleSetLoader, StringHistoryFormatter, AbapHist
106
106
  * @param {string} sRuleName The name of the rule
107
107
  * @returns {Array} All issues from a rule
108
108
  * @private
109
- * @method
110
109
  */
111
110
  var _getIssuesFromRule = function (oRun, sLibraryName, sRuleName) {
112
111
  var aIssues = [];
@@ -126,6 +125,10 @@ function (library, IssueManager, RuleSetLoader, StringHistoryFormatter, AbapHist
126
125
  return aIssues;
127
126
  };
128
127
 
128
+ /**
129
+ * @namespace
130
+ * @alias sap.ui.support.History
131
+ */
129
132
  var History = {
130
133
 
131
134
  /**
@@ -141,9 +144,7 @@ function (library, IssueManager, RuleSetLoader, StringHistoryFormatter, AbapHist
141
144
  * Stores the passed analysis object to an array of passed runs.
142
145
  *
143
146
  * @public
144
- * @method
145
147
  * @param {Object} oContext the context of the analysis
146
- * @name sap.ui.support.History.saveAnalysis
147
148
  */
148
149
  saveAnalysis: function (oContext) {
149
150
  var mIssues = IssueManager.groupIssues(IssueManager.getIssuesModel()),
@@ -175,8 +176,6 @@ function (library, IssueManager, RuleSetLoader, StringHistoryFormatter, AbapHist
175
176
  * Clears all stored analysis history objects.
176
177
  *
177
178
  * @public
178
- * @method
179
- * @name sap.ui.support.History.clearHistory
180
179
  */
181
180
  clearHistory: function () {
182
181
  _aRuns = [];
@@ -186,8 +185,6 @@ function (library, IssueManager, RuleSetLoader, StringHistoryFormatter, AbapHist
186
185
  * Gets all passed analyses in a JSON object that can easily be converted into a string.
187
186
  *
188
187
  * @public
189
- * @method
190
- * @name sap.ui.support.History.getHistory
191
188
  * @returns {Array} Which contains all passed run analysis objects.
192
189
  */
193
190
  getHistory: function () {
@@ -214,9 +211,7 @@ function (library, IssueManager, RuleSetLoader, StringHistoryFormatter, AbapHist
214
211
  * Returns the history into formatted output depending on the passed format.
215
212
  *
216
213
  * @public
217
- * @method
218
214
  * @param {string} sFormat The format into which the history object will be converted. Possible values are listed in sap.ui.support.HistoryFormats.
219
- * @name sap.ui.support.History.getFormattedHistory
220
215
  * @returns {*} All analysis history objects in the correct format.
221
216
  */
222
217
  getFormattedHistory: function (sFormat) {
@@ -61,10 +61,7 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
61
61
  * <h3>Usage</h3>
62
62
  * The IssueManager can be used as a static class and add issues using the <code>addIssue</code> method of both the IssueManager or the IssueManagerFacade.
63
63
  * @public
64
- * @name sap.ui.support.IssueManager
65
- * @alias IssueManager
66
- *
67
- * @lends IssueManager
64
+ * @alias sap.ui.support.IssueManager
68
65
  */
69
66
  var IssueManager = {
70
67
 
@@ -72,8 +69,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
72
69
  /**
73
70
  * Adds an issue to the list of issues found.
74
71
  * @public
75
- * @method
76
- * @name sap.ui.support.IssueManager.addIssue
77
72
  * @param {object} oIssue The issue to be added in the IssueManager
78
73
  */
79
74
  addIssue: function (oIssue) {
@@ -82,8 +77,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
82
77
  /**
83
78
  * Cycles through issues stored in the IssueManager and executes the given callback function.
84
79
  * @public
85
- * @method
86
- * @name sap.ui.support.IssueManager.walkIssues
87
80
  * @param {function} fnCallback Callback function to be used in the same fashion as Array.prototype.forEach
88
81
  */
89
82
  walkIssues: function (fnCallback) {
@@ -93,8 +86,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
93
86
  /**
94
87
  * Clears all issues in the IssueManager.
95
88
  * @public
96
- * @method
97
- * @name sap.ui.support.IssueManager.clearIssues
98
89
  * @returns {void}
99
90
  */
100
91
  clearIssues: function () {
@@ -107,8 +98,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
107
98
  /**
108
99
  * Converts the issues inside the IssueManager.
109
100
  * @public
110
- * @method
111
- * @name sap.ui.support.IssueManager.getIssuesModel
112
101
  * @returns {object[]} viewModel Issues in ViewModel format
113
102
  */
114
103
  getIssuesModel: function () {
@@ -124,8 +113,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
124
113
  /**
125
114
  * Gets rules and issues, and converts each rule to a ruleViewModel - parameters should be converted as specified beforehand.
126
115
  * @public
127
- * @method
128
- * @name sap.ui.support.IssueManager.getRulesViewModel
129
116
  * @param {object} rules All the rules from _mRulesets
130
117
  * @param {array} selectedRulesIDs The rule ID's of the selected rules.
131
118
  * @param {array} issues The issues to map to the rulesViewModel
@@ -200,8 +187,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
200
187
  /**
201
188
  * Gets rules and converts them into treeTable format.
202
189
  * @public
203
- * @method
204
- * @name sap.ui.support.IssueManager.getTreeTableViewModel
205
190
  * @param {object} oRules Deserialized rules found within the current state
206
191
  * @returns {object} TreeTableModel Rules in treeTable usable format
207
192
  * The rules are in a TreeTable format.
@@ -247,8 +232,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
247
232
  /**
248
233
  * Gets issues in TreeTable format.
249
234
  * @public
250
- * @method
251
- * @name sap.ui.support.IssueManager.getIssuesViewModel
252
235
  * @param {object} issuesModel All the issues after they have been grouped with <code>groupIssues</code>
253
236
  * @returns {object} All the issues in TreeTable usable model
254
237
  */
@@ -334,7 +317,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
334
317
  * Builds a string containing the formatted name e.g. (1 H, 0 M, 0 L ).
335
318
  * @private
336
319
  * @param {object} oValues
337
- * @name sap.ui.support.IssueManager._getFormattedName
338
320
  * @returns {string} String containing the formatted name.
339
321
  */
340
322
  _getFormattedName: function(oValues) {
@@ -364,7 +346,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
364
346
  * Sorts number of severity issues e.g. 1 High, 0 Medium, 0 Low.
365
347
  * @private
366
348
  * @param {array} aIssues
367
- * @name sap.ui.support.IssueManager._sortSeverityIssuesByPriority
368
349
  * @returns {object} Object containing the number of issues sorted by severity.
369
350
  */
370
351
  _sortSeverityIssuesByPriority: function(aIssues) {
@@ -391,8 +372,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
391
372
  /**
392
373
  * Converts issues to view model format.
393
374
  * @public
394
- * @method
395
- * @name sap.ui.support.IssueManager.convertToViewModel
396
375
  * @param {array} oIssues The issues to convert
397
376
  * @returns {array} viewModel Issues in ViewModel format
398
377
  */
@@ -407,8 +386,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
407
386
  /**
408
387
  * Groups all issues by library and rule ID.
409
388
  * @public
410
- * @method
411
- * @name sap.ui.support.IssueManager.groupIssues
412
389
  * @param {array} oIssues The issues to group. Must be in a ViewModel format
413
390
  * @returns {array} groupedIssues Grouped issues by library and rule id
414
391
  */
@@ -436,10 +413,8 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
436
413
  /**
437
414
  * Creates an instance of the IssueManagerFacade.
438
415
  * @public
439
- * @method
440
- * @name sap.ui.support.IssueManager.createIssueManagerFacade
441
416
  * @param {object} oRule Given rule
442
- * @returns {object} New IssueManagerFacade
417
+ * @returns {sap.ui.support.IssueManagerFacade} New IssueManagerFacade
443
418
  */
444
419
  createIssueManagerFacade: function (oRule) {
445
420
  return new IssueManagerFacade(oRule);
@@ -450,9 +425,8 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
450
425
  * Creates an IssueManagerFacade.
451
426
  * @constructor
452
427
  * @private
453
- * @method
454
428
  * @namespace
455
- * @name sap.ui.support.IssueManagerFacade
429
+ * @alias sap.ui.support.IssueManagerFacade
456
430
  * @param {object} oRule Rule for the IssueManagerFacade
457
431
  * @returns {void}
458
432
  */
@@ -463,8 +437,6 @@ sap.ui.define(["sap/base/util/deepExtend", "sap/ui/base/Object", "sap/ui/support
463
437
  /**
464
438
  * Adds issue to the IssueManager via the IssueManagerFacade.
465
439
  * @public
466
- * @method
467
- * @memberof IssueManagerFacade
468
440
  * @param {object} oIssue Issue object to be added in the IssueManager
469
441
  * @returns {void}
470
442
  */
@@ -21,27 +21,22 @@ function (Log, Version, library, storage, constants) {
21
21
  * Contains all rulesets inside the RuleSet.
22
22
  *
23
23
  * @readonly
24
- * @name sap.ui.support.RuleSet.mRuleSets
25
- * @memberof sap.ui.support
26
24
  */
27
25
  var mRuleSets = {};
28
26
 
29
27
  /**
30
28
  * Creates a RuleSet.
29
+ *
31
30
  * The RuleSet can store multiple rules concerning namespaces.
32
31
  * <h3>Usage</h3>
33
32
  * The RuleSet is an interface used to create, update and delete rulesets.
34
33
  *
35
34
  * @class
36
35
  * @public
37
- * @constructor
38
- * @namespace
39
- * @name sap.ui.support.RuleSet
40
- * @memberof sap.ui.support
36
+ * @alias sap.ui.support.RuleSet
41
37
  * @author SAP SE
42
- * @version 1.108.0
38
+ * @version 1.109.0
43
39
  * @param {object} oSettings Name of the initiated
44
- * @returns {void}
45
40
  */
46
41
  var RuleSet = function (oSettings) {
47
42
  oSettings = oSettings || {};
@@ -62,10 +57,6 @@ function (Log, Version, library, storage, constants) {
62
57
  /**
63
58
  * Clears all rulesets inside the RuleSet.
64
59
  * @public
65
- * @static
66
- * @method
67
- * @name sap.ui.support.RuleSet.clearAllRuleSets
68
- * @memberof sap.ui.support.RuleSet
69
60
  * @returns {void}
70
61
  */
71
62
  RuleSet.clearAllRuleSets = function () {
@@ -75,9 +66,6 @@ function (Log, Version, library, storage, constants) {
75
66
  /**
76
67
  * Gets all rules from the RuleSet.
77
68
  * @public
78
- * @method
79
- * @name sap.ui.support.RuleSet.getRules
80
- * @memberof sap.ui.support.RuleSet
81
69
  * @returns {object} All rules within the current RuleSet
82
70
  */
83
71
  RuleSet.prototype.getRules = function () {
@@ -87,9 +75,6 @@ function (Log, Version, library, storage, constants) {
87
75
  /**
88
76
  * Updates rules from the RuleSet.
89
77
  * @public
90
- * @method
91
- * @name sap.ui.support.RuleSet.updateRule
92
- * @memberof sap.ui.support.RuleSet
93
78
  * @param {string} sRuleId Rule ID
94
79
  * @param {object} ORuleSettings Rule settings
95
80
  * @returns {string} sRuleVerification Rule Verification status
@@ -108,9 +93,6 @@ function (Log, Version, library, storage, constants) {
108
93
  /**
109
94
  * Verifies the settings object of the current RuleSet.
110
95
  * @private
111
- * @method
112
- * @name sap.ui.support.RuleSet._verifySettingsObject
113
- * @memberof sap.ui.support.RuleSet
114
96
  * @param {object} oSettings Settings object to be verified
115
97
  * @param {boolean} bUpdate Triggers update of passed settings object
116
98
  * @returns {string} Rule Verification status
@@ -195,9 +177,6 @@ function (Log, Version, library, storage, constants) {
195
177
  /**
196
178
  * Adds rules to RuleSet.
197
179
  * @public
198
- * @method
199
- * @name sap.ui.support.RuleSet.addRule
200
- * @memberof sap.ui.support.RuleSet
201
180
  * @param {object} oSettings Settings object with rule information
202
181
  * @returns {string} sRuleVerificationStatus Verification status
203
182
  */
@@ -231,9 +210,6 @@ function (Log, Version, library, storage, constants) {
231
210
  /**
232
211
  * Remove rule from RuleSet.
233
212
  * @public
234
- * @method
235
- * @name sap.ui.support.RuleSet.removeRule
236
- * @memberof sap.ui.support.RuleSet
237
213
  * @param {object} oRule Rule object that will be removed
238
214
  */
239
215
  RuleSet.prototype.removeRule = function (oRule) {
@@ -245,10 +221,6 @@ function (Log, Version, library, storage, constants) {
245
221
  /**
246
222
  * Stores which rules are selected to be run by the analyzer on the next check
247
223
  * @public
248
- * @static
249
- * @method
250
- * @name sap.ui.support.RuleSet.storeSelectionOfRules
251
- * @memberof sap.ui.support.RuleSet
252
224
  * @param {Object[]} aLibraries The data for the libraries and their rules
253
225
  */
254
226
  RuleSet.storeSelectionOfRules = function (aLibraries) {
@@ -260,10 +232,6 @@ function (Log, Version, library, storage, constants) {
260
232
  * Loads the previous selection of the user - which rules are selected to be run by the Rule Analyzer.
261
233
  * The method applies the settings to the currently loaded rules.
262
234
  * @public
263
- * @static
264
- * @method
265
- * @name sap.ui.support.RuleSet.loadSelectionOfRules
266
- * @memberof sap.ui.support.RuleSet
267
235
  * @param {Object[]} aLibraries The current loaded libraries and their rules
268
236
  */
269
237
  RuleSet.loadSelectionOfRules = function (aLibraries) {
@@ -289,10 +257,6 @@ function (Log, Version, library, storage, constants) {
289
257
  /**
290
258
  * Extracts all the settings needed to be saved from the libraries rules.
291
259
  * @private
292
- * @method
293
- * @static
294
- * @name sap.ui.support.RuleSet._extractRulesSettingsToSave
295
- * @memberof sap.ui.support.RuleSet
296
260
  * @param {Object[]} aLibraries The libraries and rules loaded from the model
297
261
  */
298
262
  RuleSet._extractRulesSettingsToSave = function (aLibraries) {
@@ -4,11 +4,6 @@
4
4
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
5
5
  */
6
6
 
7
- /**
8
- * Creates a RuleSetLoader that handles the loading of the RuleSets in the different libraries as well as stores the
9
- * data for the loaded RuleSets
10
- */
11
-
12
7
  sap.ui.define([
13
8
  "sap/base/Log",
14
9
  "sap/base/util/extend",
@@ -60,6 +55,11 @@ sap.ui.define([
60
55
  var sSupportModuleRootPath = sSupportModulePath.replace('/sap/ui/support', '');
61
56
  var sAbsUrl = getAbsoluteUrl(sSupportModuleRootPath);
62
57
 
58
+ /**
59
+ * Handles the loading of the RuleSets in the different libraries as well as stores the
60
+ * data for the loaded RuleSets.
61
+ * @namespace
62
+ */
63
63
  var RuleSetLoader = {};
64
64
 
65
65
  RuleSetLoader._mRuleSets = {};
@@ -15,8 +15,6 @@ sap.ui.define([
15
15
  /**
16
16
  * Encodes rules written by the user.
17
17
  * @private
18
- * @function
19
- * @name Encode
20
18
  * @param {string} sData Stringified object containing rule properties.
21
19
  * @returns {string} base-64 encoded string.
22
20
  */
@@ -27,8 +25,6 @@ sap.ui.define([
27
25
  /**
28
26
  * Decodes the already encoded data by the user.
29
27
  * @private
30
- * @function
31
- * @name Decode
32
28
  * @param {string} sData Stringified base-64 object containing rule properties.
33
29
  * @returns {string} Stringified object containing rule properties.
34
30
  */
@@ -47,26 +43,24 @@ sap.ui.define([
47
43
  };
48
44
 
49
45
  /**
50
- * @class
51
46
  * The Storage is used to store and receive data in/from the LocalStorage in the browser.
47
+ *
52
48
  * <h3>Overview</h3>
53
49
  * The Storage class is used to persist user settings.
50
+ *
54
51
  * <h3>Usage</h3>
55
52
  * This class must be used with {@link sap.ui.support.RuleSerializer} and {@link sap.ui.support.Constants} in order to store user data in the LocalStorage.
56
53
  *
57
54
  * @name sap.ui.support.Storage
58
- * @alias sap.ui.support.Storage
59
55
  * @author SAP SE.
60
- * @version 1.108.0
56
+ * @version 1.109.0
61
57
  * @private
62
58
  */
63
- return {
59
+ return /** @lends sap.ui.support.Storage */ {
64
60
 
65
61
  /**
66
62
  * Returns all previously created temporary rules.
67
63
  * @private
68
- * @name sap.ui.support.Storage.getRules
69
- * @method
70
64
  * @returns {object[]} An array containing all the temporary rules.
71
65
  */
72
66
  getRules: function () {
@@ -95,8 +89,6 @@ sap.ui.define([
95
89
  /**
96
90
  * Saves the temporary rules into the LocalStorage persistence layer.
97
91
  * @private
98
- * @name sap.ui.support.Storage.setRules
99
- * @method
100
92
  * @param {object[]} rules The temporary rules from the shared model.
101
93
  */
102
94
  setRules: function (rules) {
@@ -107,8 +99,6 @@ sap.ui.define([
107
99
  /**
108
100
  * Retrieves the selected rules which are stored in the LocalStorage persistence layer.
109
101
  * @private
110
- * @method
111
- * @name sap.ui.support.Storage.getSelectedRules
112
102
  * @returns {object[]} All selected rules that are stored in the LocalStorage persistence layer.
113
103
  */
114
104
  getSelectedRules: function () {
@@ -124,8 +114,6 @@ sap.ui.define([
124
114
  /**
125
115
  * Stores which rules are selected to be run by the analyzer on the next check.
126
116
  * @private
127
- * @method
128
- * @name sap.ui.support.Storage.setSelectedRules
129
117
  * @param {object[]} aSelectedRules The data for the libraries and their rules.
130
118
  */
131
119
  setSelectedRules: function (aSelectedRules) {
@@ -135,8 +123,6 @@ sap.ui.define([
135
123
  /**
136
124
  * Sets the context for the execution scope in the LocalStorage persistence layer.
137
125
  * @private
138
- * @method
139
- * @name sap.ui.support.Storage.setSelectedContext
140
126
  * @param {object} selectedContext Object containing the <code>analyzeContext</code> and <code>subtreeExecutionContextId</code>.
141
127
  */
142
128
  setSelectedContext: function(selectedContext) {
@@ -146,8 +132,6 @@ sap.ui.define([
146
132
  /**
147
133
  * Retrieves the selected context from the LocalStorage persistence layer.
148
134
  * @private
149
- * @method
150
- * @name sap.ui.support.Storage.getSelectedContext
151
135
  * @returns {string} Parsed value of the <code>selectedContext</code> key in the LocalStorage persistence layer.
152
136
  */
153
137
  getSelectedContext: function() {
@@ -157,8 +141,6 @@ sap.ui.define([
157
141
  /**
158
142
  * Sets the scope components that are selected.
159
143
  * @private
160
- * @method
161
- * @name sap.ui.support.Storage.setSelectedScopeComponents
162
144
  * @param {object} contextComponent Component that's stored in the LocalStorage.
163
145
  */
164
146
  setSelectedScopeComponents: function(contextComponent) {
@@ -168,8 +150,6 @@ sap.ui.define([
168
150
  /**
169
151
  * Gets the scope components that are selected.
170
152
  * @private
171
- * @method
172
- * @name sap.ui.support.Storage.getSelectedScopeComponents
173
153
  * @returns {string} componentContext The selected components within a given scope.
174
154
  */
175
155
  getSelectedScopeComponents: function() {
@@ -180,8 +160,6 @@ sap.ui.define([
180
160
  /**
181
161
  * Overwrites the temporary rules into the local storage persistence layer.
182
162
  * @private
183
- * @method
184
- * @name sap.ui.support.Storage.removeSelectedRules
185
163
  * @param {object[]} aSelectedRules The temporary rules from the shared model.
186
164
  */
187
165
  removeSelectedRules: function(aSelectedRules) {
@@ -190,8 +168,6 @@ sap.ui.define([
190
168
 
191
169
  /**
192
170
  * Sets the visible column setting selection.
193
- * @method
194
- * @name sap.ui.support.Storage.setVisibleColumns
195
171
  * @param {string[]} aVisibleColumns visible columns ids
196
172
  */
197
173
  setVisibleColumns: function(aVisibleColumns) {
@@ -200,8 +176,6 @@ sap.ui.define([
200
176
 
201
177
  /**
202
178
  * Gets the visible column setting selection.
203
- * @method
204
- * @name sap.ui.support.Storage.getVisibleColumns
205
179
  * @returns {string[]} ids of visible columns.
206
180
  */
207
181
  getVisibleColumns: function() {
@@ -211,8 +185,6 @@ sap.ui.define([
211
185
  /**
212
186
  * Retrieves the list of selection presets
213
187
  * @private
214
- * @method
215
- * @name sap.ui.support.Storage.getSelectionPresets
216
188
  * @returns {Object[]} The list of selection presets
217
189
  */
218
190
  getSelectionPresets: function() {
@@ -222,8 +194,6 @@ sap.ui.define([
222
194
  /**
223
195
  * Retrieves the list of custom presets
224
196
  * @private
225
- * @method
226
- * @name sap.ui.support.Storage.getCustomPresets
227
197
  * @returns {Object[]} The list of custom presets
228
198
  */
229
199
  getCustomPresets: function() {
@@ -233,8 +203,6 @@ sap.ui.define([
233
203
  /**
234
204
  * Sets the list of selection presets
235
205
  * @private
236
- * @method
237
- * @name sap.ui.support.Storage.setSelectionPresets
238
206
  * @param {Object[]} selectionPresets The list of selection presets
239
207
  */
240
208
  setSelectionPresets: function(selectionPresets) {
@@ -244,8 +212,6 @@ sap.ui.define([
244
212
  /**
245
213
  * Sets the list of custom presets
246
214
  * @private
247
- * @method
248
- * @name sap.ui.support.Storage.setCustomPresets
249
215
  * @param {Object[]} customPresets The list of custom presets
250
216
  */
251
217
  setCustomPresets: function(customPresets) {
@@ -255,8 +221,6 @@ sap.ui.define([
255
221
  /**
256
222
  * Removes all data from LocalStorage persistence layer.
257
223
  * @private
258
- * @method
259
- * @name sap.ui.support.Storage.removeAllData
260
224
  */
261
225
  removeAllData: function() {
262
226
  _storage.removeItem(Constants.LOCAL_STORAGE_TEMP_RULES_KEY);
@@ -273,8 +237,6 @@ sap.ui.define([
273
237
  /**
274
238
  * Creates a cookie with encoded information in the LocalStorage persistence layer.
275
239
  * @private
276
- * @method
277
- * @name sap.ui.support.Storage.createPersistenceCookie
278
240
  * @param {string} sCookieName Name of the cookie.
279
241
  * @param {boolean} sCookieValue Contents of the cookie.
280
242
  * @returns {void}
@@ -286,9 +248,6 @@ sap.ui.define([
286
248
  /**
287
249
  * Retrieves the persistence options of the user in the LocalStorage layer.
288
250
  * @private
289
- * @method
290
- * @name sap.ui.support.Storage.readPersistenceCookie
291
- * @alias readPersistenceCookie
292
251
  * @param {string} sCookieName Name of the cookie.
293
252
  * @returns {string} sOutput The persistence options of the user.
294
253
  */
@@ -316,8 +275,6 @@ sap.ui.define([
316
275
  /**
317
276
  * Removes the cookie with persistence information in the LocalStorage.
318
277
  * @private
319
- * @method
320
- * @name sap.ui.support.Storage.deletePersistenceCookie
321
278
  * @param {string} sCookieName Name of the cookie
322
279
  * @returns {void}
323
280
  */
@@ -16,7 +16,8 @@ function () {
16
16
  * <h3>Usage</h3>
17
17
  * These channels are used for communication with Main.
18
18
  *
19
- * @enum {string} sap.ui.support.WCBChannels
19
+ * @enum {string}
20
+ * @name sap.ui.support.WCBChannels
20
21
  * @readonly
21
22
  * @protected
22
23
  */
@@ -25,6 +26,7 @@ function () {
25
26
  * State change in the core.
26
27
  * @type {string}
27
28
  * @const
29
+ * @protected
28
30
  */
29
31
  ON_CORE_STATE_CHANGE: "ON_CORE_STATE_CHANGE",
30
32
 
@@ -32,6 +34,7 @@ function () {
32
34
  * Shows a report.
33
35
  * @type {string}
34
36
  * @const
37
+ * @protected
35
38
  */
36
39
  ON_SHOW_REPORT_REQUEST: "ON_SHOW_REPORT_REQUEST",
37
40
 
@@ -39,6 +42,7 @@ function () {
39
42
  * Downloads a report.
40
43
  * @type {string}
41
44
  * @const
45
+ * @protected
42
46
  */
43
47
  ON_DOWNLOAD_REPORT_REQUEST: "ON_DOWNLOAD_REPORT_REQUEST",
44
48
 
@@ -53,6 +57,7 @@ function () {
53
57
  * Notifies when the rulesets have to be loaded.
54
58
  * @type {string}
55
59
  * @const
60
+ * @protected
56
61
  */
57
62
  ON_INIT_ANALYSIS_CTRL: "ON_INIT_ANALYSIS_CTRL",
58
63
 
@@ -60,6 +65,7 @@ function () {
60
65
  * Provides the current progress status of the analysis.
61
66
  * @type {string}
62
67
  * @const
68
+ * @protected
63
69
  */
64
70
  ON_PROGRESS_UPDATE: "ON_PROGRESS_UPDATE",
65
71
 
@@ -67,6 +73,7 @@ function () {
67
73
  * Notifies that the analysis has started.
68
74
  * @type {string}
69
75
  * @const
76
+ * @protected
70
77
  */
71
78
  ON_ANALYZE_STARTED: "ON_ANALYZE_STARTED",
72
79
 
@@ -74,6 +81,7 @@ function () {
74
81
  * Notifies after the analysis has finished.
75
82
  * @type {string}
76
83
  * @const
84
+ * @protected
77
85
  */
78
86
  ON_ANALYZE_FINISH: "ON_ANALYZE_FINISH",
79
87
 
@@ -81,6 +89,7 @@ function () {
81
89
  * Posts information about the UI and it's iframe.
82
90
  * @type {string}
83
91
  * @const
92
+ * @protected
84
93
  */
85
94
  POST_UI_INFORMATION: "POST_UI_INFORMATION",
86
95
 
@@ -88,6 +97,7 @@ function () {
88
97
  * Verifies rule creation.
89
98
  * @type {string}
90
99
  * @const
100
+ * @protected
91
101
  */
92
102
  VERIFY_CREATE_RULE: "VERIFY_CREATE_RULE",
93
103
 
@@ -95,6 +105,7 @@ function () {
95
105
  * Verifies rule creation after it's finished.
96
106
  * @type {string}
97
107
  * @const
108
+ * @protected
98
109
  */
99
110
  VERIFY_RULE_CREATE_RESULT: "VERIFY_RULE_CREATE_RESULT",
100
111
 
@@ -102,6 +113,7 @@ function () {
102
113
  * Verifies rule update.
103
114
  * @type {string}
104
115
  * @const
116
+ * @protected
105
117
  */
106
118
  VERIFY_UPDATE_RULE: "VERIFY_UPDATE_RULE",
107
119
 
@@ -109,6 +121,7 @@ function () {
109
121
  * Verifies rule update after it's finished.
110
122
  * @type {string}
111
123
  * @const
124
+ * @protected
112
125
  */
113
126
  VERIFY_RULE_UPDATE_RESULT: "VERIFY_RULE_UPDATE_RESULT",
114
127
 
@@ -116,13 +129,15 @@ function () {
116
129
  * Posts information about which rule to be deleted.
117
130
  * @type {string}
118
131
  * @const
132
+ * @protected
119
133
  */
120
- DELETE_RULE: "DELETE_RULE",
134
+ DELETE_RULE: "DELETE_RULE",
121
135
 
122
136
  /**
123
137
  * Posts information about the application under test.
124
138
  * @type {string}
125
139
  * @const
140
+ * @protected
126
141
  */
127
142
  POST_APPLICATION_INFORMATION: "POST_APPLICATION_INFORMATION",
128
143
 
@@ -130,6 +145,7 @@ function () {
130
145
  * Posts available libraries.
131
146
  * @type {string}
132
147
  * @const
148
+ * @protected
133
149
  */
134
150
  POST_AVAILABLE_LIBRARIES: "POST_AVAILABLE_LIBRARIES",
135
151
 
@@ -137,6 +153,7 @@ function () {
137
153
  * Loads all rule sets.
138
154
  * @type {string}
139
155
  * @const
156
+ * @protected
140
157
  */
141
158
  LOAD_RULESETS: "LOAD_RULESETS",
142
159
 
@@ -144,6 +161,7 @@ function () {
144
161
  * Gets components.
145
162
  * @type {string}
146
163
  * @const
164
+ * @protected
147
165
  */
148
166
  GET_AVAILABLE_COMPONENTS: "GET_AVAILABLE_COMPONENTS",
149
167
 
@@ -151,6 +169,7 @@ function () {
151
169
  * Posts components.
152
170
  * @type {string}
153
171
  * @const
172
+ * @protected
154
173
  */
155
174
  POST_AVAILABLE_COMPONENTS: "POST_AVAILABLE_COMPONENTS",
156
175
 
@@ -158,6 +177,7 @@ function () {
158
177
  * Highlight element in TreeTable.
159
178
  * @type {string}
160
179
  * @const
180
+ * @protected
161
181
  */
162
182
  HIGHLIGHT_ELEMENT: "HIGHLIGHT_ELEMENT",
163
183
 
@@ -165,6 +185,7 @@ function () {
165
185
  * Open given URL.
166
186
  * @type {string}
167
187
  * @const
188
+ * @protected
168
189
  */
169
190
  OPEN_URL: "OPEN_URL",
170
191
 
@@ -172,6 +193,7 @@ function () {
172
193
  * Notifies onmouseenter event on the TreeTable.
173
194
  * @type {string}
174
195
  * @const
196
+ * @protected
175
197
  */
176
198
  TREE_ELEMENT_MOUSE_ENTER: "TREE_ELEMENT_MOUSE_ENTER",
177
199
 
@@ -179,6 +201,7 @@ function () {
179
201
  * Notifies onmouseout event on the TreeTable.
180
202
  * @type {string}
181
203
  * @const
204
+ * @protected
182
205
  */
183
206
  TREE_ELEMENT_MOUSE_OUT: "TREE_ELEMENT_MOUSE_OUT",
184
207
 
@@ -186,6 +209,7 @@ function () {
186
209
  * Updates support rules in IssueManager.
187
210
  * @type {string}
188
211
  * @const
212
+ * @protected
189
213
  */
190
214
  UPDATE_SUPPORT_RULES: "UPDATE_SUPPORT_RULES",
191
215
 
@@ -193,6 +217,7 @@ function () {
193
217
  * Upload external modules.
194
218
  * @type {string}
195
219
  * @const
220
+ * @protected
196
221
  */
197
222
  EXTERNAL_MODULE_UPLOADED: "EXTERNAL_MODULE_UPLOADED",
198
223
 
@@ -200,6 +225,7 @@ function () {
200
225
  * Hides SupportAssistant iframe.
201
226
  * @type {string}
202
227
  * @const
228
+ * @protected
203
229
  */
204
230
  TOGGLE_FRAME_HIDDEN: "TOGGLE_FRAME_HIDDEN",
205
231
 
@@ -207,6 +233,7 @@ function () {
207
233
  * Ensure SupportAssistant iframe is open.
208
234
  * @type {string}
209
235
  * @const
236
+ * @protected
210
237
  */
211
238
  ENSURE_FRAME_OPENED: "ENSURE_FRAME_OPENED",
212
239
 
@@ -214,6 +241,7 @@ function () {
214
241
  * Resize SupportAssistant iframe.
215
242
  * @type {string}
216
243
  * @const
244
+ * @protected
217
245
  */
218
246
  RESIZE_FRAME: "RESIZE_FRAME",
219
247
 
@@ -221,6 +249,7 @@ function () {
221
249
  * Request rules model.
222
250
  * @type {string}
223
251
  * @const
252
+ * @protected
224
253
  */
225
254
  REQUEST_RULES_MODEL: "REQUEST_RULES_MODEL",
226
255
 
@@ -228,6 +257,7 @@ function () {
228
257
  * Get rules model.
229
258
  * @type {string}
230
259
  * @const
260
+ * @protected
231
261
  */
232
262
  GET_RULES_MODEL: "GET_RULES_MODEL",
233
263
 
@@ -235,6 +265,7 @@ function () {
235
265
  * Request issues.
236
266
  * @type {string}
237
267
  * @const
268
+ * @protected
238
269
  */
239
270
  REQUEST_ISSUES: "REQUEST_ISSUES",
240
271
 
@@ -242,6 +273,7 @@ function () {
242
273
  * Gets the issues.
243
274
  * @type {string}
244
275
  * @const
276
+ * @protected
245
277
  */
246
278
  GET_ISSUES: "GET_ISSUES",
247
279
 
@@ -249,6 +281,7 @@ function () {
249
281
  * Posts a message.
250
282
  * @type {string}
251
283
  * @const
284
+ * @protected
252
285
  */
253
286
  POST_MESSAGE: "POST_MESSAGE",
254
287
 
@@ -256,6 +289,7 @@ function () {
256
289
  * Get non loaded libraries with rules names
257
290
  * @type {string}
258
291
  * @const
292
+ * @protected
259
293
  */
260
294
  GET_NON_LOADED_RULE_SETS: "GET_NON_LOADED_RULE_SETS",
261
295
 
@@ -263,6 +297,7 @@ function () {
263
297
  * Progress of current loading process
264
298
  * @type {string}
265
299
  * @const
300
+ * @protected
266
301
  */
267
302
  CURRENT_LOADING_PROGRESS: "CURRENT_LOADING_PROGRESS"
268
303
  };
@@ -22,11 +22,9 @@ sap.ui.define([
22
22
  * Each of these child classes are singletons, so they will have one instance per window.
23
23
  * If you need to share the exact same data between the two frames, use global variables
24
24
  * @class
25
- * @constructor
26
- * @name sap.ui.support.WindowCommunicationBus
27
- * @memberof sap.ui.support
25
+ * @alias sap.ui.support.WindowCommunicationBus
28
26
  * @author SAP SE
29
- * @version 1.108.0
27
+ * @version 1.109.0
30
28
  * @private
31
29
  */
32
30
  var WindowCommunicationBus = BaseObject.extend("sap.ui.support.supportRules.WindowCommunicationBus", {
@@ -48,9 +46,6 @@ sap.ui.define([
48
46
 
49
47
  /**
50
48
  * Subscribes to a channel with callback and given context
51
- * @method
52
- * @name sap.ui.support.WindowCommunicationBus.subscribe
53
- * @memberof sap.ui.support.WindowCommunicationBus
54
49
  * @param {string} sChannelName Name of the channel to subscribe
55
50
  * @param {function} fnCallback Callback for the SupportAssistant
56
51
  * @param {object} oContext Context for the subscribed channel
@@ -69,9 +64,6 @@ sap.ui.define([
69
64
 
70
65
  /**
71
66
  * Publishes given channel by name and settings
72
- * @method
73
- * @name sap.ui.support.WindowCommunicationBus.publish
74
- * @memberof sap.ui.support.WindowCommunicationBus
75
67
  * @param {string} sChannelName Name of the channel to publish
76
68
  * @param {string} aParams Settings passed to the SupportAssistant
77
69
  */
@@ -96,7 +88,6 @@ sap.ui.define([
96
88
 
97
89
  /**
98
90
  * mark an iframe as a valid participant in the communication
99
- * @method
100
91
  * @param {object} oOptions information about the iframe
101
92
  */
102
93
  WindowCommunicationBus.prototype.allowFrame = function (oOptions) {
@@ -112,9 +103,6 @@ sap.ui.define([
112
103
  /**
113
104
  * Clears all subscribed channels from the WindowCommunicationBus
114
105
  * @private
115
- * @method
116
- * @name sap.ui.support.WindowCommunicationBus.destroyChannels
117
- * @memberof sap.ui.support.WindowCommunicationBus
118
106
  */
119
107
  WindowCommunicationBus.prototype.destroyChannels = function () {
120
108
  this._channels = {};
@@ -123,9 +111,6 @@ sap.ui.define([
123
111
  /**
124
112
  * This is the message handler used for communication between the WindowCommunicationBus and {@link sap.ui.support.WCBChannels}
125
113
  * @private
126
- * @method
127
- * @name sap.ui.support.WindowCommunicationBus._onmessage
128
- * @memberof sap.ui.support.WindowCommunicationBus
129
114
  * @param {EventListener} eMessage Event fired by the channels attached to the WindowCommunicationBus
130
115
  */
131
116
  WindowCommunicationBus.prototype._onmessage = function (eMessage) {
@@ -145,7 +130,6 @@ sap.ui.define([
145
130
  * validate messages published from external window to application window (i.e. from tool frame to opener window)
146
131
  * no validation needed the other way (i.e. from opener window to tool frame)
147
132
  * @private
148
- * @method
149
133
  * @param {EventListener} eMessage Event fired by the channels attached to the WindowCommunicationBus
150
134
  * @returns {boolean} true if the message is valid
151
135
  */
@@ -89,7 +89,7 @@ sap.ui.define([
89
89
  *
90
90
  * @extends sap.ui.support.supportRules.ui.controllers.BaseController
91
91
  * @author SAP SE
92
- * @version 1.108.0
92
+ * @version 1.109.0
93
93
  * @private
94
94
  * @alias sap.ui.support.supportRules.ui.controllers.PresetsController
95
95
  */