Package org.robolectric.shadows

Class ShadowActivity

java.lang.Object

org.robolectric.shadows.ShadowContextWrapper

org.robolectric.shadows.ShadowContextThemeWrapper

org.robolectric.shadows.ShadowActivity

Direct Known Subclasses:

ShadowActivityGroup

@Implements(value=android.app.Activity.class,
            looseSignatures=true)
public class ShadowActivity
extends ShadowContextThemeWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadowActivity.IntentForResult	Container object to hold an Intent, together with the requestCode used in a call to Activity.startActivityForResult(Intent, int)
static class	ShadowActivity.IntentSenderRequest	Class to holds details of a startIntentSenderForResult request.
static class	ShadowActivity.OverriddenActivityTransition	Class to hold overridden activity transition details after calling Activity.overrideActivityTransition(int, int, int, int)
static class	ShadowActivity.PermissionsRequest	Class to hold a permissions request, including its request code.

Field Summary

Fields

Modifier and Type	Field	Description
protected Activity	realActivity

Constructor Summary

Constructors

Constructor	Description
ShadowActivity()

Method Summary

Modifier and Type	Method	Description
<T extends Activity> void	attachController(ActivityController controller)	For internal use only.
void	callAttach(Intent intent)
void	callAttach(Intent intent, Bundle activityOptions)
void	callAttach(Intent intent, Bundle activityOptions, Object lastNonConfigurationInstances)
void	callAttach(Intent intent, Bundle activityOptions, Object lastNonConfigurationInstances, Configuration overrideConfig)
void	callOnActivityResult(int requestCode, int resultCode, Intent resultData)	Deprecated.
void	callOnGetDirectActions(CancellationSignal cancellationSignal, Consumer<List<DirectAction>> callback)	Calls Activity#onGetDirectActions with the given parameters.
protected void	clearOverrideActivityTransition(int overrideType)
boolean	clickMenuItem(int menuItemResId)	Perform a click on a menu item.
protected void	dismissDialog(int id)
protected void	enterPictureInPictureMode()
protected boolean	enterPictureInPictureMode(PictureInPictureParams params)
protected View	findViewById(int id)	Checks to ensure that thecontentView has been set
protected void	finish()
protected void	finishAffinity()
protected void	finishAndRemoveTask()
protected ComponentName	getCallingActivity()
protected String	getCallingPackage()
View	getContentView()
protected View	getCurrentFocus()
int	getDefaultKeymode()
Dialog	getDialogById(int dialogId)
ShadowActivity.IntentSenderRequest	getLastIntentSenderRequest()	Gets the last startIntentSenderForResult request made to this activity.
protected Object	getLastNonConfigurationInstance()
ShadowActivity.PermissionsRequest	getLastRequestedPermission()	Gets the last permission request submitted to this activity.
Integer	getLastShownDialogId()
protected LayoutInflater	getLayoutInflater()
List<Cursor>	getManagedCursors()
protected MenuInflater	getMenuInflater()
ShadowActivity.IntentForResult	getNextStartedActivityForResult()	Consumes and returns the next Intent on the started activities for results stack.
Menu	getOptionsMenu()	Return the options menu.
ShadowActivity.OverriddenActivityTransition	getOverriddenActivityTransition(int overrideType)	Get the overridden Activity transition, set by Activity.overrideActivityTransition(int, int, int).
protected Activity	getParent()
int	getPendingTransitionEnterAnimationResourceId()
int	getPendingTransitionExitAnimationResourceId()
boolean	getReportFullyDrawn()
protected int	getRequestedOrientation()
int	getResultCode()
Intent	getResultIntent()
boolean	getShowWhenLocked()
protected Object	getSplashScreen()
protected int	getTaskId()
boolean	getTurnScreenOn()
protected int	getVolumeControlStream()
protected Window	getWindow()	Constructs a new Window (a PhoneWindow) if no window has previously been set.
boolean	hasCancelledPendingTransitions()
void	initializeVoiceInteractor()	Initializes the associated Activity with an VoiceInteractor instance.
void	internalCallDispatchActivityResult(String who, int requestCode, int resultCode, Intent data)	For internal use only.
protected boolean	isFinishing()	Returns whether finish() was called.
protected boolean	isInMultiWindowMode()
protected boolean	isInPictureInPictureMode()
boolean	isLockTask()	Deprecated. Use ActivityManager.getLockTaskModeState() instead.
protected boolean	isTaskRoot()
protected boolean	moveTaskToBack(boolean nonRoot)
protected void	onBackPressed()
protected boolean	onCreateOptionsMenu(Menu menu)
protected void	onDestroy()
protected void	overrideActivityTransition(int overrideType, int enterAnim, int exitAnim, int backgroundColor)
protected void	overridePendingTransition(int enterAnim, int exitAnim)
ShadowActivity.IntentForResult	peekNextStartedActivityForResult()	Returns the most recent Intent started by Activity.startActivityForResult(Intent, int) without consuming it.
void	receiveResult(Intent requestIntent, int resultCode, Intent resultIntent)
protected void	recreate()
protected void	removeDialog(int id)
protected void	reportFullyDrawn()
protected void	requestPermissions(String[] permissions, int requestCode)
void	resetIsFinishing()
protected void	runOnUiThread(Runnable action)
void	setApplication(Application application)
void	setCallingActivity(ComponentName activityName)	Sets the calling activity that will be reflected in Activity.getCallingActivity() and Activity.getCallingPackage().
void	setCallingPackage(String packageName)	Sets the calling package that will be reflected in Activity.getCallingActivity() and Activity.getCallingPackage().
void	setCurrentFocus(View view)
protected void	setDefaultKeyMode(int keyMode)
void	setInMultiWindowMode(boolean value)	Changes state of isInMultiWindowMode() method.
void	setIsTaskRoot(boolean isRoot)
void	setLastNonConfigurationInstance(Object lastNonConfigurationInstance)	Deprecated. use ActivityController.recreate().
void	setParent(Activity parent)	Allow setting of Parent fragmentActivity (for unit testing purposes only)
protected void	setRequestedOrientation(int requestedOrientation)
protected void	setResult(int resultCode)
protected void	setResult(int resultCode, Intent data)
protected void	setShowWhenLocked(boolean showWhenLocked)
void	setThrowIntentSenderException(boolean throwIntentSenderException)	Sets if startIntentSenderForRequestCode will throw an IntentSender.SendIntentException.
protected void	setTurnScreenOn(boolean turnScreenOn)
protected void	setVolumeControlStream(int streamType)
void	setWindow(Window window)
protected void	showDialog(int id)
protected boolean	showDialog(int id, Bundle bundle)
void	startIntentSenderForResult(IntentSender intentSender, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)
protected void	startLockTask()	Starts a lock task.
protected void	startManagingCursor(Cursor c)
protected void	stopLockTask()	Stops a lock task.
protected void	stopManagingCursor(Cursor c)

Methods inherited from class org.robolectric.shadows.ShadowContextThemeWrapper

callGetThemeResId

Methods inherited from class org.robolectric.shadows.ShadowContextWrapper

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

Methods inherited from class java.lang.Object

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

Field Details

realActivity

@RealObject
protected Activity realActivity

Constructor Details

ShadowActivity

public ShadowActivity()

Method Details

setApplication

public void setApplication(Application application)

callAttach

public void callAttach(Intent intent)

callAttach

public void callAttach(Intent intent,
 @Nullable
 Bundle activityOptions)

callAttach

public void callAttach(Intent intent,
 @Nullable
 Bundle activityOptions,
 @Nullable
 Object lastNonConfigurationInstances)

callAttach

public void callAttach(Intent intent,
 @Nullable
 Bundle activityOptions,
 @Nullable
 Object lastNonConfigurationInstances,
 @Nullable
 Configuration overrideConfig)

setCallingActivity

public void setCallingActivity(@Nullable
 ComponentName activityName)

Sets the calling activity that will be reflected in Activity.getCallingActivity() and Activity.getCallingPackage().

getCallingActivity

@Implementation
protected ComponentName getCallingActivity()

setCallingPackage

public void setCallingPackage(@Nullable
 String packageName)

Sets the calling package that will be reflected in Activity.getCallingActivity() and Activity.getCallingPackage().

Activity name defaults to some default value.

getCallingPackage

@Implementation
protected String getCallingPackage()

setDefaultKeyMode

@Implementation
protected void setDefaultKeyMode(int keyMode)

getDefaultKeymode

public int getDefaultKeymode()

setShowWhenLocked

@Implementation(minSdk=27)
protected void setShowWhenLocked(boolean showWhenLocked)

getShowWhenLocked

@RequiresApi(api=27)
public boolean getShowWhenLocked()

setTurnScreenOn

@Implementation(minSdk=27)
protected void setTurnScreenOn(boolean turnScreenOn)

getTurnScreenOn

@RequiresApi(api=27)
public boolean getTurnScreenOn()

setResult

@Implementation
protected void setResult(int resultCode)

setResult

@Implementation
protected void setResult(int resultCode,
 Intent data)

getLayoutInflater

@Implementation
protected LayoutInflater getLayoutInflater()

getMenuInflater

@Implementation
protected MenuInflater getMenuInflater()

findViewById

@Implementation
protected View findViewById(int id)

Checks to ensure that thecontentView has been set

Parameters:

id - ID of the view to find

Returns:

the view

Throws:

RuntimeException - if the contentView has not been called first

getParent

@Implementation
protected Activity getParent()

setParent

@HiddenApi
@Implementation
public void setParent(Activity parent)

Allow setting of Parent fragmentActivity (for unit testing purposes only)

Parameters:

parent - Parent fragmentActivity to set on this fragmentActivity

onBackPressed

@Implementation
protected void onBackPressed()

finish

@Implementation
protected void finish()

finishAndRemoveTask

@Implementation(minSdk=21)
protected void finishAndRemoveTask()

finishAffinity

@Implementation
protected void finishAffinity()

resetIsFinishing

public void resetIsFinishing()

isFinishing

@Implementation
protected boolean isFinishing()

Returns whether finish() was called.

Note: this method seems redundant, but removing it will cause problems for Mockito spies of Activities that call Activity.finish() followed by Activity.isFinishing(). This is because `finish` modifies the members of realActivity, so `isFinishing` should refer to those same members.

getWindow

@Implementation
protected Window getWindow()

Constructs a new Window (a PhoneWindow) if no window has previously been set.

Returns:

the window associated with this Activity

getSplashScreen

@Implementation(minSdk=31)
protected Object getSplashScreen()

Returns:

fake SplashScreen

setWindow

public void setWindow(Window window)

runOnUiThread

@Implementation
protected void runOnUiThread(Runnable action)

setRequestedOrientation

@Implementation
protected void setRequestedOrientation(int requestedOrientation)

getRequestedOrientation

@Implementation
protected int getRequestedOrientation()

getTaskId

@Implementation
protected int getTaskId()

startIntentSenderForResult

@Implementation
public void startIntentSenderForResult(IntentSender intentSender,
 int requestCode,
 @Nullable
 Intent fillInIntent,
 int flagsMask,
 int flagsValues,
 int extraFlags,
 Bundle options)
                                throws IntentSender.SendIntentException

Throws:

IntentSender.SendIntentException

reportFullyDrawn

@Implementation
protected void reportFullyDrawn()

getReportFullyDrawn

public boolean getReportFullyDrawn()

Returns:

whether ReportFullyDrawn() methods has been called.

getContentView

public View getContentView()

Returns:

the contentView set by one of the setContentView() methods

getResultCode

public int getResultCode()

Returns:

the resultCode set by one of the setResult() methods

getResultIntent

public Intent getResultIntent()

Returns:

the Intent set by setResult(int, android.content.Intent)

getNextStartedActivityForResult

public ShadowActivity.IntentForResult getNextStartedActivityForResult()

Consumes and returns the next Intent on the started activities for results stack.

Overrides:

getNextStartedActivityForResult in class ShadowContextWrapper

Returns:

the next started Intent for an activity, wrapped in an ShadowActivity.IntentForResult object

peekNextStartedActivityForResult

public ShadowActivity.IntentForResult peekNextStartedActivityForResult()

Returns the most recent Intent started by Activity.startActivityForResult(Intent, int) without consuming it.

Overrides:

peekNextStartedActivityForResult in class ShadowContextWrapper

Returns:

the most recently started Intent, wrapped in an ShadowActivity.IntentForResult object

getLastNonConfigurationInstance

@Implementation
protected Object getLastNonConfigurationInstance()

setLastNonConfigurationInstance

@Deprecated
public void setLastNonConfigurationInstance(Object lastNonConfigurationInstance)

Deprecated.

use ActivityController.recreate().

setCurrentFocus

public void setCurrentFocus(View view)

Parameters:

view - View to focus.

getCurrentFocus

@Implementation
protected View getCurrentFocus()

getPendingTransitionEnterAnimationResourceId

public int getPendingTransitionEnterAnimationResourceId()

getPendingTransitionExitAnimationResourceId

public int getPendingTransitionExitAnimationResourceId()

getOverriddenActivityTransition

@Nullable
@RequiresApi(34)
public ShadowActivity.OverriddenActivityTransition getOverriddenActivityTransition(int overrideType)

Get the overridden Activity transition, set by Activity.overrideActivityTransition(int, int, int).

Parameters:

overrideType - Use Activity.OVERRIDE_TRANSITION_OPEN to get the overridden activity transition animation details when starting/entering an activity. Use Activity.OVERRIDE_TRANSITION_CLOSE to get the overridden activity transition animation details when finishing/closing an activity.

Returns:

overridden activity transition details after calling Activity.overrideActivityTransition(int, int, int, int) or null if was not overridden.

See Also:

• clearOverrideActivityTransition(int)

onCreateOptionsMenu

@Implementation
protected boolean onCreateOptionsMenu(Menu menu)

getOptionsMenu

public Menu getOptionsMenu()

Return the options menu.

Returns:

Options menu.

clickMenuItem

public boolean clickMenuItem(int menuItemResId)

Perform a click on a menu item.

Parameters:

menuItemResId - Menu item resource ID.

Returns:

True if the click was handled, false otherwise.

callOnActivityResult

@Deprecated
public void callOnActivityResult(int requestCode,
 int resultCode,
 Intent resultData)

Deprecated.

internalCallDispatchActivityResult

public void internalCallDispatchActivityResult(String who,
 int requestCode,
 int resultCode,
 Intent data)

For internal use only. Not for public use.

attachController

public <T extends Activity> void attachController(ActivityController controller)

For internal use only. Not for public use.

setThrowIntentSenderException

public void setThrowIntentSenderException(boolean throwIntentSenderException)

Sets if startIntentSenderForRequestCode will throw an IntentSender.SendIntentException.

receiveResult

public void receiveResult(Intent requestIntent,
 int resultCode,
 Intent resultIntent)

showDialog

@Implementation
protected void showDialog(int id)

showDialog

@Implementation
protected boolean showDialog(int id,
 Bundle bundle)

dismissDialog

@Implementation
protected void dismissDialog(int id)

removeDialog

@Implementation
protected void removeDialog(int id)

setIsTaskRoot

public void setIsTaskRoot(boolean isRoot)

isTaskRoot

@Implementation
protected boolean isTaskRoot()

getLastShownDialogId

public Integer getLastShownDialogId()

Returns:

the dialog resource id passed into Activity.showDialog(int, Bundle) or Activity.showDialog(int)

hasCancelledPendingTransitions

public boolean hasCancelledPendingTransitions()

overridePendingTransition

@Implementation
protected void overridePendingTransition(int enterAnim,
 int exitAnim)

overrideActivityTransition

@Implementation(minSdk=34)
protected void overrideActivityTransition(int overrideType,
 @AnimRes
 int enterAnim,
 @AnimRes
 int exitAnim,
 int backgroundColor)

clearOverrideActivityTransition

@Implementation(minSdk=34)
protected void clearOverrideActivityTransition(int overrideType)

getDialogById

public Dialog getDialogById(int dialogId)

onDestroy

@Implementation
protected void onDestroy()

recreate

@Implementation
protected void recreate()

startManagingCursor

@Implementation
protected void startManagingCursor(Cursor c)

stopManagingCursor

@Implementation
protected void stopManagingCursor(Cursor c)

getManagedCursors

public List<Cursor> getManagedCursors()

setVolumeControlStream

@Implementation
protected void setVolumeControlStream(int streamType)

getVolumeControlStream

@Implementation
protected int getVolumeControlStream()

requestPermissions

@Implementation(minSdk=23)
protected void requestPermissions(String[] permissions,
 int requestCode)

startLockTask

@Implementation(minSdk=21)
protected void startLockTask()

Starts a lock task.

The status of the lock task can be verified using isLockTask() method. Otherwise this implementation has no effect.

stopLockTask

@Implementation(minSdk=21)
protected void stopLockTask()

Stops a lock task.

The status of the lock task can be verified using isLockTask() method. Otherwise this implementation has no effect.

isLockTask

@Deprecated
public boolean isLockTask()

Deprecated.

Use ActivityManager.getLockTaskModeState() instead.

Returns if the activity is in the lock task mode.

setInMultiWindowMode

public void setInMultiWindowMode(boolean value)

Changes state of isInMultiWindowMode() method.

isInMultiWindowMode

@Implementation(minSdk=24)
protected boolean isInMultiWindowMode()

isInPictureInPictureMode

@Implementation(minSdk=24)
protected boolean isInPictureInPictureMode()

enterPictureInPictureMode

@Implementation(minSdk=24)
protected void enterPictureInPictureMode()

enterPictureInPictureMode

@Implementation(minSdk=26)
protected boolean enterPictureInPictureMode(PictureInPictureParams params)

moveTaskToBack

@Implementation
protected boolean moveTaskToBack(boolean nonRoot)

getLastIntentSenderRequest

public ShadowActivity.IntentSenderRequest getLastIntentSenderRequest()

Gets the last startIntentSenderForResult request made to this activity.

Returns:

The IntentSender request details.

getLastRequestedPermission

public ShadowActivity.PermissionsRequest getLastRequestedPermission()

Gets the last permission request submitted to this activity.

Returns:

The permission request details.

initializeVoiceInteractor

public void initializeVoiceInteractor()

Initializes the associated Activity with an VoiceInteractor instance. Subsequent Activity.getVoiceInteractor() calls on the associated activity will return a VoiceInteractor instance

callOnGetDirectActions

public void callOnGetDirectActions(CancellationSignal cancellationSignal,
 Consumer<List<DirectAction>> callback)

Calls Activity#onGetDirectActions with the given parameters. This method also simulates the Parcel serialization/deserialization which occurs when assistant requests DirectAction.