ViewTreeSavedStateRegistryOwner

class ViewTreeSavedStateRegistryOwner


Summary

Public constructors

Public functions

const SavedStateRegistryOwner?

Retrieve the SavedStateRegistryOwner responsible for managing the saved state for this View.

const Unit

Set the SavedStateRegistryOwner responsible for managing the saved state for this View Calls to get from this view or descendants will return owner.

Public constructors

ViewTreeSavedStateRegistryOwner

ViewTreeSavedStateRegistryOwner()

Public functions

get

const fun View!.get(): SavedStateRegistryOwner?

Retrieve the SavedStateRegistryOwner responsible for managing the saved state for this View. This may be used to save or restore the state associated with the view.

The returned SavedStateRegistryOwner is managing all the Views within the Fragment or Activity this View is added to.

Returns
SavedStateRegistryOwner?

The SavedStateRegistryOwner responsible for managing the saved state for this view and/or some subset of its ancestors

set

const fun View!.set(owner: SavedStateRegistryOwner?): Unit

Set the SavedStateRegistryOwner responsible for managing the saved state for this View Calls to get from this view or descendants will return owner.

This is is automatically set for you in the common cases of using fragments or ComponentActivity.

This should only be called by constructs such as activities or fragments that manage a view tree and their saved state through a SavedStateRegistryOwner. Callers should only set a SavedStateRegistryOwner that will be stable. The associated SavedStateRegistry should be cleared if the view tree is removed and is not guaranteed to later become reattached to a window.

Parameters
owner: SavedStateRegistryOwner?

The SavedStateRegistryOwner responsible for managing the saved state for the given view