io.appium.droiddriver.base

Class BaseUiDevice

java.lang.Object

io.appium.droiddriver.base.BaseUiDevice

All Implemented Interfaces:

UiDevice

public abstract class BaseUiDevice
extends java.lang.Object
implements UiDevice

Base implementation of UiDevice.

Constructor Summary

Constructors

Constructor and Description
BaseUiDevice()

Method Summary

Modifier and Type	Method and Description
protected abstract DroidDriverContext<?,?>	getContext()
boolean	isScreenOn() Returns whether the screen is on.
boolean	perform(Action action) Executes a global action without the context of a certain UiElement.
void	pressBack() Simulates pressing "back" button
void	sleep() Puts device to sleep if the screen is on
protected abstract android.graphics.Bitmap	takeScreenshot()
boolean	takeScreenshot(java.lang.String path) Takes a screenshot of current window and stores it in path as PNG.
boolean	takeScreenshot(java.lang.String path, android.graphics.Bitmap.CompressFormat format, int quality) Takes a screenshot of current window and stores it in path.
void	wakeUp() Wakes up device if the screen is off

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseUiDevice

public BaseUiDevice()

Method Detail

isScreenOn

public boolean isScreenOn()

Description copied from interface: UiDevice

Returns whether the screen is on.

Specified by:

isScreenOn in interface UiDevice

wakeUp

public void wakeUp()

Description copied from interface: UiDevice

Wakes up device if the screen is off

Specified by:

wakeUp in interface UiDevice

sleep

public void sleep()

Description copied from interface: UiDevice

Puts device to sleep if the screen is on

Specified by:

sleep in interface UiDevice

pressBack

public void pressBack()

Description copied from interface: UiDevice

Simulates pressing "back" button

Specified by:

pressBack in interface UiDevice

perform

public boolean perform(Action action)

Description copied from interface: UiDevice

Executes a global action without the context of a certain UiElement.

Specified by:

perform in interface UiDevice

Parameters:

action - The action to execute

Returns:

true if the action is successful

takeScreenshot

public boolean takeScreenshot(java.lang.String path)

Description copied from interface: UiDevice

Takes a screenshot of current window and stores it in path as PNG.

If this is used in a test which extends ActivityInstrumentationTestCase2, call this before tearDown() because tearDown() finishes activities created by ActivityInstrumentationTestCase2.getActivity().

Specified by:

takeScreenshot in interface UiDevice

Parameters:

path - the path of file to save screenshot

Returns:

true if screen shot is created successfully

takeScreenshot

public boolean takeScreenshot(java.lang.String path,
                              android.graphics.Bitmap.CompressFormat format,
                              int quality)

Description copied from interface: UiDevice

Takes a screenshot of current window and stores it in path. Note some implementations may not capture everything on the screen, for example InstrumentationDriver may not see the IME soft keyboard or system content.

Specified by:

takeScreenshot in interface UiDevice

Parameters:

path - the path of file to save screenshot

format - The format of the compressed image

quality - Hint to the compressor, 0-100. 0 meaning compress for small size, 100 meaning compress for max quality. Some formats, like PNG which is lossless, will ignore the quality setting

Returns:

true if screen shot is created successfully

takeScreenshot

protected abstract android.graphics.Bitmap takeScreenshot()

getContext

protected abstract DroidDriverContext<?,?> getContext()