io.appium.java_client

Class MobileElement

java.lang.Object

org.openqa.selenium.remote.RemoteWebElement

io.appium.java_client.MobileElement

All Implemented Interfaces:

ExecutesMethod, FindsByAccessibilityId<MobileElement>, FindsByFluentSelector<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, WindowsElement, 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

Modifier and Type	Method and Description
org.openqa.selenium.remote.Response	execute(java.lang.String command) Executes JSONWP command and returns a response.
org.openqa.selenium.remote.Response	execute(java.lang.String driverCommand, java.util.Map<java.lang.String,?> parameters) Executes JSONWP command and returns a response.
T	findElement(org.openqa.selenium.By by) Find the first WebElement using the given method.
T	findElement(java.lang.String by, java.lang.String using) Method performs the searching for a single element by some selector defined by string and value of the given selector
T	findElementByClassName(java.lang.String using)
T	findElementByCssSelector(java.lang.String using)
T	findElementById(java.lang.String id)
T	findElementByLinkText(java.lang.String using)
T	findElementByName(java.lang.String using)
T	findElementByPartialLinkText(java.lang.String using)
T	findElementByTagName(java.lang.String using)
T	findElementByXPath(java.lang.String using)
java.util.List<MobileElement>	findElements(org.openqa.selenium.By by) Find all elements within the current context using the given mechanism.
java.util.List<MobileElement>	findElements(java.lang.String by, java.lang.String using) Method performs the searching for a list of elements by some selector defined by string and value of the given selector
java.util.List<MobileElement>	findElementsByAccessibilityId(java.lang.String using)
java.util.List<MobileElement>	findElementsByClassName(java.lang.String using)
java.util.List<MobileElement>	findElementsByCssSelector(java.lang.String using)
java.util.List<MobileElement>	findElementsById(java.lang.String id)
java.util.List<MobileElement>	findElementsByLinkText(java.lang.String using)
java.util.List<MobileElement>	findElementsByName(java.lang.String using)
java.util.List<MobileElement>	findElementsByPartialLinkText(java.lang.String using)
java.util.List<MobileElement>	findElementsByTagName(java.lang.String using)
java.util.List<MobileElement>	findElementsByXPath(java.lang.String using)
org.openqa.selenium.Point	getCenter() Method returns central coordinates of an element.
java.lang.String	getCssValue(java.lang.String propertyName) Get the value of a given CSS property.
void	pinch() Deprecated.
void	setValue(java.lang.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) Deprecated.
void	swipe(SwipeElementDirection direction, int offsetFromStartBorder, int offsetFromEndBorder, int duration) Deprecated.
void	tap(int fingers, int duration) Deprecated.
void	zoom() Deprecated.

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

Methods inherited from interface io.appium.java_client.FindsByAccessibilityId

findElementByAccessibilityId

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

tap

@Deprecated
public void tap(int fingers,
                             int duration)

Deprecated.

This method is deprecated and it is going to be removed soon.

Parameters:

fingers - number of fingers/appendages to tap with.

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

pinch

@Deprecated
public void pinch()

Deprecated.

This method is deprecated and it is going to be removed soon.

zoom

@Deprecated
public void zoom()

Deprecated.

This method is deprecated and it is going to be removed soon.

swipe

@Deprecated
public void swipe(SwipeElementDirection direction,
                               int duration)

Deprecated.

This method does nothing. It is going to be removed.

swipe

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

Deprecated.

This method does nothing. It is going to be removed.

Throws:

IllegalCoordinatesException

findElements

public java.util.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 java.util.List<MobileElement> findElements(java.lang.String by,
                                                  java.lang.String using)

Description copied from interface: FindsByFluentSelector

Method performs the searching for a list of elements by some selector defined by string and value of the given selector

Specified by:

findElements in interface FindsByFluentSelector<MobileElement>

Parameters:

by - is a string selector

using - is a value of the given selector

Returns:

a list of elements

findElementsById

public java.util.List<MobileElement> findElementsById(java.lang.String id)

Specified by:

findElementsById in interface TouchableElement<MobileElement>

Specified by:

findElementsById in interface FindsById

findElementsByLinkText

public java.util.List<MobileElement> findElementsByLinkText(java.lang.String using)

Specified by:

findElementsByLinkText in interface TouchableElement<MobileElement>

Specified by:

findElementsByLinkText in interface FindsByLinkText

findElementsByPartialLinkText

public java.util.List<MobileElement> findElementsByPartialLinkText(java.lang.String using)

Specified by:

findElementsByPartialLinkText in interface TouchableElement<MobileElement>

Specified by:

findElementsByPartialLinkText in interface FindsByLinkText

findElementsByTagName

public java.util.List<MobileElement> findElementsByTagName(java.lang.String using)

Specified by:

findElementsByTagName in interface TouchableElement<MobileElement>

Specified by:

findElementsByTagName in interface FindsByTagName

findElementsByName

public java.util.List<MobileElement> findElementsByName(java.lang.String using)

Specified by:

findElementsByName in interface TouchableElement<MobileElement>

Specified by:

findElementsByName in interface FindsByName

findElementsByClassName

public java.util.List<MobileElement> findElementsByClassName(java.lang.String using)

Specified by:

findElementsByClassName in interface TouchableElement<MobileElement>

Specified by:

findElementsByClassName in interface FindsByClassName

findElementsByCssSelector

public java.util.List<MobileElement> findElementsByCssSelector(java.lang.String using)

Specified by:

findElementsByCssSelector in interface TouchableElement<MobileElement>

Specified by:

findElementsByCssSelector in interface FindsByCssSelector

findElementsByXPath

public java.util.List<MobileElement> findElementsByXPath(java.lang.String using)

Specified by:

findElementsByXPath in interface TouchableElement<MobileElement>

Specified by:

findElementsByXPath in interface FindsByXPath

findElementsByAccessibilityId

public java.util.List<MobileElement> findElementsByAccessibilityId(java.lang.String using)

setValue

public void setValue(java.lang.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(java.lang.String driverCommand,
                                                   java.util.Map<java.lang.String,?> parameters)

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Overrides:

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

Parameters:

driverCommand - a JSONWP command

parameters - map of command parameters

Returns:

a result response

execute

public org.openqa.selenium.remote.Response execute(java.lang.String command)

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Parameters:

command - a JSONWP command

Returns:

a result response

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(java.lang.String by,
                     java.lang.String using)

Description copied from interface: FindsByFluentSelector

Method performs the searching for a single element by some selector defined by string and value of the given selector

Specified by:

findElement in interface FindsByFluentSelector<T extends WebElement>

Overrides:

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

Parameters:

by - is a string selector

using - is a value of the given selector

Returns:

the first found element

findElementById

public T findElementById(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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

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 java.lang.String getCssValue(java.lang.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.