SavedStateRegistryOwner should describe the implementing classes' responsibilities [228887344]

Fixed

Bug

Status Update

No update yet.

Description

il...@google.com

created issue #1

Apr 11, 2022 10:47PM

Component used: SavedState

Version used: 1.2.0-alpha02

The docs on SavedStateRegistryOwner do not explain the responsibilities and contract that the owner has on how they should implement SavedStateRegistryOwner or when they should call the methods on SavedStateRegistryController.

Ideally the class docs should talk through:

That performAttach() should be called only once, usually as part of the initialization of the owner. It must be called on the main thread.
That performRestore should be called unconditionally (either with null if no state is being restored or the Bundle of state to restore) either directly before moving the Lifecycle to CREATED or as part of a LifecycleObserver that is added as part of the initialization of the owner.
When the state of the owner is saved, performSave() must be called. The Bundle saved there should be what is later sent to performRestore().

Comments

il...@google.com <il...@google.com> Apr 14, 2022 04:58PM

Assigned to cl...@google.com.

cl...@google.com <cl...@google.com> Apr 14, 2022 04:59PM

Accepted by cl...@google.com.

ap...@google.com <ap...@google.com> #2Apr 19, 2022 10:44PM

Marked as fixed.

I have the same issue. There should be a built in method for setting title dynamically.

le...@gmail.com <le...@gmail.com> #3Oct 21, 2022 02:20AM

I would expect a simple API inside the navigation architecture as this is quite a common design requirement

le...@gmail.com <le...@gmail.com> #4Oct 21, 2022 02:21AM

To me, it is perfectly reasonable to remove the `android:label` attribute from the nav_graph.xml and set the title manually based on the arguments bundle.

le...@gmail.com <le...@gmail.com> #5Oct 21, 2022 02:22AM

I'm currently working around this limitation by adding an "onNavigatedListener" to my root Activity and using the "

destination.id" property against a lookup mapping to a desired title:

private val onNavigatedListener: (NavController, NavDestination) -> Unit = { _, destination ->
this.title = titleLookup[

destination.id]
}

le...@gmail.com <le...@gmail.com> #6Oct 21, 2022 02:22AM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit a958e3d36aeca8767d1c3cb53caa55ba3dd1c65d
Author: Ian Lake <ilake@google.com>
Date: Wed Nov 28 16:06:01 2018

Allow {argName} parameterized labels

Support parameterized labels similarly
to how ActivityNavigator uses dataPattern by
using {argName} blocks in the label.

Test: testapp works
BUG: 80267266
Change-Id: I923f3a6e11662c4364d4b3f0757361edea016cec

M navigation/integration-tests/testapp/src/main/res/navigation/nav_main.xml
M navigation/integration-tests/testapp/src/main/res/values/strings.xml
M navigation/ui/src/main/java/androidx/navigation/ui/AbstractAppBarOnNavigatedListener.java

https://android-review.googlesource.com/837143

https://goto.google.com/android-sha1/a958e3d36aeca8767d1c3cb53caa55ba3dd1c65d