com.robotium.solo
Class Solo

java.lang.Object
  com.robotium.solo.Solo

public class Solo
extends Object

Main class for development of Robotium tests. Robotium has full support for Views, WebViews, Activities, Dialogs, Menus and Context Menus.
Robotium can be used in conjunction with Android test classes like ActivityInstrumentationTestCase2 and SingleLaunchActivityTestCase.

Author:

Renas Reda, renas.reda@robotium.com

Nested Class Summary

static class

Solo.Config Config class used to set the scroll behaviour, default timeouts, screenshot filetype and screenshot save path.

Field Summary

protected com.robotium.solo.ActivityUtils	activityUtils
protected com.robotium.solo.Asserter	asserter
protected com.robotium.solo.Checker	checker
protected com.robotium.solo.Clicker	clicker
static int	CLOSED
static int	DELETE
protected com.robotium.solo.DialogUtils	dialogUtils
static int	DOWN
static int	ENTER
protected com.robotium.solo.Getter	getter
protected com.robotium.solo.Illustrator	illustrator
protected android.app.Instrumentation	instrumentation
static int	LANDSCAPE
static int	LEFT
static int	MENU
static int	OPENED
static int	PORTRAIT
protected com.robotium.solo.Presser	presser
static int	RIGHT
protected com.robotium.solo.Rotator	rotator
protected com.robotium.solo.ScreenshotTaker	screenshotTaker
protected com.robotium.solo.Scroller	scroller
protected com.robotium.solo.Searcher	searcher
protected com.robotium.solo.Sender	sender
protected com.robotium.solo.Setter	setter
protected com.robotium.solo.Sleeper	sleeper
protected com.robotium.solo.Swiper	swiper
protected SystemUtils	systemUtils
protected com.robotium.solo.Tapper	tapper
protected com.robotium.solo.TextEnterer	textEnterer
static int	UP
protected com.robotium.solo.ViewFetcher	viewFetcher
protected com.robotium.solo.Waiter	waiter
protected String	webUrl
protected com.robotium.solo.WebUtils	webUtils
protected com.robotium.solo.Zoomer	zoomer

Constructor Summary

Solo(android.app.Instrumentation instrumentation)
Constructor that takes the instrumentation object.

Solo(android.app.Instrumentation instrumentation, android.app.Activity activity)
Constructor that takes the Instrumentation object and the start Activity.

Solo(android.app.Instrumentation instrumentation, Solo.Config config)
Constructor that takes the Instrumentation and Config objects.

Solo(android.app.Instrumentation instrumentation, Solo.Config config, android.app.Activity activity)
Constructor that takes the Instrumentation, Config and Activity objects.

Method Summary

void	assertCurrentActivity(String message, Class activityClass) Asserts that the Activity matching the specified class is active.
void	assertCurrentActivity(String message, Class activityClass, boolean isNewInstance) Asserts that the Activity matching the specified class is active, with the possibility to verify that the expected Activity is a new instance of the Activity.
void	assertCurrentActivity(String message, String name) Asserts that the Activity matching the specified name is active.
void	assertCurrentActivity(String message, String name, boolean isNewInstance) Asserts that the Activity matching the specified name is active, with the possibility to verify that the expected Activity is a new instance of the Activity.
void	assertMemoryNotLow() Asserts that the available memory is not considered low by the system.
void	clearEditText(android.widget.EditText editText) Clears the value of an EditText.
void	clearEditText(int index) Clears the value of an EditText.
void	clearLog() Clears the log.
void	clearTextInWebElement(By by) Clears text in a WebElement matching the specified By object.
ArrayList<android.widget.TextView>	clickInList(int line) Clicks the specified list line and returns an ArrayList of the TextView objects that the list line is displaying.
ArrayList<android.widget.TextView>	clickInList(int line, int index) Clicks the specified list line in the ListView matching the specified index and returns an ArrayList of the TextView objects that the list line is displaying.
ArrayList<android.widget.TextView>	clickInRecyclerView(int itemIndex) Clicks the specified item index and returns an ArrayList of the TextView objects that the item index is displaying.
ArrayList<android.widget.TextView>	clickInRecyclerView(int itemIndex, int recyclerViewIndex) Clicks the specified item index in the RecyclerView matching the specified RecyclerView index and returns an ArrayList of the TextView objects that the list line is displaying.
ArrayList<android.widget.TextView>	clickLongInList(int line) Long clicks the specified list line and returns an ArrayList of the TextView objects that the list line is displaying.
ArrayList<android.widget.TextView>	clickLongInList(int line, int index) Long clicks the specified list line in the ListView matching the specified index and returns an ArrayList of the TextView objects that the list line is displaying.
ArrayList<android.widget.TextView>	clickLongInList(int line, int index, int time) Long clicks the specified list line in the ListView matching the specified index and returns an ArrayList of the TextView objects that the list line is displaying.
ArrayList<android.widget.TextView>	clickLongInRecycleView(int itemIndex) Long clicks the specified item index and returns an ArrayList of the TextView objects that the item index is displaying.
ArrayList<android.widget.TextView>	clickLongInRecycleView(int itemIndex, int recyclerViewIndex) Long clicks the specified item index in the RecyclerView matching the specified RecyclerView index and returns an ArrayList of the TextView objects that the item index is displaying.
ArrayList<android.widget.TextView>	clickLongInRecycleView(int itemIndex, int recyclerViewIndex, int time) Long clicks the specified item index in the RecyclerView matching the specified RecyclerView index and returns an ArrayList of the TextView objects that the item index is displaying.
void	clickLongOnScreen(float x, float y) Long clicks the specified coordinates.
void	clickLongOnScreen(float x, float y, int time) Long clicks the specified coordinates for a specified amount of time.
void	clickLongOnText(String text) Long clicks a View or WebElement displaying the specified text.
void	clickLongOnText(String text, int match) Long clicks a View or WebElement displaying the specified text.
void	clickLongOnText(String text, int match, boolean scroll) Long clicks a View or WebElement displaying the specified text.
void	clickLongOnText(String text, int match, int time) Long clicks a View or WebElement displaying the specified text.
void	clickLongOnTextAndPress(String text, int index) Long clicks a View displaying the specified text and then selects an item from the context menu that appears.
void	clickLongOnView(android.view.View view) Long clicks the specified View.
void	clickLongOnView(android.view.View view, int time) Long clicks the specified View for a specified amount of time.
void	clickOnActionBarHomeButton() Clicks an ActionBar Home/Up button.
void	clickOnActionBarItem(int id) Clicks an ActionBarItem matching the specified resource id.
void	clickOnButton(int index) Clicks a Button matching the specified index.
void	clickOnButton(String text) Clicks a Button displaying the specified text.
void	clickOnCheckBox(int index) Clicks a CheckBox matching the specified index.
void	clickOnEditText(int index) Clicks an EditText matching the specified index.
void	clickOnImage(int index) Clicks an ImageView matching the specified index.
void	clickOnImageButton(int index) Clicks an ImageButton matching the specified index.
void	clickOnMenuItem(String text) Clicks a MenuItem displaying the specified text.
void	clickOnMenuItem(String text, boolean subMenu) Clicks a MenuItem displaying the specified text.
void	clickOnRadioButton(int index) Clicks a RadioButton matching the specified index.
void	clickOnScreen(float x, float y) Clicks the specified coordinates.
void	clickOnScreen(float x, float y, int numberOfClicks) Clicks the specified coordinates rapidly a specified number of times.
void	clickOnText(String text) Clicks a View or WebElement displaying the specified text.
void	clickOnText(String text, int match) Clicks a View or WebElement displaying the specified text.
void	clickOnText(String text, int match, boolean scroll) Clicks a View or WebElement displaying the specified text.
void	clickOnToggleButton(String text) Clicks a ToggleButton displaying the specified text.
void	clickOnView(android.view.View view) Clicks the specified View.
void	clickOnView(android.view.View view, boolean immediately) Clicks the specified View.
void	clickOnWebElement(By by) Clicks a WebElement matching the specified By object.
void	clickOnWebElement(By by, int match) Clicks a WebElement matching the specified By object.
void	clickOnWebElement(By by, int match, boolean scroll) Clicks a WebElement matching the specified By object.
void	clickOnWebElement(WebElement webElement) Clicks the specified WebElement.
Illustration.Builder	createIllustrationBuilder() An Builder pattern that will allow the client to build a new illustration
void	drag(float fromX, float toX, float fromY, float toY, int stepCount) Simulate touching the specified location and dragging it to a new location.
void	enterText(android.widget.EditText editText, String text) Enters text in the specified EditText.
void	enterText(int index, String text) Enters text in an EditText matching the specified index.
void	enterTextInWebElement(By by, String text) Enters text in a WebElement matching the specified By object.
void	finalize() Finalizes the Solo object and removes the ActivityMonitor.
void	finishOpenedActivities() The Activities that are alive are finished.
android.app.Instrumentation.ActivityMonitor	getActivityMonitor() Returns the ActivityMonitor used by Robotium.
android.widget.Button	getButton(int index) Returns a Button matching the specified index.
android.widget.Button	getButton(String text) Returns a Button displaying the specified text.
android.widget.Button	getButton(String text, boolean onlyVisible) Returns a Button displaying the specified text.
Solo.Config	getConfig() Returns the Config used by Robotium.
android.app.Activity	getCurrentActivity() Returns the current Activity.
ArrayList<android.view.View>	getCurrentViews() Returns an ArrayList of the Views currently displayed in the focused Activity or Dialog.
<T extends android.view.View> ArrayList<T>	getCurrentViews(Class<T> classToFilterBy) Returns an ArrayList of Views matching the specified class located in the focused Activity or Dialog.
<T extends android.view.View> ArrayList<T>	getCurrentViews(Class<T> classToFilterBy, boolean includeSubclasses) Returns an ArrayList of Views matching the specified class located in the focused Activity or Dialog.
<T extends android.view.View> ArrayList<T>	getCurrentViews(Class<T> classToFilterBy, boolean includeSubclasses, android.view.View parent) Returns an ArrayList of Views matching the specified class located under the specified parent.
<T extends android.view.View> ArrayList<T>	getCurrentViews(Class<T> classToFilterBy, android.view.View parent) Returns an ArrayList of Views matching the specified class located under the specified parent.
ArrayList<WebElement>	getCurrentWebElements() Returns an ArrayList of the currently displayed WebElements in the active WebView.
ArrayList<WebElement>	getCurrentWebElements(By by) Returns an ArrayList of the currently displayed WebElements in the active WebView matching the specified By object.
android.widget.EditText	getEditText(int index) Returns an EditText matching the specified index.
android.widget.EditText	getEditText(String text) Returns an EditText displaying the specified text.
android.widget.EditText	getEditText(String text, boolean onlyVisible) Returns an EditText displaying the specified text.
android.widget.ImageView	getImage(int index) Returns an ImageView matching the specified index.
android.widget.ImageButton	getImageButton(int index) Returns an ImageButton matching the specified index.
String	getString(int id) Returns a localized String matching the specified resource id.
String	getString(String id) Returns a localized String matching the specified resource id.
android.widget.TextView	getText(int index) Returns a TextView matching the specified index.
android.widget.TextView	getText(String text) Returns a TextView displaying the specified text.
android.widget.TextView	getText(String text, boolean onlyVisible) Returns a TextView displaying the specified text.
android.view.View	getTopParent(android.view.View view) Returns the absolute top parent View of the specified View.
<T extends android.view.View> T	getView(Class<T> viewClass, int index) Returns a View matching the specified class and index.
android.view.View	getView(int id) Returns a View matching the specified resource id.
android.view.View	getView(int id, int index) Returns a View matching the specified resource id and index.
android.view.View	getView(Object tag) Returns a View matching the specified tag.
android.view.View	getView(Object tag, int index) Returns a View matching the specified tag and index.
android.view.View	getView(String id) Returns a View matching the specified resource id.
android.view.View	getView(String id, int index) Returns a View matching the specified resource id and index.
ArrayList<android.view.View>	getViews() Returns an ArrayList of all the View objects located in the focused Activity or Dialog.
ArrayList<android.view.View>	getViews(android.view.View parent) Returns an ArrayList of the View objects contained in the parent View.
WebElement	getWebElement(By by, int index) Returns a WebElement matching the specified By object and index.
ArrayList<WebElement>	getWebElements() Returns an ArrayList of all the WebElements displayed in the active WebView.
ArrayList<WebElement>	getWebElements(By by) Returns an ArrayList of all the WebElements displayed in the active WebView matching the specified By object.
String	getWebUrl() Returns the current web page URL.
void	goBack() Simulates pressing the hardware back key.
void	goBackToActivity(String name) Returns to an Activity matching the specified name.
void	hideSoftKeyboard() Hides the soft keyboard.
void	illustrate(Illustration illustration) Simulate drawing an illustration on the screen.
boolean	isCheckBoxChecked(int index) Checks if a CheckBox matching the specified index is checked.
boolean	isCheckBoxChecked(String text) Checks if a CheckBox displaying the specified text is checked.
boolean	isRadioButtonChecked(int index) Checks if a RadioButton matching the specified index is checked.
boolean	isRadioButtonChecked(String text) Checks if a RadioButton displaying the specified text is checked.
boolean	isSpinnerTextSelected(int index, String text) Checks if the specified text is selected in a Spinner matching the specified index.
boolean	isSpinnerTextSelected(String text) Checks if the specified text is selected in any Spinner located in the current screen.
boolean	isTextChecked(String text) Checks if the specified text is checked.
boolean	isToggleButtonChecked(int index) Checks if a ToggleButton matching the specified index is checked.
boolean	isToggleButtonChecked(String text) Checks if a ToggleButton displaying the specified text is checked.
void	pinchToZoom(android.graphics.PointF startPoint1, android.graphics.PointF startPoint2, android.graphics.PointF endPoint1, android.graphics.PointF endPoint2) Zooms in or out if startPoint1 and startPoint2 are larger or smaller then endPoint1 and endPoint2.
void	pressMenuItem(int index) Presses a MenuItem matching the specified index.
void	pressMenuItem(int index, int itemsPerRow) Presses a MenuItem matching the specified index.
void	pressSoftKeyboardDoneButton() Presses the soft keyboard done button.
void	pressSoftKeyboardGoButton() Presses the soft keyboard go button.
void	pressSoftKeyboardNextButton() Presses the soft keyboard next button.
void	pressSoftKeyboardSearchButton() Presses the soft keyboard search button.
void	pressSpinnerItem(int spinnerIndex, int itemIndex) Presses a Spinner (drop-down menu) item.
void	rotateLarge(android.graphics.PointF center1, android.graphics.PointF center2) Draws two semi-circles at the specified centers.
void	rotateSmall(android.graphics.PointF center1, android.graphics.PointF center2) Draws two semi-circles at the specified centers.
boolean	scrollDown() Scrolls down the screen.
boolean	scrollDownList(android.widget.AbsListView list) Scrolls down the specified AbsListView.
boolean	scrollDownList(int index) Scrolls down a ListView matching the specified index.
boolean	scrollDownRecyclerView(int index) Scrolls down a RecyclerView matching the specified index.
boolean	scrollListToBottom(android.widget.AbsListView list) Scrolls to the bottom of the specified AbsListView.
boolean	scrollListToBottom(int index) Scrolls a ListView matching the specified index to the bottom.
void	scrollListToLine(android.widget.AbsListView absListView, int line) Scroll the specified AbsListView to the specified line.
void	scrollListToLine(int index, int line) Scroll a AbsListView matching the specified index to the specified line.
boolean	scrollListToTop(android.widget.AbsListView list) Scrolls to the top of the specified AbsListView.
boolean	scrollListToTop(int index) Scrolls a ListView matching the specified index to the top.
boolean	scrollRecyclerViewToBottom(int index) Scrolls a RecyclerView matching the specified index to the bottom.
boolean	scrollRecyclerViewToTop(int index) Scrolls a RecyclerView matching the specified index to the top.
void	scrollToBottom() Scrolls to the bottom of the screen.
void	scrollToSide(int side) Scrolls horizontally.
void	scrollToSide(int side, float scrollPosition) Scrolls horizontally.
void	scrollToSide(int side, float scrollPosition, int stepCount) Scrolls horizontally.
void	scrollToTop() Scrolls to the top of the screen.
boolean	scrollUp() Scrolls up the screen.
boolean	scrollUpList(android.widget.AbsListView list) Scrolls up the specified AbsListView.
boolean	scrollUpList(int index) Scrolls up a ListView matching the specified index.
boolean	scrollUpRecyclerView(int index) Scrolls up a RecyclerView matching the specified index.
void	scrollViewToSide(android.view.View view, int side) Scrolls a View horizontally.
void	scrollViewToSide(android.view.View view, int side, float scrollPosition) Scrolls a View horizontally.
void	scrollViewToSide(android.view.View view, int side, float scrollPosition, int stepCount) Scrolls a View horizontally.
boolean	searchButton(String text) Searches for a Button displaying the specified text and returns true if at least one Button is found.
boolean	searchButton(String text, boolean onlyVisible) Searches for a Button displaying the specified text and returns true if at least one Button is found.
boolean	searchButton(String text, int minimumNumberOfMatches) Searches for a Button displaying the specified text and returns true if the searched Button is found a specified number of times.
boolean	searchButton(String text, int minimumNumberOfMatches, boolean onlyVisible) Searches for a Button displaying the specified text and returns true if the searched Button is found a specified number of times.
boolean	searchEditText(String text) Searches for a text in the EditText objects currently displayed and returns true if found.
boolean	searchText(String text) Searches for the specified text and returns true if at least one item is found displaying the expected text.
boolean	searchText(String text, boolean onlyVisible) Searches for the specified text and returns true if at least one item is found displaying the expected text.
boolean	searchText(String text, int minimumNumberOfMatches) Searches for the specified text and returns true if the searched text is found a specified number of times.
boolean	searchText(String text, int minimumNumberOfMatches, boolean scroll) Searches for the specified text and returns true if the searched text is found a specified number of times.
boolean	searchText(String text, int minimumNumberOfMatches, boolean scroll, boolean onlyVisible) Searches for the specified text and returns true if the searched text is found a specified number of times.
boolean	searchToggleButton(String text) Searches for a ToggleButton displaying the specified text and returns true if at least one ToggleButton is found.
boolean	searchToggleButton(String text, int minimumNumberOfMatches) Searches for a ToggleButton displaying the specified text and returns true if the searched ToggleButton is found a specified number of times.
void	sendKey(int key) Sends a key: Right, Left, Up, Down, Enter, Menu or Delete.
void	setActivityOrientation(int orientation) Sets the Orientation (Landscape/Portrait) for the current Activity.
void	setDatePicker(android.widget.DatePicker datePicker, int year, int monthOfYear, int dayOfMonth) Sets the date in the specified DatePicker.
void	setDatePicker(int index, int year, int monthOfYear, int dayOfMonth) Sets the date in a DatePicker matching the specified index.
void	setMobileData(Boolean turnedOn) Sets if mobile data should be turned on or off.
void	setNavigationDrawer(int status) Sets the status of the NavigationDrawer.
void	setProgressBar(int index, int progress) Sets the progress of a ProgressBar matching the specified index.
void	setProgressBar(android.widget.ProgressBar progressBar, int progress) Sets the progress of the specified ProgressBar.
void	setSlidingDrawer(int index, int status) Sets the status of a SlidingDrawer matching the specified index.
void	setSlidingDrawer(android.widget.SlidingDrawer slidingDrawer, int status) Sets the status of the specified SlidingDrawer.
void	setTimePicker(int index, int hour, int minute) Sets the time in a TimePicker matching the specified index.
void	setTimePicker(android.widget.TimePicker timePicker, int hour, int minute) Sets the time in the specified TimePicker.
void	setWiFiData(Boolean turnedOn) Sets if wifi data should be turned on or off.
void	sleep(int time) Robotium will sleep for the specified time.
void	startScreenshotSequence(String name) Takes a screenshot sequence and saves the images with the specified name prefix in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/).
void	startScreenshotSequence(String name, int quality, int frameDelay, int maxFrames) Takes a screenshot sequence and saves the images with the specified name prefix in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/).
void	stopScreenshotSequence() Causes a screenshot sequence to end.
void	swipe(android.graphics.PointF startPoint1, android.graphics.PointF startPoint2, android.graphics.PointF endPoint1, android.graphics.PointF endPoint2) Swipes with two fingers in a linear path determined by starting and ending points.
void	takeScreenshot() Takes a screenshot and saves it in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/).
void	takeScreenshot(String name) Takes a screenshot and saves it with the specified name in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/).
void	takeScreenshot(String name, int quality) Takes a screenshot and saves the image with the specified name in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/).
void	typeText(android.widget.EditText editText, String text) Types text in the specified EditText.
void	typeText(int index, String text) Types text in an EditText matching the specified index.
void	typeTextInWebElement(By by, String text) Types text in a WebElement matching the specified By object.
void	typeTextInWebElement(By by, String text, int match) Types text in a WebElement matching the specified By object.
void	typeTextInWebElement(WebElement webElement, String text) Types text in the specified WebElement.
void	unlockScreen() Unlocks the lock screen.
boolean	waitForActivity(Class<? extends android.app.Activity> activityClass) Waits for an Activity matching the specified class.
boolean	waitForActivity(Class<? extends android.app.Activity> activityClass, int timeout) Waits for an Activity matching the specified class.
boolean	waitForActivity(String name) Waits for an Activity matching the specified name.
boolean	waitForActivity(String name, int timeout) Waits for an Activity matching the specified name.
boolean	waitForCondition(Condition condition, int timeout) Waits for a condition to be satisfied.
boolean	waitForDialogToClose() Waits for a Dialog to close.
boolean	waitForDialogToClose(long timeout) Waits for a Dialog to close.
boolean	waitForDialogToOpen() Waits for a Dialog to open.
boolean	waitForDialogToOpen(long timeout) Waits for a Dialog to open.
boolean	waitForEmptyActivityStack(int timeout) Wait for the activity stack to be empty.
boolean	waitForFragmentById(int id) Waits for a Fragment matching the specified resource id.
boolean	waitForFragmentById(int id, int timeout) Waits for a Fragment matching the specified resource id.
boolean	waitForFragmentByTag(String tag) Waits for a Fragment matching the specified tag.
boolean	waitForFragmentByTag(String tag, int timeout) Waits for a Fragment matching the specified tag.
boolean	waitForLogMessage(String logMessage) Waits for the specified log message to appear.
boolean	waitForLogMessage(String logMessage, int timeout) Waits for the specified log message to appear.
boolean	waitForText(String text) Waits for the specified text to appear.
boolean	waitForText(String text, int minimumNumberOfMatches, long timeout) Waits for the specified text to appear.
boolean	waitForText(String text, int minimumNumberOfMatches, long timeout, boolean scroll) Waits for the specified text to appear.
boolean	waitForText(String text, int minimumNumberOfMatches, long timeout, boolean scroll, boolean onlyVisible) Waits for the specified text to appear.
<T extends android.view.View> boolean	waitForView(Class<T> viewClass) Waits for a View matching the specified class.
<T extends android.view.View> boolean	waitForView(Class<T> viewClass, int minimumNumberOfMatches, int timeout) Waits for a View matching the specified class.
<T extends android.view.View> boolean	waitForView(Class<T> viewClass, int minimumNumberOfMatches, int timeout, boolean scroll) Waits for a View matching the specified class.
boolean	waitForView(int id) Waits for a View matching the specified resource id.
boolean	waitForView(int id, int minimumNumberOfMatches, int timeout) Waits for a View matching the specified resource id.
boolean	waitForView(int id, int minimumNumberOfMatches, int timeout, boolean scroll) Waits for a View matching the specified resource id.
boolean	waitForView(Object tag) Waits for a View matching the specified tag.
boolean	waitForView(Object tag, int minimumNumberOfMatches, int timeout) Waits for a View matching the specified tag.
boolean	waitForView(Object tag, int minimumNumberOfMatches, int timeout, boolean scroll) Waits for a View matching the specified tag
<T extends android.view.View> boolean	waitForView(android.view.View view) Waits for the specified View.
<T extends android.view.View> boolean	waitForView(android.view.View view, int timeout, boolean scroll) Waits for the specified View.
boolean	waitForWebElement(By by) Waits for a WebElement matching the specified By object.
boolean	waitForWebElement(By by, int timeout, boolean scroll) Waits for a WebElement matching the specified By object.
boolean	waitForWebElement(By by, int minimumNumberOfMatches, int timeout, boolean scroll) Waits for a WebElement matching the specified By object.

Methods inherited from class java.lang.Object

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

Field Detail

asserter

protected final com.robotium.solo.Asserter asserter

viewFetcher

protected final com.robotium.solo.ViewFetcher viewFetcher

checker

protected final com.robotium.solo.Checker checker

clicker

protected final com.robotium.solo.Clicker clicker

presser

protected final com.robotium.solo.Presser presser

searcher

protected final com.robotium.solo.Searcher searcher

activityUtils

protected final com.robotium.solo.ActivityUtils activityUtils

dialogUtils

protected final com.robotium.solo.DialogUtils dialogUtils

textEnterer

protected final com.robotium.solo.TextEnterer textEnterer

rotator

protected final com.robotium.solo.Rotator rotator

scroller

protected final com.robotium.solo.Scroller scroller

sleeper

protected final com.robotium.solo.Sleeper sleeper

swiper

protected final com.robotium.solo.Swiper swiper

tapper

protected final com.robotium.solo.Tapper tapper

illustrator

protected final com.robotium.solo.Illustrator illustrator

waiter

protected final com.robotium.solo.Waiter waiter

setter

protected final com.robotium.solo.Setter setter

getter

protected final com.robotium.solo.Getter getter

webUtils

protected final com.robotium.solo.WebUtils webUtils

sender

protected final com.robotium.solo.Sender sender

screenshotTaker

protected final com.robotium.solo.ScreenshotTaker screenshotTaker

instrumentation

protected final android.app.Instrumentation instrumentation

zoomer

protected final com.robotium.solo.Zoomer zoomer

systemUtils

protected final SystemUtils systemUtils

webUrl

protected String webUrl

LANDSCAPE

public static final int LANDSCAPE

See Also:

Constant Field Values

PORTRAIT

public static final int PORTRAIT

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

UP

public static final int UP

See Also:

Constant Field Values

DOWN

public static final int DOWN

See Also:

Constant Field Values

ENTER

public static final int ENTER

See Also:

Constant Field Values

MENU

public static final int MENU

See Also:

Constant Field Values

DELETE

public static final int DELETE

See Also:

Constant Field Values

CLOSED

public static final int CLOSED

See Also:

Constant Field Values

OPENED

public static final int OPENED

See Also:

Constant Field Values

Constructor Detail

Solo

public Solo(android.app.Instrumentation instrumentation,
            android.app.Activity activity)

Constructor that takes the Instrumentation object and the start Activity.

Parameters:

instrumentation - the Instrumentation instance

activity - the start Activity or null if no Activity is specified

Solo

public Solo(android.app.Instrumentation instrumentation,
            Solo.Config config)

Constructor that takes the Instrumentation and Config objects.

Parameters:

instrumentation - the Instrumentation instance

config - the Solo.Config instance

Solo

public Solo(android.app.Instrumentation instrumentation,
            Solo.Config config,
            android.app.Activity activity)

Constructor that takes the Instrumentation, Config and Activity objects.

Parameters:

instrumentation - the Instrumentation instance

config - the Solo.Config instance

activity - the start Activity or null if no Activity is specified

Solo

public Solo(android.app.Instrumentation instrumentation)

Constructor that takes the instrumentation object.

Parameters:

instrumentation - the Instrumentation instance

Method Detail

getActivityMonitor

public android.app.Instrumentation.ActivityMonitor getActivityMonitor()

Returns the ActivityMonitor used by Robotium.

Returns:

the ActivityMonitor used by Robotium

getConfig

public Solo.Config getConfig()

Returns the Config used by Robotium.

Returns:

the Config used by Robotium

getViews

public ArrayList<android.view.View> getViews()

Returns an ArrayList of all the View objects located in the focused Activity or Dialog.

Returns:

an ArrayList of the View objects located in the focused window

getViews

public ArrayList<android.view.View> getViews(android.view.View parent)

Returns an ArrayList of the View objects contained in the parent View.

Parameters:

parent - the parent view from which to return the views

Returns:

an ArrayList of the View objects contained in the specified View

getTopParent

public android.view.View getTopParent(android.view.View view)

Returns the absolute top parent View of the specified View.

Parameters:

view - the View whose top parent is requested

Returns:

the top parent View

waitForText

public boolean waitForText(String text)

Waits for the specified text to appear. Default timeout is 20 seconds.

Parameters:

text - the text to wait for, specified as a regular expression

Returns:

true if text is displayed and false if it is not displayed before the timeout

waitForText

public boolean waitForText(String text,
                           int minimumNumberOfMatches,
                           long timeout)

Waits for the specified text to appear.

Parameters:

text - the text to wait for, specified as a regular expression

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the the amount of time in milliseconds to wait

Returns:

true if text is displayed and false if it is not displayed before the timeout

waitForText

public boolean waitForText(String text,
                           int minimumNumberOfMatches,
                           long timeout,
                           boolean scroll)

Waits for the specified text to appear.

Parameters:

text - the text to wait for, specified as a regular expression

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

Returns:

true if text is displayed and false if it is not displayed before the timeout

waitForText

public boolean waitForText(String text,
                           int minimumNumberOfMatches,
                           long timeout,
                           boolean scroll,
                           boolean onlyVisible)

Waits for the specified text to appear.

Parameters:

text - the text to wait for, specified as a regular expression

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

onlyVisible - true if only visible text views should be waited for

Returns:

true if text is displayed and false if it is not displayed before the timeout

waitForView

public boolean waitForView(int id)

Waits for a View matching the specified resource id. Default timeout is 20 seconds.

Parameters:

id - the R.id of the View to wait for

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public boolean waitForView(int id,
                           int minimumNumberOfMatches,
                           int timeout)

Waits for a View matching the specified resource id.

Parameters:

id - the R.id of the View to wait for

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the amount of time in milliseconds to wait

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public boolean waitForView(int id,
                           int minimumNumberOfMatches,
                           int timeout,
                           boolean scroll)

Waits for a View matching the specified resource id.

Parameters:

id - the R.id of the View to wait for

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public boolean waitForView(Object tag)

Waits for a View matching the specified tag. Default timeout is 20 seconds.

Parameters:

tag - the tag of the View to wait for

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public boolean waitForView(Object tag,
                           int minimumNumberOfMatches,
                           int timeout)

Waits for a View matching the specified tag.

Parameters:

tag - the tag of the View to wait for

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the amount of time in milliseconds to wait

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public boolean waitForView(Object tag,
                           int minimumNumberOfMatches,
                           int timeout,
                           boolean scroll)

Waits for a View matching the specified tag

Parameters:

tag - the tag of the View to wait for

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public <T extends android.view.View> boolean waitForView(Class<T> viewClass)

Waits for a View matching the specified class. Default timeout is 20 seconds.

Parameters:

viewClass - the View class to wait for

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public <T extends android.view.View> boolean waitForView(android.view.View view)

Waits for the specified View. Default timeout is 20 seconds.

Parameters:

view - the View object to wait for

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public <T extends android.view.View> boolean waitForView(android.view.View view,
                                                         int timeout,
                                                         boolean scroll)

Waits for the specified View.

Parameters:

view - the View object to wait for

timeout - the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public <T extends android.view.View> boolean waitForView(Class<T> viewClass,
                                                         int minimumNumberOfMatches,
                                                         int timeout)

Waits for a View matching the specified class.

Parameters:

viewClass - the View class to wait for

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the amount of time in milliseconds to wait

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForView

public <T extends android.view.View> boolean waitForView(Class<T> viewClass,
                                                         int minimumNumberOfMatches,
                                                         int timeout,
                                                         boolean scroll)

Waits for a View matching the specified class.

Parameters:

viewClass - the View class to wait for

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

Returns:

true if the View is displayed and false if it is not displayed before the timeout

waitForWebElement

public boolean waitForWebElement(By by)

Waits for a WebElement matching the specified By object. Default timeout is 20 seconds.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

Returns:

true if the WebElement is displayed and false if it is not displayed before the timeout

waitForWebElement

public boolean waitForWebElement(By by,
                                 int timeout,
                                 boolean scroll)

Waits for a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

timeout - the the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

Returns:

true if the WebElement is displayed and false if it is not displayed before the timeout

waitForWebElement

public boolean waitForWebElement(By by,
                                 int minimumNumberOfMatches,
                                 int timeout,
                                 boolean scroll)

Waits for a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

minimumNumberOfMatches - the minimum number of matches that are expected to be found. 0 means any number of matches

timeout - the the amount of time in milliseconds to wait

scroll - true if scrolling should be performed

Returns:

true if the WebElement is displayed and false if it is not displayed before the timeout

waitForCondition

public boolean waitForCondition(Condition condition,
                                int timeout)

Waits for a condition to be satisfied.

Parameters:

condition - the condition to wait for

timeout - the amount of time in milliseconds to wait

Returns:

true if condition is satisfied and false if it is not satisfied before the timeout

searchEditText

public boolean searchEditText(String text)

Searches for a text in the EditText objects currently displayed and returns true if found. Will automatically scroll when needed.

Parameters:

text - the text to search for

Returns:

true if an EditText displaying the specified text is found or false if it is not found

searchButton

public boolean searchButton(String text)

Searches for a Button displaying the specified text and returns true if at least one Button is found. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

Returns:

true if a Button displaying the specified text is found and false if it is not found

searchButton

public boolean searchButton(String text,
                            boolean onlyVisible)

Searches for a Button displaying the specified text and returns true if at least one Button is found. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

onlyVisible - true if only Button visible on the screen should be searched

Returns:

true if a Button displaying the specified text is found and false if it is not found

searchToggleButton

public boolean searchToggleButton(String text)

Searches for a ToggleButton displaying the specified text and returns true if at least one ToggleButton is found. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

Returns:

true if a ToggleButton displaying the specified text is found and false if it is not found

searchButton

public boolean searchButton(String text,
                            int minimumNumberOfMatches)

Searches for a Button displaying the specified text and returns true if the searched Button is found a specified number of times. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

minimumNumberOfMatches - the minimum number of matches expected to be found. 0 matches means that one or more matches are expected to be found

Returns:

true if a Button displaying the specified text is found a specified number of times and false if it is not found

searchButton

public boolean searchButton(String text,
                            int minimumNumberOfMatches,
                            boolean onlyVisible)

Searches for a Button displaying the specified text and returns true if the searched Button is found a specified number of times. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

minimumNumberOfMatches - the minimum number of matches expected to be found. 0 matches means that one or more matches are expected to be found

onlyVisible - true if only Button visible on the screen should be searched

Returns:

true if a Button displaying the specified text is found a specified number of times and false if it is not found

searchToggleButton

public boolean searchToggleButton(String text,
                                  int minimumNumberOfMatches)

Searches for a ToggleButton displaying the specified text and returns true if the searched ToggleButton is found a specified number of times. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

minimumNumberOfMatches - the minimum number of matches expected to be found. 0 matches means that one or more matches are expected to be found

Returns:

true if a ToggleButton displaying the specified text is found a specified number of times and false if it is not found

searchText

public boolean searchText(String text)

Searches for the specified text and returns true if at least one item is found displaying the expected text. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

Returns:

true if the search string is found and false if it is not found

searchText

public boolean searchText(String text,
                          boolean onlyVisible)

Searches for the specified text and returns true if at least one item is found displaying the expected text. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

onlyVisible - true if only texts visible on the screen should be searched

Returns:

true if the search string is found and false if it is not found

searchText

public boolean searchText(String text,
                          int minimumNumberOfMatches)

Searches for the specified text and returns true if the searched text is found a specified number of times. Will automatically scroll when needed.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression

minimumNumberOfMatches - the minimum number of matches expected to be found. 0 matches means that one or more matches are expected to be found

Returns:

true if text is found a specified number of times and false if the text is not found

searchText

public boolean searchText(String text,
                          int minimumNumberOfMatches,
                          boolean scroll)

Searches for the specified text and returns true if the searched text is found a specified number of times.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression.

minimumNumberOfMatches - the minimum number of matches expected to be found. 0 matches means that one or more matches are expected to be found

scroll - true if scrolling should be performed

Returns:

true if text is found a specified number of times and false if the text is not found

searchText

public boolean searchText(String text,
                          int minimumNumberOfMatches,
                          boolean scroll,
                          boolean onlyVisible)

Searches for the specified text and returns true if the searched text is found a specified number of times.

Parameters:

text - the text to search for. The parameter will be interpreted as a regular expression.

minimumNumberOfMatches - the minimum number of matches expected to be found. 0 matches means that one or more matches are expected to be found

scroll - true if scrolling should be performed

onlyVisible - true if only texts visible on the screen should be searched

Returns:

true if text is found a specified number of times and false if the text is not found

setActivityOrientation

public void setActivityOrientation(int orientation)

Sets the Orientation (Landscape/Portrait) for the current Activity.

Parameters:

orientation - the orientation to set. Solo.LANDSCAPE for landscape or Solo.PORTRAIT for portrait.

getCurrentActivity

public android.app.Activity getCurrentActivity()

Returns the current Activity.

Returns:

the current Activity

assertCurrentActivity

public void assertCurrentActivity(String message,
                                  String name)

Asserts that the Activity matching the specified name is active.

Parameters:

message - the message to display if the assert fails

name - the name of the Activity that is expected to be active. Example is: "MyActivity"

assertCurrentActivity

public void assertCurrentActivity(String message,
                                  Class activityClass)

Asserts that the Activity matching the specified class is active.

Parameters:

message - the message to display if the assert fails

activityClass - the class of the Activity that is expected to be active. Example is: MyActivity.class

assertCurrentActivity

public void assertCurrentActivity(String message,
                                  String name,
                                  boolean isNewInstance)

Asserts that the Activity matching the specified name is active, with the possibility to verify that the expected Activity is a new instance of the Activity.

Parameters:

message - the message to display if the assert fails

name - the name of the Activity that is expected to be active. Example is: "MyActivity"

isNewInstance - true if the expected Activity is a new instance of the Activity

assertCurrentActivity

public void assertCurrentActivity(String message,
                                  Class activityClass,
                                  boolean isNewInstance)

Asserts that the Activity matching the specified class is active, with the possibility to verify that the expected Activity is a new instance of the Activity.

Parameters:

message - the message to display if the assert fails

activityClass - the class of the Activity that is expected to be active. Example is: MyActivity.class

isNewInstance - true if the expected Activity is a new instance of the Activity

assertMemoryNotLow

public void assertMemoryNotLow()

Asserts that the available memory is not considered low by the system.

waitForDialogToOpen

public boolean waitForDialogToOpen()

Waits for a Dialog to open. Default timeout is 20 seconds.

Returns:

true if the Dialog is opened before the timeout and false if it is not opened

waitForDialogToClose

public boolean waitForDialogToClose()

Waits for a Dialog to close. Default timeout is 20 seconds.

Returns:

true if the Dialog is closed before the timeout and false if it is not closed

waitForDialogToOpen

public boolean waitForDialogToOpen(long timeout)

Waits for a Dialog to open.

Parameters:

timeout - the amount of time in milliseconds to wait

Returns:

true if the Dialog is opened before the timeout and false if it is not opened

waitForDialogToClose

public boolean waitForDialogToClose(long timeout)

Waits for a Dialog to close.

Parameters:

timeout - the amount of time in milliseconds to wait

Returns:

true if the Dialog is closed before the timeout and false if it is not closed

goBack

public void goBack()

Simulates pressing the hardware back key.

clickOnScreen

public void clickOnScreen(float x,
                          float y)

Clicks the specified coordinates.

Parameters:

x - the x coordinate

y - the y coordinate

clickOnScreen

public void clickOnScreen(float x,
                          float y,
                          int numberOfClicks)

Clicks the specified coordinates rapidly a specified number of times. Requires API level >= 14.

Parameters:

x - the x coordinate

y - the y coordinate

numberOfClicks - the number of clicks to perform

clickLongOnScreen

public void clickLongOnScreen(float x,
                              float y)

Long clicks the specified coordinates.

Parameters:

x - the x coordinate

y - the y coordinate

clickLongOnScreen

public void clickLongOnScreen(float x,
                              float y,
                              int time)

Long clicks the specified coordinates for a specified amount of time.

Parameters:

x - the x coordinate

y - the y coordinate

time - the amount of time to long click

clickOnButton

public void clickOnButton(String text)

Clicks a Button displaying the specified text. Will automatically scroll when needed.

Parameters:

text - the text displayed by the Button. The parameter will be interpreted as a regular expression

clickOnImageButton

public void clickOnImageButton(int index)

Clicks an ImageButton matching the specified index.

Parameters:

index - the index of the ImageButton to click. 0 if only one is available

clickOnToggleButton

public void clickOnToggleButton(String text)

Clicks a ToggleButton displaying the specified text.

Parameters:

text - the text displayed by the ToggleButton. The parameter will be interpreted as a regular expression

clickOnMenuItem

public void clickOnMenuItem(String text)

Clicks a MenuItem displaying the specified text.

Parameters:

text - the text displayed by the MenuItem. The parameter will be interpreted as a regular expression

clickOnMenuItem

public void clickOnMenuItem(String text,
                            boolean subMenu)

Clicks a MenuItem displaying the specified text.

Parameters:

text - the text displayed by the MenuItem. The parameter will be interpreted as a regular expression

subMenu - true if the menu item could be located in a sub menu

clickOnWebElement

public void clickOnWebElement(WebElement webElement)

Clicks the specified WebElement.

Parameters:

webElement - the WebElement to click

clickOnWebElement

public void clickOnWebElement(By by)

Clicks a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

clickOnWebElement

public void clickOnWebElement(By by,
                              int match)

Clicks a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

match - if multiple objects match, this determines which one to click

clickOnWebElement

public void clickOnWebElement(By by,
                              int match,
                              boolean scroll)

Clicks a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

match - if multiple objects match, this determines which one to click

scroll - true if scrolling should be performed

pressMenuItem

public void pressMenuItem(int index)

Presses a MenuItem matching the specified index. Index 0 is the first item in the first row, Index 3 is the first item in the second row and index 6 is the first item in the third row.

Parameters:

index - the index of the MenuItem to press

pressMenuItem

public void pressMenuItem(int index,
                          int itemsPerRow)

Presses a MenuItem matching the specified index. Supports three rows with a specified amount of items. If itemsPerRow equals 5 then index 0 is the first item in the first row, index 5 is the first item in the second row and index 10 is the first item in the third row.

Parameters:

index - the index of the MenuItem to press

itemsPerRow - the amount of menu items there are per row

pressSoftKeyboardNextButton

public void pressSoftKeyboardNextButton()

Presses the soft keyboard next button.

pressSoftKeyboardSearchButton

public void pressSoftKeyboardSearchButton()

Presses the soft keyboard search button.

pressSoftKeyboardGoButton

public void pressSoftKeyboardGoButton()

Presses the soft keyboard go button.

pressSoftKeyboardDoneButton

public void pressSoftKeyboardDoneButton()

Presses the soft keyboard done button.

pressSpinnerItem

public void pressSpinnerItem(int spinnerIndex,
                             int itemIndex)

Presses a Spinner (drop-down menu) item.

Parameters:

spinnerIndex - the index of the Spinner menu to use

itemIndex - the index of the Spinner item to press relative to the currently selected item. A Negative number moves up on the Spinner, positive moves down

clickOnView

public void clickOnView(android.view.View view)

Clicks the specified View.

Parameters:

view - the View to click

clickOnView

public void clickOnView(android.view.View view,
                        boolean immediately)

Clicks the specified View.

Parameters:

view - the View to click

immediately - true if View should be clicked without any wait

clickLongOnView

public void clickLongOnView(android.view.View view)

Long clicks the specified View.

Parameters:

view - the View to long click

clickLongOnView

public void clickLongOnView(android.view.View view,
                            int time)

Long clicks the specified View for a specified amount of time.

Parameters:

view - the View to long click

time - the amount of time to long click

clickOnText

public void clickOnText(String text)

Clicks a View or WebElement displaying the specified text. Will automatically scroll when needed.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

clickOnText

public void clickOnText(String text,
                        int match)

Clicks a View or WebElement displaying the specified text. Will automatically scroll when needed.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

match - if multiple objects match the text, this determines which one to click

clickOnText

public void clickOnText(String text,
                        int match,
                        boolean scroll)

Clicks a View or WebElement displaying the specified text.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

match - if multiple objects match the text, this determines which one to click

scroll - true if scrolling should be performed

clickLongOnText

public void clickLongOnText(String text)

Long clicks a View or WebElement displaying the specified text. Will automatically scroll when needed.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

clickLongOnText

public void clickLongOnText(String text,
                            int match)

Long clicks a View or WebElement displaying the specified text. Will automatically scroll when needed.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

match - if multiple objects match the text, this determines which one to click

clickLongOnText

public void clickLongOnText(String text,
                            int match,
                            boolean scroll)

Long clicks a View or WebElement displaying the specified text.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

match - if multiple objects match the text, this determines which one to click

scroll - true if scrolling should be performed

clickLongOnText

public void clickLongOnText(String text,
                            int match,
                            int time)

Long clicks a View or WebElement displaying the specified text.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

match - if multiple objects match the text, this determines which one to click

time - the amount of time to long click

clickLongOnTextAndPress

public void clickLongOnTextAndPress(String text,
                                    int index)

Long clicks a View displaying the specified text and then selects an item from the context menu that appears. Will automatically scroll when needed.

Parameters:

text - the text to click. The parameter will be interpreted as a regular expression

index - the index of the menu item to press. 0 if only one is available

clickOnButton

public void clickOnButton(int index)

Clicks a Button matching the specified index.

Parameters:

index - the index of the Button to click. 0 if only one is available

clickOnRadioButton

public void clickOnRadioButton(int index)

Clicks a RadioButton matching the specified index.

Parameters:

index - the index of the RadioButton to click. 0 if only one is available

clickOnCheckBox

public void clickOnCheckBox(int index)

Clicks a CheckBox matching the specified index.

Parameters:

index - the index of the CheckBox to click. 0 if only one is available

clickOnEditText

public void clickOnEditText(int index)

Clicks an EditText matching the specified index.

Parameters:

index - the index of the EditText to click. 0 if only one is available

clickInList

public ArrayList<android.widget.TextView> clickInList(int line)

Clicks the specified list line and returns an ArrayList of the TextView objects that the list line is displaying. Will use the first ListView it finds.

Parameters:

line - the line to click

Returns:

an ArrayList of the TextView objects located in the list line

clickInList

public ArrayList<android.widget.TextView> clickInList(int line,
                                                      int index)

Clicks the specified list line in the ListView matching the specified index and returns an ArrayList of the TextView objects that the list line is displaying.

Parameters:

line - the line to click

index - the index of the list. 0 if only one is available

Returns:

an ArrayList of the TextView objects located in the list line

clickLongInList

public ArrayList<android.widget.TextView> clickLongInList(int line)

Long clicks the specified list line and returns an ArrayList of the TextView objects that the list line is displaying. Will use the first ListView it finds.

Parameters:

line - the line to click

Returns:

an ArrayList of the TextView objects located in the list line

clickLongInList

public ArrayList<android.widget.TextView> clickLongInList(int line,
                                                          int index)

Long clicks the specified list line in the ListView matching the specified index and returns an ArrayList of the TextView objects that the list line is displaying.

Parameters:

line - the line to click

index - the index of the list. 0 if only one is available

Returns:

an ArrayList of the TextView objects located in the list line

clickLongInList

public ArrayList<android.widget.TextView> clickLongInList(int line,
                                                          int index,
                                                          int time)

Long clicks the specified list line in the ListView matching the specified index and returns an ArrayList of the TextView objects that the list line is displaying.

Parameters:

line - the line to click

index - the index of the list. 0 if only one is available

time - the amount of time to long click

Returns:

an ArrayList of the TextView objects located in the list line

clickInRecyclerView

public ArrayList<android.widget.TextView> clickInRecyclerView(int itemIndex)

Clicks the specified item index and returns an ArrayList of the TextView objects that the item index is displaying. Will use the first RecyclerView it finds.

Parameters:

itemIndex - the item index to click

Returns:

an ArrayList of the TextView objects located in the item index

clickInRecyclerView

public ArrayList<android.widget.TextView> clickInRecyclerView(int itemIndex,
                                                              int recyclerViewIndex)

Clicks the specified item index in the RecyclerView matching the specified RecyclerView index and returns an ArrayList of the TextView objects that the list line is displaying.

Parameters:

itemIndex - the line to click

recyclerViewIndex - the index of the RecyclerView. 0 if only one is available

Returns:

an ArrayList of the TextView objects located in the item index

clickLongInRecycleView

public ArrayList<android.widget.TextView> clickLongInRecycleView(int itemIndex)

Long clicks the specified item index and returns an ArrayList of the TextView objects that the item index is displaying. Will use the first RecyclerView it finds.

Parameters:

itemIndex - the item index to click

Returns:

an ArrayList of the TextView objects located in the list line

clickLongInRecycleView

public ArrayList<android.widget.TextView> clickLongInRecycleView(int itemIndex,
                                                                 int recyclerViewIndex)

Long clicks the specified item index in the RecyclerView matching the specified RecyclerView index and returns an ArrayList of the TextView objects that the item index is displaying.

Parameters:

itemIndex - the item index to click

recyclerViewIndex - the index of the RecyclerView. 0 if only one is available

Returns:

an ArrayList of the TextView objects located in the list line

clickLongInRecycleView

public ArrayList<android.widget.TextView> clickLongInRecycleView(int itemIndex,
                                                                 int recyclerViewIndex,
                                                                 int time)

Long clicks the specified item index in the RecyclerView matching the specified RecyclerView index and returns an ArrayList of the TextView objects that the item index is displaying.

Parameters:

itemIndex - the item index to click

recyclerViewIndex - the index of the RecyclerView. 0 if only one is available

time - the amount of time to long click

Returns:

an ArrayList of the TextView objects located in the list line

clickOnActionBarItem

public void clickOnActionBarItem(int id)

Clicks an ActionBarItem matching the specified resource id.

Parameters:

id - the R.id of the ActionBar item to click

clickOnActionBarHomeButton

public void clickOnActionBarHomeButton()

Clicks an ActionBar Home/Up button.

createIllustrationBuilder

public Illustration.Builder createIllustrationBuilder()

An Builder pattern that will allow the client to build a new illustration

illustrate

public void illustrate(Illustration illustration)

Simulate drawing an illustration on the screen.

Example of usage:

 
        Illustration.Builder builder = solo.createIllustrationBuilder();
        builder.addPoint(200, 20000, MotionEvent.TOOL_TYPE_FINGER);
        builder.addPoint(1000, 1500, MotionEvent.TOOL_TYPE_FINGER);
        Illustration illustration = builder.build();
        solo.illustrate(illustration);
 

Parameters:

illustration - Built-up illustration containing toolType, pressure, and coordinate information.

drag

public void drag(float fromX,
                 float toX,
                 float fromY,
                 float toY,
                 int stepCount)

Simulate touching the specified location and dragging it to a new location.

Parameters:

fromX - X coordinate of the initial touch, in screen coordinates

toX - X coordinate of the drag destination, in screen coordinates

fromY - Y coordinate of the initial touch, in screen coordinates

toY - Y coordinate of the drag destination, in screen coordinates

stepCount - how many move steps to include in the drag. Less steps results in a faster drag

scrollDown

public boolean scrollDown()

Scrolls down the screen.

Returns:

true if more scrolling can be performed and false if it is at the end of the screen

scrollToBottom

public void scrollToBottom()

Scrolls to the bottom of the screen.

scrollUp

public boolean scrollUp()

Scrolls up the screen.

Returns:

true if more scrolling can be performed and false if it is at the top of the screen

scrollToTop

public void scrollToTop()

Scrolls to the top of the screen.

scrollDownList

public boolean scrollDownList(android.widget.AbsListView list)

Scrolls down the specified AbsListView.

Parameters:

list - the AbsListView to scroll

Returns:

true if more scrolling can be performed

scrollListToBottom

public boolean scrollListToBottom(android.widget.AbsListView list)

Scrolls to the bottom of the specified AbsListView.

Parameters:

list - the AbsListView to scroll

Returns:

true if more scrolling can be performed

scrollUpList

public boolean scrollUpList(android.widget.AbsListView list)

Scrolls up the specified AbsListView.

Parameters:

list - the AbsListView to scroll

Returns:

true if more scrolling can be performed

scrollListToTop

public boolean scrollListToTop(android.widget.AbsListView list)

Scrolls to the top of the specified AbsListView.

Parameters:

list - the AbsListView to scroll

Returns:

true if more scrolling can be performed

scrollDownList

public boolean scrollDownList(int index)

Scrolls down a ListView matching the specified index.

Parameters:

index - the index of the ListView to scroll. 0 if only one list is available

Returns:

true if more scrolling can be performed

scrollListToBottom

public boolean scrollListToBottom(int index)

Scrolls a ListView matching the specified index to the bottom.

Parameters:

index - the index of the ListView to scroll. 0 if only one list is available

Returns:

true if more scrolling can be performed

scrollUpList

public boolean scrollUpList(int index)

Scrolls up a ListView matching the specified index.

Parameters:

index - the index of the ListView to scroll. 0 if only one list is available

Returns:

true if more scrolling can be performed

scrollListToTop

public boolean scrollListToTop(int index)

Scrolls a ListView matching the specified index to the top.

Parameters:

index - the index of the ListView to scroll. 0 if only one list is available

Returns:

true if more scrolling can be performed

scrollListToLine

public void scrollListToLine(android.widget.AbsListView absListView,
                             int line)

Scroll the specified AbsListView to the specified line.

Parameters:

absListView - the AbsListView to scroll

line - the line to scroll to

scrollListToLine

public void scrollListToLine(int index,
                             int line)

Scroll a AbsListView matching the specified index to the specified line.

Parameters:

index - the index of the AbsListView to scroll

line - the line to scroll to

scrollDownRecyclerView

public boolean scrollDownRecyclerView(int index)

Scrolls down a RecyclerView matching the specified index.

Parameters:

index - the index of the RecyclerView to scroll. 0 if only one RecyclerView is available

Returns:

true if more scrolling can be performed

scrollRecyclerViewToBottom

public boolean scrollRecyclerViewToBottom(int index)

Scrolls a RecyclerView matching the specified index to the bottom.

Parameters:

index - the index of the RecyclerView to scroll. 0 if only one list is available

Returns:

true if more scrolling can be performed

scrollUpRecyclerView

public boolean scrollUpRecyclerView(int index)

Scrolls up a RecyclerView matching the specified index.

Parameters:

index - the index of the RecyclerView to scroll. 0 if only one list is available

Returns:

true if more scrolling can be performed

scrollRecyclerViewToTop

public boolean scrollRecyclerViewToTop(int index)

Scrolls a RecyclerView matching the specified index to the top.

Parameters:

index - the index of the RecyclerView to scroll. 0 if only one list is available

Returns:

true if more scrolling can be performed

scrollToSide

public void scrollToSide(int side,
                         float scrollPosition,
                         int stepCount)

Scrolls horizontally.

Parameters:

side - the side to scroll; RIGHT or LEFT

scrollPosition - the position to scroll to, from 0 to 1 where 1 is all the way. Example is: 0.60

stepCount - how many move steps to include in the scroll. Less steps results in a faster scroll

scrollToSide

public void scrollToSide(int side,
                         float scrollPosition)

Scrolls horizontally.

Parameters:

side - the side to scroll; RIGHT or LEFT

scrollPosition - the position to scroll to, from 0 to 1 where 1 is all the way. Example is: 0.60

scrollToSide

public void scrollToSide(int side)

Scrolls horizontally.

Parameters:

side - the side to scroll; RIGHT or LEFT

scrollViewToSide

public void scrollViewToSide(android.view.View view,
                             int side,
                             float scrollPosition,
                             int stepCount)

Scrolls a View horizontally.

Parameters:

view - the View to scroll

side - the side to scroll; RIGHT or LEFT

scrollPosition - the position to scroll to, from 0 to 1 where 1 is all the way. Example is: 0.60

stepCount - how many move steps to include in the scroll. Less steps results in a faster scroll

scrollViewToSide

public void scrollViewToSide(android.view.View view,
                             int side,
                             float scrollPosition)

Scrolls a View horizontally.

Parameters:

view - the View to scroll

side - the side to scroll; RIGHT or LEFT

scrollPosition - the position to scroll to, from 0 to 1 where 1 is all the way. Example is: 0.60

scrollViewToSide

public void scrollViewToSide(android.view.View view,
                             int side)

Scrolls a View horizontally.

Parameters:

view - the View to scroll

side - the side to scroll; RIGHT or LEFT

pinchToZoom

public void pinchToZoom(android.graphics.PointF startPoint1,
                        android.graphics.PointF startPoint2,
                        android.graphics.PointF endPoint1,
                        android.graphics.PointF endPoint2)

Zooms in or out if startPoint1 and startPoint2 are larger or smaller then endPoint1 and endPoint2. Requires API level >= 14.

Parameters:

startPoint1 - First "finger" down on the screen

startPoint2 - Second "finger" down on the screen

endPoint1 - Corresponding ending point of startPoint1

endPoint2 - Corresponding ending point of startPoint2

swipe

public void swipe(android.graphics.PointF startPoint1,
                  android.graphics.PointF startPoint2,
                  android.graphics.PointF endPoint1,
                  android.graphics.PointF endPoint2)

Swipes with two fingers in a linear path determined by starting and ending points. Requires API level >= 14.

Parameters:

startPoint1 - First "finger" down on the screen

startPoint2 - Second "finger" down on the screen

endPoint1 - Corresponding ending point of startPoint1

endPoint2 - Corresponding ending point of startPoint2

rotateLarge

public void rotateLarge(android.graphics.PointF center1,
                        android.graphics.PointF center2)

Draws two semi-circles at the specified centers. Both circles are larger than rotateSmall(). Requires API level >= 14.

Parameters:

center1 - Center of semi-circle drawn from [0, Pi]

center2 - Center of semi-circle drawn from [Pi, 3*Pi]

rotateSmall

public void rotateSmall(android.graphics.PointF center1,
                        android.graphics.PointF center2)

Draws two semi-circles at the specified centers. Both circles are smaller than rotateLarge(). Requires API level >= 14.

Parameters:

center1 - Center of semi-circle drawn from [0, Pi]

center2 - Center of semi-circle drawn from [Pi, 3*Pi]

setMobileData

public void setMobileData(Boolean turnedOn)

Sets if mobile data should be turned on or off. Requires android.permission.CHANGE_NETWORK_STATE in the AndroidManifest.xml of the application under test. NOTE: Setting it to false can kill the adb connection.

Parameters:

turnedOn - true if mobile data is to be turned on and false if not

setWiFiData

public void setWiFiData(Boolean turnedOn)

Sets if wifi data should be turned on or off. Requires android.permission.CHANGE_WIFI_STATE in the AndroidManifest.xml of the application under test.

Parameters:

turnedOn - true if mobile wifi is to be turned on and false if not

setDatePicker

public void setDatePicker(int index,
                          int year,
                          int monthOfYear,
                          int dayOfMonth)

Sets the date in a DatePicker matching the specified index.

Parameters:

index - the index of the DatePicker. 0 if only one is available

year - the year e.g. 2011

monthOfYear - the month which starts from zero e.g. 0 for January

dayOfMonth - the day e.g. 10

setDatePicker

public void setDatePicker(android.widget.DatePicker datePicker,
                          int year,
                          int monthOfYear,
                          int dayOfMonth)

Sets the date in the specified DatePicker.

Parameters:

datePicker - the DatePicker object

year - the year e.g. 2011

monthOfYear - the month which starts from zero e.g. 03 for April

dayOfMonth - the day e.g. 10

setTimePicker

public void setTimePicker(int index,
                          int hour,
                          int minute)

Sets the time in a TimePicker matching the specified index.

Parameters:

index - the index of the TimePicker. 0 if only one is available

hour - the hour e.g. 15

minute - the minute e.g. 30

setTimePicker

public void setTimePicker(android.widget.TimePicker timePicker,
                          int hour,
                          int minute)

Sets the time in the specified TimePicker.

Parameters:

timePicker - the TimePicker object

hour - the hour e.g. 15

minute - the minute e.g. 30

setProgressBar

public void setProgressBar(int index,
                           int progress)

Sets the progress of a ProgressBar matching the specified index. Examples of ProgressBars are: SeekBar and RatingBar.

Parameters:

index - the index of the ProgressBar

progress - the progress to set the ProgressBar

setProgressBar

public void setProgressBar(android.widget.ProgressBar progressBar,
                           int progress)

Sets the progress of the specified ProgressBar. Examples of ProgressBars are: SeekBar and RatingBar.

Parameters:

progressBar - the ProgressBar

progress - the progress to set the ProgressBar

setNavigationDrawer

public void setNavigationDrawer(int status)

Sets the status of the NavigationDrawer. Examples of status are: Solo.CLOSED and Solo.OPENED.

Parameters:

status - the status that the NavigationDrawer should be set to

setSlidingDrawer

public void setSlidingDrawer(int index,
                             int status)

Sets the status of a SlidingDrawer matching the specified index. Examples of status are: Solo.CLOSED and Solo.OPENED.

Parameters:

index - the index of the SlidingDrawer

status - the status to set the SlidingDrawer

setSlidingDrawer

public void setSlidingDrawer(android.widget.SlidingDrawer slidingDrawer,
                             int status)

Sets the status of the specified SlidingDrawer. Examples of status are: Solo.CLOSED and Solo.OPENED.

Parameters:

slidingDrawer - the SlidingDrawer

status - the status to set the SlidingDrawer

enterText

public void enterText(int index,
                      String text)

Enters text in an EditText matching the specified index.

Parameters:

index - the index of the EditText. 0 if only one is available

text - the text to enter in the EditText field

enterText

public void enterText(android.widget.EditText editText,
                      String text)

Enters text in the specified EditText.

Parameters:

editText - the EditText to enter text in

text - the text to enter in the EditText field

enterTextInWebElement

public void enterTextInWebElement(By by,
                                  String text)

Enters text in a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

text - the text to enter in the WebElement field

typeText

public void typeText(int index,
                     String text)

Types text in an EditText matching the specified index.

Parameters:

index - the index of the EditText. 0 if only one is available

text - the text to type in the EditText field

typeText

public void typeText(android.widget.EditText editText,
                     String text)

Types text in the specified EditText.

Parameters:

editText - the EditText to type text in

text - the text to type in the EditText field

typeTextInWebElement

public void typeTextInWebElement(By by,
                                 String text)

Types text in a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

text - the text to enter in the WebElement field

typeTextInWebElement

public void typeTextInWebElement(By by,
                                 String text,
                                 int match)

Types text in a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

text - the text to enter in the WebElement field

match - if multiple objects match, this determines which one will be typed in

typeTextInWebElement

public void typeTextInWebElement(WebElement webElement,
                                 String text)

Types text in the specified WebElement.

Parameters:

webElement - the WebElement to type text in

text - the text to enter in the WebElement field

clearEditText

public void clearEditText(int index)

Clears the value of an EditText.

Parameters:

index - the index of the EditText to clear. 0 if only one is available

clearEditText

public void clearEditText(android.widget.EditText editText)

Clears the value of an EditText.

Parameters:

editText - the EditText to clear

clearTextInWebElement

public void clearTextInWebElement(By by)

Clears text in a WebElement matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

clickOnImage

public void clickOnImage(int index)

Clicks an ImageView matching the specified index.

Parameters:

index - the index of the ImageView to click. 0 if only one is available

getEditText

public android.widget.EditText getEditText(int index)

Returns an EditText matching the specified index.

Parameters:

index - the index of the EditText. 0 if only one is available

Returns:

an EditText matching the specified index

getButton

public android.widget.Button getButton(int index)

Returns a Button matching the specified index.

Parameters:

index - the index of the Button. 0 if only one is available

Returns:

a Button matching the specified index

getText

public android.widget.TextView getText(int index)

Returns a TextView matching the specified index.

Parameters:

index - the index of the TextView. 0 if only one is available

Returns:

a TextView matching the specified index

getImage

public android.widget.ImageView getImage(int index)

Returns an ImageView matching the specified index.

Parameters:

index - the index of the ImageView. 0 if only one is available

Returns:

an ImageView matching the specified index

getImageButton

public android.widget.ImageButton getImageButton(int index)

Returns an ImageButton matching the specified index.

Parameters:

index - the index of the ImageButton. 0 if only one is available

Returns:

the ImageButton matching the specified index

getText

public android.widget.TextView getText(String text)

Returns a TextView displaying the specified text.

Parameters:

text - the text that is displayed, specified as a regular expression

Returns:

the TextView displaying the specified text

getText

public android.widget.TextView getText(String text,
                                       boolean onlyVisible)

Returns a TextView displaying the specified text.

Parameters:

text - the text that is displayed, specified as a regular expression

onlyVisible - true if only visible texts on the screen should be returned

Returns:

the TextView displaying the specified text

getButton

public android.widget.Button getButton(String text)

Returns a Button displaying the specified text.

Parameters:

text - the text that is displayed, specified as a regular expression

Returns:

the Button displaying the specified text

getButton

public android.widget.Button getButton(String text,
                                       boolean onlyVisible)

Returns a Button displaying the specified text.

Parameters:

text - the text that is displayed, specified as a regular expression

onlyVisible - true if only visible buttons on the screen should be returned

Returns:

the Button displaying the specified text

getEditText

public android.widget.EditText getEditText(String text)

Returns an EditText displaying the specified text.

Parameters:

text - the text that is displayed, specified as a regular expression

Returns:

the EditText displaying the specified text

getEditText

public android.widget.EditText getEditText(String text,
                                           boolean onlyVisible)

Returns an EditText displaying the specified text.

Parameters:

text - the text that is displayed, specified as a regular expression

onlyVisible - true if only visible EditTexts on the screen should be returned

Returns:

the EditText displaying the specified text

getView

public android.view.View getView(int id)

Returns a View matching the specified resource id.

Parameters:

id - the R.id of the View to return

Returns:

a View matching the specified id

getView

public android.view.View getView(int id,
                                 int index)

Returns a View matching the specified resource id and index.

Parameters:

id - the R.id of the View to return

index - the index of the View. 0 if only one is available

Returns:

a View matching the specified id and index

getView

public android.view.View getView(Object tag)

Returns a View matching the specified tag.

Parameters:

tag - the tag of the View to return

Returns:

a View matching the specified id

getView

public android.view.View getView(Object tag,
                                 int index)

Returns a View matching the specified tag and index.

Parameters:

tag - the tag of the View to return

index - the index of the View. 0 if only one is available

Returns:

a View matching the specified id and index

getView

public android.view.View getView(String id)

Returns a View matching the specified resource id.

Parameters:

id - the id of the View to return

Returns:

a View matching the specified id

getView

public android.view.View getView(String id,
                                 int index)

Returns a View matching the specified resource id and index.

Parameters:

id - the id of the View to return

index - the index of the View. 0 if only one is available

Returns:

a View matching the specified id and index

getView

public <T extends android.view.View> T getView(Class<T> viewClass,
                                               int index)

Returns a View matching the specified class and index.

Parameters:

viewClass - the class of the requested view

index - the index of the View. 0 if only one is available

Returns:

a View matching the specified class and index

getWebElement

public WebElement getWebElement(By by,
                                int index)

Returns a WebElement matching the specified By object and index.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

index - the index of the WebElement. 0 if only one is available

Returns:

a WebElement matching the specified index

getWebUrl

public String getWebUrl()

Returns the current web page URL.

Returns:

the current web page URL

getCurrentViews

public ArrayList<android.view.View> getCurrentViews()

Returns an ArrayList of the Views currently displayed in the focused Activity or Dialog.

Returns:

an ArrayList of the View objects currently displayed in the focused window

getCurrentViews

public <T extends android.view.View> ArrayList<T> getCurrentViews(Class<T> classToFilterBy)

Returns an ArrayList of Views matching the specified class located in the focused Activity or Dialog.

Parameters:

classToFilterBy - return all instances of this class. Examples are: Button.class or ListView.class

Returns:

an ArrayList of Views matching the specified Class located in the current Activity

getCurrentViews

public <T extends android.view.View> ArrayList<T> getCurrentViews(Class<T> classToFilterBy,
                                                                  boolean includeSubclasses)

Returns an ArrayList of Views matching the specified class located in the focused Activity or Dialog.

Parameters:

classToFilterBy - return all instances of this class. Examples are: Button.class or ListView.class

includeSubclasses - include instances of the subclasses in the ArrayList that will be returned

Returns:

an ArrayList of Views matching the specified Class located in the current Activity

getCurrentViews

public <T extends android.view.View> ArrayList<T> getCurrentViews(Class<T> classToFilterBy,
                                                                  android.view.View parent)

Returns an ArrayList of Views matching the specified class located under the specified parent.

Parameters:

classToFilterBy - return all instances of this class. Examples are: Button.class or ListView.class

parent - the parent View for where to start the traversal

Returns:

an ArrayList of Views matching the specified Class located under the specified parent

getCurrentViews

public <T extends android.view.View> ArrayList<T> getCurrentViews(Class<T> classToFilterBy,
                                                                  boolean includeSubclasses,
                                                                  android.view.View parent)

Returns an ArrayList of Views matching the specified class located under the specified parent.

Parameters:

classToFilterBy - return all instances of this class. Examples are: Button.class or ListView.class

includeSubclasses - include instances of subclasses in the ArrayList that will be returned

parent - the parent View for where to start the traversal

Returns:

an ArrayList of Views matching the specified Class located under the specified parent

getWebElements

public ArrayList<WebElement> getWebElements()

Returns an ArrayList of all the WebElements displayed in the active WebView.

Returns:

an ArrayList of all the WebElement objects currently displayed in the active WebView

getWebElements

public ArrayList<WebElement> getWebElements(By by)

Returns an ArrayList of all the WebElements displayed in the active WebView matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

Returns:

an ArrayList of all the WebElement objects displayed in the active WebView

getCurrentWebElements

public ArrayList<WebElement> getCurrentWebElements()

Returns an ArrayList of the currently displayed WebElements in the active WebView.

Returns:

an ArrayList of the WebElement objects displayed in the active WebView

getCurrentWebElements

public ArrayList<WebElement> getCurrentWebElements(By by)

Returns an ArrayList of the currently displayed WebElements in the active WebView matching the specified By object.

Parameters:

by - the By object. Examples are: By.id("id") and By.name("name")

Returns:

an ArrayList of the WebElement objects currently displayed in the active WebView

isRadioButtonChecked

public boolean isRadioButtonChecked(int index)

Checks if a RadioButton matching the specified index is checked.

Parameters:

index - of the RadioButton to check. 0 if only one is available

Returns:

true if RadioButton is checked and false if it is not checked

isRadioButtonChecked

public boolean isRadioButtonChecked(String text)

Checks if a RadioButton displaying the specified text is checked.

Parameters:

text - the text that the RadioButton displays, specified as a regular expression

Returns:

true if a RadioButton matching the specified text is checked and false if it is not checked

isCheckBoxChecked

public boolean isCheckBoxChecked(int index)

Checks if a CheckBox matching the specified index is checked.

Parameters:

index - of the CheckBox to check. 0 if only one is available

Returns:

true if CheckBox is checked and false if it is not checked

isToggleButtonChecked

public boolean isToggleButtonChecked(String text)

Checks if a ToggleButton displaying the specified text is checked.

Parameters:

text - the text that the ToggleButton displays, specified as a regular expression

Returns:

true if a ToggleButton matching the specified text is checked and false if it is not checked

isToggleButtonChecked

public boolean isToggleButtonChecked(int index)

Checks if a ToggleButton matching the specified index is checked.

Parameters:

index - of the ToggleButton to check. 0 if only one is available

Returns:

true if ToggleButton is checked and false if it is not checked

isCheckBoxChecked

public boolean isCheckBoxChecked(String text)

Checks if a CheckBox displaying the specified text is checked.

Parameters:

text - the text that the CheckBox displays, specified as a regular expression

Returns:

true if a CheckBox displaying the specified text is checked and false if it is not checked

isTextChecked

public boolean isTextChecked(String text)

Checks if the specified text is checked.

Parameters:

text - the text that the CheckedTextView or CompoundButton objects display, specified as a regular expression

Returns:

true if the specified text is checked and false if it is not checked

isSpinnerTextSelected

public boolean isSpinnerTextSelected(String text)

Checks if the specified text is selected in any Spinner located in the current screen.

Parameters:

text - the text that is expected to be selected, specified as a regular expression

Returns:

true if the specified text is selected in any Spinner and false if it is not

isSpinnerTextSelected

public boolean isSpinnerTextSelected(int index,
                                     String text)

Checks if the specified text is selected in a Spinner matching the specified index.

Parameters:

index - the index of the spinner to check. 0 if only one spinner is available

text - the text that is expected to be selected, specified as a regular expression

Returns:

true if the specified text is selected in the specified Spinner and false if it is not

hideSoftKeyboard

public void hideSoftKeyboard()

Hides the soft keyboard.

unlockScreen

public void unlockScreen()

Unlocks the lock screen.

sendKey

public void sendKey(int key)

Sends a key: Right, Left, Up, Down, Enter, Menu or Delete.

Parameters:

key - the key to be sent. Use Solo.RIGHT, LEFT, UP, DOWN, ENTER, MENU, DELETE

goBackToActivity

public void goBackToActivity(String name)

Returns to an Activity matching the specified name.

Parameters:

name - the name of the Activity to return to. Example is: "MyActivity"

waitForActivity

public boolean waitForActivity(String name)

Waits for an Activity matching the specified name. Default timeout is 20 seconds.

Parameters:

name - the name of the Activity to wait for. Example is: "MyActivity"

Returns:

true if Activity appears before the timeout and false if it does not

waitForActivity

public boolean waitForActivity(String name,
                               int timeout)

Waits for an Activity matching the specified name.

Parameters:

name - the name of the Activity to wait for. Example is: "MyActivity"

timeout - the amount of time in milliseconds to wait

Returns:

true if Activity appears before the timeout and false if it does not

waitForActivity

public boolean waitForActivity(Class<? extends android.app.Activity> activityClass)

Waits for an Activity matching the specified class. Default timeout is 20 seconds.

Parameters:

activityClass - the class of the Activity to wait for. Example is: MyActivity.class

Returns:

true if Activity appears before the timeout and false if it does not

waitForActivity

public boolean waitForActivity(Class<? extends android.app.Activity> activityClass,
                               int timeout)

Waits for an Activity matching the specified class.

Parameters:

activityClass - the class of the Activity to wait for. Example is: MyActivity.class

timeout - the amount of time in milliseconds to wait

Returns:

true if Activity appears before the timeout and false if it does not

waitForEmptyActivityStack

public boolean waitForEmptyActivityStack(int timeout)

Wait for the activity stack to be empty.

Parameters:

timeout - the amount of time in milliseconds to wait

Returns:

true if activity stack is empty before the timeout and false if it is not

waitForFragmentByTag

public boolean waitForFragmentByTag(String tag)

Waits for a Fragment matching the specified tag. Default timeout is 20 seconds.

Parameters:

tag - the name of the tag

Returns:

true if fragment appears and false if it does not appear before the timeout

waitForFragmentByTag

public boolean waitForFragmentByTag(String tag,
                                    int timeout)

Waits for a Fragment matching the specified tag.

Parameters:

tag - the name of the tag

timeout - the amount of time in milliseconds to wait

Returns:

true if fragment appears and false if it does not appear before the timeout

waitForFragmentById

public boolean waitForFragmentById(int id)

Waits for a Fragment matching the specified resource id. Default timeout is 20 seconds.

Parameters:

id - the R.id of the fragment

Returns:

true if fragment appears and false if it does not appear before the timeout

waitForFragmentById

public boolean waitForFragmentById(int id,
                                   int timeout)

Waits for a Fragment matching the specified resource id.

Parameters:

id - the R.id of the fragment

timeout - the amount of time in milliseconds to wait

Returns:

true if fragment appears and false if it does not appear before the timeout

waitForLogMessage

public boolean waitForLogMessage(String logMessage)

Waits for the specified log message to appear. Default timeout is 20 seconds. Requires read logs permission (android.permission.READ_LOGS) in AndroidManifest.xml of the application under test.

Parameters:

logMessage - the log message to wait for

Returns:

true if log message appears and false if it does not appear before the timeout

See Also:

clearLog()

waitForLogMessage

public boolean waitForLogMessage(String logMessage,
                                 int timeout)

Waits for the specified log message to appear. Requires read logs permission (android.permission.READ_LOGS) in AndroidManifest.xml of the application under test.

Parameters:

logMessage - the log message to wait for

timeout - the amount of time in milliseconds to wait

Returns:

true if log message appears and false if it does not appear before the timeout

See Also:

clearLog()

clearLog

public void clearLog()

Clears the log.

getString

public String getString(int id)

Returns a localized String matching the specified resource id.

Parameters:

id - the R.id of the String

Returns:

the localized String

getString

public String getString(String id)

Returns a localized String matching the specified resource id.

Parameters:

id - the id of the String

Returns:

the localized String

sleep

public void sleep(int time)

Robotium will sleep for the specified time.

Parameters:

time - the time in milliseconds that Robotium should sleep

finalize

public void finalize()
              throws Throwable

Finalizes the Solo object and removes the ActivityMonitor.

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

finishOpenedActivities() to close the activities that have been active

finishOpenedActivities

public void finishOpenedActivities()

The Activities that are alive are finished. Usually used in tearDown().

takeScreenshot

public void takeScreenshot()

Takes a screenshot and saves it in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/). Requires write permission (android.permission.WRITE_EXTERNAL_STORAGE) in AndroidManifest.xml of the application under test.

takeScreenshot

public void takeScreenshot(String name)

Takes a screenshot and saves it with the specified name in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/). Requires write permission (android.permission.WRITE_EXTERNAL_STORAGE) in AndroidManifest.xml of the application under test.

Parameters:

name - the name to give the screenshot

takeScreenshot

public void takeScreenshot(String name,
                           int quality)

Takes a screenshot and saves the image with the specified name in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/). Requires write permission (android.permission.WRITE_EXTERNAL_STORAGE) in AndroidManifest.xml of the application under test.

Parameters:

name - the name to give the screenshot

quality - the compression rate. From 0 (compress for lowest size) to 100 (compress for maximum quality)

startScreenshotSequence

public void startScreenshotSequence(String name)

Takes a screenshot sequence and saves the images with the specified name prefix in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/). The name prefix is appended with "_" + sequence_number for each image in the sequence, where numbering starts at 0. Requires write permission (android.permission.WRITE_EXTERNAL_STORAGE) in AndroidManifest.xml of the application under test. At present multiple simultaneous screenshot sequences are not supported. This method will throw an exception if stopScreenshotSequence() has not been called to finish any prior sequences. Calling this method is equivalend to calling startScreenshotSequence(name, 80, 400, 100);

Parameters:

name - the name prefix to give the screenshot

startScreenshotSequence

public void startScreenshotSequence(String name,
                                    int quality,
                                    int frameDelay,
                                    int maxFrames)

Takes a screenshot sequence and saves the images with the specified name prefix in the Solo.Config objects save path (default set to: /sdcard/Robotium-Screenshots/). The name prefix is appended with "_" + sequence_number for each image in the sequence, where numbering starts at 0. Requires write permission (android.permission.WRITE_EXTERNAL_STORAGE) in the AndroidManifest.xml of the application under test. Taking a screenshot will take on the order of 40-100 milliseconds of time on the main UI thread. Therefore it is possible to mess up the timing of tests if the frameDelay value is set too small. At present multiple simultaneous screenshot sequences are not supported. This method will throw an exception if stopScreenshotSequence() has not been called to finish any prior sequences.

Parameters:

name - the name prefix to give the screenshot

quality - the compression rate. From 0 (compress for lowest size) to 100 (compress for maximum quality)

frameDelay - the time in milliseconds to wait between each frame

maxFrames - the maximum number of frames that will comprise this sequence

stopScreenshotSequence

public void stopScreenshotSequence()

Causes a screenshot sequence to end. If this method is not called to end a sequence and a prior sequence is still in progress, startScreenshotSequence() will throw an exception.