io.appium.java_client

Class MobileElement

java.lang.Object

org.openqa.selenium.remote.RemoteWebElement

io.appium.java_client.MobileElement

All Implemented Interfaces:

FindsByAccessibilityId<MobileElement>, TouchableElement<MobileElement>, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, org.openqa.selenium.internal.HasIdentity, org.openqa.selenium.internal.Locatable, org.openqa.selenium.internal.WrapsDriver, SearchContext, org.openqa.selenium.TakesScreenshot, WebElement

Direct Known Subclasses:

AndroidElement, IOSElement, YouiEngineElement

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) Find the first WebElement using the given method.
T	findElement(String by, String using)
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) Find all elements within the current context using the given mechanism.
List<MobileElement>	findElements(String by, String using)
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() Method returns central coordinates of an element.
String	getCssValue(String propertyName) Get the value of a given CSS property.
void	pinch() Convenience method for pinching the given element.
void	setValue(String value) This method sets the new value of the attribute "value".
void	submit() If this current element is a form, or an element within a form, then this will be submitted to the remote server.
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, 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()

Method returns central coordinates of an element.

Returns:

The instance of the Point

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.

offsetFromStartBorder - 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.

offsetFromEndBorder - is the offset from the border of the element where the swiping should be finished. If direction is UP then this is offset from the top of the element. If direction is DOWN then this is offset from the bottom of the element. If direction is RIGHT then this is offset from the right border of the element. If direction is LEFT then this is offset from the left 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)

Description copied from interface: WebElement

Find all elements within the current context using the given mechanism. When using xpath be aware that webdriver follows standard conventions: a search prefixed with "//" will search the entire document, not just the children of this current node. Use ".//" to limit your search to the children of this WebElement. This method is affected by the 'implicit wait' times in force at the time of execution. When implicitly waiting, this method will return as soon as there are more than 0 items in the found collection, or will return an empty list if the timeout is reached.

Specified by:

findElements in interface TouchableElement<MobileElement>

Specified by:

findElements in interface SearchContext

Specified by:

findElements in interface WebElement

Parameters:

by - The locating mechanism to use

Returns:

A list of all WebElements, or an empty list if nothing matches.

See Also:

By, WebDriver.Timeouts

findElements

public List<MobileElement> findElements(String by,
                               String using)

findElementsById

public List<MobileElement> findElementsById(String id)

Specified by:

findElementsById in interface TouchableElement<MobileElement>

Specified by:

findElementsById in interface FindsById

findElementsByLinkText

public List<MobileElement> findElementsByLinkText(String using)

Specified by:

findElementsByLinkText in interface TouchableElement<MobileElement>

Specified by:

findElementsByLinkText in interface FindsByLinkText

findElementsByPartialLinkText

public List<MobileElement> findElementsByPartialLinkText(String using)

Specified by:

findElementsByPartialLinkText in interface TouchableElement<MobileElement>

Specified by:

findElementsByPartialLinkText in interface FindsByLinkText

findElementsByTagName

public List<MobileElement> findElementsByTagName(String using)

Specified by:

findElementsByTagName in interface TouchableElement<MobileElement>

Specified by:

findElementsByTagName in interface FindsByTagName

findElementsByName

public List<MobileElement> findElementsByName(String using)

Specified by:

findElementsByName in interface TouchableElement<MobileElement>

Specified by:

findElementsByName in interface FindsByName

findElementsByClassName

public List<MobileElement> findElementsByClassName(String using)

Specified by:

findElementsByClassName in interface TouchableElement<MobileElement>

Specified by:

findElementsByClassName in interface FindsByClassName

findElementsByCssSelector

public List<MobileElement> findElementsByCssSelector(String using)

Specified by:

findElementsByCssSelector in interface TouchableElement<MobileElement>

Specified by:

findElementsByCssSelector in interface FindsByCssSelector

findElementsByXPath

public List<MobileElement> findElementsByXPath(String using)

Specified by:

findElementsByXPath in interface TouchableElement<MobileElement>

Specified by:

findElementsByXPath in interface FindsByXPath

findElementsByAccessibilityId

public List<MobileElement> findElementsByAccessibilityId(String using)

Specified by:

findElementsByAccessibilityId in interface FindsByAccessibilityId<MobileElement>

setValue

public void setValue(String value)

This method sets the new value of the attribute "value".

Parameters:

value - is the new value which should be set

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)

Description copied from interface: WebElement

Find the first WebElement using the given method. See the note in WebElement.findElements(By) about finding via XPath. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached.

findElement should not be used to look for non-present elements, use WebElement.findElements(By) and assert zero length response instead.

Specified by:

findElement in interface TouchableElement<T extends WebElement>

Specified by:

findElement in interface SearchContext

Specified by:

findElement in interface WebElement

Overrides:

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

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current context.

See Also:

By, WebDriver.Timeouts

findElement

public T findElement(String by,
            String using)

Overrides:

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

findElementById

public T findElementById(String id)

Specified by:

findElementById in interface TouchableElement<T extends WebElement>

Specified by:

findElementById in interface 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 TouchableElement<T extends WebElement>

Specified by:

findElementByLinkText in interface 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 TouchableElement<T extends WebElement>

Specified by:

findElementByPartialLinkText in interface 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 TouchableElement<T extends WebElement>

Specified by:

findElementByTagName in interface FindsByTagName

Overrides:

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

findElementByName

public T findElementByName(String using)

Specified by:

findElementByName in interface TouchableElement<T extends WebElement>

Specified by:

findElementByName in interface FindsByName

Overrides:

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

findElementByClassName

public T findElementByClassName(String using)

Specified by:

findElementByClassName in interface TouchableElement<T extends WebElement>

Specified by:

findElementByClassName in interface 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 TouchableElement<T extends WebElement>

Specified by:

findElementByCssSelector in interface 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 TouchableElement<T extends WebElement>

Specified by:

findElementByXPath in interface FindsByXPath

Overrides:

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

findElementByAccessibilityId

public T findElementByAccessibilityId(String using)

Specified by:

findElementByAccessibilityId in interface FindsByAccessibilityId<T extends WebElement>

submit

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

Description copied from interface: WebElement

If this current element is a form, or an element within a form, then this will be submitted to the remote server. If this causes the current page to change, then this method will block until the new page is loaded.

Specified by:

submit in interface 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

Description copied from interface: WebElement

Get the value of a given CSS property. Color values should be returned as rgba strings, so, for example if the "background-color" property is set as "green" in the HTML source, the returned value will be "rgba(0, 255, 0, 1)".

Note that shorthand CSS properties (e.g. background, font, border, border-top, margin, margin-top, padding, padding-top, list-style, outline, pause, cue) are not returned, in accordance with the DOM CSS2 specification - you should directly access the longhand properties (e.g. background-color) to access the desired values.

Specified by:

getCssValue in interface WebElement

Overrides:

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

Parameters:

propertyName - the css property name of the element

Returns:

The current, computed value of the property.

Throws:

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