UiElement (droiddriver 1.0.0-SNAPSHOT API)

All Known Implementing Classes:

BaseUiElement, UiAutomationElement, ViewElement
```
public interface UiElement
```
Represents an UI element within an Android App.
UI elements are generally views. Users can get attributes and perform actions. Note that actions often update UiElement, so users are advised not to store instances for later use -- the instances could become stale.

Field Summary

Fields
Modifier and Type Field and Description

static Predicate<UiElement> VISIBLE
Filters out invisible children.

Fields
Modifier and Type	Field and Description
`static Predicate<UiElement>`	`VISIBLE` Filters out invisible children.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`click()` Clicks this element.
`void`	`doubleClick()` Double-clicks this element.
`<T> T`	`get(Attribute attribute)`
`android.graphics.Rect`	`getBounds()` Gets the UiElement bounds in screen coordinates.
`java.util.List<? extends UiElement>`	`getChildren(Predicate<? super UiElement> predicate)` Gets an immutable `List` of immediate children that satisfy `predicate`.
`java.lang.String`	`getClassName()` Gets the class name of the underlying view.
`java.lang.String`	`getContentDescription()` Gets the content description of this element.
`InputInjector`	`getInjector()` Gets the `InputInjector` for injecting InputEvent.
`java.lang.String`	`getPackageName()` Gets the package name of this element.
`UiElement`	`getParent()` Gets the parent.
`java.lang.String`	`getResourceId()` Gets the resource id of this element.
`java.lang.String`	`getText()` Gets the text of this element.
`android.graphics.Rect`	`getVisibleBounds()` Gets the UiElement bounds in screen coordinates.
`boolean`	`isCheckable()`
`boolean`	`isChecked()`
`boolean`	`isClickable()`
`boolean`	`isEnabled()`
`boolean`	`isFocusable()`
`boolean`	`isFocused()`
`boolean`	`isLongClickable()`
`boolean`	`isPassword()`
`boolean`	`isScrollable()`
`boolean`	`isSelected()`
`boolean`	`isVisible()`
`void`	`longClick()` Long-clicks this element.
`boolean`	`perform(Action action)` Executes the given action.
`void`	`scroll(Direction.PhysicalDirection direction)` Scrolls in the given direction.
`void`	`setText(java.lang.String text)` Sets the text of this element.

- Field Detail
  - VISIBLE
```
static final Predicate<UiElement> VISIBLE
```
    Filters out invisible children.
- Method Detail
  - getText
```
java.lang.String getText()
```
    Gets the text of this element.
  - getContentDescription
```
java.lang.String getContentDescription()
```
    Gets the content description of this element.
  - getClassName
```
java.lang.String getClassName()
```
    Gets the class name of the underlying view. The actual name could be overridden.
    
    See Also:
    
    ViewElement.overrideClassName(java.lang.String, java.lang.String)
  - getResourceId
```
java.lang.String getResourceId()
```
    Gets the resource id of this element.
  - getPackageName
```
java.lang.String getPackageName()
```
    Gets the package name of this element.
  - isVisible
```
boolean isVisible()
```
    Returns:
    
    whether or not this element is visible on the device's display.
  - isCheckable
```
boolean isCheckable()
```
    Returns:
    
    whether this element is checkable.
  - isChecked
```
boolean isChecked()
```
    Returns:
    
    whether this element is checked.
  - isClickable
```
boolean isClickable()
```
    Returns:
    
    whether this element is clickable.
  - isEnabled
```
boolean isEnabled()
```
    Returns:
    
    whether this element is enabled.
  - isFocusable
```
boolean isFocusable()
```
    Returns:
    
    whether this element is focusable.
  - isFocused
```
boolean isFocused()
```
    Returns:
    
    whether this element is focused.
  - isScrollable
```
boolean isScrollable()
```
    Returns:
    
    whether this element is scrollable.
  - isLongClickable
```
boolean isLongClickable()
```
    Returns:
    
    whether this element is long-clickable.
  - isPassword
```
boolean isPassword()
```
    Returns:
    
    whether this element is password.
  - isSelected
```
boolean isSelected()
```
    Returns:
    
    whether this element is selected.
  - getBounds
```
android.graphics.Rect getBounds()
```
    Gets the UiElement bounds in screen coordinates. The coordinates may not be visible on screen.
  - getVisibleBounds
```
android.graphics.Rect getVisibleBounds()
```
    Gets the UiElement bounds in screen coordinates. The coordinates will be visible on screen.
  - get
```
<T> T get(Attribute attribute)
```
    Returns:
    
    value of the given attribute.
  - perform
```
boolean perform(Action action)
```
    Executes the given action.
    
    Parameters:
    
    action - the action to execute
    
    Returns:
    
    true if the action is successful
  - setText
```
void setText(java.lang.String text)
```
    Sets the text of this element. The implementation may not work on all UiElements if the underlying view is not EditText.
    If this element already has text, it is cleared first if the device has API 11 or higher.
    TODO: Support this behavior on older devices.
    The IME (soft keyboard) may be shown after this call. If the text ends with '\n', the IME may be closed automatically. If the IME is open, you can call UiDevice.pressBack() to close it.
    If you are using InstrumentationDriver, you may use CloseKeyboardAction to close it. The advantage of CloseKeyboardAction is that it is a no-op if the IME is hidden. This is useful when the state of the IME cannot be determined.
    
    Parameters:
    
    text - the text to enter
  - click
```
void click()
```
    Clicks this element. The click will be at the center of the visible element.
  - longClick
```
void longClick()
```
    Long-clicks this element. The click will be at the center of the visible element.
  - doubleClick
```
void doubleClick()
```
    Double-clicks this element. The click will be at the center of the visible element.
  - scroll
```
void scroll(Direction.PhysicalDirection direction)
```
    Scrolls in the given direction.
    
    Parameters:
    
    direction - specifies where the view port will move instead of the finger
  - getChildren
```
java.util.List<? extends UiElement> getChildren(Predicate<? super UiElement> predicate)
```
    Gets an immutable List of immediate children that satisfy predicate. It always filters children that are null. This gives a low level access to the underlying data. Do not use it unless you are sure about the subtle details. Note the count may not be what you expect. For instance, a dynamic list may show more items when scrolling beyond the end, varying the count. The count also depends on the driver implementation:
    - InstrumentationDriver includes all.
    - the Accessibility API (which UiAutomationDriver depends on) does not include off-screen children, but may include invisible on-screen children.
    Another discrepancy between InstrumentationDriver UiAutomationDriver is the order of children. The Accessibility API returns children in the order of layout (see ViewGroup.addChildrenForAccessibility(java.util.ArrayList<android.view.View>), which is added in API16).
  - getParent
```
UiElement getParent()
```
    Gets the parent.
  - getInjector
```
InputInjector getInjector()
```
    Gets the InputInjector for injecting InputEvent.

Interface UiElement

Field Summary

Method Summary

Field Detail

VISIBLE

Method Detail

getText

getContentDescription

getClassName

getResourceId

getPackageName

isVisible

isCheckable

isChecked

isClickable

isEnabled

isFocusable

isFocused

isScrollable

isLongClickable

isPassword

isSelected

getBounds

getVisibleBounds

get

perform

setText

click

longClick

doubleClick

scroll

getChildren

getParent

getInjector