GitHub/Conductor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix doc mistake in ControllerChangeHandler (#691)

Browse Source
This commit is contained in:
Steven Schoen
2024-01-11 14:28:13 -04:00
committed by GitHub
parent 2ffafaee79
commit 5a1746b2d3
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
conductor/src/main/java/com/bluelinelabs/conductor/ControllerChangeHandler.kt
+5 -5
View File
@@ -29,15 +29,15 @@ abstract class ControllerChangeHandler {
* If this is true:
* - This handler's implementation of [performChange] should remove `from` from `container`
* before calling `changeListener.onChangeCompleted()`
* - When a controller is pushed, the previous controller will stay attached and its view will remain created
* - When a view is recreated (e.g. after a configuration change), any controllers underneath a transaction
* using this handler will have their view recreated and attached, even though they're not the top-most
* controller
* - When a controller is pushed, the previous controller will be detached and its view will be destroyed
*
* If this is false:
* - This handler's implementation of [performChange] should only remove `from` from `container`
* when `isPush` is false
* - When a controller is pushed, the previous controller will be detached and its view will be destroyed
* - When a controller is pushed, the previous controller will stay attached and its view will remain created
* - When a view is recreated (e.g. after a configuration change), any controllers underneath a transaction
* using this handler will have their view recreated and attached, even though they're not the top-most
* controller
*
* If a controller pushed onto the backstack will completely cover the previous controller,
* using a change handler with [removesFromViewOnPush] true should result in no visual interruption