abstract class sap.ui.test.actions.Action

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/test/actions/Action
Application Component: CA-UI5-TA

Actions for Opa5 - needs to implement an executeOn function that should simulate a user interaction on a control


Constructor

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.test.actions.Action()

Properties

Name Type Default Value Description
idSuffix string

Use this only if the target property or the default of the action does not work for your control. The id suffix of the DOM Element the press action will be executed on. For most of the controls you do not have to specify this, since the Control Adapters will find the correct DOM Element. But some controls have multiple DOM elements that could be target of your Action. Then you should set this property. For a detailed documentation of the suffix see sap.ui.core.Element#$

Since: 1.38.

Visibility: public

Methods Overview

Method Description
executeOn

Checks if the matcher is matching - will get an instance of sap.ui.core.Control as parameter Should be overwritten by subclasses

sap.ui.test.actions.Action.extend

Creates a new subclass of class sap.ui.test.actions.Action with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

getIdSuffix

Gets current value of property idSuffix.

Use this only if the target property or the default of the action does not work for your control. The id suffix of the DOM Element the press action will be executed on. For most of the controls you do not have to specify this, since the Control Adapters will find the correct DOM Element. But some controls have multiple DOM elements that could be target of your Action. Then you should set this property. For a detailed documentation of the suffix see sap.ui.core.Element#$

sap.ui.test.actions.Action.getMetadata

Returns a metadata object for class sap.ui.test.actions.Action.

setIdSuffix

Sets a new value for property idSuffix.

Use this only if the target property or the default of the action does not work for your control. The id suffix of the DOM Element the press action will be executed on. For most of the controls you do not have to specify this, since the Control Adapters will find the correct DOM Element. But some controls have multiple DOM elements that could be target of your Action. Then you should set this property. For a detailed documentation of the suffix see sap.ui.core.Element#$

When called with a value of null or undefined, the default value of the property will be restored.

executeOn

Checks if the matcher is matching - will get an instance of sap.ui.core.Control as parameter Should be overwritten by subclasses

Param Type DefaultValue Description
element sap.ui.core.Control

the sap.ui.core.Element or a control (extends element) the action will be executed on

sap.ui.test.actions.Action.extend

Creates a new subclass of class sap.ui.test.actions.Action with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getIdSuffix

Gets current value of property idSuffix.

Use this only if the target property or the default of the action does not work for your control. The id suffix of the DOM Element the press action will be executed on. For most of the controls you do not have to specify this, since the Control Adapters will find the correct DOM Element. But some controls have multiple DOM elements that could be target of your Action. Then you should set this property. For a detailed documentation of the suffix see sap.ui.core.Element#$

sap.ui.test.actions.Action.getMetadata

Returns a metadata object for class sap.ui.test.actions.Action.

setIdSuffix

Sets a new value for property idSuffix.

Use this only if the target property or the default of the action does not work for your control. The id suffix of the DOM Element the press action will be executed on. For most of the controls you do not have to specify this, since the Control Adapters will find the correct DOM Element. But some controls have multiple DOM elements that could be target of your Action. Then you should set this property. For a detailed documentation of the suffix see sap.ui.core.Element#$

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sIdSuffix string

New value for property idSuffix