org.safs.android.remotecontrol

Class SAFSDriverCommands

java.lang.Object

com.jayway.android.robotium.remotecontrol.solo.SoloWorker

com.jayway.android.robotium.remotecontrol.solo.Solo

org.safs.android.remotecontrol.SAFSWorker

org.safs.android.remotecontrol.SAFSDriverCommands

All Implemented Interfaces:

DebugListener, NamedListener

public class SAFSDriverCommands
extends SAFSWorker

Provide an Android RemoteControl API interface to SAFS Driver Commands for non-SAFS users using a SAFSTestRunner.

Default usage:

 Instantiate *and* initialize Solo API object according to the Solo class, then:

 SAFSDriverCommands driver = new SAFSDriverCommands(solo);
 (use the API)
 

Note: SAFSDriverCommands can use component UID references that have been acquired from either the remote control Solo class APIs or the SAFSEngineCommands APIs.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

SoloTest

Field Summary

Fields inherited from class com.jayway.android.robotium.remotecontrol.solo.Solo

_last_remote_result, androidsdk, CLOSED, DELETE, DOWN, ENTER, LANDSCAPE, LEFT, MENU, OPENED, PORTRAIT, RIGHT, UP

Fields inherited from class com.jayway.android.robotium.remotecontrol.solo.SoloWorker

_props, CAUSE_SEP, control, default_connect_stimeout, default_ready_stimeout, default_result_stimeout, default_running_stimeout, default_shutdown_stimeout, doProcessFailure, doProcessSuccess, err, FAIL_SUFFIX, listenername, log, out, PASS_SUFFIX, tcp_delay

Constructor Summary

Constructors

Constructor and Description
SAFSDriverCommands(Solo solo) Default (required) public constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	assignClipboardVariable() Same as getClipboard.
void	clearClipboard() ClearClipboard Clear the device clipboard.
java.lang.String	getClipboard() AssignClipboardVariable Retrieve text contents of the device clipboard.
java.awt.image.BufferedImage	getScreenShot(boolean rotatable) TakeScreenShot
boolean	hideSoftKeyboard() HideSoftKeyboard
void	setClipboard(java.lang.String text) SetClipboard
boolean	showSoftKeyboard() ShowSoftKeyboard
java.awt.image.BufferedImage	takeScreenShot(boolean rotatable) Same as getScreenShot.
boolean	waitForGUI(java.lang.String winrec, java.lang.String comprec, int stimeout) WaitForGUI
boolean	waitForGUIGone(java.lang.String winrec, java.lang.String comprec, int stimeout) WaitForGUIGone

Methods inherited from class org.safs.android.remotecontrol.SAFSWorker

createRemoteControl, getListenerName

Methods inherited from class com.jayway.android.robotium.remotecontrol.solo.Solo

assertCurrentActivityClass, assertCurrentActivityClass, assertCurrentActivityName, assertCurrentActivityName, assertMemoryNotLow, clearEditText, clearEditText, clearLog, clearTextInWebElement, clickInList, clickInList, clickLongInList, clickLongInList, clickLongInList, clickLongOnScreen, clickLongOnScreen, clickLongOnText, clickLongOnText, clickLongOnText, clickLongOnText, clickLongOnTextAndPress, clickLongOnView, clickLongOnView, clickOnActionBarHomeButton, clickOnActionBarItem, clickOnButton, clickOnButton, clickOnCheckBox, clickOnEditText, clickOnImage, clickOnImageButton, clickOnMenuItem, clickOnMenuItem, clickOnRadioButton, clickOnScreen, clickOnScreen, clickOnText, clickOnText, clickOnText, clickOnToggleButton, clickOnView, clickOnView, clickOnWebElement, clickOnWebElement, clickOnWebElement, clickOnWebElement, drag, enterText, enterText, enterTextInWebElement, finalizeRemoteSolo, finishOpenedActivities, getActivityMonitor, getAllOpenActivities, getButton, getButton, getButton, getCurrentActivity, getCurrentButtons, getCurrentCheckBoxes, getCurrentDatePickers, getCurrentEditTexts, getCurrentGridViews, getCurrentImageButtons, getCurrentImageViews, getCurrentListViews, getCurrentNumberPickers, getCurrentProgressBars, getCurrentRadioButtons, getCurrentScrollViews, getCurrentSlidingDrawers, getCurrentSpinners, getCurrentTextViews, getCurrentTimePickers, getCurrentToggleButtons, getCurrentViews, getCurrentViews, getCurrentViews, getCurrentViews, getCurrentViews, getCurrentWebElements, getCurrentWebElements, getEditText, getEditText, getEditText, getGUIImage, getImage, getImageButton, getObjectClassName, getScreenshotSequence, getScreenshotSequence, getScreenshotSequenceSize, getScreenSize, getString, getString, getTagForView, getText, getText, getText, getTextViewValue, getTopParent, getView, getView, getView, getViewByName, getViewByName, getViewByTag, getViewByTag, getViewClassName, getViewLocation, getViews, getViews, getWebElement, getWebElements, getWebElements, getWebUrl, goBack, goBackToActivity, isCheckBoxChecked, isCheckBoxChecked, isRadioButtonChecked, isRadioButtonChecked, isSpinnerTextSelected, isSpinnerTextSelected, isTextChecked, isToggleButtonChecked, isToggleButtonChecked, pinchToZoom, pressMenuItem, pressMenuItem, pressSoftKeyboardNextButton, pressSoftKeyboardSearchButton, pressSpinnerItem, rotateLarge, rotateSmall, scrollDown, scrollDownList, scrollDownListUID, scrollListToBottom, scrollListToBottomUID, scrollListToLine, scrollListToLineUID, scrollListToTop, scrollListToTopUID, scrollToBottom, scrollToSide, scrollToSide, scrollToSide, scrollToTop, scrollUp, scrollUpList, scrollUpListUID, scrollViewToSide, scrollViewToSide, scrollViewToSide, searchButton, searchButton, searchButton, searchButton, searchEditText, searchText, searchText, searchText, searchText, searchText, searchToggleButton, searchToggleButton, sendKey, setActivityOrientation, setDatePicker, setDatePicker, setMobileData, setNavigationDrawer, setProgressBar, setProgressBar, setSlidingDrawer, setSlidingDrawer, setTimePicker, setTimePicker, setWiFiData, sleep, startMainLauncher, startScreenshotSequence, startScreenshotSequence, stopScreenshotSequence, swipe, takeScreenshot, takeScreenshot, takeScreenshot, typeText, typeText, typeTextInWebElement, typeTextInWebElement, typeTextInWebElement, unlockScreen, waitForActivity, waitForActivity, waitForActivityByClass, waitForActivityByClass, waitForCondition, waitForDialogToClose, waitForDialogToClose, waitForDialogToOpen, waitForDialogToOpen, waitForEmptyActivityStack, waitForFragmentById, waitForFragmentByTag, waitForLogMessage, waitForText, waitForText, waitForText, waitForText, waitForView, waitForView, waitForView, waitForView, waitForView, waitForView, waitForViewByTag, waitForViewByTag, waitForViewByTag, waitForViewUID, waitForViewUID, waitForWebElement, waitForWebElement, waitForWebElement

Methods inherited from class com.jayway.android.robotium.remotecontrol.solo.SoloWorker

debug, getRemoteControl, initialize, onReceiveDebug, prepInstrumentDispatch, prepSoloDispatch, processFailure, processSuccess, setControllerPort, setLogsInterface, setPortForwarding, setRemoteControl, shutdown, shutdownRemote, turnProtocolDebug, turnRunnerDebug

Methods inherited from class java.lang.Object

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

Constructor Detail

SAFSDriverCommands

public SAFSDriverCommands(Solo solo)

Default (required) public constructor.

Parameters:

solo - Solo instance already created and initialized.

Method Detail

clearClipboard

public void clearClipboard()
                    throws java.lang.IllegalThreadStateException,
                           RemoteException,
                           java.util.concurrent.TimeoutException,
                           ShutdownInvocationException

ClearClipboard Clear the device clipboard.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

setClipboard

public void setClipboard(java.lang.String text)
                  throws java.lang.IllegalThreadStateException,
                         RemoteException,
                         java.util.concurrent.TimeoutException,
                         ShutdownInvocationException

SetClipboard

Parameters:

text - -- to put on the device clipboard.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getClipboard

public java.lang.String getClipboard()
                              throws java.lang.IllegalThreadStateException,
                                     RemoteException,
                                     java.util.concurrent.TimeoutException,
                                     ShutdownInvocationException

AssignClipboardVariable Retrieve text contents of the device clipboard.

Returns:

String of clipboard contents or null if no contents or not String contents.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

assignClipboardVariable

public java.lang.String assignClipboardVariable()
                                         throws java.lang.IllegalThreadStateException,
                                                RemoteException,
                                                java.util.concurrent.TimeoutException,
                                                ShutdownInvocationException

Same as getClipboard.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

See Also:

getClipboard()

hideSoftKeyboard

public boolean hideSoftKeyboard()
                         throws java.lang.IllegalThreadStateException,
                                RemoteException,
                                java.util.concurrent.TimeoutException,
                                ShutdownInvocationException

HideSoftKeyboard

Overrides:

hideSoftKeyboard in class Solo

Returns:

true if successful.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

See Also:

Solo.getCurrentObjects(Properties), Solo._last_remote_result, Message

showSoftKeyboard

public boolean showSoftKeyboard()
                         throws java.lang.IllegalThreadStateException,
                                RemoteException,
                                java.util.concurrent.TimeoutException,
                                ShutdownInvocationException

ShowSoftKeyboard

Returns:

true if successful.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

waitForGUI

public boolean waitForGUI(java.lang.String winrec,
                          java.lang.String comprec,
                          int stimeout)
                   throws java.lang.IllegalThreadStateException,
                          RemoteException,
                          java.util.concurrent.TimeoutException,
                          ShutdownInvocationException

WaitForGUI

Parameters:

winrec - -- SAFS window recognition string, or UID reference from Solo or SAFSEngineCommands

comprec - -- SAFS component recognition string, or UID reference from Solo or SAFSEngineCommands

stimeout - -- wait timeout in seconds. If less than 0 then uses default 15 second wait timeout.

Returns:

true if the GUI object was found in the timeout period. false if it was not.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

See Also:

Solo, SAFSEngineCommands

waitForGUIGone

public boolean waitForGUIGone(java.lang.String winrec,
                              java.lang.String comprec,
                              int stimeout)
                       throws java.lang.IllegalThreadStateException,
                              RemoteException,
                              java.util.concurrent.TimeoutException,
                              ShutdownInvocationException

WaitForGUIGone

Parameters:

winrec - -- SAFS window recognition string, or UID reference from Solo or SAFSEngineCommands

comprec - -- SAFS component recognition string, or UID reference from Solo or SAFSEngineCommands

stimeout - -- wait timeout in seconds. If less than 0 then uses default 15 second wait timeout.

Returns:

true if the GUI object was gone in the timeout period. false if it was still found.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

See Also:

Solo, SAFSEngineCommands

getScreenShot

public java.awt.image.BufferedImage getScreenShot(boolean rotatable)
                                           throws java.lang.IllegalThreadStateException,
                                                  RemoteException,
                                                  java.util.concurrent.TimeoutException,
                                                  ShutdownInvocationException

TakeScreenShot

Parameters:

rotatable - -- true if the app/screen might be rotated and the image should be flipped appropriately.

Returns:

BufferedImage of screenshot, or null if not received.

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

takeScreenShot

public java.awt.image.BufferedImage takeScreenShot(boolean rotatable)
                                            throws java.lang.IllegalThreadStateException,
                                                   RemoteException,
                                                   java.util.concurrent.TimeoutException,
                                                   ShutdownInvocationException

Same as getScreenShot.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

See Also:

getScreenShot(boolean)