NavDestination
open class NavDestination
kotlin.Any | |
↳ | androidx.navigation.NavDestination |
NavDestination represents one node within an overall navigation graph.
Each destination is associated with a Navigator
which knows how to navigate to this particular destination.
Destinations declare a set of actions
that they support. These actions form a navigation API for the destination; the same actions declared on different destinations that fill similar roles allow application code to navigate based on semantic intent.
Each destination has a set of arguments
that will be applied when navigating
to that destination. Any default values for those arguments can be overridden at the time of navigation.
Summary
Nested classes |
|
---|---|
This optional annotation allows tooling to offer auto-complete for the |
Public constructors |
|
---|---|
<init>(@NonNull : Navigator<out NavDestination!>) NavDestinations should be created via |
|
NavDestinations should be created via |
Public methods |
|
---|---|
Unit |
addArgument(@NonNull : String, @NonNull : NavArgument) Sets an argument type for an argument name |
Unit |
addDeepLink(@NonNull : String) Add a deep link to this destination. |
NavAction? |
Returns the destination ID for a given action. |
MutableMap<String!, NavArgument!> |
Get the arguments supported by this destination. |
Int |
getId() Returns the destination's unique ID. |
CharSequence? |
getLabel() Gets the descriptive label of this destination. |
String |
Returns the name associated with this destination's |
NavGraph? |
Gets the |
open Boolean |
hasDeepLink(@NonNull : Uri) Checks the given deep link |
open Unit |
onInflate(@NonNull : Context, @NonNull : AttributeSet) Called when inflating a destination from a resource. |
Unit |
Sets a destination ID for an action ID. |
Unit |
Sets a destination ID for an action ID. |
Unit |
removeAction(@IdRes : Int) Unsets the destination ID for an action ID. |
Unit |
removeArgument(@NonNull : String) Unsets the argument type for an argument name. |
Unit |
Sets the destination's unique ID. |
Unit |
setLabel(@Nullable : CharSequence?) Sets the descriptive label of this destination. |
open String |
toString() |
Protected methods |
|
---|---|
open static Class<out C> |
parseClassFromName(@NonNull : Context, @NonNull : String, @NonNull : Class<out C>) Parse the class associated with this destination from a raw name, generally extracted from the |
Public constructors
<init>
NavDestination(@NonNull : Navigator<out NavDestination!>)
NavDestinations should be created via Navigator#createDestination
.
This constructor requires that the given Navigator has a Navigator.Name
annotation.
<init>
NavDestination(@NonNull : String)
NavDestinations should be created via Navigator#createDestination
.
Public methods
addArgument
fun addArgument(@NonNull : String, @NonNull : NavArgument): Unit
Sets an argument type for an argument name
Parameters | |
---|---|
argumentName |
String: argument object to associate with destination |
addDeepLink
fun addDeepLink(@NonNull : String): Unit
Add a deep link to this destination. Matching Uris sent to NavController#handleDeepLink(Intent)
or NavController#navigate(Uri)
will trigger navigating to this destination.
In addition to a direct Uri match, the following features are supported:
- Uris without a scheme are assumed as http and https. For example,
www.example.com
will matchhttp://www.example.com
andhttps://www.example.com
. - Placeholders in the form of
{placeholder_name}
matches 1 or more characters. The String value of the placeholder will be available in the argumentsBundle
with a key of the same name. For example,http://www.example.com/users/{id}
will matchhttp://www.example.com/users/4
. - The
.*
wildcard can be used to match 0 or more characters.
<deepLink app:uri="uriPattern" />
elements as a child to your destination.
Deep links added in navigation XML files will automatically replace instances of ${applicationId}
with the applicationId of your app. Programmatically added deep links should use Context#getPackageName()
directly when constructing the uriPattern.
Parameters | |
---|---|
uriPattern |
String: The uri pattern to add as a deep link |
getAction
@Nullable fun getAction(@IdRes : Int): NavAction?
Returns the destination ID for a given action. This will recursively check the parent
of this destination if the action destination is not found in this destination.
Parameters | |
---|---|
id |
Int: action ID to fetch |
Return | |
---|---|
NavAction?: destination ID mapped to the given action id, or 0 if none |
getArguments
@NonNull fun getArguments(): MutableMap<String!, NavArgument!>
Get the arguments supported by this destination. Returns a read-only map of argument names to NavArgument
objects that can be used to check the type, default value and nullability of the argument.
To add and remove arguments for this NavDestination use addArgument(String, NavArgument)
and removeArgument(String)
.
Return | |
---|---|
MutableMap<String!, NavArgument!>: Read-only map of argument names to arguments. |
getId
@IdRes fun getId(): Int
Returns the destination's unique ID. This should be an ID resource generated by the Android resource system.
Return | |
---|---|
Int: this destination's ID |
getNavigatorName
@NonNull fun getNavigatorName(): String
Returns the name associated with this destination's Navigator
.
Return | |
---|---|
String: the name associated with this destination's navigator |
getParent
@Nullable fun getParent(): NavGraph?
Gets the NavGraph
that contains this destination. This will be set when a destination is added to a NavGraph via NavGraph#addDestination
.
Return | |
---|---|
NavGraph?: |
hasDeepLink
open fun hasDeepLink(@NonNull : Uri): Boolean
Checks the given deep link Uri
, and determines whether it matches a Uri pattern added to the destination by a call to addDeepLink(String)
. It returns true
if the deep link is a valid match, and false
otherwise.
This should be called prior to NavController#navigate(Uri)
to ensure the deep link can be navigated to.
Parameters | |
---|---|
deepLink |
Uri: to the destination reachable from the current NavGraph |
Return | |
---|---|
Boolean: True if the deepLink exists for the destination. |
onInflate
@CallSuper open fun onInflate(@NonNull : Context, @NonNull : AttributeSet): Unit
Called when inflating a destination from a resource.
Parameters | |
---|---|
context |
Context: local context performing inflation |
attrs |
Context: attrs to parse during inflation |
putAction
fun putAction(@IdRes : Int, @IdRes : Int): Unit
Sets a destination ID for an action ID.
Parameters | |
---|---|
actionId |
Int: action ID to bind |
destId |
Int: destination ID for the given action |
putAction
fun putAction(@IdRes : Int, @NonNull : NavAction): Unit
Sets a destination ID for an action ID.
Parameters | |
---|---|
actionId |
Int: action ID to bind |
action |
Int: action to associate with this action ID |
removeAction
fun removeAction(@IdRes : Int): Unit
Unsets the destination ID for an action ID.
Parameters | |
---|---|
actionId |
Int: action ID to remove |
removeArgument
fun removeArgument(@NonNull : String): Unit
Unsets the argument type for an argument name.
Parameters | |
---|---|
argumentName |
String: argument to remove |
setId
fun setId(@IdRes : Int): Unit
Sets the destination's unique ID. This should be an ID resource generated by the Android resource system.
Parameters | |
---|---|
id |
Int: this destination's new ID |
setLabel
fun setLabel(@Nullable : CharSequence?): Unit
Sets the descriptive label of this destination.
Parameters | |
---|---|
label |
CharSequence?: A descriptive label of this destination. |
toString
@NonNull open fun toString(): String
Protected methods
parseClassFromName
@NonNull protected open static fun <C : Any!> parseClassFromName(@NonNull : Context, @NonNull : String, @NonNull : Class<out C>): Class<out C>
Parse the class associated with this destination from a raw name, generally extracted from the android:name
attribute added to the destination's XML. This should be the class providing the visual representation of the destination that the user sees after navigating to this destination.
This method does name -> Class caching and should be strongly preferred over doing your own parsing if your Navigator
supports the android:name
attribute to give consistent behavior across all Navigators.
Parameters | |
---|---|
context |
Context: Context providing the package name for use with relative class names and the ClassLoader |
name |
Context: Absolute or relative class name. Null names will be ignored. |
expectedClassType |
Context: The expected class type |
Return | |
---|---|
Class<out C>: The parsed class |
Exceptions | |
---|---|
IllegalArgumentException |
if the class is not found in the provided Context's ClassLoader or if the class is not of the expected type |