io.appium.droiddriver.instrumentation

Class ViewElement

java.lang.Object

io.appium.droiddriver.base.BaseUiElement<android.view.View,ViewElement>

io.appium.droiddriver.instrumentation.ViewElement

All Implemented Interfaces:

UiElement

public class ViewElement
extends BaseUiElement<android.view.View,ViewElement>

A UiElement that is backed by a View.

Field Summary

Fields inherited from class io.appium.droiddriver.base.BaseUiElement

ATTRIB_NOT_VISIBLE, ATTRIB_VISIBLE_BOUNDS

Fields inherited from interface io.appium.droiddriver.UiElement

VISIBLE

Constructor Summary

Constructors

Constructor and Description
ViewElement(DroidDriverContext<android.view.View,ViewElement> context, android.view.View view, ViewElement parent) A snapshot of all attributes is taken at construction.

Method Summary

Modifier and Type	Method and Description
protected void	doPerformAndWait(java.util.concurrent.FutureTask<java.lang.Boolean> futureTask, long timeoutMillis)
protected java.util.Map<Attribute,java.lang.Object>	getAttributes()
protected java.util.List<ViewElement>	getChildren()
InputInjector	getInjector() Gets the InputInjector for injecting InputEvent.
ViewElement	getParent() Gets the parent.
android.view.View	getRawElement() Gets the raw element used to create this UiElement.
android.graphics.Rect	getVisibleBounds() Gets the UiElement bounds in screen coordinates.
boolean	isVisible()
static void	overrideClassName(java.lang.String actualClassName, java.lang.String overridingClassName) Typically users find the class name to use in tests using SDK tool uiautomatorviewer.

Methods inherited from class io.appium.droiddriver.base.BaseUiElement

click, doPerform, doubleClick, get, getBounds, getChildren, getClassName, getContentDescription, getPackageName, getResourceId, getSelectionEnd, getSelectionStart, getText, hasSelection, isCheckable, isChecked, isClickable, isEnabled, isFocusable, isFocused, isLongClickable, isPassword, isScrollable, isSelected, longClick, perform, scroll, setText, setUiElementActor, setValidator, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewElement

public ViewElement(DroidDriverContext<android.view.View,ViewElement> context,
                   android.view.View view,
                   ViewElement parent)

A snapshot of all attributes is taken at construction. The attributes of a ViewElement instance are immutable. If the underlying view is updated, a new ViewElement instance will be created in DroidDriver.refreshUiElementTree().

Method Detail

overrideClassName

public static void overrideClassName(java.lang.String actualClassName,
                                     java.lang.String overridingClassName)

Typically users find the class name to use in tests using SDK tool uiautomatorviewer. This name is returned by AccessibilityNodeInfo.getClassName(). If the app uses custom View classes that do not call AccessibilityNodeInfo.setClassName(java.lang.CharSequence) with the actual class name, different types of drivers see different class names (InstrumentationDriver sees the actual class name, while UiAutomationDriver sees AccessibilityNodeInfo.getClassName()).

If tests fail with InstrumentationDriver, find the actual class name by examining app code or by calling DroidDriver.dumpUiElementTree(java.lang.String), then call this method in setUp to override it with the class name seen in uiautomatorviewer.

A better solution is to use resource-id instead of classname, which is an implementation detail and subject to change.

getVisibleBounds

public android.graphics.Rect getVisibleBounds()

Description copied from interface: UiElement

Gets the UiElement bounds in screen coordinates. The coordinates will be visible on screen.

isVisible

public boolean isVisible()

Returns:

whether or not this element is visible on the device's display.

getParent

public ViewElement getParent()

Description copied from interface: UiElement

Gets the parent.

getChildren

protected java.util.List<ViewElement> getChildren()

Specified by:

getChildren in class BaseUiElement<android.view.View,ViewElement>

getAttributes

protected java.util.Map<Attribute,java.lang.Object> getAttributes()

Specified by:

getAttributes in class BaseUiElement<android.view.View,ViewElement>

getInjector

public InputInjector getInjector()

Description copied from interface: UiElement

Gets the InputInjector for injecting InputEvent.

doPerformAndWait

protected void doPerformAndWait(java.util.concurrent.FutureTask<java.lang.Boolean> futureTask,
                                long timeoutMillis)

Specified by:

doPerformAndWait in class BaseUiElement<android.view.View,ViewElement>

getRawElement

public android.view.View getRawElement()

Description copied from class: BaseUiElement

Gets the raw element used to create this UiElement. The attributes of this UiElement are based on a snapshot of the raw element at construction time. If the raw element is updated later, the attributes may not match.

Specified by:

getRawElement in class BaseUiElement<android.view.View,ViewElement>