Package org.robolectric.shadows

Class ShadowAccessibilityService

java.lang.Object

org.robolectric.shadows.ShadowContextWrapper

org.robolectric.shadows.ShadowService

org.robolectric.shadows.ShadowAccessibilityService

@Implements(android.accessibilityservice.AccessibilityService.class)
public class ShadowAccessibilityService
extends ShadowService

Shadow of AccessibilityService that tracks global actions and provides a mechanism to simulate the window list.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ShadowAccessibilityService.GestureDispatch	Represents a gesture that has been dispatched through the accessibility service.

Constructor Summary

Constructors

Constructor	Description
ShadowAccessibilityService()

Method Summary

Modifier and Type	Method	Description
protected boolean	dispatchGesture(GestureDescription gesture, AccessibilityService.GestureResultCallback callback, Handler handler)
List<ShadowAccessibilityService.GestureDispatch>	getGesturesDispatched()	Returns a list of gestures that have been dispatched.
List<Integer>	getGlobalActionsPerformed()
protected AccessibilityNodeInfo	getRootInActiveWindow()
protected List<AccessibilityNodeInfo.AccessibilityAction>	getSystemActions()
protected List<AccessibilityWindowInfo>	getWindows()	Returns a representation of interactive windows shown on the device's default display.
protected SparseArray<List<AccessibilityWindowInfo>>	getWindowsOnAllDisplays()	Returns a representation of interactive windows shown on the device's all displays.
protected boolean	performGlobalAction(int action)
void	setCanDispatchGestures(boolean canDispatchGestures)	Sets whether the service is currently able to dispatch gestures.
void	setRootInActiveWindow(AccessibilityNodeInfo rootInActiveWindow)
final void	setSystemActions(List<AccessibilityNodeInfo.AccessibilityAction> systemActions)
void	setTakeScreenshotErrorCode(int errorCode)	Sets AccessibilityService.takeScreenshot(int, Executor, TakeScreenshotCallback) to start returning the given errorCode.
void	setWindows(List<AccessibilityWindowInfo> windowList)	Sets the list of interactive windows shown on the device's default display as reported by getWindows()
void	setWindowsOnDisplay(int displayId, List<AccessibilityWindowInfo> windowList)	Sets the list of interactive windows shown on the device's displayId display.
void	startInput(EditorInfo editorInfo)
protected void	takeScreenshot(int displayId, Executor executor, AccessibilityService.TakeScreenshotCallback callback)
void	unsetTakeScreenshotErrorCode()	Sets AccessibilityService.takeScreenshot(int, Executor, TakeScreenshotCallback) to start returning successful results again.

Methods inherited from class org.robolectric.shadows.ShadowService

getForegroundServiceType, getLastForegroundNotification, getLastForegroundNotificationId, getNotificationShouldRemoved, getStopSelfId, getStopSelfResultId, isForegroundStopped, isLastForegroundNotificationAttached, isStoppedBySelf, onDestroy, setThrowInStartForeground, startForeground, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class org.robolectric.shadows.ShadowContextWrapper

clearBroadcastIntents, clearNextStartedActivities, clearStartedServices, denyPermissions, denyPermissions, getAllStartedServices, getBroadcastIntents, getBroadcastIntentsForUser, getBroadcastOptions, getNextStartedActivity, getNextStartedActivityForResult, getNextStartedService, getNextStoppedService, grantPermissions, grantPermissions, peekNextStartedActivity, peekNextStartedActivityForResult, peekNextStartedService, removeSystemService

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowAccessibilityService

public ShadowAccessibilityService()

Method Details

performGlobalAction

@Implementation
protected boolean performGlobalAction(int action)

getGlobalActionsPerformed

public List<Integer> getGlobalActionsPerformed()

getSystemActions

@Implementation(minSdk=31)
protected List<AccessibilityNodeInfo.AccessibilityAction> getSystemActions()

setSystemActions

public final void setSystemActions(List<AccessibilityNodeInfo.AccessibilityAction> systemActions)

getWindows

@Implementation
protected List<AccessibilityWindowInfo> getWindows()

Returns a representation of interactive windows shown on the device's default display. Mirrors the values provided to setWindows(List). Returns an empty list if not set.

getWindowsOnAllDisplays

@Implementation(minSdk=30)
protected SparseArray<List<AccessibilityWindowInfo>> getWindowsOnAllDisplays()

Returns a representation of interactive windows shown on the device's all displays. An empty list will be returned for default display and null will be return for other displays if they are not set by setWindowsOnDisplay(int, List).

dispatchGesture

@Implementation(minSdk=24)
protected boolean dispatchGesture(GestureDescription gesture,
 AccessibilityService.GestureResultCallback callback,
 Handler handler)

takeScreenshot

@Implementation(minSdk=30)
protected void takeScreenshot(int displayId,
 Executor executor,
 AccessibilityService.TakeScreenshotCallback callback)

getRootInActiveWindow

@Implementation
protected AccessibilityNodeInfo getRootInActiveWindow()

setRootInActiveWindow

public void setRootInActiveWindow(AccessibilityNodeInfo rootInActiveWindow)

setTakeScreenshotErrorCode

public void setTakeScreenshotErrorCode(int errorCode)

Sets AccessibilityService.takeScreenshot(int, Executor, TakeScreenshotCallback) to start returning the given errorCode.

See Also:

• to unset the error condition.

unsetTakeScreenshotErrorCode

public void unsetTakeScreenshotErrorCode()

Sets AccessibilityService.takeScreenshot(int, Executor, TakeScreenshotCallback) to start returning successful results again.

See Also:

• to set an error condition instead.

setWindows

public void setWindows(List<AccessibilityWindowInfo> windowList)

Sets the list of interactive windows shown on the device's default display as reported by getWindows()

setWindowsOnDisplay

public void setWindowsOnDisplay(int displayId,
 @Nullable
 List<AccessibilityWindowInfo> windowList)

Sets the list of interactive windows shown on the device's displayId display. If the windowList is null, we will remove the list with given displayId display as reported by getWindowsOnAllDisplays().

getGesturesDispatched

public List<ShadowAccessibilityService.GestureDispatch> getGesturesDispatched()

Returns a list of gestures that have been dispatched.

Gestures are dispatched by calling AccessibilityService.dispatchGesture(android.accessibilityservice.GestureDescription, android.accessibilityservice.AccessibilityService.GestureResultCallback, android.os.Handler).

setCanDispatchGestures

public void setCanDispatchGestures(boolean canDispatchGestures)

Sets whether the service is currently able to dispatch gestures.

If false, AccessibilityService.dispatchGesture(android.accessibilityservice.GestureDescription, android.accessibilityservice.AccessibilityService.GestureResultCallback, android.os.Handler) will return false.

startInput

public void startInput(EditorInfo editorInfo)