io.appium.java_client

Interface TouchableElement<T extends WebElement>

All Superinterfaces:

FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, SearchContext, org.openqa.selenium.TakesScreenshot, WebElement

All Known Implementing Classes:

AndroidElement, IOSElement, MobileElement, YouiEngineElement

public interface TouchableElement<T extends WebElement>
extends WebElement, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath

It supposed that mobile elements could be tappable, swipeable, zoomable and so on. This interface extends WebElement and describes this behavior.

Method Summary

Methods

Modifier and Type	Method and Description
T	findElement(org.openqa.selenium.By by) Find the first WebElement using the given method.
T	findElementByClassName(String className)
T	findElementByCssSelector(String cssSelector)
T	findElementById(String id)
T	findElementByLinkText(String linkText)
T	findElementByName(String name)
T	findElementByPartialLinkText(String partialLinkText)
T	findElementByTagName(String tagName)
T	findElementByXPath(String xPath)
List<T>	findElements(org.openqa.selenium.By by) Find all elements within the current context using the given mechanism.
List<T>	findElementsByClassName(String className)
List<T>	findElementsByCssSelector(String cssSelector)
List<T>	findElementsById(String id)
List<T>	findElementsByLinkText(String linkText)
List<T>	findElementsByName(String name)
List<T>	findElementsByPartialLinkText(String partialLinkText)
List<T>	findElementsByTagName(String tagName)
List<T>	findElementsByXPath(String xPath)
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 interface org.openqa.selenium.WebElement

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

Methods inherited from interface org.openqa.selenium.TakesScreenshot

getScreenshotAs

Method Detail

findElements

List<T> 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 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

findElement

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 SearchContext

Specified by:

findElement in interface WebElement

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current context.

See Also:

By, WebDriver.Timeouts

findElementByClassName

T findElementByClassName(String className)

Specified by:

findElementByClassName in interface FindsByClassName

findElementsByClassName

List<T> findElementsByClassName(String className)

Specified by:

findElementsByClassName in interface FindsByClassName

findElementByCssSelector

T findElementByCssSelector(String cssSelector)

Specified by:

findElementByCssSelector in interface FindsByCssSelector

findElementsByCssSelector

List<T> findElementsByCssSelector(String cssSelector)

Specified by:

findElementsByCssSelector in interface FindsByCssSelector

findElementById

T findElementById(String id)

Specified by:

findElementById in interface FindsById

findElementsById

List<T> findElementsById(String id)

Specified by:

findElementsById in interface FindsById

findElementByLinkText

T findElementByLinkText(String linkText)

Specified by:

findElementByLinkText in interface FindsByLinkText

findElementsByLinkText

List<T> findElementsByLinkText(String linkText)

Specified by:

findElementsByLinkText in interface FindsByLinkText

findElementByPartialLinkText

T findElementByPartialLinkText(String partialLinkText)

Specified by:

findElementByPartialLinkText in interface FindsByLinkText

findElementsByPartialLinkText

List<T> findElementsByPartialLinkText(String partialLinkText)

Specified by:

findElementsByPartialLinkText in interface FindsByLinkText

findElementByName

T findElementByName(String name)

Specified by:

findElementByName in interface FindsByName

findElementsByName

List<T> findElementsByName(String name)

Specified by:

findElementsByName in interface FindsByName

findElementByTagName

T findElementByTagName(String tagName)

Specified by:

findElementByTagName in interface FindsByTagName

findElementsByTagName

List<T> findElementsByTagName(String tagName)

Specified by:

findElementsByTagName in interface FindsByTagName

findElementByXPath

T findElementByXPath(String xPath)

Specified by:

findElementByXPath in interface FindsByXPath

findElementsByXPath

List<T> findElementsByXPath(String xPath)

Specified by:

findElementsByXPath in interface FindsByXPath

pinch

void pinch()

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

void tap(int fingers,
       int duration)

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

void zoom()

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

void swipe(SwipeElementDirection direction,
         int duration)

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

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

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.