org.safs.android.engine.processor

Class ListViewProcessor

java.lang.Object

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

org.safs.android.engine.processor.SAFSProcessor

org.safs.android.engine.processor.TestStepProcessor

org.safs.android.engine.processor.ListViewProcessor

All Implemented Interfaces:

ProcessorInterface

public class ListViewProcessor
extends TestStepProcessor

Author:

Carl Nagle, SAS Institute, Inc

Field Summary

Fields

Modifier and Type	Field and Description
protected android.widget.ListView	listview
(package private) static java.lang.String	tempError
(package private) static boolean	tempSuccess

Fields inherited from class org.safs.android.engine.processor.TestStepProcessor

debugPrefix

Fields inherited from class org.safs.android.engine.processor.SAFSProcessor

command_timeout, compname, compobj, comprec, dgcd, dgov, inst, KEY_COMPOBJ, params, resourceDetailMsg, resourceMsg, robot, secsWaitForComponent, secsWaitForWindow, solo, TAG, testObjectCache, testrunner, winname, winobj, winrec

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

INITIAL_CACHE_SIZE, remoteCommand, testRunner

Constructor Summary

Constructors

Constructor and Description
ListViewProcessor(DSAFSTestRunner testrunner)

Method Summary

Modifier and Type	Method and Description
(package private) void	_captureItems(java.util.Properties props)
protected void	_selectIndexCommands(java.util.Properties props, boolean verified, boolean activate)
protected void	_selectTextCommands(java.util.Properties props, boolean isVerified, boolean useCase, boolean isPartial, boolean activate)
(package private) int	getListViewItemIndex(android.widget.ListView view, java.util.List<java.lang.String> items, java.lang.String text, boolean useCase, boolean isPartial, int nth) Call this routine if you already have the List of items.
(package private) int	getListViewItemIndex(android.widget.ListView view, java.lang.String text, boolean useCase, boolean isPartial, int nth) Call this routine if you do NOT already have the List of items.
(package private) java.util.List<java.lang.String>	getListViewItems(android.widget.ListView view) Uses DGuiObjectRecognition.getObjectText to extract text of each Adapter item.
(package private) int	getListViewSelectedIndex(android.widget.ListView view)
(package private) java.lang.String	getListViewTextAtIndex(android.widget.ListView view, int index)
void	processComponentFunction(java.util.Properties props) Called internally by processProperties after the DGOV, WIN, and COMP components have been found and are ready for action.
(package private) boolean	selectIndex(android.widget.ListView view, int index, boolean doClick)

Methods inherited from class org.safs.android.engine.processor.TestStepProcessor

checkParameterSize, checkSolo, commandNotExecuted, convertCoords, processProperties, retrieveParameters, setGeneralError3, setGeneralErrorUnsupportedObjectType, setGeneralErrorWithDetailBundle, setGeneralSuccessWithBundle, setGenericError

Methods inherited from class org.safs.android.engine.processor.SAFSProcessor

clearTestObjectCache, extractComponentProperties, getDgcd, getInstrumentation, getParams, getSecsWaitForComponent, getSecsWaitForWindow, getSolo, getTestObject, setDgcd, setGeneralErrorWithBundleMessage, setGeneralSuccessWithBundleMessage, setParams, setSecsWaitForComponent, setSecsWaitForWindow, setSolo, setTestObject

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

convertToKey, convertToKeys, convertToKeys, debug, getCachedItem, 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

listview

protected android.widget.ListView listview

tempSuccess

static boolean tempSuccess

tempError

static java.lang.String tempError

Constructor Detail

ListViewProcessor

public ListViewProcessor(DSAFSTestRunner testrunner)

Method Detail

processComponentFunction

public void processComponentFunction(java.util.Properties props)

Description copied from class: TestStepProcessor

Called internally by processProperties after the DGOV, WIN, and COMP components have been found and are ready for action.

Specified by:

processComponentFunction in class TestStepProcessor

_selectTextCommands

protected void _selectTextCommands(java.util.Properties props,
                                   boolean isVerified,
                                   boolean useCase,
                                   boolean isPartial,
                                   boolean activate)

Parameters:

props -

isVerified, - true if this is a 'verified' command -- not 'Unverified'.

useCase, - true if text comparisons ARE case-sensitive.

isPartial, - true if text comparisons only need a substring match.

activate, - true if we need to click the item after its selection.

_selectIndexCommands

protected void _selectIndexCommands(java.util.Properties props,
                                    boolean verified,
                                    boolean activate)

Parameters:

props -

verified, - true if we need to verify the selected index is selected.

activate, - true if we need to click the item after its selection.

_captureItems

void _captureItems(java.util.Properties props)

Parameters:

index, - the index to select, 0-based.

selectIndex

boolean selectIndex(android.widget.ListView view,
                    int index,
                    boolean doClick)

Parameters:

view -

index, - 0-based index of item to select.

doClick, - true to click the item after its selection.

Returns:

true if no error occurred during attempt to select. Sets tempError to an error message if the selection attempt threw a Throwable.

getListViewSelectedIndex

int getListViewSelectedIndex(android.widget.ListView view)

Parameters:

view -

Returns:

0-N for selected item. -1 (ListView.INVALID_POSITION) if no item selected.

getListViewTextAtIndex

java.lang.String getListViewTextAtIndex(android.widget.ListView view,
                                        int index)

Parameters:

view -

index -

Returns:

item text at the provided index, or null.

getListViewItemIndex

int getListViewItemIndex(android.widget.ListView view,
                         java.util.List<java.lang.String> items,
                         java.lang.String text,
                         boolean useCase,
                         boolean isPartial,
                         int nth)

Call this routine if you already have the List of items.

Parameters:

view -

useCase - -- true if matching is case-sensitive

isPartial - -- true if we only need a substring match

nth - -- return the nth matching index: 1 for the first matching index, 2 for the second, etc..

Returns:

0-based index of matching item. -1 if a match cannot be deduced.

getListViewItemIndex

int getListViewItemIndex(android.widget.ListView view,
                         java.lang.String text,
                         boolean useCase,
                         boolean isPartial,
                         int nth)

Call this routine if you do NOT already have the List of items.

Parameters:

view -

useCase - -- true if matching is case-sensitive

isPartial - -- true if we only need a substring match

nth - -- return the nth matching index: 1 for the first matching index, 2 for the second, etc..

Returns:

0-based index of matching item. -1 if a match cannot be deduced.

getListViewItems

java.util.List<java.lang.String> getListViewItems(android.widget.ListView view)

Uses DGuiObjectRecognition.getObjectText to extract text of each Adapter item. Items with no discernable text will be returned as an EMPTY String.

Parameters:

spinner -

Returns: