NavUtils

This package is part of the
Android support library which
is no longer maintained.
The support library has been superseded by AndroidX
which is part of Jetpack.
We recommend using the AndroidX libraries in all new projects. You should also consider
migrating existing projects to AndroidX.

public
final
class
NavUtils
extends Object

java.lang.Object

↳

android.support.v4.app.NavUtils

NavUtils provides helper functionality for applications implementing
recommended Android UI navigation patterns. For information about recommended
navigation patterns see
Tasks and Back Stack
from the developer guide and Navigation
from the design guide.

getParentActivityIntent

Obtain an Intent that will launch an explicit target activity
specified by sourceActivity's PARENT_ACTIVITY <meta-data>
element in the application's manifest. If the device is running
Jellybean or newer, the android:parentActivityName attribute will be preferred
if it is present.

getParentActivityName

Return the fully qualified class name of a source activity's parent activity as specified by
a PARENT_ACTIVITY <meta-data> element within the activity element in
the application's manifest. The source activity is provided by componentName.

Parameters

context

Context: Context for looking up the activity component for the source activity

componentName

ComponentName: ComponentName for the source Activity

Returns

String

The fully qualified class name of sourceActivity's parent activity or null if
it was not specified

Note: This method should only be used when sourceActivity and the corresponding
parent are within the same task. If up navigation should cross tasks in some cases, see
shouldUpRecreateTask(Activity, Intent).

Parameters

sourceActivity

Activity: The current activity from which the user is attempting to navigate up

navigateUpTo

Navigate from sourceActivity to the activity specified by upIntent, finishing sourceActivity
in the process. upIntent will have the flag FLAG_ACTIVITY_CLEAR_TOP set
by this method, along with any others required for proper up navigation as outlined
in the Android Design Guide.

This method should be used when performing up navigation from within the same task
as the destination. If up navigation should cross tasks in some cases, see
shouldUpRecreateTask(Activity, Intent).

Parameters

sourceActivity

Activity: The current activity from which the user is attempting to navigate up

upIntent

Intent: An intent representing the target destination for up navigation

shouldUpRecreateTask

Returns true if sourceActivity should recreate the task when navigating 'up'
by using targetIntent.

If this method returns false the app can trivially call
navigateUpTo(Activity, Intent) using the same parameters to correctly perform
up navigation. If this method returns true, the app should synthesize a new task stack
by using TaskStackBuilder or another similar mechanism to perform up navigation.

Parameters

sourceActivity

Activity: The current activity from which the user is attempting to navigate up

targetIntent

Intent: An intent representing the target destination for up navigation

Returns

boolean

true if navigating up should recreate a new task stack, false if the same task
should be used for the destination