io.appium.java_client

Class MobileElement

java.lang.Object

org.openqa.selenium.remote.RemoteWebElement

io.appium.java_client.MobileElement

All Implemented Interfaces:

FindsByAccessibilityId<MobileElement>, GenericFindsByClassName<MobileElement>, GenericFindsByCssSelector<MobileElement>, GenericFindsById<MobileElement>, GenericFindsByLinkText<MobileElement>, GenericFindsByName<MobileElement>, GenericFindsByTagName<MobileElement>, GenericFindsByXPath<MobileElement>, GenericSearchContext<MobileElement>, 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.HasIdentity, org.openqa.selenium.internal.Locatable, org.openqa.selenium.internal.WrapsDriver, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement

Direct Known Subclasses:

AndroidElement, IOSElement

public abstract class MobileElement
extends org.openqa.selenium.remote.RemoteWebElement

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.remote.Response	execute(String driverCommand, Map<String,?> parameters)
T	findElement(org.openqa.selenium.By by)
T	findElementByAccessibilityId(String using)
T	findElementByClassName(String using)
T	findElementByCssSelector(String using)
T	findElementById(String id)
T	findElementByLinkText(String using)
T	findElementByName(String using)
T	findElementByPartialLinkText(String using)
T	findElementByTagName(String using)
T	findElementByXPath(String using)
List<MobileElement>	findElements(org.openqa.selenium.By by)
List<MobileElement>	findElementsByAccessibilityId(String using)
List<MobileElement>	findElementsByClassName(String using)
List<MobileElement>	findElementsByCssSelector(String using)
List<MobileElement>	findElementsById(String id)
List<MobileElement>	findElementsByLinkText(String using)
List<MobileElement>	findElementsByName(String using)
List<MobileElement>	findElementsByPartialLinkText(String using)
List<MobileElement>	findElementsByTagName(String using)
List<MobileElement>	findElementsByXPath(String using)
org.openqa.selenium.Point	getCenter()
String	getCssValue(String propertyName)
void	pinch() Convenience method for pinching the given element.
void	submit()
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, findElement, findElements, getAttribute, getCoordinates, getId, getLocation, getRect, getScreenshotAs, getSize, getTagName, getText, getWrappedDriver, hashCode, isDisplayed, isEnabled, isSelected, sendKeys, setFileDetector, setFoundBy, setId, setParent, 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, getLocation, getRect, getSize, getTagName, getText, isDisplayed, isEnabled, isSelected, sendKeys

Methods inherited from interface org.openqa.selenium.TakesScreenshot

getScreenshotAs

Field Detail

fileDetector

protected org.openqa.selenium.remote.FileDetector fileDetector

Constructor Detail

MobileElement

public MobileElement()

Method Detail

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.

tap

public void tap(int fingers,
       int duration)

Description copied from interface: TouchableElement

Convenience method for tapping the center of the given element

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.

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

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

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

findElements

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

Specified by:

findElements in interface GenericSearchContext<MobileElement>

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebElement

findElementsById

public List<MobileElement> findElementsById(String id)

Specified by:

findElementsById in interface GenericFindsById<MobileElement>

Specified by:

findElementsById in interface org.openqa.selenium.internal.FindsById

findElementsByLinkText

public List<MobileElement> findElementsByLinkText(String using)

Specified by:

findElementsByLinkText in interface GenericFindsByLinkText<MobileElement>

Specified by:

findElementsByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementsByPartialLinkText

public List<MobileElement> findElementsByPartialLinkText(String using)

Specified by:

findElementsByPartialLinkText in interface GenericFindsByLinkText<MobileElement>

Specified by:

findElementsByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementsByTagName

public List<MobileElement> findElementsByTagName(String using)

Specified by:

findElementsByTagName in interface GenericFindsByTagName<MobileElement>

Specified by:

findElementsByTagName in interface org.openqa.selenium.internal.FindsByTagName

findElementsByName

public List<MobileElement> findElementsByName(String using)

Specified by:

findElementsByName in interface GenericFindsByName<MobileElement>

Specified by:

findElementsByName in interface org.openqa.selenium.internal.FindsByName

findElementsByClassName

public List<MobileElement> findElementsByClassName(String using)

Specified by:

findElementsByClassName in interface GenericFindsByClassName<MobileElement>

Specified by:

findElementsByClassName in interface org.openqa.selenium.internal.FindsByClassName

findElementsByCssSelector

public List<MobileElement> findElementsByCssSelector(String using)

Specified by:

findElementsByCssSelector in interface GenericFindsByCssSelector<MobileElement>

Specified by:

findElementsByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

findElementsByXPath

public List<MobileElement> findElementsByXPath(String using)

Specified by:

findElementsByXPath in interface GenericFindsByXPath<MobileElement>

Specified by:

findElementsByXPath in interface org.openqa.selenium.internal.FindsByXPath

findElementsByAccessibilityId

public List<MobileElement> findElementsByAccessibilityId(String using)

Specified by:

findElementsByAccessibilityId in interface FindsByAccessibilityId<MobileElement>

execute

public org.openqa.selenium.remote.Response execute(String driverCommand,
                                          Map<String,?> parameters)

Overrides:

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

findElement

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

Specified by:

findElement in interface GenericSearchContext<T extends org.openqa.selenium.WebElement>

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

findElementById

public T findElementById(String id)

Specified by:

findElementById in interface GenericFindsById<T extends org.openqa.selenium.WebElement>

Specified by:

findElementById in interface org.openqa.selenium.internal.FindsById

Overrides:

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

findElementByLinkText

public T findElementByLinkText(String using)
                                                               throws org.openqa.selenium.WebDriverException

Specified by:

findElementByLinkText in interface GenericFindsByLinkText<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - his method doesn't work against native app UI.

findElementByPartialLinkText

public T findElementByPartialLinkText(String using)
                                                                      throws org.openqa.selenium.WebDriverException

Specified by:

findElementByPartialLinkText in interface GenericFindsByLinkText<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - his method doesn't work against native app UI.

findElementByTagName

public T findElementByTagName(String using)

Specified by:

findElementByTagName in interface GenericFindsByTagName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByTagName in interface org.openqa.selenium.internal.FindsByTagName

Overrides:

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

findElementByName

public T findElementByName(String using)

Specified by:

findElementByName in interface GenericFindsByName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByName in interface org.openqa.selenium.internal.FindsByName

Overrides:

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

findElementByClassName

public T findElementByClassName(String using)

Specified by:

findElementByClassName in interface GenericFindsByClassName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByClassName in interface org.openqa.selenium.internal.FindsByClassName

Overrides:

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

findElementByCssSelector

public T findElementByCssSelector(String using)
                                                                  throws org.openqa.selenium.WebDriverException

Specified by:

findElementByCssSelector in interface GenericFindsByCssSelector<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - his method doesn't work against native app UI.

findElementByXPath

public T findElementByXPath(String using)

Specified by:

findElementByXPath in interface GenericFindsByXPath<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByXPath in interface org.openqa.selenium.internal.FindsByXPath

Overrides:

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

findElementByAccessibilityId

public T findElementByAccessibilityId(String using)

Specified by:

findElementByAccessibilityId in interface FindsByAccessibilityId<T extends org.openqa.selenium.WebElement>

submit

public void submit()
            throws org.openqa.selenium.WebDriverException

Specified by:

submit in interface org.openqa.selenium.WebElement

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - because it may not work against native app UI.

getCssValue

public String getCssValue(String propertyName)
                   throws org.openqa.selenium.WebDriverException

Specified by:

getCssValue in interface org.openqa.selenium.WebElement

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - because it may not work against native app UI.