UiObject (SeLion Client 1.2.0 API)

java.lang.Object
- com.paypal.selion.platform.mobile.android.UiObject

All Implemented Interfaces:

UserinterfaceObject, MobileElement

Direct Known Subclasses:

UiButton, UiImage, UiLabel, UiList, UiSlider, UiSwitch, UiTextView
```
public class UiObject
extends Object
implements UserinterfaceObject, MobileElement
```
UiObject implements UserinterfaceObject and forms the base class of all Android UI automation elements.

Field Summary

Fields
Modifier and Type Field and Description

protected SeLionAndroidBridgeDriver driver

protected String locator

Fields
Modifier and Type	Field and Description
`protected SeLionAndroidBridgeDriver`	`driver`
`protected String`	`locator`

Constructor Summary

Constructors
Constructor and Description

UiObject(String locator)

Constructors
Constructor and Description
`UiObject(String locator)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearText()` Clears the existing text contents in an editable field.
`void`	`click(Object... expected)` Performs a click at the center of the visible bounds of the UI element represented by this UiObject.
`void`	`clickBottomRight(Object... expected)` Clicks the bottom and right corner of the UI element.
`void`	`clickTopLeft(Object... expected)` Clicks the top and left corner of the UI element.
`org.openqa.selenium.WebElement`	`findElement(String locator)` Finds the corresponding web element using the string locator.
`protected SeLionAndroidBridgeDriver`	`getBridgeDriver()`
`String`	`getLocator()` Returns the locator.
`String`	`getText()` Reads the text property of the UI element.
`String`	`getValue()` Returns a string containing a value attribute specific to the type of element.
`boolean`	`isCheckable()` Checks if the UI element's checkable property is currently true.
`boolean`	`isChecked()` Checks if the UI element's checked property is currently true.
`boolean`	`isClickable()` Checks if the UI element's clickable property is currently true.
`boolean`	`isEnabled()` Checks if the UI element's enabled property is currently true.
`boolean`	`isFocusable()` Checks if the UI element's focusable property is currently true.
`boolean`	`isFocused()` Checks if the UI element's focused property is currently true.
`boolean`	`isLongClickable()` Checks if the view's long-clickable property is currently true.
`boolean`	`isScrollable()` Checks if the view's scrollable property is currently true.
`boolean`	`isSelected()` Checks if the UI element's selected property is currently true.
`void`	`longClick(Object... expected)` Long clicks the center of the visible bounds of the UI element.
`void`	`longClickBottomRight(Object... expected)` Long clicks bottom and right corner of the UI element.
`void`	`longClickTopLeft(Object... expected)` Long clicks on the top and left corner of the UI element.
`void`	`setText(String text)` Sets the text in an editable field, after clearing the field's content.
`void`	`swipeDown(Object... expected)` Performs the swipe down action on the UiObject.
`void`	`swipeLeft(Object... expected)` Performs the swipe left action on the UiObject.
`void`	`swipeRight(Object... expected)` Performs the swipe right action on the UiObject.
`void`	`swipeUp(Object... expected)` Performs the swipe up action on the UiObject.
`void`	`tap(Object... expected)` Taps the specified element and optionally waits for the provided expected elements.
`protected void`	`waitFor(Object... expected)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - locator
```
protected String locator
```
  - driver
```
protected SeLionAndroidBridgeDriver driver
```
- Constructor Detail
  - UiObject
```
public UiObject(String locator)
```
- Method Detail
  - clearText
```
public void clearText()
```
    Description copied from interface: UserinterfaceObject
    
    Clears the existing text contents in an editable field.
    
    Specified by:
    
    clearText in interface UserinterfaceObject
  - click
```
public void click(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Performs a click at the center of the visible bounds of the UI element represented by this UiObject.
    
    Specified by:
    
    click in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - clickBottomRight
```
public void clickBottomRight(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Clicks the bottom and right corner of the UI element.
    
    Specified by:
    
    clickBottomRight in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - clickTopLeft
```
public void clickTopLeft(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Clicks the top and left corner of the UI element.
    
    Specified by:
    
    clickTopLeft in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - getText
```
public String getText()
```
    Description copied from interface: UserinterfaceObject
    
    Reads the text property of the UI element.
    
    Specified by:
    
    getText in interface UserinterfaceObject
    
    Returns:
    
    Text property of this UI element.
  - isCheckable
```
public boolean isCheckable()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the UI element's checkable property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isCheckable in interface UserinterfaceObject
    
    Returns:
    
    Value of checkable property.
  - isChecked
```
public boolean isChecked()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the UI element's checked property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isChecked in interface UserinterfaceObject
    
    Returns:
    
    Value of checked property.
  - isClickable
```
public boolean isClickable()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the UI element's clickable property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isClickable in interface UserinterfaceObject
    
    Returns:
    
    Value of clickable property.
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the UI element's enabled property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isEnabled in interface UserinterfaceObject
    
    Returns:
    
    Value of enabled property.
  - isFocusable
```
public boolean isFocusable()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the UI element's focusable property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isFocusable in interface UserinterfaceObject
    
    Returns:
    
    Value of focusable property.
  - isFocused
```
public boolean isFocused()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the UI element's focused property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isFocused in interface UserinterfaceObject
    
    Returns:
    
    Value of focused property.
  - isLongClickable
```
public boolean isLongClickable()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the view's long-clickable property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isLongClickable in interface UserinterfaceObject
    
    Returns:
    
    Value of long-clickable property.
  - isScrollable
```
public boolean isScrollable()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the view's scrollable property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isScrollable in interface UserinterfaceObject
    
    Returns:
    
    Value of scrollable property.
  - isSelected
```
public boolean isSelected()
```
    Description copied from interface: UserinterfaceObject
    
    Checks if the UI element's selected property is currently true. Returns false if the underlying property is null.
    
    Specified by:
    
    isSelected in interface UserinterfaceObject
    
    Returns:
    
    Value of selected property.
  - longClick
```
public void longClick(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Long clicks the center of the visible bounds of the UI element.
    
    Specified by:
    
    longClick in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - longClickBottomRight
```
public void longClickBottomRight(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Long clicks bottom and right corner of the UI element.
    
    Specified by:
    
    longClickBottomRight in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - longClickTopLeft
```
public void longClickTopLeft(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Long clicks on the top and left corner of the UI element.
    
    Specified by:
    
    longClickTopLeft in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - setText
```
public void setText(String text)
```
    Description copied from interface: UserinterfaceObject
    
    Sets the text in an editable field, after clearing the field's content.
    
    Specified by:
    
    setText in interface UserinterfaceObject
    
    Parameters:
    
    text - String to set.
  - swipeLeft
```
public void swipeLeft(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Performs the swipe left action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable.
    
    Specified by:
    
    swipeLeft in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - swipeRight
```
public void swipeRight(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Performs the swipe right action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable.
    
    Specified by:
    
    swipeRight in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - swipeUp
```
public void swipeUp(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Performs the swipe up action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable.
    
    Specified by:
    
    swipeUp in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - swipeDown
```
public void swipeDown(Object... expected)
```
    Description copied from interface: UserinterfaceObject
    
    Performs the swipe down action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable.
    
    Specified by:
    
    swipeDown in interface UserinterfaceObject
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UiObject, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - findElement
```
public org.openqa.selenium.WebElement findElement(String locator)
```
    Description copied from interface: MobileElement
    
    Finds the corresponding web element using the string locator. The locator is internally converted into By entity and fed to RemoteWebElement.findElement(By) for further processing.
    
    Specified by:
    
    findElement in interface MobileElement
    
    Parameters:
    
    locator - A String that represents the means to locate this element (could be id/name/xpath/css locator).
    
    Returns:
    
    Instance of WebElement found by the locator.
  - tap
```
public void tap(Object... expected)
```
    Description copied from interface: MobileElement
    
    Taps the specified element and optionally waits for the provided expected elements.
    
    Specified by:
    
    tap in interface MobileElement
    
    Parameters:
    
    expected - Expected entities in the form of objects extending UIAElement, xpath location in the form of String, instances of ExpectedCondition, or an instance of a WebPage
  - getValue
```
public String getValue()
```
    Description copied from interface: MobileElement
    
    Returns a string containing a value attribute specific to the type of element.
    
    Specified by:
    
    getValue in interface MobileElement
    
    Returns:
    
    The value of the element.
  - getLocator
```
public String getLocator()
```
    Returns the locator.
    
    Specified by:
    
    getLocator in interface MobileElement
    
    Returns:
    
    Locator of this UiObject
  - waitFor
```
protected void waitFor(Object... expected)
```
  - getBridgeDriver
```
protected SeLionAndroidBridgeDriver getBridgeDriver()
```

Class UiObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

locator

driver

Constructor Detail

UiObject

Method Detail

clearText

click

clickBottomRight

clickTopLeft

getText

isCheckable

isChecked

isClickable

isEnabled

isFocusable

isFocused

isLongClickable

isScrollable

isSelected

longClick

longClickBottomRight

longClickTopLeft

setText

swipeLeft

swipeRight

swipeUp

swipeDown

findElement

tap

getValue

getLocator

waitFor

getBridgeDriver