ComponentActivity

ComponentActivity

public ComponentActivity ()

Default constructor for ComponentActivity. All Activities must have a default constructor for API 27 and lower devices or when using the default AppComponentFactory.

ComponentActivity

public ComponentActivity (int contentLayoutId)

Alternate constructor that can be used to provide a default layout that will be inflated as part of super.onCreate(savedInstanceState).

This should generally be called from your constructor that takes no parameters, as is required for API 27 and lower or when using the default AppComponentFactory.

addOnBackPressedCallback

public void addOnBackPressedCallback (LifecycleOwner owner, 
                OnBackPressedCallback onBackPressedCallback)

This method is deprecated.
Use and {@link OnBackPressedDispatcher#addCallback(LifecycleOwner, OnBackPressedCallback)}.

Add a new OnBackPressedCallback. Callbacks are invoked in order of recency, so this newly added OnBackPressedCallback will be the first callback to receive a callback if onBackPressed() is called. Only if this callback returns false from its OnBackPressedCallback.handleOnBackPressed() will any previously added callback be called.

The OnBackPressedCallback.handleOnBackPressed() callback will only be called if the given LifecycleOwner is at least Lifecycle.State.STARTED. When the LifecycleOwner is destroyed, it will automatically be removed from the list of callbacks. The only time you would need to manually call removeOnBackPressedCallback(OnBackPressedCallback) is if you'd like to remove the callback prior to destruction of the associated lifecycle.

addOnBackPressedCallback

public void addOnBackPressedCallback (OnBackPressedCallback onBackPressedCallback)

This method is deprecated.
Use and {@link OnBackPressedDispatcher#addCallback(LifecycleOwner, OnBackPressedCallback)}, explicitly passing in this Activity object as the LifecycleOwner.

Add a new OnBackPressedCallback. Callbacks are invoked in order of recency, so this newly added OnBackPressedCallback will be the first callback to receive a callback if onBackPressed() is called. Only if this callback returns false from its OnBackPressedCallback.handleOnBackPressed() will any previously added callback be called.

This is the equivalent of passing this ComponentActivity to addOnBackPressedCallback(LifecycleOwner, OnBackPressedCallback) and ensures that the OnBackPressedCallback.handleOnBackPressed() callback will only be called if this ComponentActivity is at least Lifecycle.State.STARTED. You can remove the callback prior to the destruction of your activity by calling removeOnBackPressedCallback(OnBackPressedCallback).

dispatchKeyEvent

public boolean dispatchKeyEvent (KeyEvent event)

dispatchKeyShortcutEvent

public boolean dispatchKeyShortcutEvent (KeyEvent event)

getLastCustomNonConfigurationInstance

public Object getLastCustomNonConfigurationInstance ()

This method is deprecated.
Use a ViewModel to store non config state.

Return the value previously returned from onRetainCustomNonConfigurationInstance().

getLifecycle

public Lifecycle getLifecycle ()

Returns the Lifecycle of the provider.

Overriding this method is no longer supported and this method will be made final in a future version of ComponentActivity. If you do override this method, you must:

1. Return an instance of LifecycleRegistry
2. Lazily initialize your LifecycleRegistry object when this is first called. Note that this method will be called in the super classes' constructor, before any field initialization or object state creation is complete.

getOnBackPressedDispatcher

public final OnBackPressedDispatcher getOnBackPressedDispatcher ()

Retrieve the OnBackPressedDispatcher that will be triggered when onBackPressed() is called.

getSavedStateRegistry

public final SavedStateRegistry getSavedStateRegistry ()

Returns owned SavedStateRegistry

getViewModelStore

public ViewModelStore getViewModelStore ()

Returns the ViewModelStore associated with this activity

Overriding this method is no longer supported and this method will be made final in a future version of ComponentActivity.

onBackPressed

public void onBackPressed ()

Called when the activity has detected the user's press of the back key. The OnBackPressedDispatcher will be given a chance to handle the back button before the default behavior of Activity.onBackPressed() is invoked.

onRetainCustomNonConfigurationInstance

public Object onRetainCustomNonConfigurationInstance ()

This method is deprecated.
Use a ViewModel to store non config state.

Use this instead of onRetainNonConfigurationInstance(). Retrieve later with getLastCustomNonConfigurationInstance().

onRetainNonConfigurationInstance

public final Object onRetainNonConfigurationInstance ()

Retain all appropriate non-config state. You can NOT override this yourself! Use a ViewModel if you want to retain your own non config state.

removeOnBackPressedCallback

public void removeOnBackPressedCallback (OnBackPressedCallback onBackPressedCallback)

This method is deprecated.
Use Cancellable.cancel() on the Cancellable returned by and {@link OnBackPressedDispatcher#addCallback }.

Remove a previously added OnBackPressedCallback instance. The callback won't be called for any future onBackPressed() calls, but may still receive a callback if this method is called during the dispatch of an ongoing onBackPressed() call.

This call is usually not necessary as callbacks will be automatically removed when their associated LifecycleOwner is destroyed.

onCreate

protected void onCreate (Bundle savedInstanceState)

If your ComponentActivity is annotated with ContentView, this will call Activity.setContentView(int) for you.

onSaveInstanceState

protected void onSaveInstanceState (Bundle outState)