io.appium.java_client

Class MobileElement

java.lang.Object

org.openqa.selenium.remote.RemoteWebElement

io.appium.java_client.MobileElement

All Implemented Interfaces:

FindsByAccessibilityId, TouchableElement, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.internal.Locatable, org.openqa.selenium.internal.WrapsDriver, org.openqa.selenium.SearchContext, org.openqa.selenium.WebElement

Direct Known Subclasses:

AndroidElement, IOSElement

public abstract class MobileElement
extends org.openqa.selenium.remote.RemoteWebElement
implements FindsByAccessibilityId, TouchableElement

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openqa.selenium.remote.FileDetector	fileDetector

Fields inherited from class org.openqa.selenium.remote.RemoteWebElement

id, mouse, parent

Constructor Summary

Constructors

Constructor and Description
MobileElement()

Method Summary

Methods

Modifier and Type	Method and Description
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
org.openqa.selenium.WebElement	findElementByAccessibilityId(String using)
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElementsByAccessibilityId(String using)
org.openqa.selenium.Point	getCenter()
void	pinch() Convenience method for pinching the given element.
void	swipe(SwipeElementDirection direction, int duration) Convenience method for swiping on the given element to the given direction
void	swipe(SwipeElementDirection direction, int offsetFromStartBorder, int offsetFromEndBorder, int duration) Convenience method for swiping on the given element to the given direction
void	tap(int fingers, int duration) Convenience method for tapping the center of the given element
void	zoom() Convenience method for "zooming in" on the given element.

Methods inherited from class org.openqa.selenium.remote.RemoteWebElement

clear, click, equals, execute, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, getAttribute, getCoordinates, getCssValue, getId, getLocation, getSize, getTagName, getText, getWrappedDriver, hashCode, isDisplayed, isEnabled, isSelected, sendKeys, setFileDetector, setFoundBy, setId, setParent, submit, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openqa.selenium.WebElement

clear, click, getAttribute, getCssValue, getLocation, getSize, getTagName, getText, isDisplayed, isEnabled, isSelected, sendKeys, submit

Field Detail

fileDetector

protected org.openqa.selenium.remote.FileDetector fileDetector

Constructor Detail

MobileElement

public MobileElement()

Method Detail

findElements

public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebElement

Overrides:

findElements in class org.openqa.selenium.remote.RemoteWebElement

findElement

public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebElement

Overrides:

findElement in class org.openqa.selenium.remote.RemoteWebElement

findElementByAccessibilityId

public org.openqa.selenium.WebElement findElementByAccessibilityId(String using)

Specified by:

findElementByAccessibilityId in interface FindsByAccessibilityId

findElementsByAccessibilityId

public List<org.openqa.selenium.WebElement> findElementsByAccessibilityId(String using)

Specified by:

findElementsByAccessibilityId in interface FindsByAccessibilityId

getCenter

public org.openqa.selenium.Point getCenter()

pinch

public void pinch()

Description copied from interface: TouchableElement

Convenience method for pinching the given element. "pinching" refers to the action of two appendages pressing the screen and sliding towards each other. NOTE: This convenience method places the initial touches around the element, if this would happen to place one of them off the screen, appium with return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

Specified by:

pinch in interface TouchableElement

tap

public void tap(int fingers,
       int duration)

Description copied from interface: TouchableElement

Convenience method for tapping the center of the given element

Specified by:

tap in interface TouchableElement

Parameters:

fingers - number of fingers/appendages to tap with

duration - how long between pressing down, and lifting fingers/appendages

zoom

public void zoom()

Description copied from interface: TouchableElement

Convenience method for "zooming in" on the given element. "zooming in" refers to the action of two appendages pressing the screen and sliding away from each other. NOTE: This convenience method slides touches away from the element, if this would happen to place one of them off the screen, appium will return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

Specified by:

zoom in interface TouchableElement

swipe

public void swipe(SwipeElementDirection direction,
         int duration)

Description copied from interface: TouchableElement

Convenience method for swiping on the given element to the given direction

Specified by:

swipe in interface TouchableElement

Parameters:

direction - UP, DOWN, LEFT, RIGHT

duration - amount of time in milliseconds for the entire swipe action to take

swipe

public void swipe(SwipeElementDirection direction,
         int offsetFromStartBorder,
         int offsetFromEndBorder,
         int duration)
           throws IllegalCoordinatesException

Description copied from interface: TouchableElement

Convenience method for swiping on the given element to the given direction

Specified by:

swipe in interface TouchableElement

Parameters:

direction - direction UP, DOWN, LEFT, RIGHT

offsetFromEndBorder - is the offset from the border of the element where the swiping should be started. If direction is UP then this is offset from the bottom of the element. If direction is DOWN then this is offset from the top of the element. If direction is RIGHT then this is offset from the left border of the element. If direction is LEFT then this is offset from the right border of the element.

duration - amount of time in milliseconds for the entire swipe action to take

Throws:

IllegalCoordinatesException - when resulted coordinates are out of the element borders or disagree with the given direction