@sapui5/sap.fe.test 1.127.2 → 1.129.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.
Files changed (74) hide show
  1. package/package.json +1 -1
  2. package/src/sap/fe/test/.library +1 -1
  3. package/src/sap/fe/test/AppStateAdapter.js +1 -1
  4. package/src/sap/fe/test/BaseActions.js +0 -7
  5. package/src/sap/fe/test/BaseArrangements.js +0 -7
  6. package/src/sap/fe/test/BaseAssertions.js +0 -5
  7. package/src/sap/fe/test/CollaborationClient.js +1 -1
  8. package/src/sap/fe/test/FeMocks.js +1 -1
  9. package/src/sap/fe/test/Flexibility.js +2 -7
  10. package/src/sap/fe/test/JestFlexibilityHelper.js +1 -1
  11. package/src/sap/fe/test/JestTemplatingHelper.js +3 -12
  12. package/src/sap/fe/test/JestTemplatingHelper.tsx +2 -10
  13. package/src/sap/fe/test/JourneyRunner.js +0 -9
  14. package/src/sap/fe/test/ListReport.js +0 -14
  15. package/src/sap/fe/test/ObjectPage.js +144 -60
  16. package/src/sap/fe/test/Shell.js +0 -7
  17. package/src/sap/fe/test/TemplatePage.js +0 -17
  18. package/src/sap/fe/test/TemplatingTestUtils.js +0 -1
  19. package/src/sap/fe/test/UI5MockHelper.js +9 -18
  20. package/src/sap/fe/test/UI5MockHelper.ts +5 -16
  21. package/src/sap/fe/test/api/BaseAPI.js +0 -15
  22. package/src/sap/fe/test/api/ChartActions.js +0 -2
  23. package/src/sap/fe/test/api/ChartAssertions.js +0 -1
  24. package/src/sap/fe/test/api/CollaborationAPI.js +2 -10
  25. package/src/sap/fe/test/api/CollaborationAPI.ts +2 -9
  26. package/src/sap/fe/test/api/DialogAPI.js +0 -2
  27. package/src/sap/fe/test/api/DialogActions.js +0 -7
  28. package/src/sap/fe/test/api/DialogAssertions.js +0 -6
  29. package/src/sap/fe/test/api/DialogCreateActions.js +0 -2
  30. package/src/sap/fe/test/api/DialogCreateAssertions.js +0 -2
  31. package/src/sap/fe/test/api/DialogHelper.js +0 -1
  32. package/src/sap/fe/test/api/DialogMassEditActions.js +0 -4
  33. package/src/sap/fe/test/api/DialogMassEditAssertions.js +0 -5
  34. package/src/sap/fe/test/api/DialogMessageActions.js +0 -4
  35. package/src/sap/fe/test/api/DialogMessageAssertions.js +0 -4
  36. package/src/sap/fe/test/api/DialogType.js +0 -8
  37. package/src/sap/fe/test/api/DialogValueHelpActions.js +0 -12
  38. package/src/sap/fe/test/api/DialogValueHelpAssertions.js +0 -9
  39. package/src/sap/fe/test/api/EditState.js +0 -7
  40. package/src/sap/fe/test/api/FilterBarAPI.js +0 -6
  41. package/src/sap/fe/test/api/FilterBarActions.js +0 -12
  42. package/src/sap/fe/test/api/FilterBarAssertions.js +0 -10
  43. package/src/sap/fe/test/api/FooterAPI.js +0 -1
  44. package/src/sap/fe/test/api/FooterActionsBase.js +0 -2
  45. package/src/sap/fe/test/api/FooterActionsOP.js +0 -5
  46. package/src/sap/fe/test/api/FooterAssertionsBase.js +0 -3
  47. package/src/sap/fe/test/api/FooterAssertionsOP.js +0 -6
  48. package/src/sap/fe/test/api/FormAPI.js +0 -2
  49. package/src/sap/fe/test/api/FormActions.js +0 -8
  50. package/src/sap/fe/test/api/FormAssertions.js +0 -7
  51. package/src/sap/fe/test/api/HeaderAPI.js +0 -8
  52. package/src/sap/fe/test/api/HeaderActions.js +0 -14
  53. package/src/sap/fe/test/api/HeaderActionsLR.js +0 -4
  54. package/src/sap/fe/test/api/HeaderAssertions.js +0 -21
  55. package/src/sap/fe/test/api/HeaderAssertionsLR.js +0 -4
  56. package/src/sap/fe/test/api/HeaderLR.js +0 -2
  57. package/src/sap/fe/test/api/KPICardAPI.js +0 -1
  58. package/src/sap/fe/test/api/KPICardActions.js +0 -2
  59. package/src/sap/fe/test/api/KPICardAssertions.js +0 -8
  60. package/src/sap/fe/test/api/TableAPI.js +1 -14
  61. package/src/sap/fe/test/api/TableActions.js +0 -36
  62. package/src/sap/fe/test/api/TableAssertions.js +0 -28
  63. package/src/sap/fe/test/builder/FEBuilder.js +0 -5
  64. package/src/sap/fe/test/builder/KPIBuilder.js +0 -6
  65. package/src/sap/fe/test/builder/MacroFieldBuilder.js +0 -1
  66. package/src/sap/fe/test/builder/MdcFieldBuilder.js +0 -6
  67. package/src/sap/fe/test/builder/MdcFilterFieldBuilder.js +0 -2
  68. package/src/sap/fe/test/builder/MdcTableBuilder.js +2 -5
  69. package/src/sap/fe/test/builder/OverflowToolbarBuilder.js +12 -8
  70. package/src/sap/fe/test/builder/VMBuilder.js +0 -6
  71. package/src/sap/fe/test/internal/ConsoleErrorChecker.js +1 -1
  72. package/src/sap/fe/test/internal/FEArrangements.js +0 -1
  73. package/src/sap/fe/test/library.js +2 -3
  74. package/src/sap/fe/test/library.ts +0 -1
@@ -11,7 +11,6 @@ sap.ui.define(
11
11
 
12
12
  /**
13
13
  * Constructs a new DialogCreateAssertions instance.
14
- *
15
14
  * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
16
15
  * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
17
16
  * @returns {sap.fe.test.api.DialogCreateAssertions} The new instance
@@ -30,7 +29,6 @@ sap.ui.define(
30
29
 
31
30
  /**
32
31
  * Checks the <code>Create</code> action on the dialog.
33
- *
34
32
  * @param {object} [mState] Defines the expected state of the button
35
33
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
36
34
  * @public
@@ -10,7 +10,6 @@ sap.ui.define(["./DialogAPI"], function (DialogAPI) {
10
10
  return {
11
11
  /**
12
12
  * A helper function that ensures that a draft is available and confirmed.
13
- *
14
13
  * @param {object} When The Opa5 When chain
15
14
  * @param {object} Then The Opa5 Then chain
16
15
  * @param {object} oParams The general object describing the parameters for this function
@@ -11,7 +11,6 @@ sap.ui.define(
11
11
 
12
12
  /**
13
13
  * Constructs a new DialogMassEditActions instance.
14
- *
15
14
  * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
16
15
  * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
17
16
  * @returns {sap.fe.test.api.DialogMassEditActions} The new instance
@@ -30,7 +29,6 @@ sap.ui.define(
30
29
 
31
30
  /**
32
31
  * A mass edit field identifier
33
- *
34
32
  * @typedef {object} MassEditFieldIdentifier
35
33
  * @property {string} property The name of the property
36
34
  * @name sap.fe.test.api.MassEditFieldIdentifier
@@ -39,7 +37,6 @@ sap.ui.define(
39
37
 
40
38
  /**
41
39
  * A mass edit field value
42
- *
43
40
  * @typedef {object} MassEditValue
44
41
  * @property {string} dropDownText The dropdown text for the selection
45
42
  * @property {string} rawText The raw text for the selection
@@ -49,7 +46,6 @@ sap.ui.define(
49
46
 
50
47
  /**
51
48
  * Changes the value of the defined filter field.
52
- *
53
49
  * @param {string | sap.fe.test.api.MassEditFieldIdentifier} vMassEditFieldIdentifier The identifier for the mass edit field
54
50
  * @param {string | sap.fe.test.api.MassEditValue} vMassEditValue The new target value
55
51
  * @param {object} [mState] The state of the mass edit field
@@ -11,7 +11,6 @@ sap.ui.define(
11
11
 
12
12
  /**
13
13
  * Constructs a new DialogMassEditAssertions instance.
14
- *
15
14
  * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
16
15
  * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
17
16
  * @returns {sap.fe.test.api.DialogMassEditAssertions} The new instance
@@ -30,7 +29,6 @@ sap.ui.define(
30
29
 
31
30
  /**
32
31
  * A mass edit field identifier
33
- *
34
32
  * @typedef {object} MassEditFieldIdentifier
35
33
  * @property {string} property The name of the property
36
34
  * @name sap.fe.test.api.MassEditFieldIdentifier
@@ -39,7 +37,6 @@ sap.ui.define(
39
37
 
40
38
  /**
41
39
  * A mass edit field value
42
- *
43
40
  * @typedef {object} MassEditValue
44
41
  * @property {string} dropDownText The dropdown text for the selection
45
42
  * @property {string} rawText The raw text for the selection
@@ -49,7 +46,6 @@ sap.ui.define(
49
46
 
50
47
  /**
51
48
  * Check the value of the defined filter field.
52
- *
53
49
  * @param {string | sap.fe.test.api.MassEditFieldIdentifier} vMassEditFieldIdentifier The identifier for the mass edit field
54
50
  * @param {string | sap.fe.test.api.MassEditValue} vMassEditValue The new target value
55
51
  * @param {object} [mState] The state of the mass edit field
@@ -117,7 +113,6 @@ sap.ui.define(
117
113
 
118
114
  /**
119
115
  * Check the suggestions of the defined filter field.
120
- *
121
116
  * @param {string | sap.fe.test.api.MassEditFieldIdentifier} vMassEditFieldIdentifier The identifier for the mass edit field
122
117
  * @param {string | sap.fe.test.api.MassEditValue} vMassEditValue The new target value
123
118
  * @param {object} [mState] The state of the mass edit field
@@ -11,7 +11,6 @@ sap.ui.define(
11
11
 
12
12
  /**
13
13
  * Constructs a new DialogMessageActions instance.
14
- *
15
14
  * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
16
15
  * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
17
16
  * @returns {sap.fe.test.api.DialogMessageActions} The new instance
@@ -30,7 +29,6 @@ sap.ui.define(
30
29
 
31
30
  /**
32
31
  * Executes the <code>Back</code> action on the message dialog.
33
- *
34
32
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
35
33
  * @public
36
34
  */
@@ -45,7 +43,6 @@ sap.ui.define(
45
43
 
46
44
  /**
47
45
  * Executes the <code>Refresh</code> action on the message dialog.
48
- *
49
46
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
50
47
  * @public
51
48
  */
@@ -60,7 +57,6 @@ sap.ui.define(
60
57
 
61
58
  /**
62
59
  * Selects the specified entry in the draft data loss popup.
63
- *
64
60
  * @param {any} optionKey
65
61
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
66
62
  * @public
@@ -11,7 +11,6 @@ sap.ui.define(
11
11
 
12
12
  /**
13
13
  * Constructs a new DialogMessageActions instance.
14
- *
15
14
  * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
16
15
  * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
17
16
  * @returns {sap.fe.test.api.DialogMessageAssertions} The new instance
@@ -30,7 +29,6 @@ sap.ui.define(
30
29
 
31
30
  /**
32
31
  * Checks the <code>Back</code> action on the message dialog.
33
- *
34
32
  * @param {object} [mState] Defines the expected state of the button
35
33
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
36
34
  * @public
@@ -48,7 +46,6 @@ sap.ui.define(
48
46
 
49
47
  /**
50
48
  * Checks the <code>Refresh</code> action on the dialog.
51
- *
52
49
  * @param {object} [mState] Defines the expected state of the button
53
50
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
54
51
  * @public
@@ -70,7 +67,6 @@ sap.ui.define(
70
67
 
71
68
  /**
72
69
  * Checks whether a certain message is shown in the dialog.
73
- *
74
70
  * @param {object} [oMessage] Defines the expected state of the message, e.g. <code>{ title: "My message" }</code>
75
71
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
76
72
  * @public
@@ -11,7 +11,6 @@ sap.ui.define(
11
11
 
12
12
  /**
13
13
  * Enum for supported dialog types.
14
- *
15
14
  * @name sap.fe.test.api.DialogType
16
15
  * @enum {string}
17
16
  * @public
@@ -19,7 +18,6 @@ sap.ui.define(
19
18
  return {
20
19
  /**
21
20
  * A simple dialog supporting base checks and actions such as 'Confirm' and 'Cancel'
22
- *
23
21
  * @name sap.fe.test.api.DialogType.Confirmation
24
22
  * @constant
25
23
  * @type {string}
@@ -28,7 +26,6 @@ sap.ui.define(
28
26
  Confirmation: "Confirmation",
29
27
  /**
30
28
  * A ValueHelp dialog that has a condition definition panel or a filterable selection table
31
- *
32
29
  * @name sap.fe.test.api.DialogType.ValueHelp
33
30
  * @constant
34
31
  * @type {string}
@@ -37,7 +34,6 @@ sap.ui.define(
37
34
  ValueHelp: "ValueHelp",
38
35
  /**
39
36
  * A message dialog for showing back-end messages
40
- *
41
37
  * @name sap.fe.test.api.DialogType.Message
42
38
  * @constant
43
39
  * @type {string}
@@ -46,7 +42,6 @@ sap.ui.define(
46
42
  Message: "Message",
47
43
  /**
48
44
  * A dialog used for showing an error message
49
- *
50
45
  * @name sap.fe.test.api.DialogType.Error
51
46
  * @constant
52
47
  * @type {string}
@@ -55,7 +50,6 @@ sap.ui.define(
55
50
  Error: "Error",
56
51
  /**
57
52
  * A default dialog for action parameters
58
- *
59
53
  * @name sap.fe.test.api.DialogType.Action
60
54
  * @constant
61
55
  * @type {string}
@@ -64,7 +58,6 @@ sap.ui.define(
64
58
  Action: "Action",
65
59
  /**
66
60
  * A dialog used for creating a new object
67
- *
68
61
  * @name sap.fe.test.api.DialogType.Create
69
62
  * @constant
70
63
  * @type {string}
@@ -73,7 +66,6 @@ sap.ui.define(
73
66
  Create: "Create",
74
67
  /**
75
68
  * A dialog used for mass edit
76
- *
77
69
  * @name sap.fe.test.api.DialogType.MassEdit
78
70
  * @constant
79
71
  * @type {string}
@@ -21,7 +21,6 @@ sap.ui.define(
21
21
 
22
22
  /**
23
23
  * Constructs a new DialogValueHelpActions instance.
24
- *
25
24
  * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
26
25
  * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
27
26
  * @returns {sap.fe.test.api.DialogValueHelpActions} The new instance
@@ -40,7 +39,6 @@ sap.ui.define(
40
39
 
41
40
  /**
42
41
  * Navigates to the <code>Search and Select</code> tab.
43
- *
44
42
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
45
43
  * @public
46
44
  */
@@ -58,7 +56,6 @@ sap.ui.define(
58
56
 
59
57
  /**
60
58
  * Navigates to the <code>Define Conditions</code> tab.
61
- *
62
59
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
63
60
  * @public
64
61
  */
@@ -76,7 +73,6 @@ sap.ui.define(
76
73
 
77
74
  /**
78
75
  * Clicks the <code>Hide/Show Filters</code> button.
79
- *
80
76
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
81
77
  * @public
82
78
  */
@@ -94,7 +90,6 @@ sap.ui.define(
94
90
 
95
91
  /**
96
92
  * Changes the value of the search field.
97
- *
98
93
  * @param {string} [sSearchText] The new search value.
99
94
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
100
95
  * @public
@@ -114,7 +109,6 @@ sap.ui.define(
114
109
 
115
110
  /**
116
111
  * Starts the search.
117
- *
118
112
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
119
113
  * @public
120
114
  */
@@ -128,7 +122,6 @@ sap.ui.define(
128
122
 
129
123
  /**
130
124
  * Resets the search field value.
131
- *
132
125
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
133
126
  * @public
134
127
  */
@@ -142,7 +135,6 @@ sap.ui.define(
142
135
 
143
136
  /**
144
137
  * Changes the value of a filter field.
145
- *
146
138
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the filter field
147
139
  * @param {string} [vValue] The new target value.
148
140
  * @param {boolean} [bClearFirst] Set to <code>true</code> to clear previously set filters, otherwise all previously set values will be kept
@@ -174,7 +166,6 @@ sap.ui.define(
174
166
 
175
167
  /**
176
168
  * Selects the specified rows.
177
- *
178
169
  * @param {object | number} [vRowValues] Defines the row values of the target row. The pattern is:
179
170
  * <code><pre>
180
171
  * {
@@ -206,7 +197,6 @@ sap.ui.define(
206
197
 
207
198
  /**
208
199
  * Adds a new condition.
209
- *
210
200
  * @param {string} sOperator The condition operator, like EQ, BT, LT, GT (see also {@link sap.ui.model.filter.FilterOperator})
211
201
  * @param {string | string[]} vValues The values to be set. If the operator requires more than one value, like BT (between),
212
202
  * an array with the two entries is expected
@@ -219,7 +209,6 @@ sap.ui.define(
219
209
 
220
210
  /**
221
211
  * Changes an existing condition.
222
- *
223
212
  * @param {string} sOperator The condition operator, like EQ, BT, LT, GT (see also {@link sap.ui.model.filter.FilterOperator})
224
213
  * @param {string | string[]} vValues The values to be set. If the operator requires more than one value like BT (between)
225
214
  * an array with the two entries is expected
@@ -264,7 +253,6 @@ sap.ui.define(
264
253
 
265
254
  /**
266
255
  * Removes an existing condition.
267
- *
268
256
  * @param {number} [iConditionIndex] The index of the condition to be removed. If not set, the index 0 is used
269
257
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
270
258
  * @public
@@ -20,7 +20,6 @@ sap.ui.define(
20
20
 
21
21
  /**
22
22
  * Constructs a new DialogValueHelpAssertions instance.
23
- *
24
23
  * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
25
24
  * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
26
25
  * @returns {sap.fe.test.api.DialogValueHelpAssertions} The new instance
@@ -39,7 +38,6 @@ sap.ui.define(
39
38
 
40
39
  /**
41
40
  * Checks the filter bar.
42
- *
43
41
  * @param {object} [mState] Defines the expected state of the filter bar
44
42
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
45
43
  * @public
@@ -64,7 +62,6 @@ sap.ui.define(
64
62
  /**
65
63
  * Checks a filter field.
66
64
  * If <code>vConditionValues</code> is <code>undefined</code>, the current condition values are ignored.
67
- *
68
65
  * @param {object | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the filter field
69
66
  * @param {string|object|Array} [vConditionValues] The expected value(s) of the filter field
70
67
  * @param {string} [sOperator] The expected operator
@@ -101,7 +98,6 @@ sap.ui.define(
101
98
 
102
99
  /**
103
100
  * Checks the search field in the filter bar. If the <code>sSearchText</code> parameter is <code>undefined</code>, the search text is not validated.
104
- *
105
101
  * @param {string} [sSearchText] The expected text in the search field
106
102
  * @param {object} [mState] Defines the expected state of the search field
107
103
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
@@ -129,7 +125,6 @@ sap.ui.define(
129
125
 
130
126
  /**
131
127
  * Checks the table.
132
- *
133
128
  * @param {object} [mState] Defines the expected state of the search field
134
129
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
135
130
  * @public
@@ -156,7 +151,6 @@ sap.ui.define(
156
151
  * If <code>iNumberOfRows</code> is provided, the number of rows are checked with respect to the provided <code>mRowValues</code> (if set) or in total.
157
152
  * If <code>iNumberOfRows</code> is omitted, it checks for at least one matching row.
158
153
  * If <code>mState</code> is provided, the row must be in the given state.
159
- *
160
154
  * @param {object} [mRowValues] Defines the row values of the target row. The pattern is:
161
155
  * <code><pre>
162
156
  * {
@@ -241,7 +235,6 @@ sap.ui.define(
241
235
  /**
242
236
  * Checks the <code>Define conditions</code> tab in a value help dialog.
243
237
  * Please be aware that the tab control of the toolbar is checked.
244
- *
245
238
  * @param {object} [mState] Defines the expected state of the filter bar
246
239
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
247
240
  * @public
@@ -267,7 +260,6 @@ sap.ui.define(
267
260
  /**
268
261
  * Checks the <code>Search and Select</code> tab in a value help dialog.
269
262
  * Please be aware that the tab control of the toolbar is checked.
270
- *
271
263
  * @param {object} [mState] Defines the expected state of the filter bar
272
264
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
273
265
  * @public
@@ -293,7 +285,6 @@ sap.ui.define(
293
285
 
294
286
  /**
295
287
  * Checks the dialog.
296
- *
297
288
  * @param {object} [mDialogState] Defines the expected state of the dialog
298
289
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
299
290
  * @public
@@ -11,7 +11,6 @@ sap.ui.define(
11
11
 
12
12
  /**
13
13
  * Enum for supported editing states.
14
- *
15
14
  * @name sap.fe.test.api.EditState
16
15
  * @enum {string}
17
16
  * @public
@@ -19,7 +18,6 @@ sap.ui.define(
19
18
  return {
20
19
  /**
21
20
  * All
22
- *
23
21
  * @name sap.fe.test.api.EditState.All
24
22
  * @constant
25
23
  * @type {string}
@@ -28,7 +26,6 @@ sap.ui.define(
28
26
  All: EditState.ALL.id,
29
27
  /**
30
28
  * Unchanged
31
- *
32
29
  * @name sap.fe.test.api.EditState.Unchanged
33
30
  * @constant
34
31
  * @type {string}
@@ -37,7 +34,6 @@ sap.ui.define(
37
34
  AllHidingDrafts: EditState.ALL_HIDING_DRAFTS.id,
38
35
  /**
39
36
  * All (Hiding Drafts)
40
- *
41
37
  * @name sap.fe.test.api.EditState.AllHidingDrafts
42
38
  * @constant
43
39
  * @type {string}
@@ -46,7 +42,6 @@ sap.ui.define(
46
42
  Unchanged: EditState.UNCHANGED.id,
47
43
  /**
48
44
  * Own Draft
49
- *
50
45
  * @name sap.fe.test.api.EditState.OwnDraft
51
46
  * @constant
52
47
  * @type {string}
@@ -55,7 +50,6 @@ sap.ui.define(
55
50
  OwnDraft: EditState.OWN_DRAFT.id,
56
51
  /**
57
52
  * Locked by Another User
58
- *
59
53
  * @name sap.fe.test.api.EditState.Locked
60
54
  * @constant
61
55
  * @type {string}
@@ -64,7 +58,6 @@ sap.ui.define(
64
58
  Locked: EditState.LOCKED.id,
65
59
  /**
66
60
  * Unsaved Changes by Another User
67
- *
68
61
  * @name sap.fe.test.api.EditState.UnsavedChanges
69
62
  * @constant
70
63
  * @type {string}
@@ -19,7 +19,6 @@ sap.ui.define(
19
19
 
20
20
  /**
21
21
  * A filter field identifier
22
- *
23
22
  * @typedef {object} FilterFieldIdentifier
24
23
  * @property {string} property The name of the property
25
24
  * @name sap.fe.test.api.FilterFieldIdentifier
@@ -28,7 +27,6 @@ sap.ui.define(
28
27
 
29
28
  /**
30
29
  * Constructs a new FilterBarAPI instance.
31
- *
32
30
  * @param {sap.fe.test.builder.FilterBarBuilder} oFilterBarBuilder The {@link sap.fe.test.builder.FilterBarBuilder} instance used to interact with the UI
33
31
  * @param {string} [vFilterBarDescription] Description (optional) of the filter bar to be used for logging messages
34
32
  * @returns {sap.fe.test.api.FilterBarAPI} The new instance
@@ -48,7 +46,6 @@ sap.ui.define(
48
46
 
49
47
  /**
50
48
  * Retrieve a filter field by its identifier.
51
- *
52
49
  * @param {sap.fe.test.builder.FilterBarBuilder} oFilterBarBuilder The builder of the filter bar to which the field belongs
53
50
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the field in the filter bar
54
51
  * @param {any} mState
@@ -72,7 +69,6 @@ sap.ui.define(
72
69
 
73
70
  /**
74
71
  * Opens the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.
75
- *
76
72
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
77
73
  * @public
78
74
  */
@@ -108,7 +104,6 @@ sap.ui.define(
108
104
 
109
105
  /**
110
106
  * Confirms the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.
111
- *
112
107
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
113
108
  * @public
114
109
  */
@@ -125,7 +120,6 @@ sap.ui.define(
125
120
  * Helper method to adapt filter fields. If no actions are given, this function can be used for checking only.
126
121
  * During execution it checks for an already open adaptation popover. If it does not exist, it is opened before
127
122
  * the check/interaction of the filter fields, and closed directly afterwards.
128
- *
129
123
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the field
130
124
  * @param {object} [mState] Defines the expected state of the adaptation filter field
131
125
  * @param {Function|Array|sap.ui.test.actions.Action} [vActions] The actions to be executed on found adaptation field
@@ -19,7 +19,6 @@ sap.ui.define(
19
19
 
20
20
  /**
21
21
  * Constructs a new FilterBarActions instance.
22
- *
23
22
  * @param {sap.fe.test.builder.FilterBarBuilder} oFilterBarBuilder The {@link sap.fe.test.builder.FilterBarBuilder} instance used to interact with the UI
24
23
  * @param {string} [vFilterBarDescription] Description (optional) of the filter bar to be used for logging messages
25
24
  * @returns {sap.fe.test.api.FilterBarActions} The new instance
@@ -38,7 +37,6 @@ sap.ui.define(
38
37
 
39
38
  /**
40
39
  * Changes the value of the defined filter field.
41
- *
42
40
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier for the filter field
43
41
  * @param {string} [vValue] The new target value
44
42
  * @param {boolean} [bClearFirst] Set to <code>true</code> to clear previously set filters, otherwise all previously set values will be kept
@@ -67,7 +65,6 @@ sap.ui.define(
67
65
 
68
66
  /**
69
67
  * Opens the value help of the given field.
70
- *
71
68
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the filter field
72
69
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
73
70
  * @public
@@ -90,7 +87,6 @@ sap.ui.define(
90
87
 
91
88
  /**
92
89
  * Changes the search field.
93
- *
94
90
  * @param {string} [sSearchText] The new search text
95
91
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
96
92
  * @public
@@ -113,7 +109,6 @@ sap.ui.define(
113
109
 
114
110
  /**
115
111
  * Resets the search field.
116
- *
117
112
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
118
113
  * @public
119
114
  */
@@ -129,7 +124,6 @@ sap.ui.define(
129
124
 
130
125
  /**
131
126
  * Changes the editing status filter field.
132
- *
133
127
  * @param {sap.fe.test.api.EditState} sEditState Value of an edit state
134
128
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
135
129
  * @public
@@ -152,7 +146,6 @@ sap.ui.define(
152
146
 
153
147
  /**
154
148
  * Executes the search with the current filters.
155
- *
156
149
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
157
150
  * @public
158
151
  */
@@ -168,7 +161,6 @@ sap.ui.define(
168
161
 
169
162
  /**
170
163
  * Adds a field as a filter field.
171
- *
172
164
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the field
173
165
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
174
166
  * @public
@@ -184,7 +176,6 @@ sap.ui.define(
184
176
 
185
177
  /**
186
178
  * Removes a field as a filter field.
187
- *
188
179
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the field
189
180
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
190
181
  * @public
@@ -200,7 +191,6 @@ sap.ui.define(
200
191
 
201
192
  /**
202
193
  * Executes a keyboard shortcut.
203
- *
204
194
  * @param {string} sShortcut Pattern for the shortcut
205
195
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} [vFieldIdentifier] The identifier of the field
206
196
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
@@ -227,7 +217,6 @@ sap.ui.define(
227
217
 
228
218
  /**
229
219
  * Saves a variant under the given name, or overwrites the current variant.
230
- *
231
220
  * @param {string} [sVariantName] The name of the new variant. If no new variant name is defined, the current variant will be overwritten.
232
221
  * @param {string} [bSetAsDefault] Saves the new variant with option "Set as Default".
233
222
  * @param {string} [bApplyAutomatically] Saves the new variant with option "Apply Automatically".
@@ -264,7 +253,6 @@ sap.ui.define(
264
253
 
265
254
  /**
266
255
  * Selects the chosen variant.
267
- *
268
256
  * @param {string} sVariantName The name of the variant to be selected
269
257
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
270
258
  * @public
@@ -17,7 +17,6 @@ sap.ui.define(
17
17
 
18
18
  /**
19
19
  * Constructs a new FilterBarAssertions instance.
20
- *
21
20
  * @param {sap.fe.test.builder.FilterBarBuilder} oFilterBarBuilder The {@link sap.fe.test.builder.FilterBarBuilder} instance used to interact with the UI
22
21
  * @param {string} [vFilterBarDescription] Description (optional) of the filter bar to be used for logging messages
23
22
  * @returns {sap.fe.test.api.FilterBarAssertions} The new instance
@@ -36,7 +35,6 @@ sap.ui.define(
36
35
 
37
36
  /**
38
37
  * Checks the filter bar.
39
- *
40
38
  * @param {object} [mFilterBarState] Defines the expected state of the filter bar
41
39
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
42
40
  * @public
@@ -57,7 +55,6 @@ sap.ui.define(
57
55
  /**
58
56
  * Checks a filter field.
59
57
  * If <code>vConditionValues</code> is <code>undefined</code>, the current condition values are ignored.
60
- *
61
58
  * @param {object | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the filter field
62
59
  * @param {string|object|Array} [vConditionValues] The expected value(s) of the filter field
63
60
  * @param {string} [sOperator] The expected operator
@@ -91,7 +88,6 @@ sap.ui.define(
91
88
 
92
89
  /**
93
90
  * Checks if the focus is on the filter field.
94
- *
95
91
  * @param {string} [sFilterFieldLabel] The field label
96
92
  * @returns {object} The result of the {@link sa p.ui.test.Opa5#waitFor} function, to be used for chained statements
97
93
  * @public
@@ -109,7 +105,6 @@ sap.ui.define(
109
105
 
110
106
  /**
111
107
  * Checks if the focus is on the Go Button of the filter bar.
112
- *
113
108
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
114
109
  * @public
115
110
  */
@@ -123,7 +118,6 @@ sap.ui.define(
123
118
 
124
119
  /**
125
120
  * Checks the search field in the filter bar. If the <code>sSearchText</code> parameter is <code>undefined</code>, the search text is not validated.
126
- *
127
121
  * @param {string} [sSearchText] The expected text in the search field
128
122
  * @param {object} [mState] Defines the expected state of the search field
129
123
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
@@ -149,7 +143,6 @@ sap.ui.define(
149
143
 
150
144
  /**
151
145
  * Check the filter field for the editing status.
152
- *
153
146
  * @param {sap.fe.test.api.EditState} [sEditState] The expected edit state value
154
147
  * @param {object} [mFieldState] Defines the expected state of the filter field
155
148
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
@@ -175,7 +168,6 @@ sap.ui.define(
175
168
 
176
169
  /**
177
170
  * Checks the search button.
178
- *
179
171
  * @param {object} [mState] Defines the expected state of the Go button
180
172
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
181
173
  * @public
@@ -192,7 +184,6 @@ sap.ui.define(
192
184
 
193
185
  /**
194
186
  * Checks whether the filter adaptation dialog is open.
195
- *
196
187
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
197
188
  * @public
198
189
  */
@@ -210,7 +201,6 @@ sap.ui.define(
210
201
 
211
202
  /**
212
203
  * Checks a field in the adaptation dialog.
213
- *
214
204
  * @param {string | sap.fe.test.api.FilterFieldIdentifier} vFieldIdentifier The identifier of the filter field, or its label
215
205
  * @param {object} [mState] Defines the expected state of the filter field in the adaptation dialog
216
206
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
@@ -17,7 +17,6 @@ sap.ui.define(
17
17
 
18
18
  /**
19
19
  * Constructs a new FooterAPI instance.
20
- *
21
20
  * @param {sap.fe.test.builder.OverflowToolbarBuilder} oOverflowToolbarBuilder The {@link sap.fe.test.builder.OverflowToolbarBuilder} instance used to interact with the UI
22
21
  * @param {string} [vFooterDescription] Description (optional) of the footer bar to be used for logging messages
23
22
  * @returns {sap.fe.test.api.FooterAPI} The new instance
@@ -9,7 +9,6 @@ sap.ui.define(["./FooterAPI", "sap/fe/test/Utils", "sap/ui/test/OpaBuilder"], fu
9
9
 
10
10
  /**
11
11
  * Constructs a new FooterActionsBase instance.
12
- *
13
12
  * @param {sap.fe.test.builder.OverflowToolbarBuilder} oOverflowToolbarBuilder The {@link sap.fe.test.builder.OverflowToolbarBuilder} instance used to interact with the UI
14
13
  * @param {string} [vFooterDescription] Description (optional) of the footer bar to be used for logging messages
15
14
  * @returns {sap.fe.test.api.FooterActionsBase} The new instance
@@ -27,7 +26,6 @@ sap.ui.define(["./FooterAPI", "sap/fe/test/Utils", "sap/ui/test/OpaBuilder"], fu
27
26
 
28
27
  /**
29
28
  * Executes a footer action.
30
- *
31
29
  * @param {string | sap.fe.test.api.ActionIdentifier} [vActionIdentifier] The identifier of the action or its label
32
30
  * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
33
31
  * @public