io.appium.droiddriver.base

Class BaseUiElement<R,E extends BaseUiElement<R,E>>

java.lang.Object

io.appium.droiddriver.base.BaseUiElement<R,E>

Type Parameters:

R - the type of the raw element this class wraps, for example, View or AccessibilityNodeInfo

E - the type of the concrete subclass of BaseUiElement

All Implemented Interfaces:

UiElement

Direct Known Subclasses:

UiAutomationElement, ViewElement

public abstract class BaseUiElement<R,E extends BaseUiElement<R,E>>
extends java.lang.Object
implements UiElement

Base UiElement that implements the common operations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIB_NOT_VISIBLE
static java.lang.String	ATTRIB_VISIBLE_BOUNDS

Fields inherited from interface io.appium.droiddriver.UiElement

VISIBLE

Constructor Summary

Constructors

Constructor and Description
BaseUiElement()

Method Summary

Modifier and Type	Method and Description
void	click() Clicks this element.
protected boolean	doPerform(Action action)
protected abstract void	doPerformAndWait(java.util.concurrent.FutureTask<java.lang.Boolean> futureTask, long timeoutMillis)
void	doubleClick() Double-clicks this element.
<T> T	get(Attribute attribute)
protected abstract java.util.Map<Attribute,java.lang.Object>	getAttributes()
android.graphics.Rect	getBounds() Gets the UiElement bounds in screen coordinates.
protected abstract java.util.List<E>	getChildren()
java.util.List<E>	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.
java.lang.String	getPackageName() Gets the package name of this element.
abstract R	getRawElement() Gets the raw element used to create this UiElement.
java.lang.String	getResourceId() Gets the resource id of this element.
int	getSelectionEnd()
int	getSelectionStart()
java.lang.String	getText() Gets the text of this element.
boolean	hasSelection()
boolean	isCheckable()
boolean	isChecked()
boolean	isClickable()
boolean	isEnabled()
boolean	isFocusable()
boolean	isFocused()
boolean	isLongClickable()
boolean	isPassword()
boolean	isScrollable()
boolean	isSelected()
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.
void	setUiElementActor(UiElementActor uiElementActor)
void	setValidator(Validator validator) Sets the validator to check when perform(Action) is called.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.appium.droiddriver.UiElement

getInjector, getParent, getVisibleBounds, isVisible

Field Detail

ATTRIB_VISIBLE_BOUNDS

public static final java.lang.String ATTRIB_VISIBLE_BOUNDS

See Also:

Constant Field Values

ATTRIB_NOT_VISIBLE

public static final java.lang.String ATTRIB_NOT_VISIBLE

See Also:

Constant Field Values

Constructor Detail

BaseUiElement

public BaseUiElement()

Method Detail

get

public <T> T get(Attribute attribute)

Specified by:

get in interface UiElement

Returns:

value of the given attribute.

getText

public java.lang.String getText()

Description copied from interface: UiElement

Gets the text of this element.

Specified by:

getText in interface UiElement

getContentDescription

public java.lang.String getContentDescription()

Description copied from interface: UiElement

Gets the content description of this element.

Specified by:

getContentDescription in interface UiElement

getClassName

public java.lang.String getClassName()

Description copied from interface: UiElement

Gets the class name of the underlying view. The actual name could be overridden.

Specified by:

getClassName in interface UiElement

See Also:

ViewElement.overrideClassName(java.lang.String, java.lang.String)

getResourceId

public java.lang.String getResourceId()

Description copied from interface: UiElement

Gets the resource id of this element.

Specified by:

getResourceId in interface UiElement

getPackageName

public java.lang.String getPackageName()

Description copied from interface: UiElement

Gets the package name of this element.

Specified by:

getPackageName in interface UiElement

isCheckable

public boolean isCheckable()

Specified by:

isCheckable in interface UiElement

Returns:

whether this element is checkable.

isChecked

public boolean isChecked()

Specified by:

isChecked in interface UiElement

Returns:

whether this element is checked.

isClickable

public boolean isClickable()

Specified by:

isClickable in interface UiElement

Returns:

whether this element is clickable.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface UiElement

Returns:

whether this element is enabled.

isFocusable

public boolean isFocusable()

Specified by:

isFocusable in interface UiElement

Returns:

whether this element is focusable.

isFocused

public boolean isFocused()

Specified by:

isFocused in interface UiElement

Returns:

whether this element is focused.

isScrollable

public boolean isScrollable()

Specified by:

isScrollable in interface UiElement

Returns:

whether this element is scrollable.

isLongClickable

public boolean isLongClickable()

Specified by:

isLongClickable in interface UiElement

Returns:

whether this element is long-clickable.

isPassword

public boolean isPassword()

Specified by:

isPassword in interface UiElement

Returns:

whether this element is password.

isSelected

public boolean isSelected()

Specified by:

isSelected in interface UiElement

Returns:

whether this element is selected.

getBounds

public android.graphics.Rect getBounds()

Description copied from interface: UiElement

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

Specified by:

getBounds in interface UiElement

getSelectionStart

public int getSelectionStart()

getSelectionEnd

public int getSelectionEnd()

hasSelection

public boolean hasSelection()

perform

public boolean perform(Action action)

Description copied from interface: UiElement

Executes the given action.

Specified by:

perform in interface UiElement

Parameters:

action - the action to execute

Returns:

true if the action is successful

doPerform

protected boolean doPerform(Action action)

doPerformAndWait

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

setText

public void setText(java.lang.String text)

Description copied from interface: UiElement

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.

Specified by:

setText in interface UiElement

Parameters:

text - the text to enter

click

public void click()

Description copied from interface: UiElement

Clicks this element. The click will be at the center of the visible element.

Specified by:

click in interface UiElement

longClick

public void longClick()

Description copied from interface: UiElement

Long-clicks this element. The click will be at the center of the visible element.

Specified by:

longClick in interface UiElement

doubleClick

public void doubleClick()

Description copied from interface: UiElement

Double-clicks this element. The click will be at the center of the visible element.

Specified by:

doubleClick in interface UiElement

scroll

public void scroll(Direction.PhysicalDirection direction)

Description copied from interface: UiElement

Scrolls in the given direction.

Specified by:

scroll in interface UiElement

Parameters:

direction - specifies where the view port will move instead of the finger

getAttributes

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

getChildren

protected abstract java.util.List<E> getChildren()

getChildren

public java.util.List<E> getChildren(Predicate<? super UiElement> predicate)

Description copied from interface: UiElement

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).

Specified by:

getChildren in interface UiElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRawElement

public abstract R getRawElement()

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.

setUiElementActor

public void setUiElementActor(UiElementActor uiElementActor)

setValidator

public void setValidator(Validator validator)

Sets the validator to check when perform(Action) is called.