@sap/open.fe 1.94.0

package/packages/sap.fe.test/test/sap/fe/test/designtime/apiref/api.json

@@ -0,0 +1 @@
+{"$schema-ref":"http://schemas.sap.com/sapui5/designtime/api.json/1.0","version":"1.94.0","library":"sap.fe.test","symbols":[{"kind":"namespace","name":"sap.fe.test","basename":"test","resource":"sap/fe/test/library.js","module":"sap/fe/test/library","export":"","static":true,"visibility":"public","description":"<p><p>Test library for SAP Fiori elements</p></p>","displayName":"sap.fe.test","nodes":[{"name":"sap.fe.test.BaseActions","description":"<p>All common actions (<code>When</code>) for all Opa tests are defined here.</p>","href":"api/sap.fe.test.BaseActions"},{"name":"sap.fe.test.BaseArrangements","description":"<p>All common arrangements (<code>Given</code>) for all Opa tests are defined here.</p>","href":"api/sap.fe.test.BaseArrangements"},{"name":"sap.fe.test.BaseAssertions","description":"<p>All common assertions (<code>Then</code>) for all Opa tests are defined here.</p>","href":"api/sap.fe.test.BaseAssertions"},{"name":"sap.fe.test.JourneyRunner","description":"<p>A JourneyRunner for executing integration tests with given settings.</p>","href":"api/sap.fe.test.JourneyRunner"},{"name":"sap.fe.test.ListReport","description":"<p>Provides a test page definition for a list report page with the corresponding parameters.\n</p>","href":"api/sap.fe.test.ListReport"},{"name":"sap.fe.test.ObjectPage","description":"<p>Provides a test page definition for an object page with the corresponding parameters.\n</p>","href":"api/sap.fe.test.ObjectPage"},{"name":"sap.fe.test.Shell","description":"<p>Provides a test page definition for the shell.\n</p>","href":"api/sap.fe.test.Shell"},{"name":"sap.fe.test.TemplatePage","description":"<p>Provides a test page definition for a template page with the corresponding parameters.</p>","href":"api/sap.fe.test.TemplatePage"},{"name":"sap.fe.test.api","description":"","href":"api/sap.fe.test.api"}],"title":"namespace sap.fe.test","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.ActionDialogFieldIdentifier","basename":"ActionDialogFieldIdentifier","resource":"sap/fe/test/api/BaseAPI.js","module":"sap/fe/test/api/BaseAPI","static":true,"visibility":"public","description":"<p><p>An action parameter dialog field identifier</p></p>","properties":[{"name":"property","optional":false,"visibility":"public","description":"<p>The name of the field</p>","types":[{"value":"string"}]}],"displayName":"sap.fe.test.api.ActionDialogFieldIdentifier","title":"typedef sap.fe.test.api.ActionDialogFieldIdentifier","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.ActionIdentifier","basename":"ActionIdentifier","resource":"sap/fe/test/api/BaseAPI.js","module":"sap/fe/test/api/BaseAPI","static":true,"visibility":"public","description":"<p><p>An action identifier</p></p>","properties":[{"name":"service","optional":false,"visibility":"public","description":"<p>The name of the service</p>","types":[{"value":"string"}]},{"name":"action","optional":false,"visibility":"public","description":"<p>The name of the action</p>","types":[{"value":"string"}]},{"name":"unbound","optional":true,"visibility":"public","description":"<p>Defines whether the action is a bound action (default: false)</p>","types":[{"value":"boolean"}]}],"displayName":"sap.fe.test.api.ActionIdentifier","title":"typedef sap.fe.test.api.ActionIdentifier","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.ColumnIdentifier","basename":"ColumnIdentifier","resource":"sap/fe/test/api/TableAPI.js","module":"sap/fe/test/api/TableAPI","static":true,"visibility":"public","description":"<p><p>A column identifier</p></p>","properties":[{"name":"name","optional":false,"visibility":"public","description":"<p>The technical name of the column</p>","types":[{"value":"string"}]}],"displayName":"sap.fe.test.api.ColumnIdentifier","title":"typedef sap.fe.test.api.ColumnIdentifier","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogActions","basename":"DialogActions","resource":"sap/fe/test/api/DialogActions.js","module":"sap/fe/test/api/DialogActions","export":"","static":true,"visibility":"public","methods":[{"name":"iCancel","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Cancels the dialog by clicking the corresponding button (for example, 'Cancel').</p>","href":"api/sap.fe.test.api.DialogActions#methods/iCancel","code":"<pre class=\"prettyprint\">iCancel() : object</pre>"},{"name":"iChangeActionParameterDialogField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"sap.fe.test.api.ActionDialogFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionDialogFieldIdentifier"}],"defaultValue":""},{"name":"vValue","optional":true,"description":"<p>The new target value.</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"bClearFirst","optional":true,"description":"<p>Set to <code>true</code> to clear previously set filters, otherwise all previously set values will be kept</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Changes the content of a field in an action parameter dialog.</p>","href":"api/sap.fe.test.api.DialogActions#methods/iChangeActionParameterDialogField","code":"<pre class=\"prettyprint\">iChangeActionParameterDialogField(vFieldIdentifier, vValue?, bClearFirst?) : object</pre>"},{"name":"iClose","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Closes the dialog by pressing the 'Escape' key.</p>","href":"api/sap.fe.test.api.DialogActions#methods/iClose","code":"<pre class=\"prettyprint\">iClose() : object</pre>"},{"name":"iConfirm","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Confirms the dialog by clicking the corresponding button (for example, 'OK').</p>","href":"api/sap.fe.test.api.DialogActions#methods/iConfirm","code":"<pre class=\"prettyprint\">iConfirm() : object</pre>"}],"displayName":"sap.fe.test.api.DialogActions","title":"class sap.fe.test.api.DialogActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogAssertions","basename":"DialogAssertions","resource":"sap/fe/test/api/DialogAssertions.js","module":"sap/fe/test/api/DialogAssertions","export":"","static":true,"visibility":"public","methods":[{"name":"iCheckActionParameterDialogField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"sap.fe.test.api.ActionDialogFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionDialogFieldIdentifier"}],"defaultValue":""},{"name":"vValue","optional":true,"description":"<p>Expected value(s) of the field. if passed as an object, the following pattern will be considered: <code><pre>\n{\n    value: <string>, \t\t// optional\n}\n</pre></code></p>","types":[{"value":"string"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"object"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the content and state of a field in an action parameter dialog.</p>","href":"api/sap.fe.test.api.DialogAssertions#methods/iCheckActionParameterDialogField","code":"<pre class=\"prettyprint\">iCheckActionParameterDialogField(vFieldIdentifier, vValue?, mState?) : object</pre>"},{"name":"iCheckCancel","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mButtonState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the cancellation button of the dialog.</p>","href":"api/sap.fe.test.api.DialogAssertions#methods/iCheckCancel","code":"<pre class=\"prettyprint\">iCheckCancel(mButtonState?) : object</pre>"},{"name":"iCheckConfirm","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mButtonState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the confirmation button of the dialog.</p>","href":"api/sap.fe.test.api.DialogAssertions#methods/iCheckConfirm","code":"<pre class=\"prettyprint\">iCheckConfirm(mButtonState?) : object</pre>"},{"name":"iCheckState","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mDialogState","optional":true,"description":"<p>Defines the expected state of the dialog</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the dialog.</p>","href":"api/sap.fe.test.api.DialogAssertions#methods/iCheckState","code":"<pre class=\"prettyprint\">iCheckState(mDialogState?) : object</pre>"}],"displayName":"sap.fe.test.api.DialogAssertions","title":"class sap.fe.test.api.DialogAssertions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogCreateActions","basename":"DialogCreateActions","resource":"sap/fe/test/api/DialogCreateActions.js","module":"sap/fe/test/api/DialogCreateActions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.DialogActions","methods":[{"name":"iExecuteCreate","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Create</code> action on the create dialog.</p>","href":"api/sap.fe.test.api.DialogCreateActions#methods/iExecuteCreate","code":"<pre class=\"prettyprint\">iExecuteCreate() : object</pre>"}],"displayName":"sap.fe.test.api.DialogCreateActions","title":"class sap.fe.test.api.DialogCreateActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogCreateAssertions","basename":"DialogCreateAssertions","resource":"sap/fe/test/api/DialogCreateAssertions.js","module":"sap/fe/test/api/DialogCreateAssertions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.DialogAssertions","methods":[{"name":"iCheckCreate","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Create</code> action on the dialog.</p>","href":"api/sap.fe.test.api.DialogCreateAssertions#methods/iCheckCreate","code":"<pre class=\"prettyprint\">iCheckCreate(mState?) : object</pre>"}],"displayName":"sap.fe.test.api.DialogCreateAssertions","title":"class sap.fe.test.api.DialogCreateAssertions","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.DialogIdentifier","basename":"DialogIdentifier","resource":"sap/fe/test/api/BaseAPI.js","module":"sap/fe/test/api/BaseAPI","static":true,"visibility":"public","description":"<p><p>A dialog identifier</p></p>","properties":[{"name":"type","optional":false,"visibility":"public","description":"<p>The type of the dialog</p>","types":[{"value":"sap.fe.test.api.DialogType","linkEnabled":true,"href":"api/sap.fe.test.api.DialogType"}]}],"displayName":"sap.fe.test.api.DialogIdentifier","title":"typedef sap.fe.test.api.DialogIdentifier","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogMessageActions","basename":"DialogMessageActions","resource":"sap/fe/test/api/DialogMessageActions.js","module":"sap/fe/test/api/DialogMessageActions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.DialogActions","methods":[{"name":"iExecuteBack","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Back</code> action on the message dialog.</p>","href":"api/sap.fe.test.api.DialogMessageActions#methods/iExecuteBack","code":"<pre class=\"prettyprint\">iExecuteBack() : object</pre>"},{"name":"iExecuteRefresh","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Refresh</code> action on the message dialog.</p>","href":"api/sap.fe.test.api.DialogMessageActions#methods/iExecuteRefresh","code":"<pre class=\"prettyprint\">iExecuteRefresh() : object</pre>"}],"displayName":"sap.fe.test.api.DialogMessageActions","title":"class sap.fe.test.api.DialogMessageActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogMessageAssertions","basename":"DialogMessageAssertions","resource":"sap/fe/test/api/DialogMessageAssertions.js","module":"sap/fe/test/api/DialogMessageAssertions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.DialogAssertions","methods":[{"name":"iCheckBack","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Back</code> action on the message dialog.</p>","href":"api/sap.fe.test.api.DialogMessageAssertions#methods/iCheckBack","code":"<pre class=\"prettyprint\">iCheckBack(mState?) : object</pre>"},{"name":"iCheckMessage","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"oMessage","optional":true,"description":"<p>Defines the expected state of the message, e.g. <code>{ title: \"My message\" }</code></p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks whether a certain message is shown in the dialog.</p>","href":"api/sap.fe.test.api.DialogMessageAssertions#methods/iCheckMessage","code":"<pre class=\"prettyprint\">iCheckMessage(oMessage?) : object</pre>"},{"name":"iCheckRefresh","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Refresh</code> action on the dialog.</p>","href":"api/sap.fe.test.api.DialogMessageAssertions#methods/iCheckRefresh","code":"<pre class=\"prettyprint\">iCheckRefresh(mState?) : object</pre>"}],"displayName":"sap.fe.test.api.DialogMessageAssertions","title":"class sap.fe.test.api.DialogMessageAssertions","subTitle":""},{"kind":"enum","name":"sap.fe.test.api.DialogType","basename":"DialogType","resource":"sap/fe/test/api/DialogType.js","module":"sap/fe/test/api/DialogType","export":"","static":true,"visibility":"public","description":"<p><p>Enum for supported dialog types.</p></p>","properties":[{"name":"sap.fe.test.api.DialogType.Action","visibility":"public","description":"<p>A default dialog for action parameters</p>"},{"name":"sap.fe.test.api.DialogType.Confirmation","visibility":"public","description":"<p>A simple dialog supporting base checks and actions such as 'Confirm' and 'Cancel'</p>"},{"name":"sap.fe.test.api.DialogType.Create","visibility":"public","description":"<p>A dialog used for creating a new object</p>"},{"name":"sap.fe.test.api.DialogType.Error","visibility":"public","description":"<p>A dialog used for showing an error message</p>"},{"name":"sap.fe.test.api.DialogType.Message","visibility":"public","description":"<p>A message dialog for showing back-end messages</p>"},{"name":"sap.fe.test.api.DialogType.ValueHelp","visibility":"public","description":"<p>A ValueHelp dialog that has a condition definition panel or a filterable selection table</p>"}],"displayName":"sap.fe.test.api.DialogType","title":"enum sap.fe.test.api.DialogType","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogValueHelpActions","basename":"DialogValueHelpActions","resource":"sap/fe/test/api/DialogValueHelpActions.js","module":"sap/fe/test/api/DialogValueHelpActions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.DialogActions","methods":[{"name":"iAddCondition","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sOperator","optional":false,"description":"<p>The condition operator, like EQ, BT, LT, GT (see also <a target=\"_self\" href=\"api/sap.ui.model.filter.FilterOperator\">sap.ui.model.filter.FilterOperator</a>)</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"vValues","optional":false,"description":"<p>The values to be set. If the operator requires more than one value, like BT (between), an array with the two entries is expected</p>","types":[{"value":"string"},{"value":"string[]"}],"defaultValue":""}],"description":"<p>Adds a new condition.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iAddCondition","code":"<pre class=\"prettyprint\">iAddCondition(sOperator, vValues) : object</pre>"},{"name":"iChangeCondition","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sOperator","optional":false,"description":"<p>The condition operator, like EQ, BT, LT, GT (see also <a target=\"_self\" href=\"api/sap.ui.model.filter.FilterOperator\">sap.ui.model.filter.FilterOperator</a>)</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"vValues","optional":false,"description":"<p>The values to be set. If the operator requires more than one value like BT (between) an array with the two entries is expected</p>","types":[{"value":"string"},{"value":"string[]"}],"defaultValue":""},{"name":"iConditionIndex","optional":true,"description":"<p>The index of the condition to be altered. If not set, the index 0 is used</p>","types":[{"value":"number"}],"defaultValue":""}],"description":"<p>Changes an existing condition.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iChangeCondition","code":"<pre class=\"prettyprint\">iChangeCondition(sOperator, vValues, iConditionIndex?) : object</pre>"},{"name":"iChangeFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the filter field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""},{"name":"vValue","optional":true,"description":"<p>The new target value.</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"bClearFirst","optional":true,"description":"<p>Set to <code>true</code> to clear previously set filters, otherwise all previously set values will be kept</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Changes the value of a filter field.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iChangeFilterField","code":"<pre class=\"prettyprint\">iChangeFilterField(vFieldIdentifier, vValue?, bClearFirst?) : object</pre>"},{"name":"iChangeSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sSearchText","optional":true,"description":"<p>The new search value.</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Changes the value of the search field.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iChangeSearchField","code":"<pre class=\"prettyprint\">iChangeSearchField(sSearchText?) : object</pre>"},{"name":"iExecuteSearch","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"description":"<p>Starts the search.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iExecuteSearch","code":"<pre class=\"prettyprint\">iExecuteSearch() : object</pre>"},{"name":"iExecuteShowHideFilters","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"description":"<p>Clicks the <code>Hide/Show Filters</code> button.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iExecuteShowHideFilters","code":"<pre class=\"prettyprint\">iExecuteShowHideFilters() : object</pre>"},{"name":"iGoToDefineConditions","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"description":"<p>Navigates to the <code>Define Conditions</code> tab.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iGoToDefineConditions","code":"<pre class=\"prettyprint\">iGoToDefineConditions() : object</pre>"},{"name":"iGoToSearchAndSelect","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"description":"<p>Navigates to the <code>Search and Select</code> tab.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iGoToSearchAndSelect","code":"<pre class=\"prettyprint\">iGoToSearchAndSelect() : object</pre>"},{"name":"iRemoveCondition","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"iConditionIndex","optional":true,"description":"<p>The index of the condition to be removed. If not set, the index 0 is used</p>","types":[{"value":"number"}],"defaultValue":""}],"description":"<p>Removes an existing condition.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iRemoveCondition","code":"<pre class=\"prettyprint\">iRemoveCondition(iConditionIndex?) : object</pre>"},{"name":"iResetSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"description":"<p>Resets the search field value.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iResetSearchField","code":"<pre class=\"prettyprint\">iResetSearchField() : object</pre>"},{"name":"iSelectRows","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code> Alternatively, the 0-based row index can be used.</p>","types":[{"value":"object"},{"value":"number"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the row</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Selects the specified rows.</p>","href":"api/sap.fe.test.api.DialogValueHelpActions#methods/iSelectRows","code":"<pre class=\"prettyprint\">iSelectRows(vRowValues?, mState?) : object</pre>"}],"displayName":"sap.fe.test.api.DialogValueHelpActions","title":"class sap.fe.test.api.DialogValueHelpActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.DialogValueHelpAssertions","basename":"DialogValueHelpAssertions","resource":"sap/fe/test/api/DialogValueHelpAssertions.js","module":"sap/fe/test/api/DialogValueHelpAssertions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.DialogAssertions","methods":[{"name":"iCheckDefineConditions","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the filter bar</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Define conditions</code> tab.</p>","href":"api/sap.fe.test.api.DialogValueHelpAssertions#methods/iCheckDefineConditions","code":"<pre class=\"prettyprint\">iCheckDefineConditions(mState?) : object</pre>"},{"name":"iCheckFilterBar","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the filter bar</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the filter bar.</p>","href":"api/sap.fe.test.api.DialogValueHelpAssertions#methods/iCheckFilterBar","code":"<pre class=\"prettyprint\">iCheckFilterBar(mState?) : object</pre>"},{"name":"iCheckFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the filter field</p>","types":[{"value":"object"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""},{"name":"vConditionValues","optional":true,"description":"<p>The expected value(s) of the filter field</p>","types":[{"value":"string"},{"value":"object"},{"value":"Array","linkEnabled":true,"href":"api/Array"}],"defaultValue":""},{"name":"sOperator","optional":true,"description":"<p>The expected operator</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the filter field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks a filter field. If <code>vConditionValues</code> is <code>undefined</code>, the current condition values are ignored.</p>","href":"api/sap.fe.test.api.DialogValueHelpAssertions#methods/iCheckFilterField","code":"<pre class=\"prettyprint\">iCheckFilterField(vFieldIdentifier, vConditionValues?, sOperator?, mState?) : object</pre>"},{"name":"iCheckRows","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""},{"name":"iExpectedNumberOfRows","optional":true,"description":"<p>The expected number of rows considering <code>mRowValues</code> and <code>mRowState</code></p>","types":[{"value":"number"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the target row</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the rows of a table. If <code>mRowValues</code> is provided, only rows with the corresponding values are considered. 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. If <code>iNumberOfRows</code> is omitted, it checks for at least one matching row. If <code>mState</code> is provided, the row must be in the given state.</p>","href":"api/sap.fe.test.api.DialogValueHelpAssertions#methods/iCheckRows","code":"<pre class=\"prettyprint\">iCheckRows(mRowValues?, iExpectedNumberOfRows?, mState?) : object</pre>"},{"name":"iCheckSearchAndSelect","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the filter bar</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Search and Select</code> tab.</p>","href":"api/sap.fe.test.api.DialogValueHelpAssertions#methods/iCheckSearchAndSelect","code":"<pre class=\"prettyprint\">iCheckSearchAndSelect(mState?) : object</pre>"},{"name":"iCheckSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sSearchText","optional":true,"description":"<p>The expected text in the search field</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the search field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the search field in the filter bar. If the <code>sSearchText</code> parameter is <code>undefined</code>, the search text is not validated.</p>","href":"api/sap.fe.test.api.DialogValueHelpAssertions#methods/iCheckSearchField","code":"<pre class=\"prettyprint\">iCheckSearchField(sSearchText?, mState?) : object</pre>"},{"name":"iCheckTable","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the search field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the table.</p>","href":"api/sap.fe.test.api.DialogValueHelpAssertions#methods/iCheckTable","code":"<pre class=\"prettyprint\">iCheckTable(mState?) : object</pre>"}],"displayName":"sap.fe.test.api.DialogValueHelpAssertions","title":"class sap.fe.test.api.DialogValueHelpAssertions","subTitle":""},{"kind":"enum","name":"sap.fe.test.api.EditState","basename":"EditState","resource":"sap/fe/test/api/EditState.js","module":"sap/fe/test/api/EditState","export":"","static":true,"visibility":"public","description":"<p><p>Enum for supported editing states.</p></p>","properties":[{"name":"sap.fe.test.api.EditState.All","visibility":"public","description":"<p>All</p>"},{"name":"sap.fe.test.api.EditState.Locked","visibility":"public","description":"<p>Locked by Another User</p>"},{"name":"sap.fe.test.api.EditState.OwnDraft","visibility":"public","description":"<p>Own Draft</p>"},{"name":"sap.fe.test.api.EditState.Unchanged","visibility":"public","description":"<p>Unchanged</p>"},{"name":"sap.fe.test.api.EditState.UnsavedChanges","visibility":"public","description":"<p>Unsaved Changes by Another User</p>"}],"displayName":"sap.fe.test.api.EditState","title":"enum sap.fe.test.api.EditState","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.FieldIdentifier","basename":"FieldIdentifier","resource":"sap/fe/test/api/BaseAPI.js","module":"sap/fe/test/api/BaseAPI","static":true,"visibility":"public","description":"<p><p>A field identifier</p></p>","properties":[{"name":"fieldGroup","optional":true,"visibility":"public","description":"<p>The name of the field group containing the field</p>","types":[{"value":"string"}]},{"name":"property","optional":false,"visibility":"public","description":"<p>The name of the field</p>","types":[{"value":"string"}]},{"name":"connectedFields","optional":true,"visibility":"public","description":"<p>The name of the connected field containing the field</p>","types":[{"value":"string"}]}],"displayName":"sap.fe.test.api.FieldIdentifier","title":"typedef sap.fe.test.api.FieldIdentifier","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FilterBarActions","basename":"FilterBarActions","resource":"sap/fe/test/api/FilterBarActions.js","module":"sap/fe/test/api/FilterBarActions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.FilterBarAPI","methods":[{"name":"iAddAdaptationFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""}],"description":"<p>Adds a field as a filter field.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iAddAdaptationFilterField","code":"<pre class=\"prettyprint\">iAddAdaptationFilterField(vFieldIdentifier) : object</pre>"},{"name":"iChangeEditingStatus","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sEditState","optional":false,"description":"<p>Value of an edit state</p>","types":[{"value":"sap.fe.test.api.EditState","linkEnabled":true,"href":"api/sap.fe.test.api.EditState"}],"defaultValue":""}],"description":"<p>Changes the editing status filter field.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iChangeEditingStatus","code":"<pre class=\"prettyprint\">iChangeEditingStatus(sEditState) : object</pre>"},{"name":"iChangeFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier for the filter field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""},{"name":"vValue","optional":true,"description":"<p>The new target value</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"bClearFirst","optional":true,"description":"<p>Set to <code>true</code> to clear previously set filters, otherwise all previously set values will be kept</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Changes the value of the defined filter field.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iChangeFilterField","code":"<pre class=\"prettyprint\">iChangeFilterField(vFieldIdentifier, vValue?, bClearFirst?) : object</pre>"},{"name":"iChangeSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sSearchText","optional":true,"description":"<p>The new search text</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Changes the search field.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iChangeSearchField","code":"<pre class=\"prettyprint\">iChangeSearchField(sSearchText?) : object</pre>"},{"name":"iExecuteKeyboardShortcut","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sShortcut","optional":false,"description":"<p>Pattern for the shortcut</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"vFieldIdentifier","optional":true,"description":"<p>The identifier of the field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""}],"description":"<p>Executes a keyboard shortcut.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iExecuteKeyboardShortcut","code":"<pre class=\"prettyprint\">iExecuteKeyboardShortcut(sShortcut, vFieldIdentifier?) : object</pre>"},{"name":"iExecuteSearch","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the search with the current filters.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iExecuteSearch","code":"<pre class=\"prettyprint\">iExecuteSearch() : object</pre>"},{"name":"iOpenValueHelp","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the filter field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""}],"description":"<p>Opens the value help of the given field.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iOpenValueHelp","code":"<pre class=\"prettyprint\">iOpenValueHelp(vFieldIdentifier) : object</pre>"},{"name":"iRemoveAdaptationFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""}],"description":"<p>Removes a field as a filter field.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iRemoveAdaptationFilterField","code":"<pre class=\"prettyprint\">iRemoveAdaptationFilterField(vFieldIdentifier) : object</pre>"},{"name":"iResetSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Resets the search field.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iResetSearchField","code":"<pre class=\"prettyprint\">iResetSearchField() : object</pre>"},{"name":"iSaveVariant","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sVariantName","optional":true,"description":"<p>The name of the new variant. If omitted, the current variant will be overwritten.</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Saves a variant under the given name, or overwrites the current variant.</p>","href":"api/sap.fe.test.api.FilterBarActions#methods/iSaveVariant","code":"<pre class=\"prettyprint\">iSaveVariant(sVariantName?) : object</pre>"}],"displayName":"sap.fe.test.api.FilterBarActions","title":"class sap.fe.test.api.FilterBarActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FilterBarAPI","basename":"FilterBarAPI","resource":"sap/fe/test/api/FilterBarAPI.js","module":"sap/fe/test/api/FilterBarAPI","export":"","static":true,"visibility":"public","methods":[{"name":"sap.fe.test.api.FilterBarAPI.createFilterFieldBuilder","visibility":"restricted","static":true,"returnValue":{"type":"sap.fe.test.builder.FilterFieldBuilder","description":"<p>The FieldBuilder instance</p>","types":[{"value":"sap.fe.test.builder.FilterFieldBuilder","href":"api/sap.fe.test.builder.FilterFieldBuilder","linkEnabled":true}]},"parameters":[{"name":"oFilterBarBuilder","optional":false,"description":"<p>The builder of the filter bar to which the field belongs</p>","types":[{"value":"sap.fe.test.builder.FilterBarBuilder","linkEnabled":true,"href":"api/sap.fe.test.builder.FilterBarBuilder"}],"defaultValue":""},{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field in the filter bar</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""},{"name":"mState","optional":false,"types":[{"value":"undefined"}],"defaultValue":"","description":""}],"description":"<p>Retrieve a filter field by its identifier.</p>","href":"api/sap.fe.test.api.FilterBarAPI#methods/sap.fe.test.api.FilterBarAPI.createFilterFieldBuilder","code":"<pre class=\"prettyprint\">sap.fe.test.api.FilterBarAPI.createFilterFieldBuilder(oFilterBarBuilder, vFieldIdentifier, mState) : sap.fe.test.builder.FilterFieldBuilder</pre>"},{"name":"filterFieldAdaptation","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the adaptation filter field</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"vActions","optional":true,"description":"<p>The actions to be executed on found adaptation field</p>","types":[{"value":"function"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"sap.ui.test.actions.Action","linkEnabled":true,"href":"api/sap.ui.test.actions.Action"}],"defaultValue":""},{"name":"sDescription","optional":false,"description":"<p>The description of the check or adaptation</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Helper method to adapt filter fields. If no actions are given, this function can be used for checking only. During execution it checks for an already open adaptation popover. If it does not exist, it is opened before the check/interaction of the filter fields, and closed directly afterwards.</p>","href":"api/sap.fe.test.api.FilterBarAPI#methods/filterFieldAdaptation","code":"<pre class=\"prettyprint\">filterFieldAdaptation(vFieldIdentifier, mState?, vActions?, sDescription) : object</pre>"},{"name":"iConfirmFilterAdaptation","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Confirms the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.</p>","href":"api/sap.fe.test.api.FilterBarAPI#methods/iConfirmFilterAdaptation","code":"<pre class=\"prettyprint\">iConfirmFilterAdaptation() : object</pre>"},{"name":"iOpenFilterAdaptation","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Opens the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.</p>","href":"api/sap.fe.test.api.FilterBarAPI#methods/iOpenFilterAdaptation","code":"<pre class=\"prettyprint\">iOpenFilterAdaptation() : object</pre>"}],"displayName":"sap.fe.test.api.FilterBarAPI","title":"class sap.fe.test.api.FilterBarAPI","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FilterBarAssertions","basename":"FilterBarAssertions","resource":"sap/fe/test/api/FilterBarAssertions.js","module":"sap/fe/test/api/FilterBarAssertions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.FilterBarAPI","methods":[{"name":"iCheckAdaptationFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the filter field, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the filter field in the adaptation dialog</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks a field in the adaptation dialog.</p>","href":"api/sap.fe.test.api.FilterBarAssertions#methods/iCheckAdaptationFilterField","code":"<pre class=\"prettyprint\">iCheckAdaptationFilterField(vFieldIdentifier, mState?) : object</pre>"},{"name":"iCheckEditingStatus","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sEditState","optional":true,"description":"<p>The expected edit state value</p>","types":[{"value":"sap.fe.test.api.EditState","linkEnabled":true,"href":"api/sap.fe.test.api.EditState"}],"defaultValue":""},{"name":"mFieldState","optional":true,"description":"<p>Defines the expected state of the filter field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Check the filter field for the editing status.</p>","href":"api/sap.fe.test.api.FilterBarAssertions#methods/iCheckEditingStatus","code":"<pre class=\"prettyprint\">iCheckEditingStatus(sEditState?, mFieldState?) : object</pre>"},{"name":"iCheckFilterAdaptation","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks whether the filter adaptation dialog is open.</p>","href":"api/sap.fe.test.api.FilterBarAssertions#methods/iCheckFilterAdaptation","code":"<pre class=\"prettyprint\">iCheckFilterAdaptation() : object</pre>"},{"name":"iCheckFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the filter field</p>","types":[{"value":"object"},{"value":"sap.fe.test.api.FilterFieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FilterFieldIdentifier"}],"defaultValue":""},{"name":"vConditionValues","optional":true,"description":"<p>The expected value(s) of the filter field</p>","types":[{"value":"string"},{"value":"object"},{"value":"Array","linkEnabled":true,"href":"api/Array"}],"defaultValue":""},{"name":"sOperator","optional":true,"description":"<p>The expected operator</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the filter field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks a filter field. If <code>vConditionValues</code> is <code>undefined</code>, the current condition values are ignored.</p>","href":"api/sap.fe.test.api.FilterBarAssertions#methods/iCheckFilterField","code":"<pre class=\"prettyprint\">iCheckFilterField(vFieldIdentifier, vConditionValues?, sOperator?, mState?) : object</pre>"},{"name":"iCheckSearch","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the Go button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the search button.</p>","href":"api/sap.fe.test.api.FilterBarAssertions#methods/iCheckSearch","code":"<pre class=\"prettyprint\">iCheckSearch(mState?) : object</pre>"},{"name":"iCheckSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sSearchText","optional":true,"description":"<p>The expected text in the search field</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the search field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the search field in the filter bar. If the <code>sSearchText</code> parameter is <code>undefined</code>, the search text is not validated.</p>","href":"api/sap.fe.test.api.FilterBarAssertions#methods/iCheckSearchField","code":"<pre class=\"prettyprint\">iCheckSearchField(sSearchText?, mState?) : object</pre>"},{"name":"iCheckState","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mFilterBarState","optional":true,"description":"<p>Defines the expected state of the filter bar</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the filter bar.</p>","href":"api/sap.fe.test.api.FilterBarAssertions#methods/iCheckState","code":"<pre class=\"prettyprint\">iCheckState(mFilterBarState?) : object</pre>"}],"displayName":"sap.fe.test.api.FilterBarAssertions","title":"class sap.fe.test.api.FilterBarAssertions","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.FilterFieldIdentifier","basename":"FilterFieldIdentifier","resource":"sap/fe/test/api/FilterBarAPI.js","module":"sap/fe/test/api/FilterBarAPI","static":true,"visibility":"public","description":"<p><p>A filter field identifier</p></p>","properties":[{"name":"property","optional":false,"visibility":"public","description":"<p>The name of the property</p>","types":[{"value":"string"}]}],"displayName":"sap.fe.test.api.FilterFieldIdentifier","title":"typedef sap.fe.test.api.FilterFieldIdentifier","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FooterActionsBase","basename":"FooterActionsBase","resource":"sap/fe/test/api/FooterActionsBase.js","module":"sap/fe/test/api/FooterActionsBase","export":"","static":true,"visibility":"public","methods":[{"name":"iExecuteAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":true,"description":"<p>The identifier of the action or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""}],"description":"<p>Executes a footer action.</p>","href":"api/sap.fe.test.api.FooterActionsBase#methods/iExecuteAction","code":"<pre class=\"prettyprint\">iExecuteAction(vActionIdentifier?) : object</pre>"}],"displayName":"sap.fe.test.api.FooterActionsBase","title":"class sap.fe.test.api.FooterActionsBase","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FooterActionsOP","basename":"FooterActionsOP","resource":"sap/fe/test/api/FooterActionsOP.js","module":"sap/fe/test/api/FooterActionsOP","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.FooterActionsBase","methods":[{"name":"iConfirmCancel","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Confirms the Cancel action when user clicks <code>Cancel</code> in draft mode.</p>","href":"api/sap.fe.test.api.FooterActionsOP#methods/iConfirmCancel","code":"<pre class=\"prettyprint\">iConfirmCancel() : object</pre>"},{"name":"iExecuteApply","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Apply action in the footer bar of a sub-object page.</p>","href":"api/sap.fe.test.api.FooterActionsOP#methods/iExecuteApply","code":"<pre class=\"prettyprint\">iExecuteApply() : object</pre>"},{"name":"iExecuteCancel","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Cancel action in the footer bar of the object page.</p>","href":"api/sap.fe.test.api.FooterActionsOP#methods/iExecuteCancel","code":"<pre class=\"prettyprint\">iExecuteCancel() : object</pre>"},{"name":"iExecuteSave","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Save or Create action in the footer bar of the object page.</p>","href":"api/sap.fe.test.api.FooterActionsOP#methods/iExecuteSave","code":"<pre class=\"prettyprint\">iExecuteSave() : object</pre>"}],"displayName":"sap.fe.test.api.FooterActionsOP","title":"class sap.fe.test.api.FooterActionsOP","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FooterAssertionsBase","basename":"FooterAssertionsBase","resource":"sap/fe/test/api/FooterAssertionsBase.js","module":"sap/fe/test/api/FooterAssertionsBase","export":"","static":true,"visibility":"public","methods":[{"name":"iCheckAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":false,"description":"<p>The identifier of an action</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of an action in the footer bar.</p>","href":"api/sap.fe.test.api.FooterAssertionsBase#methods/iCheckAction","code":"<pre class=\"prettyprint\">iCheckAction(vActionIdentifier, mState?) : object</pre>"},{"name":"iCheckState","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the footer bar</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the footer bar.</p>","href":"api/sap.fe.test.api.FooterAssertionsBase#methods/iCheckState","code":"<pre class=\"prettyprint\">iCheckState(mState?) : object</pre>"}],"displayName":"sap.fe.test.api.FooterAssertionsBase","title":"class sap.fe.test.api.FooterAssertionsBase","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FooterAssertionsOP","basename":"FooterAssertionsOP","resource":"sap/fe/test/api/FooterAssertionsOP.js","module":"sap/fe/test/api/FooterAssertionsOP","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.FooterAssertionsBase","methods":[{"name":"iCheckApply","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the Apply action in the footer bar.</p>","href":"api/sap.fe.test.api.FooterAssertionsOP#methods/iCheckApply","code":"<pre class=\"prettyprint\">iCheckApply(mState?) : object</pre>"},{"name":"iCheckCancel","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the Cancel action in the footer bar.</p>","href":"api/sap.fe.test.api.FooterAssertionsOP#methods/iCheckCancel","code":"<pre class=\"prettyprint\">iCheckCancel(mState?) : object</pre>"},{"name":"iCheckDraftStateClear","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks for draft state 'Clear' in the footer bar.</p>","href":"api/sap.fe.test.api.FooterAssertionsOP#methods/iCheckDraftStateClear","code":"<pre class=\"prettyprint\">iCheckDraftStateClear() : object</pre>"},{"name":"iCheckDraftStateSaved","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks for draft state 'Saved' in the footer bar.</p>","href":"api/sap.fe.test.api.FooterAssertionsOP#methods/iCheckDraftStateSaved","code":"<pre class=\"prettyprint\">iCheckDraftStateSaved() : object</pre>"},{"name":"iCheckSave","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the Save or Create action in the footer bar.</p>","href":"api/sap.fe.test.api.FooterAssertionsOP#methods/iCheckSave","code":"<pre class=\"prettyprint\">iCheckSave(mState?) : object</pre>"}],"displayName":"sap.fe.test.api.FooterAssertionsOP","title":"class sap.fe.test.api.FooterAssertionsOP","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FormActions","basename":"FormActions","resource":"sap/fe/test/api/FormActions.js","module":"sap/fe/test/api/FormActions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.FormAPI","methods":[{"name":"iChangeField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"sap.fe.test.api.FieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FieldIdentifier"},{"value":"string"}],"defaultValue":""},{"name":"sValue","optional":true,"description":"<p>The value to be set for the field</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Changes the value of a field within a form.</p>","href":"api/sap.fe.test.api.FormActions#methods/iChangeField","code":"<pre class=\"prettyprint\">iChangeField(vFieldIdentifier, sValue?) : object</pre>"},{"name":"iClickCheckBox","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"sap.fe.test.api.FieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FieldIdentifier"}],"defaultValue":""}],"description":"<p>Toggles the value of a checkbox within a form.</p>","href":"api/sap.fe.test.api.FormActions#methods/iClickCheckBox","code":"<pre class=\"prettyprint\">iClickCheckBox(vFieldIdentifier) : object</pre>"},{"name":"iClickLink","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"sap.fe.test.api.FieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FieldIdentifier"},{"value":"string"}],"defaultValue":""}],"description":"<p>Clicks a link within a form.</p>","href":"api/sap.fe.test.api.FormActions#methods/iClickLink","code":"<pre class=\"prettyprint\">iClickLink(vFieldIdentifier) : object</pre>"},{"name":"iExecuteAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":false,"description":"<p>The identifier of the action or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""}],"description":"<p>Executes an action assigned to a form in a subsection.</p>","href":"api/sap.fe.test.api.FormActions#methods/iExecuteAction","code":"<pre class=\"prettyprint\">iExecuteAction(vActionIdentifier) : object</pre>"},{"name":"iExecuteShowLess","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Show Less action of a form in a subsection.</p>","href":"api/sap.fe.test.api.FormActions#methods/iExecuteShowLess","code":"<pre class=\"prettyprint\">iExecuteShowLess() : object</pre>"},{"name":"iExecuteShowMore","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Show More action of a form in a subsection.</p>","href":"api/sap.fe.test.api.FormActions#methods/iExecuteShowMore","code":"<pre class=\"prettyprint\">iExecuteShowMore() : object</pre>"},{"name":"iOpenValueHelp","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FieldIdentifier"}],"defaultValue":""}],"description":"<p>Opens the value help of the given field.</p>","href":"api/sap.fe.test.api.FormActions#methods/iOpenValueHelp","code":"<pre class=\"prettyprint\">iOpenValueHelp(vFieldIdentifier) : object</pre>"}],"displayName":"sap.fe.test.api.FormActions","title":"class sap.fe.test.api.FormActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FormAPI","basename":"FormAPI","resource":"sap/fe/test/api/FormAPI.js","module":"sap/fe/test/api/FormAPI","export":"","static":true,"visibility":"public","displayName":"sap.fe.test.api.FormAPI","title":"class sap.fe.test.api.FormAPI","subTitle":""},{"kind":"class","name":"sap.fe.test.api.FormAssertions","basename":"FormAssertions","resource":"sap/fe/test/api/FormAssertions.js","module":"sap/fe/test/api/FormAssertions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.FormAPI","methods":[{"name":"iCheckAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":false,"description":"<p>The identifier of an action</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of an action in a subsection.</p>","href":"api/sap.fe.test.api.FormAssertions#methods/iCheckAction","code":"<pre class=\"prettyprint\">iCheckAction(vActionIdentifier, mState?) : object</pre>"},{"name":"iCheckField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FieldIdentifier"}],"defaultValue":""},{"name":"vValue","optional":true,"description":"<p>Expected value(s) of the field. if passed as an object, the following pattern will be considered: <code><pre>\n{\n    value: <string>, \t\t// optional\n    description: <string> \t// optional\n}\n</pre></code></p>","types":[{"value":"string"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"object"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the content and state of a field within a form.</p>","href":"api/sap.fe.test.api.FormAssertions#methods/iCheckField","code":"<pre class=\"prettyprint\">iCheckField(vFieldIdentifier, vValue?, mState?) : object</pre>"},{"name":"iCheckLink","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.FieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FieldIdentifier"}],"defaultValue":""},{"name":"sText","optional":true,"description":"<p>The link text</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the field is a link with the given text and state.</p>","href":"api/sap.fe.test.api.FormAssertions#methods/iCheckLink","code":"<pre class=\"prettyprint\">iCheckLink(vFieldIdentifier, sText?, mState?) : object</pre>"},{"name":"iCheckShowLess","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the Show Less action of a form in a subsection.</p>","href":"api/sap.fe.test.api.FormAssertions#methods/iCheckShowLess","code":"<pre class=\"prettyprint\">iCheckShowLess(mState?) : object</pre>"},{"name":"iCheckShowMore","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the Show More action of a form in a subsection.</p>","href":"api/sap.fe.test.api.FormAssertions#methods/iCheckShowMore","code":"<pre class=\"prettyprint\">iCheckShowMore(mState?) : object</pre>"},{"name":"iCheckState","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":false,"description":"<p>Defines the expected state of the form</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the form.</p>","href":"api/sap.fe.test.api.FormAssertions#methods/iCheckState","code":"<pre class=\"prettyprint\">iCheckState(mState) : object</pre>"}],"displayName":"sap.fe.test.api.FormAssertions","title":"class sap.fe.test.api.FormAssertions","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.FormIdentifier","basename":"FormIdentifier","resource":"sap/fe/test/api/FormAPI.js","module":"sap/fe/test/api/FormAPI","static":true,"visibility":"public","description":"<p><p>A form identifier</p></p>","properties":[{"name":"section","optional":false,"visibility":"public","description":"<p>The facet ID</p>","types":[{"value":"string"}]},{"name":"fieldGroup","optional":false,"visibility":"public","description":"<p>The fieldgroup ID</p>","types":[{"value":"string"}]}],"displayName":"sap.fe.test.api.FormIdentifier","title":"typedef sap.fe.test.api.FormIdentifier","subTitle":""},{"kind":"class","name":"sap.fe.test.api.HeaderActions","basename":"HeaderActions","resource":"sap/fe/test/api/HeaderActions.js","module":"sap/fe/test/api/HeaderActions","export":"","static":true,"visibility":"public","methods":[{"name":"iClickLink","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vLinkIdentifier","optional":false,"description":"<p>The label of the link to be clicked (TODO it actually must be the link text with the current implementation)</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Clicks a link within the object page header.</p><p>TODO this function will not made public as it is, it needs some refactoring to behave similar to the FormActions#iClickLink function.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iClickLink","code":"<pre class=\"prettyprint\">iClickLink(vLinkIdentifier) : object</pre>"},{"name":"iExecuteAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":false,"description":"<p>The identifier of the action</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""}],"description":"<p>Executes an action in the header toolbar of an object page.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecuteAction","code":"<pre class=\"prettyprint\">iExecuteAction(vActionIdentifier) : object</pre>"},{"name":"iExecuteDelete","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Delete action in the header toolbar of an object page.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecuteDelete","code":"<pre class=\"prettyprint\">iExecuteDelete() : object</pre>"},{"name":"iExecuteEdit","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Edit action in the header toolbar of an object page.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecuteEdit","code":"<pre class=\"prettyprint\">iExecuteEdit() : object</pre>"},{"name":"iExecuteMenuAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vAction","optional":false,"description":"<p>The label of the action or its state</p>","types":[{"value":"string"},{"value":"object"}],"defaultValue":""}],"description":"<p>Executes an action in the drop-down menu that is currently open.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecuteMenuAction","code":"<pre class=\"prettyprint\">iExecuteMenuAction(vAction) : object</pre>"},{"name":"iExecutePaginatorDown","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Navigates to the next sub-object page.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecutePaginatorDown","code":"<pre class=\"prettyprint\">iExecutePaginatorDown() : object</pre>"},{"name":"iExecutePaginatorUp","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Navigates to the previous sub-object page.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecutePaginatorUp","code":"<pre class=\"prettyprint\">iExecutePaginatorUp() : object</pre>"},{"name":"iExecuteRelatedApps","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the Related Apps action in the header toolbar of an object page.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecuteRelatedApps","code":"<pre class=\"prettyprint\">iExecuteRelatedApps() : object</pre>"},{"name":"iExecuteSaveAsTile","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sBookmarkTitle","optional":false,"description":"<p>The title of the new tile</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Executes the <code>Save as Tile</code> action.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecuteSaveAsTile","code":"<pre class=\"prettyprint\">iExecuteSaveAsTile(sBookmarkTitle) : object</pre>"},{"name":"iExecuteSendEmail","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Send E-Mail</code> action.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iExecuteSendEmail","code":"<pre class=\"prettyprint\">iExecuteSendEmail() : object</pre>"},{"name":"iNavigateByBreadcrumb","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sLink","optional":false,"description":"<p>The label of the link to be navigated to</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Navigates by using a breadcrumb link on an object page.</p>","href":"api/sap.fe.test.api.HeaderActions#methods/iNavigateByBreadcrumb","code":"<pre class=\"prettyprint\">iNavigateByBreadcrumb(sLink) : object</pre>"}],"displayName":"sap.fe.test.api.HeaderActions","title":"class sap.fe.test.api.HeaderActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.HeaderActionsLR","basename":"HeaderActionsLR","resource":"sap/fe/test/api/HeaderActionsLR.js","module":"sap/fe/test/api/HeaderActionsLR","export":"","static":true,"visibility":"public","methods":[{"name":"iExecuteAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":true,"description":"<p>The identifier of the action</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""}],"description":"<p>Executes an action in the header toolbar of a list report.</p>","href":"api/sap.fe.test.api.HeaderActionsLR#methods/iExecuteAction","code":"<pre class=\"prettyprint\">iExecuteAction(vActionIdentifier?) : object</pre>"},{"name":"iExecuteSaveAsTile","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sBookmarkTitle","optional":false,"description":"<p>The title of the new tile</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Executes the <code>Save as Tile</code> action.</p>","href":"api/sap.fe.test.api.HeaderActionsLR#methods/iExecuteSaveAsTile","code":"<pre class=\"prettyprint\">iExecuteSaveAsTile(sBookmarkTitle) : object</pre>"},{"name":"iExecuteSendEmail","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Send E-Mail</code> action.</p>","href":"api/sap.fe.test.api.HeaderActionsLR#methods/iExecuteSendEmail","code":"<pre class=\"prettyprint\">iExecuteSendEmail() : object</pre>"}],"displayName":"sap.fe.test.api.HeaderActionsLR","title":"class sap.fe.test.api.HeaderActionsLR","subTitle":""},{"kind":"class","name":"sap.fe.test.api.HeaderAssertions","basename":"HeaderAssertions","resource":"sap/fe/test/api/HeaderAssertions.js","module":"sap/fe/test/api/HeaderAssertions","export":"","static":true,"visibility":"public","methods":[{"name":"iCheckAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":false,"description":"<p>The identifier of the action</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks an action in the header toolbar.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckAction","code":"<pre class=\"prettyprint\">iCheckAction(vActionIdentifier, mState?) : object</pre>"},{"name":"iCheckBreadCrumb","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sLink","optional":true,"description":"<p>The text property of the link to be tested. The <code>links</code> aggregation of the breadcrumb control is checked for the availability of the given text. If <code>sLink</code> is provided as an empty string, a check is executed to see whether the breadcrumb control exists and has an empty <code>links</code> aggregation. This is the case for the main object page, which does not show breadcrumb links. If <code>sLink</code> is not provided, a check is executed to ensure the breadcrumb control does not exist at all. This is the case for the flexible column layout showing multiple floorplans at the same time.</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Checks a specific breadcrumb link on the object page.</p><p>TODO this function will not be public yet: Its signature doesn't fit the framework.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckBreadCrumb","code":"<pre class=\"prettyprint\">iCheckBreadCrumb(sLink?) : object</pre>"},{"name":"iCheckDataPoint","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sTitle","optional":false,"description":"<p>The title of the data point</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"sValue","optional":false,"description":"<p>The expected value of the data point</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Checks a data point in the object page header.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckDataPoint","code":"<pre class=\"prettyprint\">iCheckDataPoint(sTitle, sValue) : object</pre>"},{"name":"iCheckDelete","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Delete</code> action in the header toolbar.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckDelete","code":"<pre class=\"prettyprint\">iCheckDelete(mState?) : object</pre>"},{"name":"iCheckEdit","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Edit</code> action in the header toolbar.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckEdit","code":"<pre class=\"prettyprint\">iCheckEdit(mState?) : object</pre>"},{"name":"iCheckFieldInFieldGroup","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFieldIdentifier","optional":false,"description":"<p>The identifier of the field</p>","types":[{"value":"sap.fe.test.api.FieldIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FieldIdentifier"},{"value":"string"}],"defaultValue":""},{"name":"vValue","optional":true,"description":"<p>The value to check. If it is an array, the first entry is considered as the value and the second as the description. If it is an object it must follow this pattern: <code><pre>\n\t{\n\t\tvalue: <string>, \t\t// optional\n\t\tdescription: <string> \t// optional\n\t}\n</pre></code></p>","types":[{"value":"string"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"object"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks a field within a field group in the object page header.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckFieldInFieldGroup","code":"<pre class=\"prettyprint\">iCheckFieldInFieldGroup(vFieldIdentifier, vValue?, mState?) : object</pre>"},{"name":"iCheckHeaderFacet","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vFacetIdentifier","optional":false,"description":"<p>The Identifier of the header facet</p>","types":[{"value":"sap.fe.test.api.HeaderFacetIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.HeaderFacetIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the custom facet in the object page header.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckHeaderFacet","code":"<pre class=\"prettyprint\">iCheckHeaderFacet(vFacetIdentifier, mState?) : object</pre>"},{"name":"iCheckMenuAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vAction","optional":false,"description":"<p>The state map or label of the action</p>","types":[{"value":"object"},{"value":"string"}],"defaultValue":""}],"description":"<p>Checks an action in the popover that is currently open.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckMenuAction","code":"<pre class=\"prettyprint\">iCheckMenuAction(vAction) : object</pre>"},{"name":"iCheckMicroChart","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vMicroChartIdentifier","optional":false,"description":"<p>Id/Type or Title of MicroChart</p>","types":[{"value":"object"},{"value":"string"}],"defaultValue":""},{"name":"sUoMLabel","optional":false,"description":"<p>UoM label of the MicroChart</p>","types":[{"value":"undefined"}],"defaultValue":""}],"description":"<p>Checks a MicroChart shown in the header of an object page.</p><p>TODO this function will not be public yet: Its signature doesn't fit the framework.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckMicroChart","code":"<pre class=\"prettyprint\">iCheckMicroChart(vMicroChartIdentifier, sUoMLabel) : object</pre>"},{"name":"iCheckNumberOfHeaderContentItems","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"iNumberOfItems","optional":false,"description":"<p>The expected number of items</p>","types":[{"value":"number"}],"defaultValue":""},{"name":"bIncludeHidden","optional":true,"description":"<p>Defines whether non-visible items should be counted</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Checks the number of items available in the Object Page header.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckNumberOfHeaderContentItems","code":"<pre class=\"prettyprint\">iCheckNumberOfHeaderContentItems(iNumberOfItems, bIncludeHidden?) : object</pre>"},{"name":"iCheckPaginatorDown","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":false,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the paginator down button.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckPaginatorDown","code":"<pre class=\"prettyprint\">iCheckPaginatorDown(mState) : object</pre>"},{"name":"iCheckPaginatorUp","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":false,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the paginator up button.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckPaginatorUp","code":"<pre class=\"prettyprint\">iCheckPaginatorUp(mState) : object</pre>"},{"name":"iCheckRelatedApps","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Related Apps</code> action in the header toolbar.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckRelatedApps","code":"<pre class=\"prettyprint\">iCheckRelatedApps(mState?) : object</pre>"},{"name":"iCheckSaveAsTile","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Save as Tile</code> action.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckSaveAsTile","code":"<pre class=\"prettyprint\">iCheckSaveAsTile(mState?) : object</pre>"},{"name":"iCheckSendEmail","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks <code>Send Email</code> action.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckSendEmail","code":"<pre class=\"prettyprint\">iCheckSendEmail(mState?) : object</pre>"},{"name":"iCheckTitle","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sTitle","optional":true,"description":"<p>Title of the object page header</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"sDescription","optional":true,"description":"<p>Description of the object page header</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Checks the title and description of the object page.</p><p>If either title or description is <code>undefined</code>, it will not be checked.</p>","href":"api/sap.fe.test.api.HeaderAssertions#methods/iCheckTitle","code":"<pre class=\"prettyprint\">iCheckTitle(sTitle?, sDescription?) : object</pre>"}],"displayName":"sap.fe.test.api.HeaderAssertions","title":"class sap.fe.test.api.HeaderAssertions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.HeaderAssertionsLR","basename":"HeaderAssertionsLR","resource":"sap/fe/test/api/HeaderAssertionsLR.js","module":"sap/fe/test/api/HeaderAssertionsLR","export":"","static":true,"visibility":"public","methods":[{"name":"iCheckAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":true,"description":"<p>The identifier of the action, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks an action of the header toolbar.</p>","href":"api/sap.fe.test.api.HeaderAssertionsLR#methods/iCheckAction","code":"<pre class=\"prettyprint\">iCheckAction(vActionIdentifier?, mState?) : object</pre>"},{"name":"iCheckSaveAsTile","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Save as Tile</code> action.</p>","href":"api/sap.fe.test.api.HeaderAssertionsLR#methods/iCheckSaveAsTile","code":"<pre class=\"prettyprint\">iCheckSaveAsTile(mState?) : object</pre>"},{"name":"iCheckSendEmail","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Send Email</code> action.</p>","href":"api/sap.fe.test.api.HeaderAssertionsLR#methods/iCheckSendEmail","code":"<pre class=\"prettyprint\">iCheckSendEmail(mState?) : object</pre>"}],"displayName":"sap.fe.test.api.HeaderAssertionsLR","title":"class sap.fe.test.api.HeaderAssertionsLR","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.HeaderFacetIdentifier","basename":"HeaderFacetIdentifier","resource":"sap/fe/test/api/HeaderAPI.js","module":"sap/fe/test/api/HeaderAPI","static":true,"visibility":"public","description":"<p><p>An identifier for the header facet</p></p>","properties":[{"name":"facetId","optional":false,"visibility":"public","description":"<p>The identifier of the facet</p>","types":[{"value":"string"}]},{"name":"collection","optional":true,"visibility":"public","description":"<p>Defines whether the facet is a collection facet (default: <code>false</code>)</p>","types":[{"value":"boolean"}]},{"name":"custom","optional":true,"visibility":"public","description":"<p>Defines whether the facet is a custom header facet (default: <code>false</code>)</p>","types":[{"value":"boolean"}]}],"displayName":"sap.fe.test.api.HeaderFacetIdentifier","title":"typedef sap.fe.test.api.HeaderFacetIdentifier","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.SectionIdentifier","basename":"SectionIdentifier","resource":"sap/fe/test/api/BaseAPI.js","module":"sap/fe/test/api/BaseAPI","static":true,"visibility":"public","description":"<p><p>A section identifier</p></p>","properties":[{"name":"section","optional":false,"visibility":"public","description":"<p>The name of the section facet</p>","types":[{"value":"string"}]},{"name":"subSection","optional":true,"visibility":"public","description":"<p>The name of the sub-section facet</p>","types":[{"value":"string"}]}],"displayName":"sap.fe.test.api.SectionIdentifier","title":"typedef sap.fe.test.api.SectionIdentifier","subTitle":""},{"kind":"class","name":"sap.fe.test.api.TableActions","basename":"TableActions","resource":"sap/fe/test/api/TableActions.js","module":"sap/fe/test/api/TableActions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.TableAPI","methods":[{"name":"iAddAdaptationColumn","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column field, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""}],"description":"<p>Adds a field as a column to the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iAddAdaptationColumn","code":"<pre class=\"prettyprint\">iAddAdaptationColumn(vColumnIdentifier) : object</pre>"},{"name":"iAggregateByColumn","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column field, its label or index</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"},{"value":"number"}],"defaultValue":""},{"name":"sFieldLabel","optional":true,"description":"<p>The target field to group on in case of a complex property</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Aggregates the table entries by the specified column.</p>","href":"api/sap.fe.test.api.TableActions#methods/iAggregateByColumn","code":"<pre class=\"prettyprint\">iAggregateByColumn(vColumnIdentifier, sFieldLabel?) : object</pre>"},{"name":"iChangeFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"vValue","optional":false,"description":"<p>Defines the value of the filter field condition</p>","types":[{"value":"string"},{"value":"object"}],"defaultValue":""},{"name":"bClearFirst","optional":true,"description":"<p>Set to <code>true</code> to clear previously set filters, otherwise all previously set values will be kept</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Adds a filter condition to the filter field.</p>","href":"api/sap.fe.test.api.TableActions#methods/iChangeFilterField","code":"<pre class=\"prettyprint\">iChangeFilterField(vColumnIdentifier, vValue, bClearFirst?) : object</pre>"},{"name":"iChangeRow","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code> Alternatively, the 0-based row index can be used.</p>","types":[{"value":"object"},{"value":"number"}],"defaultValue":""},{"name":"mTargetValues","optional":false,"description":"<p>A map of columns (either name or index) to its new value. The columns do not need to match the ones defined in <code>vRowValues</code>.</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Changes the specified row. The given value map must match exactly one row.</p><p>If only one parameter is provided, it must be the <code>mTargetValues</code> and <code>mRowValues</code> is considered undefined. If <code>vRowValues</code> are not defined, then the targetValues are inserted in the creationRow.</p>","href":"api/sap.fe.test.api.TableActions#methods/iChangeRow","code":"<pre class=\"prettyprint\">iChangeRow(vRowValues?, mTargetValues) : object</pre>"},{"name":"iChangeSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sSearchText","optional":true,"description":"<p>The new search text</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Changes the search field.</p>","href":"api/sap.fe.test.api.TableActions#methods/iChangeSearchField","code":"<pre class=\"prettyprint\">iChangeSearchField(sSearchText?) : object</pre>"},{"name":"iChangeSortOrder","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column field, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"sSortOrder","optional":true,"description":"<p>The sort order, default is <a target=\"_self\" href=\"api/sap.ui.core.SortOrder\">sap.ui.core.SortOrder.Ascending</a></p>","types":[{"value":"sap.ui.core.SortOrder","linkEnabled":true,"href":"api/sap.ui.core.SortOrder"}],"defaultValue":""}],"description":"<p>Adds a field to the sorting of the table via the sort dialog.</p>","href":"api/sap.fe.test.api.TableActions#methods/iChangeSortOrder","code":"<pre class=\"prettyprint\">iChangeSortOrder(vColumnIdentifier, sSortOrder?) : object</pre>"},{"name":"iClickOnMessageStripFilter","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Presses the messageStrip filter in case of issues, warnings or error message on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iClickOnMessageStripFilter","code":"<pre class=\"prettyprint\">iClickOnMessageStripFilter() : object</pre>"},{"name":"iCollapseGroupRow","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"iLevel","optional":false,"description":"<p>The level of the group row to be collapsed (1-based)</p>","types":[{"value":"number"}],"defaultValue":""},{"name":"sTitle","optional":false,"description":"<p>The title of the group row to be collapsed</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Collapses a row corresponding to a visual group.</p>","href":"api/sap.fe.test.api.TableActions#methods/iCollapseGroupRow","code":"<pre class=\"prettyprint\">iCollapseGroupRow(iLevel, sTitle) : object</pre>"},{"name":"iExecuteAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":true,"description":"<p>The identifier of the action, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""}],"description":"<p>Executes an action on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteAction","code":"<pre class=\"prettyprint\">iExecuteAction(vActionIdentifier?) : object</pre>"},{"name":"iExecuteCreate","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Create</code> action on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteCreate","code":"<pre class=\"prettyprint\">iExecuteCreate() : object</pre>"},{"name":"iExecuteDelete","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Delete</code> action on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteDelete","code":"<pre class=\"prettyprint\">iExecuteDelete() : object</pre>"},{"name":"iExecuteFullScreen","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Fullscreen</code> action on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteFullScreen","code":"<pre class=\"prettyprint\">iExecuteFullScreen() : object</pre>"},{"name":"iExecuteInlineAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code> Alternatively, the 0-based row index can be used.</p>","types":[{"value":"object"},{"value":"number"}],"defaultValue":""},{"name":"vColumn","optional":false,"description":"<p>The column name, label or index</p>","types":[{"value":"string"},{"value":"number"}],"defaultValue":""}],"description":"<p>Executes an action that is available in a certain column within a table row.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteInlineAction","code":"<pre class=\"prettyprint\">iExecuteInlineAction(vRowValues?, vColumn) : object</pre>"},{"name":"iExecuteInlineCreate","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the action to create a row in the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteInlineCreate","code":"<pre class=\"prettyprint\">iExecuteInlineCreate() : object</pre>"},{"name":"iExecuteKeyboardShortcut","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sShortcut","optional":false,"description":"<p>The shortcut pattern</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"vRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code> Alternatively, the 0-based row index can be used.</p>","types":[{"value":"object"},{"value":"number"}],"defaultValue":""},{"name":"vColumn","optional":false,"description":"<p>The column name, label or index</p>","types":[{"value":"string"},{"value":"number"}],"defaultValue":""}],"description":"<p>Executes a keyboard shortcut on the table or a cell control. If only <code>sShortcut</code> is defined, the shortcut is executed on the table directly. If additionally <code>vRowValues</code> and <code>vColumn</code> are defined, the shortcut is executed on table cell level.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteKeyboardShortcut","code":"<pre class=\"prettyprint\">iExecuteKeyboardShortcut(sShortcut, vRowValues?, vColumn) : object</pre>"},{"name":"iExecuteMenuAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vAction","optional":false,"description":"<p>The label of the action or its state</p>","types":[{"value":"string"},{"value":"object"}],"defaultValue":""}],"description":"<p>Executes an action form the drop-down menu that is currently open.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteMenuAction","code":"<pre class=\"prettyprint\">iExecuteMenuAction(vAction) : object</pre>"},{"name":"iExecutePaste","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Executes the <code>Paste</code> action on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecutePaste","code":"<pre class=\"prettyprint\">iExecutePaste() : object</pre>"},{"name":"iExecuteShowHideDetails","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"bShowDetails","optional":true,"description":"<p>Optional parameter to enforce a certain state (showing details yes/no corresponds to true/false); if not set, state is toggled</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Executes the <code>Show/Hide details</code> action on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExecuteShowHideDetails","code":"<pre class=\"prettyprint\">iExecuteShowHideDetails(bShowDetails?) : object</pre>"},{"name":"iExpandGroupRow","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"iLevel","optional":false,"description":"<p>The level of the group row to be expanded (1-based)</p>","types":[{"value":"number"}],"defaultValue":""},{"name":"sTitle","optional":false,"description":"<p>The title of the group row to be expanded</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Expands a row corresponding to a visual group.</p>","href":"api/sap.fe.test.api.TableActions#methods/iExpandGroupRow","code":"<pre class=\"prettyprint\">iExpandGroupRow(iLevel, sTitle) : object</pre>"},{"name":"iGroupByColumn","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column field, its label or index</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"},{"value":"number"}],"defaultValue":""},{"name":"sFieldLabel","optional":true,"description":"<p>The target field to group on in case of a complex property</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Groups the table entries by the specified column.</p>","href":"api/sap.fe.test.api.TableActions#methods/iGroupByColumn","code":"<pre class=\"prettyprint\">iGroupByColumn(vColumnIdentifier, sFieldLabel?) : object</pre>"},{"name":"iPasteData","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"aData","optional":false,"description":"<p>The data to be pasted</p>","types":[{"value":"string[][]"}],"defaultValue":""}],"description":"<p>Pastes data into the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iPasteData","code":"<pre class=\"prettyprint\">iPasteData(aData) : object</pre>"},{"name":"iPressCell","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mRowValues","optional":true,"description":"<p>Specifies the target row by column-value map, e.g. <code><pre>\n{\n    0: \"Max\",\n    \"Last Name\": \"Mustermann\"\n}\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""},{"name":"vColumn","optional":false,"description":"<p>The column name, label or index</p>","types":[{"value":"string"},{"value":"number"}],"defaultValue":""}],"description":"<p>Presses the control in the table cell.</p>","href":"api/sap.fe.test.api.TableActions#methods/iPressCell","code":"<pre class=\"prettyprint\">iPressCell(mRowValues?, vColumn) : object</pre>"},{"name":"iPressMore","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Scrolls update the grow threshold of responsive table and rebind the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iPressMore","code":"<pre class=\"prettyprint\">iPressMore() : object</pre>"},{"name":"iPressRow","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code> Alternatively, the 0-based row index can be used.</p>","types":[{"value":"object"},{"value":"number"}],"defaultValue":""}],"description":"<p>Clicks the specified row.</p>","href":"api/sap.fe.test.api.TableActions#methods/iPressRow","code":"<pre class=\"prettyprint\">iPressRow(vRowValues?) : object</pre>"},{"name":"iRemoveAdaptationColumn","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column field, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""}],"description":"<p>Removes a field as a column from the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iRemoveAdaptationColumn","code":"<pre class=\"prettyprint\">iRemoveAdaptationColumn(vColumnIdentifier) : object</pre>"},{"name":"iRemoveVariant","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sVariantName","optional":false,"description":"<p>The name of the variant to be removed</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Removes the variant of the given name.</p>","href":"api/sap.fe.test.api.TableActions#methods/iRemoveVariant","code":"<pre class=\"prettyprint\">iRemoveVariant(sVariantName) : object</pre>"},{"name":"iResetSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Resets the search field.</p>","href":"api/sap.fe.test.api.TableActions#methods/iResetSearchField","code":"<pre class=\"prettyprint\">iResetSearchField() : object</pre>"},{"name":"iSaveVariant","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sVariantName","optional":true,"description":"<p>The name of the new variant. If omitted, the current variant will be overwritten</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Saves a variant under the given name, or overwrites the current one.</p>","href":"api/sap.fe.test.api.TableActions#methods/iSaveVariant","code":"<pre class=\"prettyprint\">iSaveVariant(sVariantName?) : object</pre>"},{"name":"iScroll","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sDirection","optional":true,"description":"<p>The scroll direction \"up\" or \"down\" (default)</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Scrolls up/down to the first/last row of the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iScroll","code":"<pre class=\"prettyprint\">iScroll(sDirection?) : object</pre>"},{"name":"iSelectAllRows","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Selects all rows in a table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iSelectAllRows","code":"<pre class=\"prettyprint\">iSelectAllRows() : object</pre>"},{"name":"iSelectQuickFilterItem","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vItemIdentifier","optional":true,"description":"<p>If passed as an object, the following pattern will be considered: <code><pre>\n\t{\n\t\t<annotationPath>: <name of the key>\n }\n</pre></code> If using a plain string as the identifier, it is considered the item label</p>","types":[{"value":"object"},{"value":"string"}],"defaultValue":""}],"description":"<p>Selects a quick-filter item on the table.</p>","href":"api/sap.fe.test.api.TableActions#methods/iSelectQuickFilterItem","code":"<pre class=\"prettyprint\">iSelectQuickFilterItem(vItemIdentifier?) : object</pre>"},{"name":"iSelectRows","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code> Alternatively, the 0-based row index can be used.</p>","types":[{"value":"object"},{"value":"number"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the row</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Selects the specified rows.</p>","href":"api/sap.fe.test.api.TableActions#methods/iSelectRows","code":"<pre class=\"prettyprint\">iSelectRows(vRowValues?, mState?) : object</pre>"},{"name":"iSelectVariant","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sVariantName","optional":false,"description":"<p>The name of the variant to be selected</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Selects the variant of the given name.</p>","href":"api/sap.fe.test.api.TableActions#methods/iSelectVariant","code":"<pre class=\"prettyprint\">iSelectVariant(sVariantName) : object</pre>"},{"name":"iSetDefaultVariant","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sVariantName","optional":false,"description":"<p>The name of the variant to be set as the default variant. If omitted, the Standard variant is set as the default</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Sets the variant as the default.</p>","href":"api/sap.fe.test.api.TableActions#methods/iSetDefaultVariant","code":"<pre class=\"prettyprint\">iSetDefaultVariant(sVariantName) : object</pre>"},{"name":"iSortByColumn","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column field, its label or index</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"},{"value":"number"}],"defaultValue":""},{"name":"sFieldLabel","optional":true,"description":"<p>The target field to sort by in case of a complex property</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"bDescending","optional":false,"types":[{"value":"undefined"}],"defaultValue":"","description":""}],"description":"<p>Sorts the table entries by the specified column.</p>","href":"api/sap.fe.test.api.TableActions#methods/iSortByColumn","code":"<pre class=\"prettyprint\">iSortByColumn(vColumnIdentifier, sFieldLabel?, bDescending) : object</pre>"}],"displayName":"sap.fe.test.api.TableActions","title":"class sap.fe.test.api.TableActions","subTitle":""},{"kind":"class","name":"sap.fe.test.api.TableAPI","basename":"TableAPI","resource":"sap/fe/test/api/TableAPI.js","module":"sap/fe/test/api/TableAPI","export":"","static":true,"visibility":"public","methods":[{"name":"columnAdaptation","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the state of the adaptation column</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"vActions","optional":true,"description":"<p>The actions to be executed on found adaptation field</p>","types":[{"value":"function"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"sap.ui.test.actions.Action","linkEnabled":true,"href":"api/sap.ui.test.actions.Action"}],"defaultValue":""},{"name":"sDescription","optional":false,"description":"<p>The description of the check or adaptation</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Helper method to adapt columns fields. If no actions are given, this function can be used for checking only. During execution it checks for an already open adaptation dialog. If it does not exist, it is opened before the check/interaction of the columns, and closed/confirmed directly afterwards.</p>","href":"api/sap.fe.test.api.TableAPI#methods/columnAdaptation","code":"<pre class=\"prettyprint\">columnAdaptation(vColumnIdentifier, mState?, vActions?, sDescription) : object</pre>"},{"name":"columnSorting","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the state of the adaptation column</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"vActions","optional":true,"description":"<p>The actions to be executed on found adaptation field</p>","types":[{"value":"function"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"sap.ui.test.actions.Action","linkEnabled":true,"href":"api/sap.ui.test.actions.Action"}],"defaultValue":""},{"name":"sDescription","optional":false,"description":"<p>The description of the check or adaptation</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Helper method to sort columns fields. If no actions are given, this function can be used for checking only. During execution it checks for an already open sorting dialog. If it does not exist, it is opened before the check/interaction of the columns, and closed/confirmed directly afterwards.</p>","href":"api/sap.fe.test.api.TableAPI#methods/columnSorting","code":"<pre class=\"prettyprint\">columnSorting(vColumnIdentifier, mState?, vActions?, sDescription) : object</pre>"},{"name":"iConfirmColumnAdaptation","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Confirms and closes the adaptation dialog of the table.</p>","href":"api/sap.fe.test.api.TableAPI#methods/iConfirmColumnAdaptation","code":"<pre class=\"prettyprint\">iConfirmColumnAdaptation() : object</pre>"},{"name":"iConfirmColumnSorting","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Confirms and closes the sorting dialog of the table.</p>","href":"api/sap.fe.test.api.TableAPI#methods/iConfirmColumnSorting","code":"<pre class=\"prettyprint\">iConfirmColumnSorting() : object</pre>"},{"name":"iConfirmFilterDialog","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Confirms and closes the filtering dialog of the table.</p>","href":"api/sap.fe.test.api.TableAPI#methods/iConfirmFilterDialog","code":"<pre class=\"prettyprint\">iConfirmFilterDialog() : object</pre>"},{"name":"iOpenColumnAdaptation","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Opens the column adaptation dialog of the table.</p>","href":"api/sap.fe.test.api.TableAPI#methods/iOpenColumnAdaptation","code":"<pre class=\"prettyprint\">iOpenColumnAdaptation() : object</pre>"},{"name":"iOpenColumnSorting","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Opens the sorting dialog of the table.</p>","href":"api/sap.fe.test.api.TableAPI#methods/iOpenColumnSorting","code":"<pre class=\"prettyprint\">iOpenColumnSorting() : object</pre>"},{"name":"iOpenFilterDialog","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Opens the filtering dialog of the table.</p>","href":"api/sap.fe.test.api.TableAPI#methods/iOpenFilterDialog","code":"<pre class=\"prettyprint\">iOpenFilterDialog() : object</pre>"},{"name":"personalization","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The field identifier</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>The state of the personalization field. The following states are supported: <code><pre>\n\t{\n\t\tselected: true|false\n\t}\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""},{"name":"vActions","optional":true,"description":"<p>The actions to be executed on found field</p>","types":[{"value":"function"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"sap.ui.test.actions.Action","linkEnabled":true,"href":"api/sap.ui.test.actions.Action"}],"defaultValue":""},{"name":"sDescription","optional":false,"description":"<p>The description of the check or adaptation</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oDialogBuilder","optional":false,"description":"<p>The dialog builder</p>","types":[{"value":"sap.ui.test.OpaBuilder","linkEnabled":true,"href":"api/sap.ui.test.OpaBuilder"}],"defaultValue":""},{"name":"fnOpenDialog","optional":false,"description":"<p>A callback for opening the dialog</p>","types":[{"value":"function"}],"defaultValue":""},{"name":"fnCloseDialog","optional":false,"description":"<p>A callback for closing the dialog</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Helper method to personalize table, either adapt columns or filter. If no actions are given, this function can be used for checking only. During execution it checks for an already open dialog. If it does not exist, it is opened before the check/interaction of the columns, and closed/confirmed directly afterwards.</p>","href":"api/sap.fe.test.api.TableAPI#methods/personalization","code":"<pre class=\"prettyprint\">personalization(vColumnIdentifier, mState?, vActions?, sDescription, oDialogBuilder, fnOpenDialog, fnCloseDialog) : object</pre>"},{"name":"sortingPersonalization","visibility":"restricted","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The field identifier</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>The state of the personalization field. The following states are supported: <code><pre>\n\t{\n\t\tsortOrder: SortOrder.Ascending|SortOrder.Descending|SortOrder.None\n\t}\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""},{"name":"vActions","optional":true,"description":"<p>The actions to be executed on found field</p>","types":[{"value":"function"},{"value":"Array","linkEnabled":true,"href":"api/Array"},{"value":"sap.ui.test.actions.Action","linkEnabled":true,"href":"api/sap.ui.test.actions.Action"}],"defaultValue":""},{"name":"sDescription","optional":false,"description":"<p>The description of the check or adaptation</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oDialogBuilder","optional":false,"description":"<p>The dialog builder</p>","types":[{"value":"sap.ui.test.OpaBuilder","linkEnabled":true,"href":"api/sap.ui.test.OpaBuilder"}],"defaultValue":""},{"name":"fnOpenDialog","optional":false,"description":"<p>A callback for opening the dialog</p>","types":[{"value":"function"}],"defaultValue":""},{"name":"fnCloseDialog","optional":false,"description":"<p>A callback for closing the dialog</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Helper method to adapt the sorting of a table. If no actions are given, this function can be used for checking only. During execution it checks for an already open dialog. If it does not exist, it is opened before the check/interaction of the columns, and closed/confirmed directly afterwards.</p>","href":"api/sap.fe.test.api.TableAPI#methods/sortingPersonalization","code":"<pre class=\"prettyprint\">sortingPersonalization(vColumnIdentifier, mState?, vActions?, sDescription, oDialogBuilder, fnOpenDialog, fnCloseDialog) : object</pre>"}],"displayName":"sap.fe.test.api.TableAPI","title":"class sap.fe.test.api.TableAPI","subTitle":""},{"kind":"class","name":"sap.fe.test.api.TableAssertions","basename":"TableAssertions","resource":"sap/fe/test/api/TableAssertions.js","module":"sap/fe/test/api/TableAssertions","export":"","static":true,"visibility":"public","extends":"sap.fe.test.api.TableAPI","methods":[{"name":"iCheckAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vActionIdentifier","optional":false,"description":"<p>The identifier of the action, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ActionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ActionIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of a table action.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckAction","code":"<pre class=\"prettyprint\">iCheckAction(vActionIdentifier, mState?) : object</pre>"},{"name":"iCheckAdaptationColumn","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the field control in the adaptation dialog</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks a field in the adaptation dialog.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckAdaptationColumn","code":"<pre class=\"prettyprint\">iCheckAdaptationColumn(vColumnIdentifier, mState?) : object</pre>"},{"name":"iCheckCells","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code> Alternatively, the 0-based row index can be used.</p>","types":[{"value":"object"},{"value":"number"}],"defaultValue":""},{"name":"mColumnStateMap","optional":false,"description":"<p>A map of columns and their state. The map looks like <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: {\n\t\t\theader: \"My header\"\n\t\t}\n\t}\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the cells of a table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckCells","code":"<pre class=\"prettyprint\">iCheckCells(vRowValues?, mColumnStateMap) : object</pre>"},{"name":"iCheckColumnAdaptation","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks whether the adaptation button is available for the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckColumnAdaptation","code":"<pre class=\"prettyprint\">iCheckColumnAdaptation() : object</pre>"},{"name":"iCheckColumnAdaptationDialog","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks whether the column adaptation dialog is open.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckColumnAdaptationDialog","code":"<pre class=\"prettyprint\">iCheckColumnAdaptationDialog() : object</pre>"},{"name":"iCheckColumnFiltering","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks whether the filter button is available for the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckColumnFiltering","code":"<pre class=\"prettyprint\">iCheckColumnFiltering() : object</pre>"},{"name":"iCheckColumns","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"iExpectedNumberOfColumns","optional":true,"description":"<p>The expected number of columns</p>","types":[{"value":"number"}],"defaultValue":""},{"name":"mColumnStateMap","optional":true,"description":"<p>A map of columns and their expected state. The map looks like <code><pre>\n\t{\n\t\t&lt;columnName | columnLabel | columnIndex>: {\n\t\t\theader: \"My header\"\n\t\t}\n\t}\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the columns of the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckColumns","code":"<pre class=\"prettyprint\">iCheckColumns(iExpectedNumberOfColumns?, mColumnStateMap?) : object</pre>"},{"name":"iCheckColumnSorting","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks whether the sort button is available for the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckColumnSorting","code":"<pre class=\"prettyprint\">iCheckColumnSorting() : object</pre>"},{"name":"iCheckCreate","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Create</code> action of the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckCreate","code":"<pre class=\"prettyprint\">iCheckCreate(mState?) : object</pre>"},{"name":"iCheckCreationRow","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mRowValues","optional":true,"description":"<p>Defines the expected row values. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the target row</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the CreationRow button in the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckCreationRow","code":"<pre class=\"prettyprint\">iCheckCreationRow(mRowValues?, mState?) : object</pre>"},{"name":"iCheckDelete","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Delete</code> action of the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckDelete","code":"<pre class=\"prettyprint\">iCheckDelete(mState?) : object</pre>"},{"name":"iCheckExport","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Checks whether the export button is available for the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckExport","code":"<pre class=\"prettyprint\">iCheckExport() : object</pre>"},{"name":"iCheckFilterField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the field, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the field control in the filter dialog</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks a filter field in the filter dialog.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckFilterField","code":"<pre class=\"prettyprint\">iCheckFilterField(vColumnIdentifier, mState?) : object</pre>"},{"name":"iCheckFullScreen","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Fullscreen</code> action of the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckFullScreen","code":"<pre class=\"prettyprint\">iCheckFullScreen(mState?) : object</pre>"},{"name":"iCheckMenuAction","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vAction","optional":false,"description":"<p>The label of the action, or its state</p>","types":[{"value":"object"},{"value":"string"}],"defaultValue":""}],"description":"<p>Checks an action in the drop-down menu that is currently open.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckMenuAction","code":"<pre class=\"prettyprint\">iCheckMenuAction(vAction) : object</pre>"},{"name":"iCheckMessageStrip","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mProperty","optional":true,"description":"<p>Defines the expected properties of the messageStrip in the table</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks a messageStrip on a table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckMessageStrip","code":"<pre class=\"prettyprint\">iCheckMessageStrip(mProperty?) : object</pre>"},{"name":"iCheckPaste","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the button</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the <code>Paste</code> action of the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckPaste","code":"<pre class=\"prettyprint\">iCheckPaste(mState?) : object</pre>"},{"name":"iCheckQuickFilter","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the control</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the quick filter action of the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckQuickFilter","code":"<pre class=\"prettyprint\">iCheckQuickFilter(mState?) : object</pre>"},{"name":"iCheckQuickFilterItems","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"iExpectedNumberOfItems","optional":false,"description":"<p>The expected number of quick-filter items</p>","types":[{"value":"number"}],"defaultValue":""}],"description":"<p>Checks the number of items in the quick-filter menu.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckQuickFilterItems","code":"<pre class=\"prettyprint\">iCheckQuickFilterItems(iExpectedNumberOfItems) : object</pre>"},{"name":"iCheckRows","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mRowValues","optional":true,"description":"<p>Defines the row values of the target row. The pattern is: <code><pre>\n\t{\n\t\t&lt;column-name-or-index>: &lt;expected-value>\n }\n</pre></code></p>","types":[{"value":"object"}],"defaultValue":""},{"name":"iExpectedNumberOfRows","optional":true,"description":"<p>The expected number of rows considering <code>mRowValues</code> and <code>mRowState</code></p>","types":[{"value":"number"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the target row</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"vEmptyColumns","optional":true,"description":"<p>Defines the expected empty columns</p>","types":[{"value":"Array","linkEnabled":true,"href":"api/Array"}],"defaultValue":""}],"description":"<p>Checks the rows of a table. If <code>mRowValues</code> is provided, only rows with the corresponding values are considered. 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. If <code>iNumberOfRows</code> is omitted, it checks for at least one matching row. If <code>mState</code> is provided, the row must be in the given state.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckRows","code":"<pre class=\"prettyprint\">iCheckRows(mRowValues?, iExpectedNumberOfRows?, mState?, vEmptyColumns?) : object</pre>"},{"name":"iCheckSearchField","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function that can be used for chaining statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sSearchText","optional":true,"description":"<p>The expected text in the search field</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mState","optional":true,"description":"<p>Defines the expected state of the search field</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the search field in the table toolbar. If the <code>sSearchText</code> parameter is <code>undefined</code>, the search text is not validated.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckSearchField","code":"<pre class=\"prettyprint\">iCheckSearchField(sSearchText?, mState?) : object</pre>"},{"name":"iCheckSortOrder","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vColumnIdentifier","optional":false,"description":"<p>The identifier of the column, or its label</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.ColumnIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.ColumnIdentifier"}],"defaultValue":""},{"name":"sSortOrder","optional":true,"description":"<p>The sort order of the column, default is <a target=\"_self\" href=\"api/sap.ui.core.SortOrder\">sap.ui.core.SortOrder.Ascending</a></p>","types":[{"value":"sap.ui.core.SortOrder","linkEnabled":true,"href":"api/sap.ui.core.SortOrder"}],"defaultValue":""},{"name":"bCheckPersonalization","optional":true,"description":"<p>Defines if the order is checked via sorting dialog, or via the column itself</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Checks a field in the sorting dialog.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckSortOrder","code":"<pre class=\"prettyprint\">iCheckSortOrder(vColumnIdentifier, sSortOrder?, bCheckPersonalization?) : object</pre>"},{"name":"iCheckState","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"mState","optional":true,"description":"<p>Defines the expected state of the table</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Checks the state of the table.</p>","href":"api/sap.fe.test.api.TableAssertions#methods/iCheckState","code":"<pre class=\"prettyprint\">iCheckState(mState?) : object</pre>"}],"displayName":"sap.fe.test.api.TableAssertions","title":"class sap.fe.test.api.TableAssertions","subTitle":""},{"kind":"typedef","name":"sap.fe.test.api.TableIdentifier","basename":"TableIdentifier","resource":"sap/fe/test/api/BaseAPI.js","module":"sap/fe/test/api/BaseAPI","static":true,"visibility":"public","description":"<p><p>A table identifier</p></p>","properties":[{"name":"property","optional":false,"visibility":"public","description":"<p>The name of the navigation property used for the table</p>","types":[{"value":"string"}]}],"displayName":"sap.fe.test.api.TableIdentifier","title":"typedef sap.fe.test.api.TableIdentifier","subTitle":""},{"kind":"class","name":"sap.fe.test.BaseActions","basename":"BaseActions","resource":"sap/fe/test/BaseActions.js","module":"sap/fe/test/BaseActions","export":"","static":true,"visibility":"public","extends":"sap.ui.test.Opa5","description":"<p>All common actions (<code>When</code>) for all Opa tests are defined here.</p>","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","description":"<p>Constructs a new <a target=\"_self\" href=\"api/sap.fe.test.Opa5\">sap.fe.test.Opa5</a> instance.</p>","references":[],"codeExample":"<pre class=\"prettyprint\">new sap.fe.test.BaseActions()</pre>"},"methods":[{"name":"sap.fe.test.BaseActions.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.test.BaseActions with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extend\">sap.ui.test.Opa5.extend</a>.</p>","href":"api/sap.fe.test.BaseActions#methods/sap.fe.test.BaseActions.extend","code":"<pre class=\"prettyprint\">sap.fe.test.BaseActions.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"sap.fe.test.BaseActions.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class sap.fe.test.BaseActions.</p>","href":"api/sap.fe.test.BaseActions#methods/sap.fe.test.BaseActions.getMetadata","code":"<pre class=\"prettyprint\">sap.fe.test.BaseActions.getMetadata() : sap.ui.base.Metadata</pre>"},{"name":"iClosePopover","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Closes the open popover via function.</p><p>NOTE: This function ensures that a certain UI state is maintained in some exceptional cases. This function isn't usually called directly in a journey.</p>","href":"api/sap.fe.test.BaseActions#methods/iClosePopover","code":"<pre class=\"prettyprint\">iClosePopover() : object</pre>"},{"name":"iPressEscape","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Simulates the pressing of the Esc key for the element in focus.</p>","href":"api/sap.fe.test.BaseActions#methods/iPressEscape","code":"<pre class=\"prettyprint\">iPressEscape() : object</pre>"}],"displayName":"sap.fe.test.BaseActions","title":"class sap.fe.test.BaseActions","subTitle":""},{"kind":"class","name":"sap.fe.test.BaseArrangements","basename":"BaseArrangements","resource":"sap/fe/test/BaseArrangements.js","module":"sap/fe/test/BaseArrangements","export":"","static":true,"visibility":"public","extends":"sap.ui.test.Opa5","description":"<p>All common arrangements (<code>Given</code>) for all Opa tests are defined here.</p>","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"mSettings","optional":false,"description":"<p>The settings object required for launching the application</p>","phoneName":"mSettings","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""},{"name":"launchUrl","optional":false,"description":"<p>The URL to the launching page (usually a FLP.html)</p>","phoneName":"mSettings.launchUrl","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"launchParameters","optional":false,"description":"<p>The URL launch parameters</p>","phoneName":"mSettings.launchParameters","depth":1,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""}],"description":"<p>Constructs a new <a target=\"_self\" href=\"api/sap.fe.test.Opa5\">sap.fe.test.Opa5</a> instance.</p>","references":[],"codeExample":"<pre class=\"prettyprint\">new sap.fe.test.BaseArrangements(mSettings)</pre>"},"methods":[{"name":"sap.fe.test.BaseArrangements.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.test.BaseArrangements with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extend\">sap.ui.test.Opa5.extend</a>.</p>","href":"api/sap.fe.test.BaseArrangements#methods/sap.fe.test.BaseArrangements.extend","code":"<pre class=\"prettyprint\">sap.fe.test.BaseArrangements.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"sap.fe.test.BaseArrangements.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class sap.fe.test.BaseArrangements.</p>","href":"api/sap.fe.test.BaseArrangements#methods/sap.fe.test.BaseArrangements.getMetadata","code":"<pre class=\"prettyprint\">sap.fe.test.BaseArrangements.getMetadata() : sap.ui.base.Metadata</pre>"},{"name":"iResetTestData","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Resets the test data.</p>","href":"api/sap.fe.test.BaseArrangements#methods/iResetTestData","code":"<pre class=\"prettyprint\">iResetTestData() : object</pre>"},{"name":"iRestartMyApp","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Simulates a refresh of the page by tearing it down and then restarting it with the very same hash.</p>","href":"api/sap.fe.test.BaseArrangements#methods/iRestartMyApp","code":"<pre class=\"prettyprint\">iRestartMyApp() : object</pre>"},{"name":"iStartMyApp","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sAppHash","optional":true,"description":"<p>The app hash</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mUrlParameters","optional":true,"description":"<p>A map with additional URL parameters</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Starts the app in an IFrame, using the <code>launchUrl</code> and <code>launchParameters</code> provided via the settings object of the <a target=\"_self\" href=\"api/sap.fe.test.BaseArrangements#constructor\">sap.fe.test.BaseArrangements#constructor</a>.</p>","href":"api/sap.fe.test.BaseArrangements#methods/iStartMyApp","code":"<pre class=\"prettyprint\">iStartMyApp(sAppHash?, mUrlParameters?) : object</pre>"},{"name":"iTearDownMyApp","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Tears down the current application.</p>","href":"api/sap.fe.test.BaseArrangements#methods/iTearDownMyApp","code":"<pre class=\"prettyprint\">iTearDownMyApp() : object</pre>"},{"name":"resetTestData","visibility":"protected","returnValue":{"type":"object","description":"<p>A <code>Promise</code> object</p>","types":[{"value":"object"}]},"description":"<p>Clears the browser's local storage and session storage.</p><p>NOTE: The function itself is not meant to be called directly within a journey. Instead, it can be overwritten to add custom clean-up functionality when calling <a target=\"_self\" href=\"api/sap.fe.test.BaseArrangements#methods/iResetTestData\">sap.fe.test.BaseArrangements#iResetTestData</a>.</p>","href":"api/sap.fe.test.BaseArrangements#methods/resetTestData","code":"<pre class=\"prettyprint\">resetTestData() : object</pre>"}],"displayName":"sap.fe.test.BaseArrangements","title":"class sap.fe.test.BaseArrangements","subTitle":""},{"kind":"class","name":"sap.fe.test.BaseAssertions","basename":"BaseAssertions","resource":"sap/fe/test/BaseAssertions.js","module":"sap/fe/test/BaseAssertions","export":"","static":true,"visibility":"public","extends":"sap.ui.test.Opa5","description":"<p>All common assertions (<code>Then</code>) for all Opa tests are defined here.</p>","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","description":"<p>Constructs a new <a target=\"_self\" href=\"api/sap.fe.test.Opa5\">sap.fe.test.Opa5</a> instance.</p>","references":[],"codeExample":"<pre class=\"prettyprint\">new sap.fe.test.BaseAssertions()</pre>"},"methods":[{"name":"sap.fe.test.BaseAssertions.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.test.BaseAssertions with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extend\">sap.ui.test.Opa5.extend</a>.</p>","href":"api/sap.fe.test.BaseAssertions#methods/sap.fe.test.BaseAssertions.extend","code":"<pre class=\"prettyprint\">sap.fe.test.BaseAssertions.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"sap.fe.test.BaseAssertions.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class sap.fe.test.BaseAssertions.</p>","href":"api/sap.fe.test.BaseAssertions#methods/sap.fe.test.BaseAssertions.getMetadata","code":"<pre class=\"prettyprint\">sap.fe.test.BaseAssertions.getMetadata() : sap.ui.base.Metadata</pre>"},{"name":"iSeeMessagePage","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sMessage","optional":false,"description":"<p>The message shown on the message page</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Checks whether a <a target=\"_self\" href=\"api/sap.m.MessagePage\">sap.m.MessagePage</a> with given message is shown.</p>","href":"api/sap.fe.test.BaseAssertions#methods/iSeeMessagePage","code":"<pre class=\"prettyprint\">iSeeMessagePage(sMessage) : object</pre>"},{"name":"iSeeMessageToast","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sText","optional":false,"description":"<p>The text shown in the MessageToast</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Checks whether a <a target=\"_self\" href=\"api/sap.m.MessageToast\">sap.m.MessageToast</a> with the given text is shown.</p>","href":"api/sap.fe.test.BaseAssertions#methods/iSeeMessageToast","code":"<pre class=\"prettyprint\">iSeeMessageToast(sText) : object</pre>"}],"displayName":"sap.fe.test.BaseAssertions","title":"class sap.fe.test.BaseAssertions","subTitle":""},{"kind":"class","name":"sap.fe.test.JourneyRunner","basename":"JourneyRunner","resource":"sap/fe/test/JourneyRunner.js","module":"sap/fe/test/JourneyRunner","export":"","static":true,"visibility":"public","extends":"sap.ui.base.Object","description":"<p>A JourneyRunner for executing integration tests with given settings.</p>","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"mSettings","optional":true,"description":"<p>The settings object</p>","phoneName":"mSettings","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""},{"name":"pages","optional":true,"description":"<p>The available Opa pages</p>","phoneName":"mSettings.pages","depth":1,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""},{"name":"opaConfig","optional":true,"description":"<p>The Opa configuration applied via <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extendConfig\">sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig</a></p>","phoneName":"mSettings.opaConfig","depth":1,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""},{"name":"launchUrl","optional":true,"description":"<p>The URL to the launching page (usually a FLP.html)</p>","phoneName":"mSettings.launchUrl","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"launchParameters","optional":true,"description":"<p>The URL launch parameters</p>","phoneName":"mSettings.launchParameters","depth":1,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""},{"name":"async","optional":true,"description":"<p>If false (default), only one JourneyRunner is executed at a time</p>","phoneName":"mSettings.async","depth":1,"types":[{"name":"boolean","linkEnabled":false}],"defaultValue":""}],"description":"<p>Constructs a new JourneyRunner instance.</p>","references":[],"codeExample":"<pre class=\"prettyprint\">new sap.fe.test.JourneyRunner(mSettings?)</pre>"},"methods":[{"name":"sap.fe.test.JourneyRunner.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.test.JourneyRunner with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.ui.base.Object#methods/sap.ui.base.Object.extend\">sap.ui.base.Object.extend</a>.</p>","href":"api/sap.fe.test.JourneyRunner#methods/sap.fe.test.JourneyRunner.extend","code":"<pre class=\"prettyprint\">sap.fe.test.JourneyRunner.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"getBaseActions","visibility":"protected","returnValue":{"type":"sap.ui.test.Opa","description":"<p>An Opa instance for the base actions</p>","types":[{"value":"sap.ui.test.Opa","href":"api/sap.ui.test.Opa","linkEnabled":true}]},"parameters":[{"name":"mSettings","optional":false,"description":"<p>The settings object of the runner instance</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Returns the base action instance to be used for <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extendConfig\">sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig</a> <code>actions</code> setting.</p><p>This function is only used if <code>actions</code> is not defined via the runner settings. It is meant to be overridden by a custom JourneyRunner implementation to provide custom base actions.</p><p>By default, an instance of <a target=\"_self\" href=\"api/sap.fe.test.BaseActions\">sap.fe.test.BaseActions</a> will be returned.</p>","href":"api/sap.fe.test.JourneyRunner#methods/getBaseActions","code":"<pre class=\"prettyprint\">getBaseActions(mSettings) : sap.ui.test.Opa</pre>"},{"name":"getBaseArrangements","visibility":"protected","returnValue":{"type":"sap.ui.test.Opa","description":"<p>An Opa instance for the base arrangements</p>","types":[{"value":"sap.ui.test.Opa","href":"api/sap.ui.test.Opa","linkEnabled":true}]},"parameters":[{"name":"mSettings","optional":false,"description":"<p>The settings object of the runner instance</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Returns the base arrangements instance to be used for <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extendConfig\">sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig</a> <code>arrangements</code> setting.</p><p>This function is only used if <code>arrangements</code> is not defined via the runner settings. It is meant to be overridden by a custom JourneyRunner implementation to provide custom base assertions.</p><p>By default, an instance of <a target=\"_self\" href=\"api/sap.fe.test.BaseArrangements\">sap.fe.test.BaseArrangements</a> will be returned.</p>","href":"api/sap.fe.test.JourneyRunner#methods/getBaseArrangements","code":"<pre class=\"prettyprint\">getBaseArrangements(mSettings) : sap.ui.test.Opa</pre>"},{"name":"getBaseAssertions","visibility":"protected","returnValue":{"type":"sap.ui.test.Opa","description":"<p>An Opa instance for the base assertions</p>","types":[{"value":"sap.ui.test.Opa","href":"api/sap.ui.test.Opa","linkEnabled":true}]},"parameters":[{"name":"mSettings","optional":false,"description":"<p>The settings object of the runner instance</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Returns the base assertions instance to be used for <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extendConfig\">sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig</a> <code>assertions</code> setting.</p><p>This function is only used if <code>assertions</code> is not defined via the runner settings. It is meant to be overridden by a custom JourneyRunner implementation to provide custom base assertions.</p><p>By default, an instance of <a target=\"_self\" href=\"api/sap.fe.test.BaseAssertions\">sap.fe.test.BaseAssertions</a> will be returned.</p>","href":"api/sap.fe.test.JourneyRunner#methods/getBaseAssertions","code":"<pre class=\"prettyprint\">getBaseAssertions(mSettings) : sap.ui.test.Opa</pre>"},{"name":"sap.fe.test.JourneyRunner.getDefaultRunner","visibility":"public","static":true,"returnValue":{"type":"object","description":"<p>The global default <a target=\"_self\" href=\"api/sap.fe.test.JourneyRunner\">sap.fe.test.JourneyRunner</a> instance</p>","types":[{"value":"object"}]},"description":"<p>Gets the global journey runner instance.</p>","href":"api/sap.fe.test.JourneyRunner#methods/sap.fe.test.JourneyRunner.getDefaultRunner","code":"<pre class=\"prettyprint\">sap.fe.test.JourneyRunner.getDefaultRunner() : object</pre>"},{"name":"sap.fe.test.JourneyRunner.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class sap.fe.test.JourneyRunner.</p>","href":"api/sap.fe.test.JourneyRunner#methods/sap.fe.test.JourneyRunner.getMetadata","code":"<pre class=\"prettyprint\">sap.fe.test.JourneyRunner.getMetadata() : sap.ui.base.Metadata</pre>"},{"name":"run","visibility":"public","returnValue":{"type":"object","description":"<p>A <code>Promise</code> that is resolved after all tests have been executed</p>","types":[{"value":"object"}]},"parameters":[{"name":"mSettings","optional":true,"description":"<p>The settings object for the tests to run. Overrides instance settings</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"pages","optional":true,"description":"<p>The available Opa pages</p>","depth":1,"types":[{"value":"object"}],"phoneName":"mSettings.pages","defaultValue":""},{"name":"opaConfig","optional":true,"description":"<p>The Opa configuration applied via <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/sap.ui.test.Opa5.extendConfig\">sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig</a></p>","depth":1,"types":[{"value":"object"}],"phoneName":"mSettings.opaConfig","defaultValue":""},{"name":"launchUrl","optional":true,"description":"<p>The URL to the launching page (usually a FLP.html)</p>","depth":1,"types":[{"value":"string"}],"phoneName":"mSettings.launchUrl","defaultValue":""},{"name":"launchParameters","optional":true,"description":"<p>The URL launch parameters</p>","depth":1,"types":[{"value":"object"}],"phoneName":"mSettings.launchParameters","defaultValue":""},{"name":"async","optional":true,"description":"<p>If false (default), only one JourneyRunner is executed at a time</p>","depth":1,"types":[{"value":"boolean"}],"phoneName":"mSettings.async","defaultValue":""},{"name":"vJourneys","optional":false,"description":"<p>The journeys to be executed. If a journey is represented as a string, it will be interpreted as a module path to the file that should be loaded. Else it is expected to be a function</p>","types":[{"value":"Array<function()>"},{"value":"string[]"}],"defaultValue":""}],"description":"<p>Executes the journeys in the given order.</p><p>The settings provided as first parameter are merged into the base settings of the JourneyRunner instance.</p>","href":"api/sap.fe.test.JourneyRunner#methods/run","code":"<pre class=\"prettyprint\">run(mSettings?, vJourneys) : object</pre>"},{"name":"sap.fe.test.JourneyRunner.run","visibility":"public","static":true,"description":"<p>Static function to run the default runner with given parameters. Shortcut for <pre>JourneyRunner.getDefaultRunner().run(mSettings, Journey1, Journey2, ...)</pre> See <a target=\"_self\" href=\"api/sap.fe.test.JourneyRunner#methods/run\">sap.fe.test.JourneyRunner#run</a> for parameter details.</p>","href":"api/sap.fe.test.JourneyRunner#methods/sap.fe.test.JourneyRunner.run","code":"<pre class=\"prettyprint\">sap.fe.test.JourneyRunner.run() : void</pre>"},{"name":"sap.fe.test.JourneyRunner.setDefaultRunner","visibility":"public","static":true,"parameters":[{"name":"oDefaultRunner","optional":false,"description":"<p>Defines the global default <a target=\"_self\" href=\"api/sap.fe.test.JourneyRunner\">sap.fe.test.JourneyRunner</a> instance</p>","types":[{"value":"sap.fe.test.JourneyRunner","linkEnabled":true,"href":"api/sap.fe.test.JourneyRunner"}],"defaultValue":""}],"description":"<p>Sets the global journey runner instance.</p>","href":"api/sap.fe.test.JourneyRunner#methods/sap.fe.test.JourneyRunner.setDefaultRunner","code":"<pre class=\"prettyprint\">sap.fe.test.JourneyRunner.setDefaultRunner(oDefaultRunner) : void</pre>"}],"displayName":"sap.fe.test.JourneyRunner","title":"class sap.fe.test.JourneyRunner","subTitle":""},{"kind":"class","name":"sap.fe.test.ListReport","basename":"ListReport","resource":"sap/fe/test/ListReport.js","module":"sap/fe/test/ListReport","export":"","static":true,"visibility":"public","extends":"sap.fe.test.TemplatePage","description":"<p>Provides a test page definition for a list report page with the corresponding parameters.</p><p>Sample usage: <code><pre>\nvar oListReportDefinition = new ListReport({ appId: \"MyApp\", componentId: \"MyListReportId\", entitySet: \"MyEntitySet\" });\n</pre></code></p>","constructor":{"visibility":"public","parameters":[{"name":"oPageDefinition","optional":false,"description":"<p>The required parameters</p>","phoneName":"oPageDefinition","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""},{"name":"appId","optional":false,"description":"<p>The app id (defined in the manifest root)</p>","phoneName":"oPageDefinition.appId","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"componentId","optional":false,"description":"<p>The component id (defined in the target section for the list report within the manifest)</p>","phoneName":"oPageDefinition.componentId","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"entitySet","optional":false,"description":"<p>The entitySet (optional)(defined in the settings of the corresponding target component within the manifest)</p>","phoneName":"oPageDefinition.entitySet","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"contextPath","optional":false,"description":"<p>The contextPath (optional)(defined in the settings of the corresponding target component within the manifest)</p>","phoneName":"oPageDefinition.contextPath","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"aAdditionalPageDefinitions","optional":true,"repeatable":true,"description":"<p>Additional custom page functions, provided in an object containing <code>actions</code> and <code>assertions</code></p>","phoneName":"aAdditionalPageDefinitions","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""}],"description":"<p>Constructs a new ListReport definition.</p>","references":[],"codeExample":"<pre class=\"prettyprint\">new sap.fe.test.ListReport(oPageDefinition, aAdditionalPageDefinitions?)</pre>"},"displayName":"sap.fe.test.ListReport","nodes":[{"name":"sap.fe.test.ListReport.actions","description":"<p>ListReport actions</p>","href":"api/sap.fe.test.ListReport.actions"},{"name":"sap.fe.test.ListReport.assertions","description":"<p>ListReport assertions</p>","href":"api/sap.fe.test.ListReport.assertions"}],"title":"class sap.fe.test.ListReport","subTitle":""},{"kind":"namespace","name":"sap.fe.test.ListReport.actions","basename":"actions","resource":"sap/fe/test/ListReport.js","module":"sap/fe/test/ListReport","export":"actions","static":true,"visibility":"public","extends":"sap.fe.test.TemplatePage.actions","description":"<p><p>ListReport actions</p></p>","methods":[{"name":"iCollapseExpandPageHeader","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"bCollapse","optional":true,"description":"<p>Defines whether the header should be collapsed, else it is expanded (default)</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Collapses or expands the page header.</p>","href":"api/sap.fe.test.ListReport.actions#methods/iCollapseExpandPageHeader","code":"<pre class=\"prettyprint\">iCollapseExpandPageHeader(bCollapse?) : object</pre>"},{"name":"onFilterBar","visibility":"public","returnValue":{"type":"sap.fe.test.api.FilterBarActions","description":"<p>The available filter bar actions</p>","types":[{"value":"sap.fe.test.api.FilterBarActions","href":"api/sap.fe.test.api.FilterBarActions","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.FilterBarActions\">sap.fe.test.api.FilterBarActions</a> instance.</p>","href":"api/sap.fe.test.ListReport.actions#methods/onFilterBar","code":"<pre class=\"prettyprint\">onFilterBar() : sap.fe.test.api.FilterBarActions</pre>"},{"name":"onHeader","visibility":"public","returnValue":{"type":"sap.fe.test.api.HeaderActionsLR","description":"<p>The available header actions</p>","types":[{"value":"sap.fe.test.api.HeaderActionsLR","href":"api/sap.fe.test.api.HeaderActionsLR","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.HeaderActionsLR\">sap.fe.test.api.HeaderActionsLR</a> instance.</p>","href":"api/sap.fe.test.ListReport.actions#methods/onHeader","code":"<pre class=\"prettyprint\">onHeader() : sap.fe.test.api.HeaderActionsLR</pre>"},{"name":"onTable","visibility":"public","returnValue":{"type":"sap.fe.test.api.TableActions","description":"<p>The available table actions</p>","types":[{"value":"sap.fe.test.api.TableActions","href":"api/sap.fe.test.api.TableActions","linkEnabled":true}]},"parameters":[{"name":"vTableIdentifier","optional":false,"description":"<p>The identifier of the table, or its header title</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.TableIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.TableIdentifier"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.TableActions\">sap.fe.test.api.TableActions</a> instance for the specified table.</p>","href":"api/sap.fe.test.ListReport.actions#methods/onTable","code":"<pre class=\"prettyprint\">onTable(vTableIdentifier) : sap.fe.test.api.TableActions</pre>"}],"displayName":"sap.fe.test.ListReport.actions","title":"namespace sap.fe.test.ListReport.actions","subTitle":""},{"kind":"namespace","name":"sap.fe.test.ListReport.assertions","basename":"assertions","resource":"sap/fe/test/ListReport.js","module":"sap/fe/test/ListReport","export":"assertions","static":true,"visibility":"public","extends":"sap.fe.test.TemplatePage.assertions","description":"<p><p>ListReport assertions</p></p>","methods":[{"name":"onFilterBar","visibility":"public","returnValue":{"type":"sap.fe.test.api.FilterBarAssertions","description":"<p>The available filter bar assertions</p>","types":[{"value":"sap.fe.test.api.FilterBarAssertions","href":"api/sap.fe.test.api.FilterBarAssertions","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.FilterBarAssertions\">sap.fe.test.api.FilterBarAssertions</a> instance.</p>","href":"api/sap.fe.test.ListReport.assertions#methods/onFilterBar","code":"<pre class=\"prettyprint\">onFilterBar() : sap.fe.test.api.FilterBarAssertions</pre>"},{"name":"onHeader","visibility":"public","returnValue":{"type":"sap.fe.test.api.HeaderAssertionsLR","description":"<p>The available header assertions</p>","types":[{"value":"sap.fe.test.api.HeaderAssertionsLR","href":"api/sap.fe.test.api.HeaderAssertionsLR","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.HeaderAssertionsLR\">sap.fe.test.api.HeaderAssertionsLR</a> instance.</p>","href":"api/sap.fe.test.ListReport.assertions#methods/onHeader","code":"<pre class=\"prettyprint\">onHeader() : sap.fe.test.api.HeaderAssertionsLR</pre>"},{"name":"onTable","visibility":"public","returnValue":{"type":"sap.fe.test.api.TableAssertions","description":"<p>The available table assertions</p>","types":[{"value":"sap.fe.test.api.TableAssertions","href":"api/sap.fe.test.api.TableAssertions","linkEnabled":true}]},"parameters":[{"name":"vTableIdentifier","optional":false,"description":"<p>The identifier of the table, or its header title</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.TableIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.TableIdentifier"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.TableAssertions\">sap.fe.test.api.TableAssertions</a> instance for the specified table.</p>","href":"api/sap.fe.test.ListReport.assertions#methods/onTable","code":"<pre class=\"prettyprint\">onTable(vTableIdentifier) : sap.fe.test.api.TableAssertions</pre>"}],"displayName":"sap.fe.test.ListReport.assertions","title":"namespace sap.fe.test.ListReport.assertions","subTitle":""},{"kind":"class","name":"sap.fe.test.ObjectPage","basename":"ObjectPage","resource":"sap/fe/test/ObjectPage.js","module":"sap/fe/test/ObjectPage","export":"","static":true,"visibility":"public","extends":"sap.fe.test.TemplatePage","description":"<p>Provides a test page definition for an object page with the corresponding parameters.</p><p>Sample usage: <code><pre>\nvar oObjectPageDefinition = new ObjectPage({ appId: \"MyApp\", componentId: \"MyObjectPageId\", entitySet: \"MyEntitySet\" });\n</pre></code></p>","constructor":{"visibility":"public","parameters":[{"name":"oPageDefinition","optional":false,"description":"<p>The required parameters</p>","phoneName":"oPageDefinition","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""},{"name":"appId","optional":false,"description":"<p>The app id (defined in the manifest root)</p>","phoneName":"oPageDefinition.appId","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"componentId","optional":false,"description":"<p>The component id (defined in the target section for the list report within the manifest)</p>","phoneName":"oPageDefinition.componentId","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"entitySet","optional":false,"description":"<p>The entitySet (defined in the settings of the corresponding target component within the manifest)</p>","phoneName":"oPageDefinition.entitySet","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"contextPath","optional":false,"description":"<p>The contextPath (optional)(defined in the settings of the corresponding target component within the manifest)</p>","phoneName":"oPageDefinition.contextPath","depth":1,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"aAdditionalPageDefinitions","optional":true,"repeatable":true,"description":"<p>Additional custom page functions, provided in an object containing <code>actions</code> and <code>assertions</code></p>","phoneName":"aAdditionalPageDefinitions","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""}],"description":"<p>Constructs a new ObjectPage instance.</p>","references":[],"codeExample":"<pre class=\"prettyprint\">new sap.fe.test.ObjectPage(oPageDefinition, aAdditionalPageDefinitions?)</pre>"},"displayName":"sap.fe.test.ObjectPage","nodes":[{"name":"sap.fe.test.ObjectPage.actions","description":"<p>ObjectPage actions</p>","href":"api/sap.fe.test.ObjectPage.actions"},{"name":"sap.fe.test.ObjectPage.assertions","description":"<p>ObjectPage assertions</p>","href":"api/sap.fe.test.ObjectPage.assertions"}],"title":"class sap.fe.test.ObjectPage","subTitle":""},{"kind":"namespace","name":"sap.fe.test.ObjectPage.actions","basename":"actions","resource":"sap/fe/test/ObjectPage.js","module":"sap/fe/test/ObjectPage","export":"actions","static":true,"visibility":"public","extends":"sap.fe.test.TemplatePage.actions","description":"<p><p>ObjectPage actions</p></p>","methods":[{"name":"iCollapseExpandPageHeader","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"bCollapse","optional":true,"description":"<p>Defines whether header should be collapsed, else it gets expanded (default)</p>","types":[{"value":"boolean"}],"defaultValue":""}],"description":"<p>Collapses or expands the page header.</p>","href":"api/sap.fe.test.ObjectPage.actions#methods/iCollapseExpandPageHeader","code":"<pre class=\"prettyprint\">iCollapseExpandPageHeader(bCollapse?) : object</pre>"},{"name":"iGoToSection","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"vSectionIdentifier","optional":false,"description":"<p>The identifier of a section, or its label if passed as an object, the following pattern will be considered: <code><pre>\n{\n    section: <string>,\n    subSection: <string>\n}\n</pre></code> to open the editable header section use pattern: <code><pre>\n{\n    section: \"EditableHeaderSection\"\n}\n</pre></code></p>","types":[{"value":"string"},{"value":"sap.fe.test.api.SectionIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.SectionIdentifier"}],"defaultValue":""}],"description":"<p>Navigates to or focuses on the defined section.</p>","href":"api/sap.fe.test.ObjectPage.actions#methods/iGoToSection","code":"<pre class=\"prettyprint\">iGoToSection(vSectionIdentifier) : object</pre>"},{"name":"onFooter","visibility":"public","returnValue":{"type":"sap.fe.test.api.FooterActionsOP","description":"<p>The available footer actions</p>","types":[{"value":"sap.fe.test.api.FooterActionsOP","href":"api/sap.fe.test.api.FooterActionsOP","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.FooterActionsOP\">sap.fe.test.api.FooterActionsOP</a> instance.</p>","href":"api/sap.fe.test.ObjectPage.actions#methods/onFooter","code":"<pre class=\"prettyprint\">onFooter() : sap.fe.test.api.FooterActionsOP</pre>"},{"name":"onForm","visibility":"public","returnValue":{"type":"sap.fe.test.api.FormActions","description":"<p>The available form actions</p>","types":[{"value":"sap.fe.test.api.FormActions","href":"api/sap.fe.test.api.FormActions","linkEnabled":true}]},"parameters":[{"name":"vFormIdentifier","optional":false,"description":"<p>The identifier of the form, or its title</p>","types":[{"value":"sap.fe.test.api.FormIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FormIdentifier"},{"value":"string"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.FormActions\">sap.fe.test.api.FormActions</a> instance.</p>","href":"api/sap.fe.test.ObjectPage.actions#methods/onForm","code":"<pre class=\"prettyprint\">onForm(vFormIdentifier) : sap.fe.test.api.FormActions</pre>"},{"name":"onHeader","visibility":"public","returnValue":{"type":"sap.fe.test.api.HeaderActions","description":"<p>The available header actions</p>","types":[{"value":"sap.fe.test.api.HeaderActions","href":"api/sap.fe.test.api.HeaderActions","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.HeaderActions\">sap.fe.test.api.HeaderActions</a> instance.</p>","href":"api/sap.fe.test.ObjectPage.actions#methods/onHeader","code":"<pre class=\"prettyprint\">onHeader() : sap.fe.test.api.HeaderActions</pre>"},{"name":"onTable","visibility":"public","returnValue":{"type":"sap.fe.test.api.TableActions","description":"<p>The available table actions</p>","types":[{"value":"sap.fe.test.api.TableActions","href":"api/sap.fe.test.api.TableActions","linkEnabled":true}]},"parameters":[{"name":"vTableIdentifier","optional":false,"description":"<p>The identifier of the table, or its header title</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.TableIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.TableIdentifier"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.TableActions\">sap.fe.test.api.TableActions</a> instance for the specified table.</p>","href":"api/sap.fe.test.ObjectPage.actions#methods/onTable","code":"<pre class=\"prettyprint\">onTable(vTableIdentifier) : sap.fe.test.api.TableActions</pre>"}],"displayName":"sap.fe.test.ObjectPage.actions","title":"namespace sap.fe.test.ObjectPage.actions","subTitle":""},{"kind":"namespace","name":"sap.fe.test.ObjectPage.assertions","basename":"assertions","resource":"sap/fe/test/ObjectPage.js","module":"sap/fe/test/ObjectPage","export":"assertions","static":true,"visibility":"public","extends":"sap.fe.test.TemplatePage.assertions","description":"<p><p>ObjectPage assertions</p></p>","methods":[{"name":"onFooter","visibility":"public","returnValue":{"type":"sap.fe.test.api.FooterAssertionsOP","description":"<p>The available footer assertions</p>","types":[{"value":"sap.fe.test.api.FooterAssertionsOP","href":"api/sap.fe.test.api.FooterAssertionsOP","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.FooterAssertionsOP\">sap.fe.test.api.FooterAssertionsOP</a> instance.</p>","href":"api/sap.fe.test.ObjectPage.assertions#methods/onFooter","code":"<pre class=\"prettyprint\">onFooter() : sap.fe.test.api.FooterAssertionsOP</pre>"},{"name":"onForm","visibility":"public","returnValue":{"type":"sap.fe.test.api.FormAssertions","description":"<p>The available form actions</p>","types":[{"value":"sap.fe.test.api.FormAssertions","href":"api/sap.fe.test.api.FormAssertions","linkEnabled":true}]},"parameters":[{"name":"vFormIdentifier","optional":false,"description":"<p>The identifier of the form, or its title</p>","types":[{"value":"sap.fe.test.api.FormIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.FormIdentifier"},{"value":"string"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.FormAssertions\">sap.fe.test.api.FormAssertions</a> instance.</p>","href":"api/sap.fe.test.ObjectPage.assertions#methods/onForm","code":"<pre class=\"prettyprint\">onForm(vFormIdentifier) : sap.fe.test.api.FormAssertions</pre>"},{"name":"onHeader","visibility":"public","returnValue":{"type":"sap.fe.test.api.HeaderAssertions","description":"<p>The available header assertions</p>","types":[{"value":"sap.fe.test.api.HeaderAssertions","href":"api/sap.fe.test.api.HeaderAssertions","linkEnabled":true}]},"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.HeaderAssertions\">sap.fe.test.api.HeaderAssertions</a> instance.</p>","href":"api/sap.fe.test.ObjectPage.assertions#methods/onHeader","code":"<pre class=\"prettyprint\">onHeader() : sap.fe.test.api.HeaderAssertions</pre>"},{"name":"onTable","visibility":"public","returnValue":{"type":"sap.fe.test.api.TableAssertions","description":"<p>The available table assertions</p>","types":[{"value":"sap.fe.test.api.TableAssertions","href":"api/sap.fe.test.api.TableAssertions","linkEnabled":true}]},"parameters":[{"name":"vTableIdentifier","optional":false,"description":"<p>The identifier of the table, or its header title</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.TableIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.TableIdentifier"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.TableAssertions\">sap.fe.test.api.TableAssertions</a> instance for the specified table.</p>","href":"api/sap.fe.test.ObjectPage.assertions#methods/onTable","code":"<pre class=\"prettyprint\">onTable(vTableIdentifier) : sap.fe.test.api.TableAssertions</pre>"}],"displayName":"sap.fe.test.ObjectPage.assertions","title":"namespace sap.fe.test.ObjectPage.assertions","subTitle":""},{"kind":"class","name":"sap.fe.test.Shell","basename":"Shell","resource":"sap/fe/test/Shell.js","module":"sap/fe/test/Shell","export":"","static":true,"visibility":"public","description":"<p>Provides a test page definition for the shell.</p><p>When using <a target=\"_self\" href=\"api/sap.fe.test.JourneyRunner\">sap.fe.test.JourneyRunner</a>, this page is made available by default via <code>onTheShell</code>.</p>","constructor":{"visibility":"public","parameters":[{"name":"aAdditionalPageDefinitions","optional":true,"repeatable":true,"description":"<p>Additional custom page functions, provided in an object containing <code>actions</code> and <code>assertions</code></p>","phoneName":"aAdditionalPageDefinitions","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""}],"description":"<p>Constructs a test page definition for the shell.</p>","references":[],"codeExample":"<pre class=\"prettyprint\">new sap.fe.test.Shell(aAdditionalPageDefinitions?)</pre>"},"methods":[{"name":"iNavigateBack","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Navigates back via shell back button.</p>","href":"api/sap.fe.test.Shell#methods/iNavigateBack","code":"<pre class=\"prettyprint\">iNavigateBack() : object</pre>"},{"name":"iNavigateHome","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Navigates to the launch pad via home button.</p>","href":"api/sap.fe.test.Shell#methods/iNavigateHome","code":"<pre class=\"prettyprint\">iNavigateHome() : object</pre>"},{"name":"iNavigateViaMenu","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sItem","optional":false,"description":"<p>The label of the navigation item</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Navigates via a navigation item in the shell's navigation menu.</p>","href":"api/sap.fe.test.Shell#methods/iNavigateViaMenu","code":"<pre class=\"prettyprint\">iNavigateViaMenu(sItem) : object</pre>"},{"name":"iOpenNavigationMenu","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Opens the navigation menu in the shell header.</p>","href":"api/sap.fe.test.Shell#methods/iOpenNavigationMenu","code":"<pre class=\"prettyprint\">iOpenNavigationMenu() : object</pre>"},{"name":"iPressTile","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"parameters":[{"name":"sTarget","optional":false,"description":"<p>The target application (hash)</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Selecting a tile in the launchpad by its target app, for example <code>iPressTile(\"SalesOrder-manage\")</code>.</p>","href":"api/sap.fe.test.Shell#methods/iPressTile","code":"<pre class=\"prettyprint\">iPressTile(sTarget) : object</pre>"}],"displayName":"sap.fe.test.Shell","title":"class sap.fe.test.Shell","subTitle":""},{"kind":"class","name":"sap.fe.test.TemplatePage","basename":"TemplatePage","resource":"sap/fe/test/TemplatePage.js","module":"sap/fe/test/TemplatePage","export":"","static":true,"visibility":"public","description":"<p>Provides a test page definition for a template page with the corresponding parameters.</p>","displayName":"sap.fe.test.TemplatePage","nodes":[{"name":"sap.fe.test.TemplatePage.actions","description":"<p>TemplatePage actions</p>","href":"api/sap.fe.test.TemplatePage.actions"},{"name":"sap.fe.test.TemplatePage.assertions","description":"<p>Assertions that are available to all template pages used in SAP Fiori elements.</p>","href":"api/sap.fe.test.TemplatePage.assertions"}],"title":"class sap.fe.test.TemplatePage","subTitle":""},{"kind":"namespace","name":"sap.fe.test.TemplatePage.actions","basename":"actions","resource":"sap/fe/test/TemplatePage.js","module":"sap/fe/test/TemplatePage","export":"actions","static":true,"visibility":"public","description":"<p><p>TemplatePage actions</p></p>","methods":[{"name":"onActionDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogActions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogActions","href":"api/sap.fe.test.api.DialogActions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Action })</code>.</p>","href":"api/sap.fe.test.TemplatePage.actions#methods/onActionDialog","code":"<pre class=\"prettyprint\">onActionDialog() : sap.fe.test.api.DialogActions</pre>"},{"name":"onConfirmationDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogActions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogActions","href":"api/sap.fe.test.api.DialogActions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Confirmation })</code>.</p>","href":"api/sap.fe.test.TemplatePage.actions#methods/onConfirmationDialog","code":"<pre class=\"prettyprint\">onConfirmationDialog() : sap.fe.test.api.DialogActions</pre>"},{"name":"onCreateDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogCreateActions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogCreateActions","href":"api/sap.fe.test.api.DialogCreateActions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Create })</code>.</p>","href":"api/sap.fe.test.TemplatePage.actions#methods/onCreateDialog","code":"<pre class=\"prettyprint\">onCreateDialog() : sap.fe.test.api.DialogCreateActions</pre>"},{"name":"onDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogActions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogActions","href":"api/sap.fe.test.api.DialogActions","linkEnabled":true}]},"parameters":[{"name":"vDialogIdentifier","optional":false,"description":"<p>The identifier of the dialog, or its title</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.DialogIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.DialogIdentifier"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.DialogActions\">sap.fe.test.api.DialogActions</a> instance.</p>","href":"api/sap.fe.test.TemplatePage.actions#methods/onDialog","code":"<pre class=\"prettyprint\">onDialog(vDialogIdentifier) : sap.fe.test.api.DialogActions</pre>"},{"name":"onErrorDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogActions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogActions","href":"api/sap.fe.test.api.DialogActions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Error })</code>.</p>","href":"api/sap.fe.test.TemplatePage.actions#methods/onErrorDialog","code":"<pre class=\"prettyprint\">onErrorDialog() : sap.fe.test.api.DialogActions</pre>"},{"name":"onMessageDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogMessageActions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogMessageActions","href":"api/sap.fe.test.api.DialogMessageActions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Message })</code>.</p>","href":"api/sap.fe.test.TemplatePage.actions#methods/onMessageDialog","code":"<pre class=\"prettyprint\">onMessageDialog() : sap.fe.test.api.DialogMessageActions</pre>"},{"name":"onValueHelpDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogValueHelpActions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogValueHelpActions","href":"api/sap.fe.test.api.DialogValueHelpActions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })</code>.</p>","href":"api/sap.fe.test.TemplatePage.actions#methods/onValueHelpDialog","code":"<pre class=\"prettyprint\">onValueHelpDialog() : sap.fe.test.api.DialogValueHelpActions</pre>"}],"displayName":"sap.fe.test.TemplatePage.actions","title":"namespace sap.fe.test.TemplatePage.actions","subTitle":""},{"kind":"namespace","name":"sap.fe.test.TemplatePage.assertions","basename":"assertions","resource":"sap/fe/test/TemplatePage.js","module":"sap/fe/test/TemplatePage","export":"assertions","static":true,"visibility":"public","description":"<p><p>Assertions that are available to all template pages used in SAP Fiori elements.</p></p>","methods":[{"name":"iSeeThisPage","visibility":"public","returnValue":{"type":"object","description":"<p>The result of the <a target=\"_self\" href=\"api/sap.ui.test.Opa5#methods/waitFor\">sap.ui.test.Opa5#waitFor</a> function, to be used for chained statements</p>","types":[{"value":"object"}]},"description":"<p>Confirms the visibility of the current page.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/iSeeThisPage","code":"<pre class=\"prettyprint\">iSeeThisPage() : object</pre>"},{"name":"onActionDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogAssertions","description":"<p>The available dialog assertions</p>","types":[{"value":"sap.fe.test.api.DialogAssertions","href":"api/sap.fe.test.api.DialogAssertions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Action })</code>.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/onActionDialog","code":"<pre class=\"prettyprint\">onActionDialog() : sap.fe.test.api.DialogAssertions</pre>"},{"name":"onConfirmationDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogAssertions","description":"<p>The available dialog assertions</p>","types":[{"value":"sap.fe.test.api.DialogAssertions","href":"api/sap.fe.test.api.DialogAssertions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Confirmation })</code>.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/onConfirmationDialog","code":"<pre class=\"prettyprint\">onConfirmationDialog() : sap.fe.test.api.DialogAssertions</pre>"},{"name":"onCreateDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogCreateAssertions","description":"<p>The available dialog assertions</p>","types":[{"value":"sap.fe.test.api.DialogCreateAssertions","href":"api/sap.fe.test.api.DialogCreateAssertions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Create })</code>.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/onCreateDialog","code":"<pre class=\"prettyprint\">onCreateDialog() : sap.fe.test.api.DialogCreateAssertions</pre>"},{"name":"onDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogAssertions","description":"<p>The available dialog actions</p>","types":[{"value":"sap.fe.test.api.DialogAssertions","href":"api/sap.fe.test.api.DialogAssertions","linkEnabled":true}]},"parameters":[{"name":"vDialogIdentifier","optional":false,"description":"<p>The identifier of the dialog, or its title</p>","types":[{"value":"string"},{"value":"sap.fe.test.api.DialogIdentifier","linkEnabled":true,"href":"api/sap.fe.test.api.DialogIdentifier"}],"defaultValue":""}],"description":"<p>Returns a <a target=\"_self\" href=\"api/sap.fe.test.api.DialogAssertions\">sap.fe.test.api.DialogAssertions</a> instance.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/onDialog","code":"<pre class=\"prettyprint\">onDialog(vDialogIdentifier) : sap.fe.test.api.DialogAssertions</pre>"},{"name":"onErrorDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogAssertions","description":"<p>The available dialog assertions</p>","types":[{"value":"sap.fe.test.api.DialogAssertions","href":"api/sap.fe.test.api.DialogAssertions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Error })</code>.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/onErrorDialog","code":"<pre class=\"prettyprint\">onErrorDialog() : sap.fe.test.api.DialogAssertions</pre>"},{"name":"onMessageDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogMessageAssertions","description":"<p>The available dialog assertions</p>","types":[{"value":"sap.fe.test.api.DialogMessageAssertions","href":"api/sap.fe.test.api.DialogMessageAssertions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.Message })</code>.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/onMessageDialog","code":"<pre class=\"prettyprint\">onMessageDialog() : sap.fe.test.api.DialogMessageAssertions</pre>"},{"name":"onValueHelpDialog","visibility":"public","returnValue":{"type":"sap.fe.test.api.DialogValueHelpAssertions","description":"<p>The available dialog assertions</p>","types":[{"value":"sap.fe.test.api.DialogValueHelpAssertions","href":"api/sap.fe.test.api.DialogValueHelpAssertions","linkEnabled":true}]},"description":"<p>Shortcut for <code>onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })</code>.</p>","href":"api/sap.fe.test.TemplatePage.assertions#methods/onValueHelpDialog","code":"<pre class=\"prettyprint\">onValueHelpDialog() : sap.fe.test.api.DialogValueHelpAssertions</pre>"}],"displayName":"sap.fe.test.TemplatePage.assertions","title":"namespace sap.fe.test.TemplatePage.assertions","subTitle":""},{"name":"sap","displayName":"sap","kind":"namespace","nodes":[{"name":"sap.fe","description":"","href":"api/sap.fe"}],"title":"namespace sap","subTitle":""},{"name":"sap.fe","displayName":"sap.fe","kind":"namespace","nodes":[{"name":"sap.fe.test","description":"<p>Test library for SAP Fiori elements</p>","href":"api/sap.fe.test"}],"title":"namespace sap.fe","subTitle":""},{"name":"sap.fe.test.api","displayName":"sap.fe.test.api","kind":"namespace","nodes":[{"name":"sap.fe.test.api.ActionDialogFieldIdentifier","description":"<p>An action parameter dialog field identifier</p>","href":"api/sap.fe.test.api.ActionDialogFieldIdentifier"},{"name":"sap.fe.test.api.ActionIdentifier","description":"<p>An action identifier</p>","href":"api/sap.fe.test.api.ActionIdentifier"},{"name":"sap.fe.test.api.ColumnIdentifier","description":"<p>A column identifier</p>","href":"api/sap.fe.test.api.ColumnIdentifier"},{"name":"sap.fe.test.api.DialogActions","description":"","href":"api/sap.fe.test.api.DialogActions"},{"name":"sap.fe.test.api.DialogAssertions","description":"","href":"api/sap.fe.test.api.DialogAssertions"},{"name":"sap.fe.test.api.DialogCreateActions","description":"","href":"api/sap.fe.test.api.DialogCreateActions"},{"name":"sap.fe.test.api.DialogCreateAssertions","description":"","href":"api/sap.fe.test.api.DialogCreateAssertions"},{"name":"sap.fe.test.api.DialogIdentifier","description":"<p>A dialog identifier</p>","href":"api/sap.fe.test.api.DialogIdentifier"},{"name":"sap.fe.test.api.DialogMessageActions","description":"","href":"api/sap.fe.test.api.DialogMessageActions"},{"name":"sap.fe.test.api.DialogMessageAssertions","description":"","href":"api/sap.fe.test.api.DialogMessageAssertions"},{"name":"sap.fe.test.api.DialogType","description":"<p>Enum for supported dialog types.</p>","href":"api/sap.fe.test.api.DialogType"},{"name":"sap.fe.test.api.DialogValueHelpActions","description":"","href":"api/sap.fe.test.api.DialogValueHelpActions"},{"name":"sap.fe.test.api.DialogValueHelpAssertions","description":"","href":"api/sap.fe.test.api.DialogValueHelpAssertions"},{"name":"sap.fe.test.api.EditState","description":"<p>Enum for supported editing states.</p>","href":"api/sap.fe.test.api.EditState"},{"name":"sap.fe.test.api.FieldIdentifier","description":"<p>A field identifier</p>","href":"api/sap.fe.test.api.FieldIdentifier"},{"name":"sap.fe.test.api.FilterBarActions","description":"","href":"api/sap.fe.test.api.FilterBarActions"},{"name":"sap.fe.test.api.FilterBarAPI","description":"","href":"api/sap.fe.test.api.FilterBarAPI"},{"name":"sap.fe.test.api.FilterBarAssertions","description":"","href":"api/sap.fe.test.api.FilterBarAssertions"},{"name":"sap.fe.test.api.FilterFieldIdentifier","description":"<p>A filter field identifier</p>","href":"api/sap.fe.test.api.FilterFieldIdentifier"},{"name":"sap.fe.test.api.FooterActionsBase","description":"","href":"api/sap.fe.test.api.FooterActionsBase"},{"name":"sap.fe.test.api.FooterActionsOP","description":"","href":"api/sap.fe.test.api.FooterActionsOP"},{"name":"sap.fe.test.api.FooterAssertionsBase","description":"","href":"api/sap.fe.test.api.FooterAssertionsBase"},{"name":"sap.fe.test.api.FooterAssertionsOP","description":"","href":"api/sap.fe.test.api.FooterAssertionsOP"},{"name":"sap.fe.test.api.FormActions","description":"","href":"api/sap.fe.test.api.FormActions"},{"name":"sap.fe.test.api.FormAPI","description":"","href":"api/sap.fe.test.api.FormAPI"},{"name":"sap.fe.test.api.FormAssertions","description":"","href":"api/sap.fe.test.api.FormAssertions"},{"name":"sap.fe.test.api.FormIdentifier","description":"<p>A form identifier</p>","href":"api/sap.fe.test.api.FormIdentifier"},{"name":"sap.fe.test.api.HeaderActions","description":"","href":"api/sap.fe.test.api.HeaderActions"},{"name":"sap.fe.test.api.HeaderActionsLR","description":"","href":"api/sap.fe.test.api.HeaderActionsLR"},{"name":"sap.fe.test.api.HeaderAssertions","description":"","href":"api/sap.fe.test.api.HeaderAssertions"},{"name":"sap.fe.test.api.HeaderAssertionsLR","description":"","href":"api/sap.fe.test.api.HeaderAssertionsLR"},{"name":"sap.fe.test.api.HeaderFacetIdentifier","description":"<p>An identifier for the header facet</p>","href":"api/sap.fe.test.api.HeaderFacetIdentifier"},{"name":"sap.fe.test.api.SectionIdentifier","description":"<p>A section identifier</p>","href":"api/sap.fe.test.api.SectionIdentifier"},{"name":"sap.fe.test.api.TableActions","description":"","href":"api/sap.fe.test.api.TableActions"},{"name":"sap.fe.test.api.TableAPI","description":"","href":"api/sap.fe.test.api.TableAPI"},{"name":"sap.fe.test.api.TableAssertions","description":"","href":"api/sap.fe.test.api.TableAssertions"},{"name":"sap.fe.test.api.TableIdentifier","description":"<p>A table identifier</p>","href":"api/sap.fe.test.api.TableIdentifier"}],"title":"namespace sap.fe.test.api","subTitle":""}]}