com.jayway.android.robotium.remotecontrol.client.processor

Class SoloProcessor

java.lang.Object

com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

com.jayway.android.robotium.remotecontrol.client.processor.SoloProcessor

All Implemented Interfaces:

CacheReferenceInterface, ProcessorInterface

public class SoloProcessor
extends AbstractProcessor
implements CacheReferenceInterface

This class is used to process the "remote command" from the robotium-remote-control
The input parameters are in a Properties object, and the results will be put into
that properties object, which will be sent back to robotium-remote-control
They will be in key-value format in the properties object.
The key is defined as constant in SoloMessage
Refer to the following page to know what key to get and what key to set for each "command"
http://safsdev.sourceforge.net/doc/com/jayway/android/robotium/remotecontrol/solo/Solo.html

For example:
For command "assertCurrentActivityClass", at the Returns part, you can see
(in ):KEY_TARGET=target_solo
(in ):KEY_COMMAND=cmd_assertcurrentactivityclass
(out):KEY_ISREMOTERESULT=true
(out):KEY_REMOTERESULTCODE=String:int:0=success/normal=SoloMessage.STATUS_REMOTERESULT_OK
.....
When it marks a 'in', you should get; while it marks a 'out', you should set it with a result

Since:

Feb 16, 2012
May 17, 2013 (Lei Wang) Update to support Robotium 4.1
May 23, 2013 (Lei Wang) Modify method takeScreenshot()
Jun 21, 2013 (Lei Wang) Update to support Robotium 4.1+
Jun 25, 2013 (Carl Nagle) Update to support Robotium 4.2
Jul 18, 2013 (Lei Wang) Modify method getViewByName(): try to get view under package 'android'.
SEP 04, 2013 (Carl Nagle) Update to support getViewId(int, index)
MAR 13, 2014 (Carl Nagle) Update to support Robotium 5.x
JUL 21, 2014 (Lei Wang) Update to support Robotium 5.2.1
MAR 05, 2015 (Lei Wang) Update to support Robotium 5.3.1

Author:

Lei Wang, SAS Institute, Inc

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable<java.lang.String,android.app.Activity>	activityCache local cache for containing the Activity Note: Don't manipulate it directly like activityCache.get(key) etc. Use the cache-manipulation-methods defined in AbstractProcessor
protected java.util.Hashtable<java.lang.String,android.app.Instrumentation.ActivityMonitor>	activityMonitorCache local cache for containing the Instrumentation.ActivityMonitor Note: Don't manipulate it directly like activityMonitorCache.get(key) etc. Use the cache-manipulation-methods defined in AbstractProcessor
(package private) RobotiumTestCase	activityrunner
(package private) android.app.Activity	mainApp The main Activity object.
(package private) RobotiumTestRunner	robotiumTestrunner
(package private) RCSolo	solo The instance of RCSolo, it is used to do the real work for handling the messages from 'solo remote control'
static java.lang.String	TAG
protected java.util.Hashtable<java.lang.String,java.lang.Object>	tagCache local cache for containing the View.getTag() Note: Don't manipulate it directly like tagCache.get(key) etc. Use the cache-manipulation-methods defined in AbstractProcessor
protected java.util.Hashtable<java.lang.String,android.view.View>	viewCache local cache for containing the View Note: Don't manipulate it directly like viewCache.get(key) etc. Use the cache-manipulation-methods defined in AbstractProcessor
protected java.util.Hashtable<java.lang.String,com.robotium.solo.WebElement>	webElementCache local cache for containing the WebElement Note: Don't manipulate it directly like webElementCache.get(key) etc. Use the cache-manipulation-methods defined in AbstractProcessor

Fields inherited from class com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

INITIAL_CACHE_SIZE, remoteCommand, testRunner

Constructor Summary

Constructors

Constructor and Description
SoloProcessor(RobotiumTestRunner robotiumTestrunner)

Method Summary

Modifier and Type	Method and Description
void	addCacheReferenceInterface(CacheReferenceInterface cache) CacheReferenceInterface implementation.
(package private) void	assertCurrentActivity(java.util.Properties props) assert the current activity has the given name/class, with the possibility to verify that the expected Activity is a new instance of the Activity.
(package private) void	assertMemoryNotLow(java.util.Properties props) assert that the memory is enough
protected boolean	checkSolo() Test if the solo is null.
void	clearCache(boolean useChain) CacheReferenceInterface implementation.
(package private) void	clearEditText(java.util.Properties props) clear the text in EditText
(package private) void	clearTextInWebElement(java.util.Properties props) Clears text in a WebElement matching the specified By object.
(package private) void	clickInList(java.util.Properties props, boolean longtime) click an item in android.widget.ListView
(package private) void	clickOnActionBarItem(java.util.Properties props) Clicks on an ActionBar item with a given resource id. Requires Robotium 3.6
(package private) void	clickOnMenuItem(java.util.Properties props, boolean subMenu) click on a 'menu item' indicated by text
(package private) void	clickOnScreen(java.util.Properties props, boolean longtime) click some point on screen
(package private) void	clickOnText(java.util.Properties props, boolean longtime) click on a string within the current
(package private) void	clickOnView(java.util.Properties props, boolean longtime) click on a View The view's id is given by parameter, according to this id, We will find the View from local cache viewCache and click on it. This method has no relationship with method clickOnViewByIndex(Properties)
(package private) void	clickOnViewByIndex(java.util.Properties props) click on the following TextView by index CheckBox EditText ImageView ImageButton RadioButton Button The index is given by parameter, according to that index Solo will click on the appropriate TextView. This method has no relationship with method clickOnView(Properties, boolean)
(package private) void	clickOnViewByName(java.util.Properties props) click on the following TextView by name Button ToggleButton The name is given by parameter, according to that name Solo will click on the appropriate TextView. This method has no relationship with method clickOnView(Properties, boolean)
(package private) void	clickOnWebElement(java.util.Properties props) Clicks a WebElement matching the specified By object.
(package private) void	clickOnWebElementByUID(java.util.Properties props) Clicks a WebElement stored in cache by reference UID.
(package private) void	drag(java.util.Properties props) Simulate touching a given location and dragging it to a new location.
(package private) void	enterText(java.util.Properties props) input the text in EditText
(package private) void	enterTextInWebElement(java.util.Properties props) Enters text in a WebElement matching the specified By object.
(package private) void	finalizeRemoteSolo(java.util.Properties props) Finalizes the solo object and removes the ActivityMonitor.
(package private) void	finishOpenedActivities(java.util.Properties props) All activities that have been active are finished.
(package private) void	getActivityMonitor(java.util.Properties props) Returns a String UID for the Robotium Solo Activity Monitor Use a cache to store the ActivityMonitor. If the ActivityMonitor doesn't exist in the cache, we generate an ID and put the ActivityMonitor into cache with that ID. If the ActivityMonitor exists in the cache, we just return the related ID.
(package private) void	getAllOpenActivities(java.util.Properties props) get all activities and return their ID in format ";ID;ID;ID" the ID string will be stored in remoteresultinfo of parameter props.
protected android.graphics.Bitmap	getBitmapOfView(android.view.View view) Get bitmap image of a View. This method call View.getDrawingCache() to get the bitmap image. For some special views, we can't generate the bitmap by this way.
java.lang.Object	getCachedObject(java.lang.String key, boolean useChain) CacheReferenceInterface implementation.
(package private) void	getCurrentActivity(java.util.Properties props) get the current activity and return its ID the ID string will be stored in remoteresultinfo of parameter props.
(package private) void	getCurrentViews(java.util.Properties props) get all the Views of following type: Button CheckBox DatePicker EditText GridView ImageButton ImageView ListView ProgressBar RadioButton ScrollView SlidingDrawer Spinner TextView TimePicker ToggleButton View
(package private) void	getCurrentWebElements(java.util.Properties props) get the current WebElements and return its ID the ID string will be stored in remoteresultinfo of parameter props.
(package private) void	getGuiImage(java.util.Properties props) Get image of a View. According to the view's id, try to get a View from cache. If not found, a ProcessorException will be thrown out. If a view is found, we will get the bitmap of that view and compress the bytes to String and return it through KEY_REMOTERESULTINFO
(package private) java.lang.String	getImageBase64EncodedString(java.lang.String filename, java.lang.StringBuffer absoluteFilePath) Read a JPG file with name 'filename' from folder '/sdcard/Robotium-Screenshots/', then encode it to a String and return, this method doesn't care when the image file is created.
(package private) java.lang.String	getImageBase64EncodedString(java.lang.String filename, java.lang.StringBuffer absoluteFilePath, long newerThan) Read a JPG file with name 'filename' from folder '/sdcard/Robotium-Screenshots/', then encode it to a String and return, this method will only read the image file created after the time provide by parameter 'newerThan'
(package private) void	getObjectClassName(java.util.Properties props, boolean isViewObject) Get class name of an object. According to the object's id, try to get it from cache. If not found, a ProcessorException will be thrown out. If it is found, we will get its class name and return through KEY_REMOTERESULTINFO
(package private) void	getScreenshotSequence(java.util.Properties props) Retrieve a sequence of screenshots, which are stored in "/sdcard/Robotium-Screenshots/". Requires Robotium 4.1+
(package private) void	getScreenSize(java.util.Properties props) Get the screen's size.
(package private) void	getString(java.util.Properties props) Returns a localized String from localized String resources, according to 'resource id' in a current Activity, or a String resource name in the context of the current package, or the android package. given by Message.PARAM_RESID or Message.PARAM_ID
(package private) void	getTagForView(java.util.Properties props) Get the View's Tag accroding to a View's UID, and return the Tag's UID.
(package private) void	getTextViewValue(java.util.Properties props) According to the view's id, try to get a View of type 'TextView'.
(package private) void	getTopParent(java.util.Properties props) Get the top parent view of the given view, identified by the parameter Message.PARAM_REFERENCE
(package private) void	getViewById(java.util.Properties props) get the View by id (R.id) can also get the nth View by id at a provided index.
(package private) void	getViewByIndex(java.util.Properties props) get the following TextView by index Button EditText TextView ImageView ImageButton The index is given by parameter, according to that index Solo will get the appropriate TextView.
(package private) void	getViewByName(java.util.Properties props) get the View by resource idname.
(package private) void	getViewByTag(java.util.Properties props) get the View by Tag Object.
(package private) void	getViewByText(java.util.Properties props) get the following TextView by text Button EditText TextView The text is given by parameter, according to that text Solo will get the appropriate TextView.
(package private) void	getViewClassName(java.util.Properties props) Deprecated. we can use getObjectClassName(Properties, boolean) instead
(package private) void	getViewLocation(java.util.Properties props) Get the View's location, (x,y,width,height).
(package private) void	getViewsInParent(java.util.Properties props) Get all the views belonging to a parent view.
(package private) void	goBack(java.util.Properties props) Simulates pressing the hardware back key.
(package private) void	goBackToActivity(java.util.Properties props) Returns to the given Activity.
(package private) void	handleComandWithoutParams(java.util.Properties props) Handle the commands without parameters
(package private) void	handleConfigScreenshotFileTypeCommands(java.util.Properties props) Handle the GET/SET commands for Solo.Config.screenshotFileType.
(package private) void	handleConfigScreenshotSavePathCommands(java.util.Properties props) Handle the GET/SET commands for Solo.Config.screenshotSavePath.
(package private) void	handleConfigShouldScrollCommands(java.util.Properties props) Handle the GET/SET commands for Solo.Config.shouldScroll.
(package private) void	handleConfigTimeoutCommands(java.util.Properties props) Handle the GET/SET commands for Solo.Config.timeout_small and Solo.Config.timeout_large.
(package private) void	handleConfigUseJavaScriptToClickWebElementsCommands(java.util.Properties props) Handle the GET/SET commands for Solo.Config.useJavaScriptToClickWebElements.
(package private) void	handleRobotiumTimeoutCommand(java.util.Properties props) Handle the static methods of class Timeout. Requires Robotium 4.1+
(package private) void	handleRobotiumUtilsCommand(java.util.Properties props) Handle the static methods of class RobotiumUtils. Requires Robotium 4.1
(package private) void	handleZoomRotateSwipe(java.util.Properties props) Handle the zoom, rotate, swipe methods of Robotium Solo. Requires Robotium 4.1+
(package private) void	isViewByIndexChecked(java.util.Properties props) test if the following TextView is checked. CheckBox RadioButton Spinner ToggleButton The index is given by parameter, according to that index Solo will get the appropriate View and test if it is checked.
(package private) void	isViewByTextChecked(java.util.Properties props) test if the following TextView is checked. CheckBox RadioButton Spinner ToggleButton The text is given by parameter, according to that text Solo will get the appropriate View and test if it is checked.
(package private) void	pressMenuItem(java.util.Properties props) press an item in android.widget.Menu
(package private) void	pressSoftKeyboardNextButton(java.util.Properties props) Press the soft keyboard Next button. Requires Robotium 5.0.1
(package private) void	pressSoftKeyboardSearchButton(java.util.Properties props) Press the soft keyboard Search button. Requires Robotium 5.x
(package private) void	pressSpinnerItem(java.util.Properties props) press an item in Spinner
void	processProperties(java.util.Properties props) Before calling this method, you should call setRemoteCommand()
void	removeCacheReferenceInterface(CacheReferenceInterface cache) CacheReferenceInterface implementation.
(package private) void	scroll(java.util.Properties props) scroll vertically.
(package private) void	scrollToSide(java.util.Properties props) scroll horizontally. scrollPosition is an optional parameter.
(package private) void	searchView(java.util.Properties props) search the following view. Button EditText TextView ToggleButton
(package private) void	sendKey(java.util.Properties props) send a key to current view.
(package private) void	setActivityOrientation(java.util.Properties props) set orientation of view.
(package private) void	setDatePicker(java.util.Properties props) set value of DatePicker.
(package private) void	setMobileData(java.util.Properties props) Turn on/off 'mobile data'
(package private) void	setNavigationDrawer(java.util.Properties props) Sets the status of the NavigationDrawer.
(package private) void	setProgressBar(java.util.Properties props) set value of ProgressBar.
(package private) void	setSlidingDrawer(java.util.Properties props) set value of SlidingDrawer.
(package private) void	setTimePicker(java.util.Properties props) set value of TimePicker.
(package private) void	setWiFiData(java.util.Properties props) Turn on/off 'wifi data'
(package private) void	sleep(java.util.Properties props) Robotium will sleep for a specified time (milliseconds).
protected void	startMainLauncher(java.util.Properties props) This method will launch the main activity. It will initialize the Solo object of RobotiumTestRunner This Solo object will also be shared by this class If you want to use the Solo object, you MUST call this method firstly.
(package private) void	startScreenshotSequenceMax(java.util.Properties props) Takes a screenshot sequence and stores the images via the Robotium Solo API. Requires Robotium 4.2
(package private) void	takeScreenshot(java.util.Properties props) Takes a Screenshot and retrieve it from /sdcard/Robotium-Screenshots/. Requires Robotium 3.4.1
(package private) void	typeTextInWebElementByUID(java.util.Properties props) Type text in a WebElement stored in cache by reference UID.
(package private) void	waitForActivity(java.util.Properties props) Wait for Activity.
(package private) void	waitForCondition(java.util.Properties props) Waits for a condition to be satisfied.
(package private) void	waitForDialog(java.util.Properties props) Wait for Dialog to close/open.
(package private) void	waitForEmptyActivityStack(java.util.Properties props) Wait for Empty Activity Stack. Requires Robotium 5.0.1
(package private) void	waitForFragmentById(java.util.Properties props) Wait for a V4 Fragment by Id. Requires Robotium 3.4.1
(package private) void	waitForFragmentByTag(java.util.Properties props) Wait for a V4 Fragment by Tag. Requires Robotium 3.4.1
(package private) void	waitForLogMessage(java.util.Properties props) Wait for a specific log message. Requires Robotium 3.4.1
(package private) void	waitForText(java.util.Properties props) Wait for TextView.
(package private) void	waitForView(java.util.Properties props) Wait for View.
(package private) void	waitForViewByID(java.util.Properties props) Wait for View according to ID (R.id) Requires Robotium4.1+
(package private) void	waitForViewByTag(java.util.Properties props) Wait for View.
(package private) void	waitForViewUID(java.util.Properties props) Wait for View.
(package private) void	waitForWebElement(java.util.Properties props) Wait for WebElement.

Methods inherited from class com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

cacheContainValue, convertToKey, convertToKeys, convertToKeys, debug, getCachedItem, getCacheKeyForValue, getStackTrace, makeUniqueCacheKey, processMessage, putCachedItem, removeCachedItem, resetExternalModeCache, setGeneralError, setGeneralError, setGeneralErrorWithSpecialInfo, setGeneralErrorWithSpecialInfo, setGeneralSuccess, setGeneralSuccess, setGeneralSuccessWithSpecialInfo, setGeneralWarningWithSpecialInfo, setRemoteCommand, stringIsMatched

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static java.lang.String TAG

mainApp

android.app.Activity mainApp

The main Activity object.

solo

RCSolo solo

The instance of RCSolo, it is used
to do the real work for handling the messages from 'solo remote control'

activityrunner

RobotiumTestCase activityrunner

robotiumTestrunner

RobotiumTestRunner robotiumTestrunner

activityMonitorCache

protected java.util.Hashtable<java.lang.String,android.app.Instrumentation.ActivityMonitor> activityMonitorCache

local cache for containing the Instrumentation.ActivityMonitor Note: Don't manipulate it directly like activityMonitorCache.get(key) etc.
Use the cache-manipulation-methods defined in AbstractProcessor

See Also:

AbstractProcessor.getCachedItem(Hashtable, Object), AbstractProcessor.removeCachedItem(Hashtable, Object), AbstractProcessor.putCachedItem(Hashtable, Object, Object)

activityCache

protected java.util.Hashtable<java.lang.String,android.app.Activity> activityCache

local cache for containing the Activity Note: Don't manipulate it directly like activityCache.get(key) etc.
Use the cache-manipulation-methods defined in AbstractProcessor

See Also:

AbstractProcessor.getCachedItem(Hashtable, Object), AbstractProcessor.removeCachedItem(Hashtable, Object), AbstractProcessor.putCachedItem(Hashtable, Object, Object)

viewCache

protected java.util.Hashtable<java.lang.String,android.view.View> viewCache

local cache for containing the View Note: Don't manipulate it directly like viewCache.get(key) etc.
Use the cache-manipulation-methods defined in AbstractProcessor

See Also:

AbstractProcessor.getCachedItem(Hashtable, Object), AbstractProcessor.removeCachedItem(Hashtable, Object), AbstractProcessor.putCachedItem(Hashtable, Object, Object)

webElementCache

protected java.util.Hashtable<java.lang.String,com.robotium.solo.WebElement> webElementCache

local cache for containing the WebElement Note: Don't manipulate it directly like webElementCache.get(key) etc.
Use the cache-manipulation-methods defined in AbstractProcessor

See Also:

AbstractProcessor.getCachedItem(Hashtable, Object), AbstractProcessor.removeCachedItem(Hashtable, Object), AbstractProcessor.putCachedItem(Hashtable, Object, Object)

tagCache

protected java.util.Hashtable<java.lang.String,java.lang.Object> tagCache

local cache for containing the View.getTag()
Note: Don't manipulate it directly like tagCache.get(key) etc.
Use the cache-manipulation-methods defined in AbstractProcessor

See Also:

AbstractProcessor.getCachedItem(Hashtable, Object), AbstractProcessor.removeCachedItem(Hashtable, Object), AbstractProcessor.putCachedItem(Hashtable, Object, Object)

Constructor Detail

SoloProcessor

public SoloProcessor(RobotiumTestRunner robotiumTestrunner)

Method Detail

checkSolo

protected boolean checkSolo()

Test if the solo is null. If it is, try to set it with that of RobotiumTestRunner

See Also:

RobotiumTestRunner.getSolo()

processProperties

public void processProperties(java.util.Properties props)

Before calling this method, you should call setRemoteCommand()

Specified by:

processProperties in interface ProcessorInterface

Overrides:

processProperties in class AbstractProcessor

Parameters:

props - The Properties object containing the in and out parameters

See Also:

ProcessorInterface.processProperties(Properties)

startMainLauncher

protected void startMainLauncher(java.util.Properties props)
                          throws ProcessorException

This method will launch the main activity.
It will initialize the Solo object of RobotiumTestRunner
This Solo object will also be shared by this class
If you want to use the Solo object, you MUST call this method firstly.

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

See Also:

RobotiumTestRunner.launchApplication()

assertCurrentActivity

void assertCurrentActivity(java.util.Properties props)
                    throws ProcessorException

assert the current activity has the given name/class, with the possibility to verify that
the expected Activity is a new instance of the Activity.

calling:
Solo.assertCurrentActivity(String, Class)
Solo#assertCurrentActivity(String, Class, boolean)

Solo#assertCurrentActivity(String, String))
Solo#assertCurrentActivity(String, String, boolean))

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

assertMemoryNotLow

void assertMemoryNotLow(java.util.Properties props)

assert that the memory is enough

calling:
Solo.assertMemoryNotLow()

Parameters:

props - The Properties object containing the in and out parameters

clearEditText

void clearEditText(java.util.Properties props)
            throws ProcessorException

clear the text in EditText

calling:
Solo.clearEditText(EditText)
Solo.clearEditText(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

handleComandWithoutParams

void handleComandWithoutParams(java.util.Properties props)

Handle the commands without parameters

calling:

Solo.clearLog() Requires Robotium4.1+
Solo.stopScreenshotSequence() Requires Robotium4.2
Solo.clickOnActionBarHomeButton() Robotium 3.4.1
Solo.unlockScreen() Robotium 5.2.1

Parameters:

props - The Properties object containing the in and out parameters

clickInList

void clickInList(java.util.Properties props,
                 boolean longtime)
          throws ProcessorException

click an item in android.widget.ListView

calling:
Solo.clickInList(int)
Solo.clickInList(int, int)
Solo.clickLongInList(int)
Solo.clickLongInList(int, int)
Solo.clickLongInList(int, int, int)

Parameters:

props - The Properties object containing the in and out parameters

longtime - Boolean, if a long-time click should be performed.

Throws:

ProcessorException

clickOnScreen

void clickOnScreen(java.util.Properties props,
                   boolean longtime)
            throws ProcessorException

click some point on screen

calling:
Solo.clickOnScreen(float, float)
Solo.clickLongOnScreen(float, float)
Solo.clickLongOnScreen(float, float, int)
Solo.clickOnScreen(float, float, int) Requires Robotium4.1+

Parameters:

props - The Properties object containing the in and out parameters

longtime - Boolean, if a long-time click should be performed.

Throws:

ProcessorException

clickOnActionBarItem

void clickOnActionBarItem(java.util.Properties props)
                   throws ProcessorException

Clicks on an ActionBar item with a given resource id.
Requires Robotium 3.6

calling:
Solo.clickOnActionBarItem(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

clickOnText

void clickOnText(java.util.Properties props,
                 boolean longtime)
          throws ProcessorException

click on a string within the current

calling:
Solo.clickOnText(String)
Solo.clickOnText(String, int)
Solo.clickOnText(String, int, boolean)
Solo.clickLongOnText(String)
Solo.clickLongOnText(String, int)
Solo.clickLongOnText(String, int, boolean)
Solo.clickLongOnText(String, int, int)
Solo.clickLongOnTextAndPress(String, int)

Parameters:

props - The Properties object containing the in and out parameters

longtime - Boolean, if a long-time click should be performed.

Throws:

ProcessorException

clickOnView

void clickOnView(java.util.Properties props,
                 boolean longtime)
          throws ProcessorException

click on a View
The view's id is given by parameter, according to this id,
We will find the View from local cache viewCache and click on it.
This method has no relationship with method clickOnViewByIndex(Properties)

calling:
Solo.clickOnView(View)
Solo.clickOnView(View, boolean) -- Robotium 4.1
Solo.clickLongOnView(View)
Solo.clickLongOnView(View, int)

Parameters:

props - The Properties object containing the in and out parameters

longtime - Boolean, if a long-time click should be performed.

Throws:

ProcessorException

See Also:

Solo.clickOnView(View)

clickOnViewByName

void clickOnViewByName(java.util.Properties props)
                throws ProcessorException

click on the following TextView by name
Button
ToggleButton
The name is given by parameter, according to that name
Solo will click on the appropriate TextView.
This method has no relationship with method clickOnView(Properties, boolean)

calling:
Solo.clickOnButton(String)
Solo.clickOnToggleButton(String)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

clickOnViewByIndex

void clickOnViewByIndex(java.util.Properties props)
                 throws ProcessorException

click on the following TextView by index
CheckBox
EditText
ImageView
ImageButton
RadioButton
Button
The index is given by parameter, according to that index
Solo will click on the appropriate TextView.
This method has no relationship with method clickOnView(Properties, boolean)

calling:
Solo.clickOnCheckBox(int)
Solo.clickOnEditText(int)
Solo.clickOnImage(int)
Solo.clickOnImageButton(int)
Solo.clickOnRadioButton(int)
Solo.clickOnButton(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

clickOnMenuItem

void clickOnMenuItem(java.util.Properties props,
                     boolean subMenu)
              throws ProcessorException

click on a 'menu item' indicated by text

calling:
Solo.clickOnMenuItem(String)
Solo.clickOnMenuItem(String, boolean)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

drag

void drag(java.util.Properties props)
   throws ProcessorException

Simulate touching a given location and dragging it to a new location.

calling:
Solo.drag(float, float, float, float, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

enterText

void enterText(java.util.Properties props)
        throws ProcessorException

input the text in EditText

calling:
Solo.enterText(int, String)
Solo.enterText(EditText, String)
Solo.typeText(int, String) -- Robotium 3.6
Solo.typeText(EditText, String) -- Robotium 3.6

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

finalizeRemoteSolo

void finalizeRemoteSolo(java.util.Properties props)

Finalizes the solo object and removes the ActivityMonitor.

calling:
Solo.finalize()

Parameters:

props - The Properties object containing the in and out parameters

finishOpenedActivities

void finishOpenedActivities(java.util.Properties props)

All activities that have been active are finished.

calling:
Solo.finishOpenedActivities()

Parameters:

props - The Properties object containing the in and out parameters

getActivityMonitor

void getActivityMonitor(java.util.Properties props)
                 throws ProcessorException

Returns a String UID for the Robotium Solo Activity Monitor
Use a cache to store the ActivityMonitor.
If the ActivityMonitor doesn't exist in the cache, we generate an ID
and put the ActivityMonitor into cache with that ID.
If the ActivityMonitor exists in the cache, we just return the related ID.

calling:
Solo.getActivityMonitor()

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getAllOpenActivities

void getAllOpenActivities(java.util.Properties props)
                   throws ProcessorException

get all activities and return their ID in format ";ID;ID;ID"
the ID string will be stored in remoteresultinfo of parameter props.

calling:
Solo#getAllOpenedActivities()

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getCurrentActivity

void getCurrentActivity(java.util.Properties props)
                 throws ProcessorException

get the current activity and return its ID
the ID string will be stored in remoteresultinfo of parameter props.

Upon success the resultProperties should contain:

PARAM_CLASS=full Classname of the Activity, and
PARAM_NAME=Local (short) classname of the Activity.

calling:
Solo.getCurrentActivity()

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getCurrentViews

void getCurrentViews(java.util.Properties props)
              throws ProcessorException

get all the Views of following type:
Button
CheckBox
DatePicker
EditText
GridView
ImageButton
ImageView
ListView
ProgressBar
RadioButton
ScrollView
SlidingDrawer
Spinner
TextView
TimePicker
ToggleButton
View

calling:
Solo.getViews() - Robotium 4.1
Solo.getCurrentViews() - Robotium 4.1
Solo.getCurrentViews(Class) - Robotium 4.1
Solo.getCurrentViews(Class, View) - Robotium 4.1
Solo.getCurrentViews(Class, boolean) - Robotium 5.2.1
Solo.getCurrentViews(Class, boolean, View) - Robotium 5.2.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getCurrentWebElements

void getCurrentWebElements(java.util.Properties props)
                    throws ProcessorException

get the current WebElements and return its ID
the ID string will be stored in remoteresultinfo of parameter props.

calling:
Solo.getCurrentWebElements() -- Robotium 4.1
Solo.getCurrentWebElements(By) -- Robotium 4.1
Solo.getWebElements() -- Robotium 5.1
Solo.getWebElements(By) -- Robotium 5.1
Solo.getWebElement(By, int) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getViewById

void getViewById(java.util.Properties props)
          throws ProcessorException

get the View by id (R.id)
can also get the nth View by id at a provided index. The id is given by parameter, according to that id
The optional index is given by parameter
Solo will get the appropriate View.

calling:
getViewById(int, Class)
getViewById(int, int, Class)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getViewByName

void getViewByName(java.util.Properties props)
            throws ProcessorException

get the View by resource idname. Requires Robotium4.1+
The resource idname is stored in AUT layout xml file.
For example, in xml a view is given id as "@+id/flipper", "flipper" is the idname.
The idname is given by parameter, according to that name, Solo will get the appropriate View.

calling:
Solo.getView(String)
Solo.getView(String, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getViewByTag

void getViewByTag(java.util.Properties props)
           throws ProcessorException

get the View by Tag Object. Requires Robotium 5.3.0+

calling:
Solo.getView(Object)
Solo.getView(Object, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getViewByIndex

void getViewByIndex(java.util.Properties props)
             throws ProcessorException

get the following TextView by index
Button
EditText
TextView
ImageView
ImageButton
The index is given by parameter, according to that index
Solo will get the appropriate TextView.

calling:
Solo.getButton(int)
Solo.getEditText(int)
Solo.getImage(int)
Solo.getImageButton(int)
Solo.getText(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getViewByText

void getViewByText(java.util.Properties props)
            throws ProcessorException

get the following TextView by text
Button
EditText
TextView
The text is given by parameter, according to that text
Solo will get the appropriate TextView.

calling:
Solo.getButton(String)
Solo.getButton(String, boolean)
Solo#getEditBox(String)
Solo#getEditBox(String, boolean)
Solo.getText(String)
Solo.getText(String, boolean)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getViewsInParent

void getViewsInParent(java.util.Properties props)
               throws ProcessorException

Get all the views belonging to a parent view. The parent view is given
by the parameter Message.PARAM_REFERENCE

calling:
Solo.getViews(View)

Throws:

ProcessorException

getString

void getString(java.util.Properties props)
        throws ProcessorException

Returns a localized String from localized String resources, according to 'resource id' in a current Activity, or a String resource name in the context of the current package, or the android package.
given by Message.PARAM_RESID or Message.PARAM_ID

calling:
Solo.getString(int)
Solo.getString(String)

Throws:

ProcessorException

getTopParent

void getTopParent(java.util.Properties props)
           throws ProcessorException

Get the top parent view of the given view, identified by the parameter Message.PARAM_REFERENCE

calling:
Solo.getView(int)
Solo.getTopParent(View)

Throws:

ProcessorException

goBack

void goBack(java.util.Properties props)
     throws ProcessorException

Simulates pressing the hardware back key.

calling:
Solo.goBack()

Throws:

ProcessorException

goBackToActivity

void goBackToActivity(java.util.Properties props)
               throws ProcessorException

Returns to the given Activity.

calling:
Solo.goBackToActivity(String)

Throws:

ProcessorException

isViewByIndexChecked

void isViewByIndexChecked(java.util.Properties props)
                   throws ProcessorException

test if the following TextView is checked.
CheckBox
RadioButton
Spinner
ToggleButton
The index is given by parameter, according to that index
Solo will get the appropriate View and test if it is checked.

calling:
Solo.isCheckBoxChecked(int)
Solo.isRadioButtonChecked(int)
Solo.isSpinnerTextSelected(int, String)
Solo.isToggleButtonChecked(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

isViewByTextChecked

void isViewByTextChecked(java.util.Properties props)
                  throws ProcessorException

test if the following TextView is checked.
CheckBox
RadioButton
Spinner
ToggleButton
The text is given by parameter, according to that text
Solo will get the appropriate View and test if it is checked.

calling:
Solo.isCheckBoxChecked(String)
Solo.isRadioButtonChecked(String)
Solo.isSpinnerTextSelected(String)
Solo.isTextChecked(String)
Solo.isToggleButtonChecked(String)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

pressSoftKeyboardNextButton

void pressSoftKeyboardNextButton(java.util.Properties props)

Press the soft keyboard Next button.
Requires Robotium 5.0.1

calling:
Solo.pressSoftKeyboardNextButton()

Parameters:

props - The Properties object containing the in and out parameters

pressSoftKeyboardSearchButton

void pressSoftKeyboardSearchButton(java.util.Properties props)

Press the soft keyboard Search button.
Requires Robotium 5.x

calling:
Solo.pressSoftKeyboardSearchButton()

Parameters:

props - The Properties object containing the in and out parameters

pressMenuItem

void pressMenuItem(java.util.Properties props)
            throws ProcessorException

press an item in android.widget.Menu

calling:
Solo.pressMenuItem(int)
Solo.pressMenuItem(int, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

pressSpinnerItem

void pressSpinnerItem(java.util.Properties props)
               throws ProcessorException

press an item in Spinner

calling:
Solo.pressSpinnerItem(int, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

scroll

void scroll(java.util.Properties props)
     throws ProcessorException

scroll vertically.

calling:
Solo.scrollDown()
Solo.scrollDownList(int)
Solo.scrollDownList(AbsListView) -- Robotium 3.6
Solo.scrollUp()
Solo.scrollToTop() -- Robotium 3.4.1
Solo.scrollToBottom() -- Robotium 3.4.1
Solo.scrollUpList(int)
Solo.scrollUpList(AbsListView) -- Robotium 3.6
Solo.scrollListToTop(int) -- Robotium 3.4.1
Solo.scrollListToTop(AbsListView) -- Robotium 3.6
Solo.scrollListToBottom(int) -- Robotium 3.4.1
Solo.scrollListToBottom(AbsListView) -- Robotium 3.6
Solo.scrollListToLine(AbsListView, int) -- Robotium 3.6
Solo.scrollListToLine(int, int) -- Robotium 3.6

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

scrollToSide

void scrollToSide(java.util.Properties props)
           throws ProcessorException

scroll horizontally.
scrollPosition is an optional parameter.

calling:
Solo.scrollToSide(int)
Solo.scrollViewToSide(View, int) -- Robotium 3.6
Solo.scrollToSide(int, float) -- Robotium 4.3
Solo.scrollToSide(int, float, int) -- Robotium 5.2.1
Solo.scrollViewToSide(View, int, float) -- Robotium 4.3
Solo.scrollViewToSide(View, int, float, int) -- Robotium 5.2.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

searchView

void searchView(java.util.Properties props)
         throws ProcessorException

search the following view.
Button
EditText
TextView
ToggleButton

calling:
Solo.searchButton(String)
Solo.searchButton(String, boolean)
Solo.searchButton(String, int)
Solo.searchButton(String, int, boolean)
Solo.searchEditText(String)
Solo.searchText(String)
Solo.searchText(String, boolean)
Solo.searchText(String, int)
Solo.searchText(String, int, boolean)
Solo.searchToggleButton(String)
Solo.searchToggleButton(String, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

sendKey

void sendKey(java.util.Properties props)
      throws ProcessorException

send a key to current view.

calling:
Solo.sendKey(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setActivityOrientation

void setActivityOrientation(java.util.Properties props)
                     throws ProcessorException

set orientation of view.

calling:
Solo.setActivityOrientation(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setDatePicker

void setDatePicker(java.util.Properties props)
            throws ProcessorException

set value of DatePicker.

calling:
Solo.setDatePicker(DatePicker, int, int, int)
Solo.setDatePicker(int, int, int, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setMobileData

void setMobileData(java.util.Properties props)
            throws ProcessorException

Turn on/off 'mobile data'

calling:
Solo.setMobileData(Boolean) -- Robotium 5.3.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setWiFiData

void setWiFiData(java.util.Properties props)
          throws ProcessorException

Turn on/off 'wifi data'

calling:
Solo.setWiFiData(Boolean) -- Robotium 5.3.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setProgressBar

void setProgressBar(java.util.Properties props)
             throws ProcessorException

set value of ProgressBar.

calling:
Solo.setProgressBar(int, int)
Solo.setProgressBar(ProgressBar, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setNavigationDrawer

void setNavigationDrawer(java.util.Properties props)
                  throws ProcessorException

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

calling:
Solo.setNavigationDrawer(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setSlidingDrawer

void setSlidingDrawer(java.util.Properties props)
               throws ProcessorException

set value of SlidingDrawer.

calling:
Solo.setSlidingDrawer(int, int)
Solo.setSlidingDrawer(android.widget.SlidingDrawer, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

setTimePicker

void setTimePicker(java.util.Properties props)
            throws ProcessorException

set value of TimePicker.

calling:
Solo.setTimePicker(int, int, int)
Solo.setTimePicker(android.widget.TimePicker, int, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

sleep

void sleep(java.util.Properties props)
    throws ProcessorException

Robotium will sleep for a specified time (milliseconds).

calling:
Solo.sleep(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForActivity

void waitForActivity(java.util.Properties props)
              throws ProcessorException

Wait for Activity.

calling:
Solo.waitForActivity(String)
Solo.waitForActivity(String, int)
Solo.waitForActivity(Class) -- Robotium 4.1
Solo.waitForActivity(Class, int) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForFragmentByTag

void waitForFragmentByTag(java.util.Properties props)
                   throws ProcessorException

Wait for a V4 Fragment by Tag.
Requires Robotium 3.4.1

calling:
Solo.waitForFragmentByTag(String, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForEmptyActivityStack

void waitForEmptyActivityStack(java.util.Properties props)
                        throws ProcessorException

Wait for Empty Activity Stack.
Requires Robotium 5.0.1

calling:
Solo.waitForEmptyActivityStack(int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForFragmentById

void waitForFragmentById(java.util.Properties props)
                  throws ProcessorException

Wait for a V4 Fragment by Id.
Requires Robotium 3.4.1

calling:
Solo.waitForFragmentById(int, int)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForDialog

void waitForDialog(java.util.Properties props)
            throws ProcessorException

Wait for Dialog to close/open.

calling:
Solo.waitForDialogToClose(long)
Solo.waitForDialogToOpen(long) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForText

void waitForText(java.util.Properties props)
          throws ProcessorException

Wait for TextView.

calling:
Solo.waitForText(String)
Solo#waitForText(String, int, long))
Solo#waitForText(String, int, long, boolean))
Solo#waitForText(String, int, long, boolean, boolean))

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForLogMessage

void waitForLogMessage(java.util.Properties props)
                throws ProcessorException

Wait for a specific log message.
Requires Robotium 3.4.1

calling:
Solo.waitForLogMessage(String)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForView

void waitForView(java.util.Properties props)
          throws ProcessorException

Wait for View.

calling:
Solo.waitForView(Class)
Solo#waitForView(Class, int, int))
Solo#waitForView(Class, int, int, boolean))

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForViewByTag

void waitForViewByTag(java.util.Properties props)
               throws ProcessorException

Wait for View.

calling:
Solo.waitForView(Object) Since Robotium5.3.1
Solo.waitForView(Object, int, int) Since Robotium5.3.1
Solo.waitForView(Object, int, int, boolean) Since Robotium5.3.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForViewUID

void waitForViewUID(java.util.Properties props)
             throws ProcessorException

Wait for View.

calling:
Solo.waitForView(View)
Solo#waitForView(View, int, boolean))

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getTagForView

void getTagForView(java.util.Properties props)
            throws ProcessorException

Get the View's Tag accroding to a View's UID, and return the Tag's UID. The real Tag object will be stored in cache tagCache.

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForViewByID

void waitForViewByID(java.util.Properties props)
              throws ProcessorException

Wait for View according to ID (R.id) Requires Robotium4.1+

calling:
Solo.waitForView(int)
Solo.waitForView(int, int, int)
Solo.waitForView(int, int, int, boolean)

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

waitForWebElement

void waitForWebElement(java.util.Properties props)
                throws ProcessorException

Wait for WebElement. -- Robotium 4.1

calling:
Solo.waitForWebElement(By) -- Robotium 4.1
Solo.waitForWebElement(By, int, boolean) -- Robotium 4.1
Solo.waitForWebElement(By, int, int, boolean) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getScreenSize

void getScreenSize(java.util.Properties props)
            throws ProcessorException

Get the screen's size.

Parameters:

props - The Properties object containing the in and out parameters

Throws:

ProcessorException

getViewLocation

void getViewLocation(java.util.Properties props)
              throws ProcessorException

Get the View's location, (x,y,width,height).

Parameters:

props - The Properties object containing the in and out parameters
<in> UID, String, This is the view's UID according to which we will get a View.

Throws:

ProcessorException

getTextViewValue

void getTextViewValue(java.util.Properties props)
               throws ProcessorException

According to the view's id, try to get a View of type 'TextView'.

Parameters:

props - The Properties object containing the in and out parameters
<in> UID, String, This is the view's UID according to which we will get a View.

Throws:

ProcessorException

waitForCondition

void waitForCondition(java.util.Properties props)
               throws ProcessorException

Waits for a condition to be satisfied.

calling:
Solo.waitForCondition(Condition, int) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters
<in> condition, Condition, the condition to wait for.
<in> timeout, int, the amount of time in milliseconds to wait.
<out> boolean, true if condition is satisfied; false if it is not satisfied or the timeout is reached.

Throws:

ProcessorException

clearTextInWebElement

void clearTextInWebElement(java.util.Properties props)
                    throws ProcessorException

Clears text in a WebElement matching the specified By object.

calling:
Solo.clearTextInWebElement(By) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters
<in> by the By object. Examples are: By.id("id") and By.name("name").

Throws:

ProcessorException

clickOnWebElement

void clickOnWebElement(java.util.Properties props)
                throws ProcessorException

Clicks a WebElement matching the specified By object.

calling:
Solo.clickOnWebElement(By) -- Robotium 4.1
Solo.clickOnWebElement(By, int) -- Robotium 4.1
Solo.clickOnWebElement(By, int, boolean) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters
<in> by the By object. Examples are: By.id("id") and By.name("name").

Throws:

ProcessorException

clickOnWebElementByUID

void clickOnWebElementByUID(java.util.Properties props)
                     throws ProcessorException

Clicks a WebElement stored in cache by reference UID.

calling:
Solo.clickOnWebElement(WebElement) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters
<in> UID, String, the reference for a WebElement object stored in cache.

Throws:

ProcessorException

enterTextInWebElement

void enterTextInWebElement(java.util.Properties props)
                    throws ProcessorException

Enters text in a WebElement matching the specified By object.

calling:
Solo.enterTextInWebElement(By, String) -- Robotium 4.1
Solo.typeTextInWebElement(By, String) -- Robotium 4.1
Solo.typeTextInWebElement(By, String, int) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters
<in> by the By object. Examples are: By.id("id") and By.name("name").
<in> text, String, the text to type into a WebElement.
<in> index, int, decide into which WebElement to type.

Throws:

ProcessorException

typeTextInWebElementByUID

void typeTextInWebElementByUID(java.util.Properties props)
                        throws ProcessorException

Type text in a WebElement stored in cache by reference UID.

calling:
Solo.typeTextInWebElement(WebElement, String) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters
<in> UID, String, the reference for a WebElement object stored in cache.
<in> text, String, the text to type into a WebElement.

Throws:

ProcessorException

getGuiImage

void getGuiImage(java.util.Properties props)
          throws ProcessorException

Get image of a View.
According to the view's id, try to get a View from cache.
If not found, a ProcessorException will be thrown out.
If a view is found, we will get the bitmap of that view and compress
the bytes to String and return it through KEY_REMOTERESULTINFO

Parameters:

uid - String, This is the view's uid according to which we will get a View. This uid is the key in local cache viewCache

Throws:

ProcessorException

getBitmapOfView

protected android.graphics.Bitmap getBitmapOfView(android.view.View view)

Get bitmap image of a View.
This method call View.getDrawingCache() to get the bitmap image.
For some special views, we can't generate the bitmap by this way. We can
override this method and provide a special way in the subclass.

Parameters:

view - View, The View object

Returns:

The bitmap object of a view.

getViewClassName

void getViewClassName(java.util.Properties props)
               throws ProcessorException

Deprecated. we can use getObjectClassName(Properties, boolean) instead

Get class name of a View.
According to the view's id, try to get a View from cache.
If not found, a ProcessorException will be thrown out.
If a view is found, we will get the name of that view and return
it through KEY_REMOTERESULTINFO

Parameters:

uid - String, This is the view's uid according to which we will get a View. This uid is the key in local cache viewCache

Throws:

ProcessorException

getObjectClassName

void getObjectClassName(java.util.Properties props,
                        boolean isViewObject)
                 throws ProcessorException

Get class name of an object.
According to the object's id, try to get it from cache.
If not found, a ProcessorException will be thrown out.
If it is found, we will get its class name and return
through KEY_REMOTERESULTINFO

Parameters:

uid - String, This is the object's uid according to which we will get the object. This uid is the key in local cache viewCache or activityCache or webElementCache

Throws:

ProcessorException

startScreenshotSequenceMax

void startScreenshotSequenceMax(java.util.Properties props)

Takes a screenshot sequence and stores the images via the Robotium Solo API.
Requires Robotium 4.2

calling:
Solo.startScreenshotSequence(String,int,int,int)

Parameters:

props - The Properties object containing the in and out parameters

getScreenshotSequence

void getScreenshotSequence(java.util.Properties props)

Retrieve a sequence of screenshots, which are stored in "/sdcard/Robotium-Screenshots/".
Requires Robotium 4.1+

These screenshots are generated by calling:
Solo.startScreenshotSequence(String) -- Robotium 4.1+
Solo.startScreenshotSequence(String, int, int, int) -- Robotium 4.1+

Parameters:

props - The Properties object containing the in and out parameters

takeScreenshot

void takeScreenshot(java.util.Properties props)

Takes a Screenshot and retrieve it from /sdcard/Robotium-Screenshots/.
Requires Robotium 3.4.1

calling:
Solo.takeScreenshot(String)
Solo.takeScreenshot(String, int) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters

getImageBase64EncodedString

java.lang.String getImageBase64EncodedString(java.lang.String filename,
                                             java.lang.StringBuffer absoluteFilePath)
                                      throws ProcessorException

Read a JPG file with name 'filename' from folder '/sdcard/Robotium-Screenshots/', then encode it to a String and return, this method doesn't care when the image file is created.

Parameters:

filename, - String, in, the image file to read from mobile device.

absoluteFilePath, - StringBuffer, out, the absolute name of the image file.

Returns:

String, the Base64 encoded string of the image.

Throws:

ProcessorException

See Also:

getImageBase64EncodedString(String, StringBuffer, long)

getImageBase64EncodedString

java.lang.String getImageBase64EncodedString(java.lang.String filename,
                                             java.lang.StringBuffer absoluteFilePath,
                                             long newerThan)
                                      throws ProcessorException

Read a JPG file with name 'filename' from folder '/sdcard/Robotium-Screenshots/', then encode it to a String and return, this method will only read the image file created after the time provide by parameter 'newerThan'

Parameters:

filename, - String, in, the image file to read from mobile device.

absoluteFilePath, - StringBuffer, out, the absolute name of the image file.

newerThan, - long, in, the time to compare with the file's last modified time, if 'last modified time' is smaller than it, the file will not be read.

Returns:

String, the Base64 encoded string of the image.

Throws:

ProcessorException

See Also:

getImageBase64EncodedString(String, StringBuffer)

handleRobotiumUtilsCommand

void handleRobotiumUtilsCommand(java.util.Properties props)

Handle the static methods of class RobotiumUtils.
Requires Robotium 4.1

calling:
RobotiumUtils.filterViews(Class, Iterable) -- Robotium 4.1
RobotiumUtils.filterViewsByText(Iterable, java.util.regex.Pattern) -- Robotium 4.1
RobotiumUtils.filterViewsByText(Iterable, String) -- Robotium 4.1
RobotiumUtils.filterViewsToSet(Class[], Iterable) -- Robotium 4.1
RobotiumUtils.sortViewsByLocationOnScreen(List) -- Robotium 4.1
RobotiumUtils.sortViewsByLocationOnScreen(List, boolean) -- Robotium 4.1
RobotiumUtils.getNumberOfMatches(String, TextView, java.util.Set) -- Robotium 4.1

Parameters:

props - The Properties object containing the in and out parameters

handleRobotiumTimeoutCommand

void handleRobotiumTimeoutCommand(java.util.Properties props)

Handle the static methods of class Timeout.
Requires Robotium 4.1+

calling:
Timeout.setLargeTimeout(int) -- Robotium 4.1+
Timeout.setSmallTimeout(int) -- Robotium 4.1+
Timeout.getLargeTimeout() -- Robotium 4.1+
Timeout.getSmallTimeout() -- Robotium 4.1+

Parameters:

props - The Properties object containing the in and out parameters

handleZoomRotateSwipe

void handleZoomRotateSwipe(java.util.Properties props)

Handle the zoom, rotate, swipe methods of Robotium Solo.
Requires Robotium 4.1+

calling:
Solo.pinchToZoom(PointF, PointF, PointF, PointF) -- Robotium 4.1+
{@link Solo#rotateLarge(PointF, PointF) -- Robotium 4.1+
{@link Solo#rotateSmall(PointF, PointF) -- Robotium 4.1+
{@link Solo#swipe(PointF, PointF, PointF, PointF) -- Robotium 4.1+

Parameters:

props - The Properties object containing the in and out parameters

handleConfigTimeoutCommands

void handleConfigTimeoutCommands(java.util.Properties props)

Handle the GET/SET commands for Solo.Config.timeout_small and Solo.Config.timeout_large. (Robotium 5.0.1)

calling:
Solo.Config.timeout_small
Solo.Config.timeout_large

Parameters:

props - The Properties object containing the in and out parameters

handleConfigShouldScrollCommands

void handleConfigShouldScrollCommands(java.util.Properties props)

Handle the GET/SET commands for Solo.Config.shouldScroll. (Robotium 5.0.1)

calling:
Solo.Config.shouldScroll

Parameters:

props - The Properties object containing the in and out parameters

handleConfigUseJavaScriptToClickWebElementsCommands

void handleConfigUseJavaScriptToClickWebElementsCommands(java.util.Properties props)

Handle the GET/SET commands for Solo.Config.useJavaScriptToClickWebElements. (Robotium 5.0.1)

calling:
Solo.Config.useJavaScriptToClickWebElements

Parameters:

props - The Properties object containing the in and out parameters

handleConfigScreenshotSavePathCommands

void handleConfigScreenshotSavePathCommands(java.util.Properties props)

Handle the GET/SET commands for Solo.Config.screenshotSavePath. (Robotium 5.0.1)

calling:
Solo.Config.screenshotSavePath

Parameters:

props - The Properties object containing the in and out parameters

handleConfigScreenshotFileTypeCommands

void handleConfigScreenshotFileTypeCommands(java.util.Properties props)

Handle the GET/SET commands for Solo.Config.screenshotFileType. (Robotium 5.0.1)

calling:
Solo.Config.screenshotFileType

Parameters:

props - The Properties object containing the in and out parameters

getCachedObject

public java.lang.Object getCachedObject(java.lang.String key,
                                        boolean useChain)

CacheReferenceInterface implementation.

Specified by:

getCachedObject in interface CacheReferenceInterface

Parameters:

key - -- String key for identifying the object stored in cache.

useChain - -- true if the instance should search in all chained caches, false if only the individual local cache should be searched.

Returns:

-- the object stored in cache identified by the key, or null if not found.

addCacheReferenceInterface

public void addCacheReferenceInterface(CacheReferenceInterface cache)

CacheReferenceInterface implementation.

Specified by:

addCacheReferenceInterface in interface CacheReferenceInterface

See Also:

CacheReferenceInterface.addCacheReferenceInterface(CacheReferenceInterface)

removeCacheReferenceInterface

public void removeCacheReferenceInterface(CacheReferenceInterface cache)

CacheReferenceInterface implementation.

Specified by:

removeCacheReferenceInterface in interface CacheReferenceInterface

See Also:

CacheReferenceInterface.removeCacheReferenceInterface(CacheReferenceInterface)

clearCache

public void clearCache(boolean useChain)

CacheReferenceInterface implementation.

Specified by:

clearCache in interface CacheReferenceInterface

Parameters:

useChain - -- true if the instance should clear all chained caches, false if only the individual local cache should be cleared.

See Also:

CacheReferenceInterface.clearCache(boolean)