In package com.nhaarman.acorn.navigation
class com.nhaarman.acorn.navigation.SingleSceneNavigator
A simple Navigator that only hosts a single Scene.
This Navigator is able to save and restore its instance state in saveInstanceState, but does not implement SavableNavigator itself. You can opt in to this state saving by explicitly implementing the SavableNavigator interface.
Constructors
A simple Navigator that only hosts a single Scene.
This Navigator is able to save and restore its instance state in saveInstanceState, but does not implement SavableNavigator itself. You can opt in to this state saving by explicitly implementing the SavableNavigator interface.
-
savedState: NavigatorState?
An optional instance that contains saved state as returned by saveInstanceState.
Methods
protected abstract fun createScene(state: SceneState?): Scene
Creates the Scene instance to host.
-
state: SceneState?
An optional saved state instance to restore the Scene's state from.
fun finish()
Finishes this Navigator.
If this Navigator is currently active, the current Scene will go through its destroying lifecycle calling Scene.onStop and Scene.onDestroy.
If this Navigator is currently not active, the current Scene will only have its Scene.onDestroy method called.
Calling this method when the Navigator has been destroyed will have no effect.
- No parameters
open fun onStart()
Starts this Navigator.
Calling this method when the Navigator is not started or destroyed triggers a call to Scene.onStart for the Scene that is currently active in the Navigator. Listeners registered with addNavigatorEventsListener will be notified of that Scene through Events.scene.
Calling this method when the Navigator is started or destroyed has no effect.
- No parameters
open fun onStop()
Stops this Navigator.
Calling this method when the Navigator is started triggers a call to Scene.onStop for any Scenes that are currently active in the Navigator.
Calling this method when the Navigator is stopped or destroyed has no effect.
- No parameters
open fun onDestroy()
Destroys this Navigator.
Calling this method when the Navigator is started will trigger a call to Scene.onStop for the Scene that is currently active in the Navigator. Furthermore, a call to Scene.onDestroy is triggered for every Scene this Navigator is managing.
Calling this method when the Navigator is stopped triggers a call to Scene.onDestroy for every Scene this Navigator is managing.
Calling this method when the Navigator is destroyed has no effect.
When this method has been called, the Navigator must be considered as dead, and no calls to onStart or onStop should be done anymore.
- No parameters
open fun onBackPressed(): Boolean
Invoked when the user presses the back button.
- No parameters
- No parameters
open fun isDestroyed(): Boolean
Returns whether this Navigator has been destroyed.
- No parameters