class sap.ui.test.actions.Scroll

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

The Scroll action is used to simulate a scroll interaction with a control. The control should be scrollable and use a sap.ui.core.delegate.ScrollEnablement delegate. Supported controls include: sap.uxap.ObjectPageLayout, sap.m.Dialog, sap.m.Page, sap.f.DynamicPage


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.Scroll(sId?, mSettings?)
Param Type Default Value Description
sId? string

Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can be omitted, no matter whether mSettings are given or not!

mSettings? object

Optional object with initial settings for the new instance


Properties

Name Type Default Value Description
x int 0 Visibility: public
y int 0 Visibility: public

Borrowed 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
sap.ui.test.actions.Scroll.extend

Creates a new subclass of class sap.ui.test.actions.Scroll 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.test.actions.Action.extend.

sap.ui.test.actions.Scroll.getMetadata

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

getX

Gets current value of property x.

Default value is 0.

getY

Gets current value of property y.

Default value is 0.

setX

Sets a new value for property x.

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

Default value is 0.

setY

Sets a new value for property y.

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

Default value is 0.

sap.ui.test.actions.Scroll.extend

Creates a new subclass of class sap.ui.test.actions.Scroll 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.test.actions.Action.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

sap.ui.test.actions.Scroll.getMetadata

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

getX

Gets current value of property x.

Default value is 0.

getY

Gets current value of property y.

Default value is 0.

setX

Sets a new value for property x.

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

Default value is 0.

Param Type DefaultValue Description
iX int 0

New value for property x

setY

Sets a new value for property y.

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

Default value is 0.

Param Type DefaultValue Description
iY int 0

New value for property y