Compare commits

..

384 Commits

Author SHA1 Message Date
EricKuck 6a87a4140e minSdk 19 2024-01-17 11:52:24 -05:00
EricKuck ad81c4819b jdk 17 in CI 2024-01-17 11:38:55 -05:00
EricKuck 49018ed84c Fix a few early bugs when disabled 2024-01-17 10:59:50 -05:00
EricKuck fbfe3ce2e9 WIP predictive back change handlers 2024-01-16 18:36:13 -05:00
Steven Schoen 5a1746b2d3 Fix doc mistake in ControllerChangeHandler (#691) 2024-01-11 13:28:13 -05:00
Steven Schoen 2ffafaee79 Add kdoc to ControllerChangeHandler::removesFromViewOnPush (#688) 2023-09-29 23:19:21 -04:00
EricKuck eabfc005d0 Preview version bump 2023-08-15 14:50:42 -04:00
EricKuck a90ca5180e Fix issue with child controllers frozen at detach time not re-attaching 2023-08-15 14:30:19 -04:00
EricKuck 4d4d8bfbd1 Fix ConcurrentModificationException when manipulating backstack during instantiation 2023-05-09 11:09:58 -04:00
EricKuck f69fab6062 Merge LifecycleOwner into Controller, add back handling demo 2023-03-24 11:50:37 -04:00
Eric Kuck 590debf975 Conductor 4.0-preview-1 (#686) 2023-03-22 11:26:52 -05:00
EricKuck c3f7d128f5 Version bump 2023-01-30 11:56:22 -05:00
EricKuck 5e1f072672 Update maven publishing 2023-01-27 10:38:57 -05:00
EricKuck b0d15d9f9e Update maven publishing 2023-01-27 10:26:15 -05:00
Eric Kuck 8ac2e04c62 Make change start/end callbacks when parent controller is popped. Fixes #683 (#684) 2023-01-26 10:11:33 -06:00
Eric Kuck cdbdee5c42 Don't pop the final controller in pager adapters. Fixes #681 (#682) 2023-01-26 09:57:39 -06:00
EricKuck 8488242a26 Version bump 2022-11-29 15:04:22 -05:00
Eric Kuck 1fe0187439 Update ancestor change listeners to prevent memory leak (#680) 2022-11-29 13:51:25 -06:00
EricKuck f78726b916 Version bump 2022-11-07 10:38:21 -05:00
EricKuck 1f918f10c5 Fix ControllerLifecycleOwner crash when onContextAvailable was never called 2022-11-03 15:29:15 -04:00
EricKuck bd584727be Fix edge case ConcurrentModificationException 2022-09-19 16:10:39 -04:00
EricKuck 91db7fe65f Capture view reference in inflate call 2022-07-28 11:29:02 -05:00
EricKuck 2abe2b33f9 Version bump 2022-07-28 09:41:02 -05:00
Mario Noll ac4e09cf67 Fix NPE when removing view reference (#678)
Great catch, thanks!
2022-07-28 08:59:29 -05:00
EricKuck 055532bb21 Fix github actions badge 2022-07-25 17:17:08 -05:00
EricKuck 15037c2217 Version bump 2022-07-25 16:48:26 -05:00
EricKuck 728f1fb4e9 Ensure onContextUnavailable called on child routers for edge case 2022-07-22 11:55:15 -05:00
EricKuck 55c8d64d8a Fix CI badge 2022-07-05 14:46:14 -05:00
EricKuck 88e0eb882b Fix crash when a parent is transitioned out before a child can create its view 2022-07-05 10:43:52 -05:00
EricKuck 63a92db540 Pass along View's context on destroy if available 2022-07-05 10:43:06 -05:00
py - Pierre Yves Ricau ba98e3b165 Add leak detection for destroyed controller views (#676) 2022-06-23 12:00:39 -05:00
Eric Kuck 966bc1645d Convert dependencies to version catalogs (#675)
Also bumps gradle, agp, and kotlin versions
2022-06-16 16:40:05 -05:00
EricKuck c8ac58ad6a Version bump 2022-06-14 13:44:57 -05:00
Eric Kuck 5f04d9de89 Fix edge case NPE when the user hits the back button very rapidly during state restoration (#674) 2022-06-14 10:12:44 -05:00
Eric Kuck d32fc813d0 Set awaitingParentAttach to false on detach, even if not currently attached (#673) 2022-06-13 18:09:55 -05:00
Eric Kuck c2bc72c5ce Fix issue where child controllers may not get their onPause event soon enough (#672) 2022-06-13 18:09:42 -05:00
EricKuck 924e4bebfa Version bump 2022-02-18 14:28:27 -06:00
EricKuck 4ea4aa5c56 Fix issue with detach callbacks happening while not yet attached 2022-02-18 14:15:05 -06:00
Eric Kuck 3b275d31c2 Add PopRootControllerMode to address Android 12 back button behavior (#663) 2022-01-27 16:41:20 -06:00
EricKuck 0e21c8c9c1 Version bump 2021-11-30 11:39:30 -06:00
EricKuck 8297e0273d RouterStateAdapter now properly restores routers after process death 2021-11-28 11:27:47 -06:00
EricKuck 46519c2c2c Ensure preContextUnavailable can't use a null context in the parameter
Fixes #377 and #516
2021-11-23 15:50:52 -06:00
EricKuck 211da8b2ea Version bump for 3.1.1 release 2021-07-19 17:42:43 -05:00
EricKuck 26db962168 Revert maven-publish plugin migration 2021-07-19 17:41:17 -05:00
EricKuck f4c1c6ccf5 Provide a bit more safety around pushing controllers outside of normal lifecycle events 2021-07-19 17:20:32 -05:00
Mario c89caa87e0 Apply the kotlin plugin to lint module (#653)
Fixes missing IssueRegistry from lint.jar
2021-07-19 13:08:34 -05:00
Paul Woitaschek 2748566437 Make the StringSparseArrayParceler internal. 2021-07-03 22:09:39 +02:00
Paul Woitaschek 506c99ed41 Convert the StringSparseArrayParceler to kotlin. 2021-07-03 22:08:18 +02:00
Paul Woitaschek 4fe0ec5f51 Rename .java to .kt 2021-07-03 22:08:18 +02:00
Paul Woitaschek afa93f2cc1 Unit-test the StringSparseArrayParceler. 2021-07-03 22:02:08 +02:00
Paul Woitaschek 836f92b615 Update the publish task name. 2021-07-03 21:41:21 +02:00
Paul Woitaschek 94c817bbd9 Remove support for rxLifecycle2. 2021-07-03 21:40:43 +02:00
Paul Woitaschek fc1fee3e17 Kotlin backstack (#652)
Migrate the Backstack to kotlin
2021-07-03 21:32:11 +02:00
Paul Woitaschek 76b7572a01 Migrate to the maven-publish plugin. (#651) 2021-07-03 21:31:24 +02:00
Paul Woitaschek 3fc63b7f5f Remove the deprecated kotlin-android-extensions plugin and use the kotlin-parcelize plugin replacement instead. 2021-07-03 14:37:40 +02:00
Paul Woitaschek 0ef52211a2 Update LeakCanary to 2.7. (#650)
Also simplify the usage by extracting the leak watching logic into a lifecycle listener.
2021-07-03 14:31:04 +02:00
Paul Woitaschek 7574131940 Remove the unused rxJavaVersion declaration. 2021-07-02 22:40:01 +02:00
Paul Woitaschek 1ab9a4c4f6 Remove the unused rxLifecycleVersion declaration. 2021-07-02 22:35:52 +02:00
Paul Woitaschek 3bc23bd5cd Update to agp 7.0.0-beta05 2021-07-02 22:31:53 +02:00
EricKuck 5f138e5d43 Version bump for 3.1.0 release 2021-07-02 11:18:50 -05:00
Paul Woitaschek 03701d05a9 Add basic support for compose (#644)
Includes required lifecycle and saved state owners
2021-07-02 10:23:00 -05:00
Paul Woitaschek a19968e0c9 Update dokka 2021-06-18 08:19:31 +02:00
Paul Woitaschek 5501ab2ac8 Remove the deprecated jcenter repo. 2021-06-17 21:48:52 +02:00
Paul Woitaschek 804fdb615e Update Gradle to 7.1 2021-06-16 12:29:18 +02:00
EricKuck c01b2a74d6 Version bump 2021-02-05 15:33:01 -06:00
EricKuck 8a8622c261 Fixed issue with VP2 routers potentially restoring incorrectly 2021-02-05 13:04:37 -06:00
Eric Kuck 6820aa7d6a Convert demo app to Kotlin w/ ViewBinding (#635) 2020-12-22 13:09:57 -06:00
EricKuck 9ce27e4dee Added proguard rules to keep empty constructors 2020-12-22 11:49:40 -06:00
Eric Kuck 3c8ad0a833 Switch to GitHub Actions for CI 2020-12-21 14:53:11 -06:00
EricKuck a720ac57e8 Move env vars out of travis config 2020-12-21 11:28:31 -06:00
EricKuck 7d6901389b Always attempt to restore child controllers, even if the views might not exist anymore
Likely fixes #631, #632
2020-11-30 22:43:19 -06:00
EricKuck e54e88bf0d Ensure VP2 adapter saves visible controller instance states
Fixes #634
2020-11-30 22:37:00 -06:00
EricKuck 010117603c Ensure all views are removed when VP2 pages are detached 2020-11-06 10:25:49 -06:00
EricKuck cd11ac9d6b Version bump for 3.0.0 release 2020-11-05 14:40:15 -06:00
EricKuck e78347709b Revert to Java 7 - we'll be kotlinizing soon anyway 2020-11-05 14:12:34 -06:00
EricKuck 341debc5b9 Bump back kotlin version 2020-11-04 16:59:35 -06:00
EricKuck 2346e48154 Fix errant onAttach calls for children whose parents were popped on attach
Fixes #481
Fixes #426
Fixes #407
2020-11-04 16:58:04 -06:00
EricKuck 4174e12958 Fix bug where old views could remain in the hierarchy after being popped
Fixes #608
2020-11-04 16:06:55 -06:00
EricKuck c0abed0813 Fix popping a controller during view creation
Fixes #348
2020-11-04 12:58:50 -06:00
Eric Kuck 6fdb1d6ed3 Adds ViewPager2 Adapter (#594) 2020-11-03 16:17:30 -06:00
Eric Kuck 3334b8e21f Don't remove host references on configuration changes (#629)
Should fix #567
2020-11-03 16:13:17 -06:00
Paul Woitaschek 240424dc63 Lint changehandler subclass fix (#627)
* Updated gradle to 6.7

* Updated AGP to 4.1.0 and infer lint from the agp version.

* Suppress the UnstableApiUsage on the lint tests.

* Added a test case where private change handler extends a base class that extends from the ControllerChangeHandler.

* Fixed the test case by checking the all super classes.

* Added a controller stub for the controleller detector tests.

* Added a testcase for when a controller has a base class.

* Added a testcase for when a controller has a base class.

* Accept licenses before installing for travis.

* Attempt to not add the android components.

* Removed the licenses command.

* Added the preview license too.
2020-10-27 08:23:55 +01:00
Eric Kuck f768e9ab00 Pushing to child router while unattached fixed. Closes #606 (#607) 2020-05-13 14:24:41 -05:00
Islom Matnazarov 4c89124683 Update CircularRevealChangeHandler to not ignore removesFromViewOnPush (#600) 2020-05-11 11:17:09 -05:00
Eric Kuck e0bbd48935 Remove platform transition module 2020-05-04 20:14:33 -05:00
Eric Kuck 76074d1e3d Update mvn publish plugin, version bump 2020-05-04 18:07:12 -05:00
Eric Kuck 623ed03df8 Revert transition module package name change 2020-05-04 17:56:53 -05:00
Eric Kuck 28b8810e56 Fixes tests 2020-05-04 17:55:11 -05:00
Eric Kuck 5c397404ce ChangeHandlerFrameLayout now open 2020-05-04 17:05:48 -05:00
Eric Kuck 3b81a962b1 Revert attachRouter as an extension 2020-05-04 17:05:07 -05:00
Eric Kuck 4f3662bbf6 Fixes a potential state restoration NPE
Could occur if backing containers for child controllers are not immediately available when the app is restored after being killed.
2020-04-27 15:59:31 -05:00
Paul Woitaschek c53b8d9d49 Migrated the StateSaveTests to kotlin and set an id on the frame layout. 2020-04-12 08:58:15 +02:00
Paul Woitaschek c8f6e552e4 Require setting an id in getChildRouter. Fixes #515 2020-04-12 08:43:53 +02:00
Paul Woitaschek c1cc2e2bca Updated robolectric. 2020-04-12 08:22:41 +02:00
Paul Woitaschek 9ace20b88b Updated AGP 2020-04-12 08:22:31 +02:00
Paul Woitaschek d8606498b0 For rotating, change the requested orientation. 2020-04-12 08:21:31 +02:00
Paul Woitaschek f35768393d Migrated the AcitvityProxy to kotlin. 2020-04-12 08:11:51 +02:00
Chris Horner bbb4e8c066 Add platform transition module (#591) 2020-04-04 21:40:02 -05:00
Eric Kuck 12e66867f1 Version bumps 2020-03-30 12:27:21 -05:00
Paul Woitaschek 8eee79dcea Updated lint. (#587) 2020-03-30 11:37:34 -05:00
Eric Kuck 5ebd8c9a5d Minor lambda cleanup 2020-03-30 11:22:38 -05:00
Eric Kuck 4c9f2e9f30 RestoreViewOnCreateController functionality merged into Controller 2020-03-30 11:19:04 -05:00
Eric Kuck b0340d4c67 Removes platform TransitionChangeHandler 2020-03-30 11:12:07 -05:00
Eric Kuck f6b396f679 Removes RxLifecycle for RxJava 1 2020-03-30 11:10:54 -05:00
Paul Woitaschek 589cb91fff Introduce Kotlin (and Java 8) (#585)
* Introduce kotlin and converted the ControllerChangeType to kotlin.

* Migrated the ThreadUtils to kotlin.

* Migrated the TransactionIndexer to kotlin.

* Migrated the ChangeHandlerFrameLayout to kotlin.

* Migrated Conductor to kotlin.

* Added RestrictTo annotations.

* Migrated the RouterRequiringFunc to kotlin.

* Migrated the RouterTransaction to kotlin

* Make use of diamonds.

* Make use of lambdas and method references.

* Use an interface with default implementations for the LifecycleListener.

* Simplify the attachRouter function.

* Updated the code style and checkin the idea folder.

* Use a Controller extension function for the router transaction.

* Use let's instead of forced !! casts.

* Added default implementations of ControllerChangeListener

* Migrated the NoOpControllerChangeHandler to kotlin.

* Use a top level extension function for the asTransaction function.

* Add JvmField annotations to the ControllerChangeType fields.

* Use the local variables instead of calling the controller again.
2020-03-30 16:37:13 +02:00
Paul Woitaschek a51f4192cb Updated AGP to 3.6.1 2020-03-28 21:29:19 +01:00
Paul Woitaschek 266d6a0fd6 Updated the androidx annotations. 2020-03-28 21:24:34 +01:00
Paul Woitaschek 7410f7d123 Disabled the jetifier as it's no longer needed. 2020-03-28 21:24:13 +01:00
Paul Woitaschek 56b5ce3b33 Updated gradle to 6.3 2020-03-28 21:23:21 +01:00
Paul Woitaschek a20ee6477a Replaced unmock with robolectric. 2020-03-28 21:22:55 +01:00
Eric Kuck 41f14f6ae5 support package renamed to viewpager 2020-03-28 14:44:15 -05:00
Alexey Glushkov a170942ae1 fix of removing/adding child view controller views when the retain mode of a parent controller is RETAIN_DETACH (#571) 2020-03-28 14:36:11 -05:00
Alexey Glushkov 6df6ce8de7 Fix Conductor pending changes lock, related to #287 discussion (#570) 2020-03-28 14:33:44 -05:00
Chris Horner 7ddc115918 Fix memory leak in SharedElementTransitionChangeHandler. (#528) 2020-03-28 14:26:41 -05:00
Alexey Glushkov 5f8f3ad98e Fix #563 bug: Controller in the middle of a backstack isn't destroyed after calling popController (#569) 2020-03-28 14:19:42 -05:00
Eric Kuck 5205033cc6 Renamed support->viewpager, removed old deprecated code 2020-03-28 14:07:19 -05:00
Steven Schoen bbd26995c5 Add androidx-transition module, update demos (#584) 2020-03-26 21:54:25 -05:00
Eric Kuck 94e4112ece Travis updates 2020-03-24 11:32:37 -05:00
Eric Kuck 45db55c678 Fixes RouterPagerAdapter state restoration when removing pages.
Fixes #582
2020-03-24 11:17:06 -05:00
dtrabo 7a00a6777e Fixed outdated docs (#576) 2019-12-06 16:04:40 -06:00
Eric Kuck 7a50f12740 Build tools updates 2019-08-11 11:14:36 -05:00
Steven Schoen 530bd551e2 Fix TransitionChangeHandlers getting stuck when two are run simultaneously (#547)
* Fix TransitionChangeHandlers getting stuck when two are run simultaneously

* Don't unnecessarily re-execute changes
2019-08-11 11:09:58 -05:00
Steven Schoen e40cdf2fb0 Keep ControllerChangeHandler default constructor in Proguard rules (#550) 2019-08-11 10:46:56 -05:00
Eric Kuck 94c9121bb1 Fixed logic error that could result in undestroyed controllers 2019-04-06 14:58:54 -04:00
Eric Kuck f72b5bed65 Fixes #524 - onContextAvailable not being called on all child controllers 2019-03-26 18:24:30 -05:00
Eric Kuck 7cb681f6f1 Fixed an edge case that could result in View being null in change handlers when setting backstack before view has been fully restored 2019-03-01 16:48:36 +02:00
Isuru Kusumal Rajapakse f80d78858d Fix MainActivity from leaking by releasing the listeners kept by handlers (#502) 2019-02-27 15:29:09 +02:00
Eric Kuck 6f856453c1 Version bump 2018-12-18 14:41:18 -06:00
Eric Kuck a6c50fccca Fix for onAttach potentially being called after destroy 2018-12-18 14:21:48 -06:00
Shaishav Gandhi 9ad140d00f Upgrade AutoDispose to 1.0.0 (#497)
* Upgrade AutoDispose to 1.0.0
2018-11-04 07:36:53 +01:00
Paul Woitaschek bb173b7cdc Migrate to AndroidX. Fixes #490 (#492)
* Gradle 4.10.2
* Android Build tools 3.2.1
* compileSdk 27, targetSdk 27, support libraries 28.0.0
* Migrated to androidX
2018-10-22 20:10:50 +02:00
Andy Byrnes 5f68328131 Fix README typos (#479) 2018-09-18 15:49:47 -05:00
Eric Kuck 61826fb42b Added a list of 3rd party modules to the readme 2018-09-04 11:35:09 -07:00
Shaishav Gandhi 6b5495a13b Update AutoDispose to 1.0.0-RC2 (#469)
* Upgrade AutoDispose to 1.0.0-RC2

Signed-off-by: shaishavgandhi05 <shaishgandhi@gmail.com>

* Remove fully qualified reference

Signed-off-by: shaishavgandhi05 <shaishgandhi@gmail.com>
2018-08-22 09:26:50 -05:00
Eric Kuck 7a24f77b59 No longer re-attaches controllers that shouldn't be attached when popController(controller) is called. Fixes #463. 2018-08-09 14:40:15 -05:00
Paul Woitaschek 562ed171c3 Specify the current api for the IssueRegistry. (#460) 2018-08-02 09:18:56 +02:00
Eric Kuck 241f052a7b Version bump 2018-08-01 16:19:16 -05:00
Eric Kuck f239376b03 Added a more helpful exception when TransactionIndexer object can't be found. 2018-08-01 12:32:00 -05:00
Eric Kuck 9dc5e5def6 setBackstack with an empty list will now remove all visible views when it's supposed to 2018-07-31 15:43:19 -05:00
Eric Kuck 23d2bab764 Fixes potential out-of-order attach calls for children if the framework itself calls them out of order. (Fixes #416) 2018-07-29 22:42:42 -05:00
Eric Kuck 814121d686 Ensures getTransactionIndexer() will never throw a StackOverflowException 2018-07-29 21:37:05 -05:00
Eric Kuck 4a5442e821 Adds more Autodispose options (fixes #452) 2018-07-29 21:33:15 -05:00
Eric Kuck 3b67822b25 Fixed another lifecycle call order issue with Android P 2018-07-19 14:01:31 -05:00
Eric Kuck 24754364c8 Fix rotation issue for SDK 28 (fixes #457) 2018-07-18 13:32:24 -05:00
Eric Kuck 131589670f Now removes savedPageHistory for pages that are reinstated (and therefore no longer saved) 2018-06-20 15:36:34 -05:00
Dhi Aurrahman efca85829b Fix unresolved dep, failed to resolve: common (#443)
Thanks :)
2018-06-12 13:11:26 +02:00
inorichi 3d64903e54 Fix demo not compiling after dependency updates (#437)
LGTM 👍
2018-06-12 10:08:56 +02:00
Eric Kuck ad3b4911be Fixes #367 2018-06-06 14:58:58 -05:00
Eric Kuck a0d92a631f Fixes #432 2018-05-30 13:53:07 -05:00
Eric Kuck f1b38219b4 Fixes #425 2018-05-30 10:58:18 -05:00
Eric Kuck d59e9ccabf Fixes #429 2018-05-30 10:46:54 -05:00
Eric Kuck 4c81db3a09 Fixes #394 2018-05-29 16:01:12 -05:00
Eric Kuck a8cfd4be9f Added a first draft of contribution guidelines 2018-05-29 15:39:08 -05:00
Eric Kuck 894601700d Fixed potential ConcurrentModificationExceptions if developers added or removed routers during lifecycle callbacks 2018-05-29 15:05:36 -05:00
Eric Kuck d72951eb04 Fixed up lint calls and related tests 2018-05-29 14:43:16 -05:00
Eric Kuck ca3ec3ac12 Fixed false positives for new UAST lint checks 2018-05-29 12:13:51 -05:00
Paul Woitaschek 5ce857bb24 Dependency update & Migrate Lint to UAST (#433)
* Use Android Sdk 27

* Updated the unmock plugin and use the default configuration.

* Removed the explicit buildTools and use the one bundled with the plugin.

* Updated the support library, butterknife, leakCanary, rxjava 1 & 2,
rxlifecycle 1 & 2, junit and robolectric.

* Migrated the lint checks to UAST.

* Rename the UClass "declaration" to "field" to be consistent to the
other check and the default name.

* Moved the evaluator of the ControllerIssueDetector to the handler too.
2018-05-29 11:31:32 -05:00
Eric Kuck f6512d3e1c Fixed build 2018-05-29 11:14:28 -05:00
Eric Kuck 52f095d945 Codestyle updates 2018-05-25 14:45:58 -05:00
Stephan Schuster 91da937d4f Improved lifecycle integration of Conductor and Architecture Components (#383)
Previous mapping was:
- () -> ON_CREATE -> CREATED
- preCreateView -> ON_START -> STARTED
- preAttach -> ON_RESUME -> RESUMED
- preDetach -> ON_PAUSE -> STARTED
- preDestroyView -> ON_STOP -> CREATED
- preDestroy -> ON_DESTROY -> DESTROYED

New mapping is:
- () -> INITIALIZED
- postContextAvailable -> ON_CREATE -> CREATED
- postCreateView -> ON_START -> STARTED
- postAttach -> ON_RESUME -> RESUMED
- preDetach -> ON_PAUSE -> STARTED
- preDestroyView -> ON_STOP -> CREATED
- preContextUnavailable -> // do nothing
- preDestroy -> ON_DESTROY -> DESTROYED

Change-Id: I9f65480018dc1204dc89a8065fa7c7f554ad7dd2
2018-05-25 14:41:06 -05:00
Eric Kuck 9e3095957c Autodispose dependency update, fixed build 2018-05-25 14:38:23 -05:00
Eric Kuck fac44b74e9 build.gradle updates 2018-05-25 13:26:48 -05:00
Daniel Stout ed6ba3a5eb Fix ConcurrentModificationException thrown in Router.popController (#406) 2018-05-25 13:15:25 -05:00
Paul Woitaschek df70e983be Removed synthetic accessors (#347)
* Removed synthetic accessors.

* Upon copying child routers, init the list with the new size and use
addAll.

* Initialize some lists with an appropriate initial capacity.

* Don't wrap methods.
2017-10-09 14:55:35 -05:00
Stefan M 4d28dcefac Styles snapshot section (#364)
* Add missing curly braces
* Make snapshot bold and remove double point
* Fix typo
2017-10-09 11:46:22 -05:00
Eric Kuck 8ab528a566 Fixed ordering of onContextAvailable calls when setting the backstack 2017-10-03 16:42:23 -05:00
Eric Kuck 9bbf050cd2 setBackstack now delays destroying old controllers until after the change handler that removes them has completed 2017-08-04 10:59:19 -05:00
Eric Kuck 5a545aca20 Fixes removeAllExceptVisibleAndUnowned when there is more than 1 View that needs to be removed. Fixes #336 2017-08-01 16:13:40 -05:00
inorichi 0987b311d9 Only show options menu of the active item in a ViewPager (#335) 2017-07-28 10:54:12 -05:00
Eric Kuck ff105abf12 Fixes waitOnSharedElementNamed 2017-07-27 13:42:55 -05:00
Gustavo Pagani 422ca7a544 Expose parent constructor with Bundle as parameter (#328)
* Expose constructor with Bundle as parameter
* Add Nullable annotation to Bundle parameter
2017-07-21 11:58:20 -05:00
Eric Kuck 09df937c88 Fixes evaluation of isPush for several cases of setBackstack. Fixes #327 2017-07-17 14:00:11 -05:00
Eric Kuck ec8ac2a371 setBackstack will now make context available to all new controllers as soon as possible 2017-07-17 11:56:41 -05:00
Eric Kuck 66b0458c0e Fixed potential ConcurrentModificationException when listeners are removed during change handler events 2017-07-14 13:10:05 -05:00
Eric Kuck bd0cd361f2 Readme update 2017-07-11 14:54:19 -05:00
Eric Kuck 60c237bf82 Travis yml update 2017-07-10 17:08:03 -05:00
Eric Kuck bae8a16d8c Added SharedElementTransitionChangeHandler, which handles transitions much more robustly 2017-07-10 16:02:51 -05:00
Eric Kuck 55e8aebb87 Version bump 2017-07-05 13:02:07 -05:00
Eric Kuck 272c507f91 Args are now restored to a controller after process death even if there is only a no-arg constructor. Fixes #313 2017-07-05 10:26:56 -05:00
Hannes Struß 8e945cde52 Fixes ControllerScopeProvider.from return type (#319) 2017-06-25 14:23:28 -05:00
Eric Kuck c17287db67 shouldShowRequestPermissionRationale now returns the correct result. Fixes #317 2017-06-24 12:29:35 -05:00
Eric Kuck 625a3fcfd6 Fixes fade change handler animation when popping and removesFromViewOnPush is false 2017-06-21 17:11:37 -05:00
Eric Kuck dd2ecf2f83 onContextUnavailable now correctly called before onDestroy even if the host Activity is still around 2017-06-16 08:37:21 -05:00
Eric Kuck 0efc2b3daf Fixed rx lifecycle handling for subscriptions in the onContextAvailable callback 2017-06-15 10:27:05 -05:00
Eric Kuck 4b4c3a82b8 Added context available/unavailable to lifecycle listeners. Now supported by all rx lifecycle modules as well. 2017-06-12 12:14:18 -05:00
Eric Kuck 7d0599fc5d Fixed tests 2017-06-02 16:15:37 -05:00
Eric Kuck 0adea89d34 Arch components lifecycle module now labeled as an alpha 2017-06-02 15:55:22 -05:00
Eric Kuck 044363517c Added modules for Autodispose and architecture components's Lifecycle
Cleaned up the demo and directory structure a bit now that there are so many external modules
2017-06-02 15:47:56 -05:00
Eric Kuck a2f11d5d51 The final controller popped in a router now has onDestroy properly called in it, even if the pop change handler is a no-op. 2017-05-26 16:09:56 -05:00
Eric Kuck bcd8ddbfb5 - Added ability to query current controller lifecycle state (needed for things like Google's Lifecycle and Uber's AutoDispose)
- Added onContextAvailable and onContextUnavailable callback to controllers (helpful for dependency injection)
2017-05-26 13:42:29 -05:00
Eric Kuck 479e3f0474 Pop changes that happen rapidly are now properly immediately completed instead of aborted. 2017-05-26 07:01:24 -05:00
Eric Kuck c298ca905c Fixes leaked activity introduced in e64fe1c610 2017-05-26 06:14:05 -05:00
Eric Kuck aebb19effa Fixes attach state management when a controller is pushed while the Activity is paused. (Fixes #303) 2017-05-24 03:05:42 -05:00
Eric Kuck e64fe1c610 Fixes issue when immediately creating two routers in the same Activity caused by the async nature of fragment transactions (fixes #299) 2017-05-24 03:01:36 -05:00
Frieder Bluemle 2357297531 Project updates (#264)
* Update Gradle wrapper to 3.5

* Fix whitespace errors

* Remove executable bit from regular files

* Fix DrawableRes annotation

* Update Android Gradle plugin to 2.3.2

* Update build tools to 25.0.3

* Do not ignore Lint errors

* Replace android-apt with annotationProcessor

* Update unmock to 0.6.0

* Update support libs to 25.3.1
2017-05-18 10:35:30 -05:00
Eric Kuck 926f7da6ce Now ensures that parent controller is restored after process death (fixes #300) 2017-05-18 10:29:12 -05:00
Eric Kuck d260dfcf12 Change handlers that occur after a deferred change handler are now deferred until the preceding handler completes to ensure correct ordering. Handlers will only be deferred when the containing view isn’t yet fully attached and they could cause a NPE in ViewGroup.java. 2017-05-18 07:36:02 -05:00
Eric Kuck a84b2fb4c4 Reverts 81a499d and attempts to fix #274, #285, and #287 in a more reliable way. 2017-05-10 12:19:00 +03:00
Eric Kuck 6aca3f578a Fixes a case that caused the incorrect change handler to execute when setting the backstack (fixes #286) 2017-05-10 11:37:10 +03:00
Eric Kuck 45ab54b5d7 Fixes issue where calling setBackstack repeatedly could result in a situation where multiple ControllerChangeHandlers are executing at the same time and interfering with each others states (#263) 2017-05-04 11:26:18 -05:00
Eric Kuck ca84419e0c Version bump 2017-05-03 16:28:23 -05:00
Eric Kuck a04dec7ec1 Fixes views never attaching if the host activity is stopped before inflation. Fixes #273 2017-05-03 16:03:58 -05:00
Eric Kuck 81a499d121 Now handles sequences of immediate pushing and popping of controllers much better. Also guards against NPEs due to popping a controller during onAttach. Fixes #274 2017-05-03 14:42:17 -05:00
Eric Kuck ff8ab621bc From controller’s initial position now correctly based on translationX in HorizontalChangeHandler. Fixes #279 2017-05-02 12:31:26 -05:00
Eric Kuck cdb5e5a978 Ensures AnimatorChangeHandlers can’t animate more than once per change 2017-05-02 11:27:01 -05:00
Eric Kuck effa410eae Fixes #269 in the demo app 2017-04-24 07:43:35 -05:00
Paul Woitaschek df27bfaa3d Made removeLifecycleListener final too (#268) 2017-04-13 13:45:33 -05:00
Eric Kuck a865c210b6 addLifecycleListener method now final. Fixes #267 2017-04-13 13:39:03 -05:00
Leonardo Ferrari 7820748cce Update README.md (#261)
fix latest version value
2017-04-06 09:30:02 -05:00
Eric Kuck 2147b2aa5e Version bump 2017-04-05 17:09:26 -05:00
fergusonm 19418617dd Pass along the correct view state (#258) 2017-04-04 07:59:12 -05:00
Eric Kuck e1924bf8a7 Args and savedInstanceState bundles now have classLoaders properly set. Fixes #246. 2017-03-31 09:38:20 -05:00
Eric Kuck 6d3faaebe3 Now ensures view hierarchy-affecting calls are made on the main thread. Fixes #255 2017-03-31 09:24:18 -05:00
Eric Kuck 17639129b9 Fixed issue where child controllers added while the parent is in the process of transitioning off the screen would not be properly restored - Fixes #256. 2017-03-31 09:01:13 -05:00
Valery 1c809095ec Fix image display (#251)
Github doesn't understand spaces in file name
2017-03-21 10:16:00 -05:00
Valery 3bc563de38 Fixed readme table (#250) 2017-03-21 09:58:21 -05:00
Eric Kuck 7beb94f8cc Fixed readme table 2017-03-20 16:56:19 -05:00
Eric Kuck 2b32a30c1a Version bump 2017-03-03 11:53:29 -06:00
Eric Kuck 893ffc0461 Version bump 2017-03-03 11:50:59 -06:00
Eric Kuck 0df11e3224 Build tools updates 2017-03-03 09:22:37 -06:00
Eric Kuck 75ad389424 Fixed a few warnings 2017-03-01 16:51:45 -06:00
Eric Kuck 00577823dc Moved popToTransaction calls over to use setBackstack internally. Fixes #239 2017-03-01 16:33:19 -06:00
Eric Kuck 671a117b96 Added ability to specify the maximum number of pages for which states should be saved. Fixes #236 2017-02-23 16:52:50 -06:00
Eric Kuck 3d1c2d392c Added startIntentSenderForResult method to controller. Fixes #235 2017-02-23 12:01:47 -06:00
Eric Kuck b7611e1a1b Added a RecyclerView -> RecyclerView shared element transition demo 2017-02-20 16:57:56 -06:00
Eric Kuck d13af316d3 Dialog background no longer fades out over the top of the outgoing dialog 2017-02-17 12:52:51 -06:00
Eric Kuck 7d5cc26ea4 Replaced png icon with vector drawable 2017-02-17 10:47:58 -06:00
Eric Kuck c4d881ac47 Added some better shared element demos 2017-02-17 10:40:38 -06:00
Eduardo Alejandro Pool Aké 0a53b9f07a Dependency updates 2017-02-16 11:20:25 -06:00
Eric Kuck c2ad655af2 Added fade to dialog’s immersive background
Moved FabToDialogTransitionChangeHandler over to the library’s TransitionChangeHandler
2017-02-16 11:13:04 -06:00
Simon Vergauwen a888073e1b DialogToFabTransition (#229) 2017-02-16 10:24:49 -06:00
Eric Kuck df68655b13 Added missing comments to new methods 2017-02-14 13:52:20 -06:00
Eric Kuck 86227ae3b3 TransitionChangeHandler is now much more flexible (doesn’t force you to add/remove views) 2017-02-14 13:50:13 -06:00
Paul Woitaschek 97878b1ad6 List simplification (#225)
* Use a singleton list for transactions
* Use built-in java list functions
2017-02-08 10:37:07 -06:00
Eric Kuck 314ee2b456 Routers now properly remove views of all owned controllers on destroy (fixes #221) 2017-02-07 10:22:33 -06:00
Paul Woitaschek f4ef47c2d2 Added missing nullity annotations for the pager adapters (#219) 2017-02-02 08:21:38 -06:00
Eric Kuck 769d552e88 Fixed typo in lifecycle diagram 2017-02-01 19:13:50 -06:00
Eric Kuck afa4b69d7a Version bump 2017-02-01 19:04:01 -06:00
Eric Kuck a9bdf0dd06 Revamped how child backtacks are handled to be more reliable with unforseen uses of state restoration. Fixes #194 and #217 2017-02-01 18:44:33 -06:00
Eric Kuck 6ffa94ed3a Added documentation for @Nullable’s. Fixes #218 2017-02-01 11:01:29 -06:00
blazeroni 690001ed2a Fixes issue when retrieving an existing controller from a ControllerPagerAdapter (#216) 2017-02-01 10:12:36 -06:00
Eric Kuck 90e015b6b3 Now correctly calls onDetach when the host activity is stopped, even if the view is not detached from the window. Fixes #213 2017-01-31 18:06:23 -06:00
Eric Kuck 44bcd0f977 Fixes #205 2017-01-20 17:35:15 -06:00
Eric Kuck 60d0fabcf4 Fixes #208 2017-01-20 17:15:33 -06:00
Eric Kuck 10a1c8af3e Version bump 2017-01-19 14:21:48 -06:00
Eric Kuck 6834df73e6 Fixes #203 2017-01-19 14:13:26 -06:00
Eric Kuck 04d40a5b90 Minor ViewAttachHandler optimizations 2017-01-19 13:21:02 -06:00
Allan Hasegawa be40900e1e #Fixes 206 (#207) 2017-01-19 13:20:20 -06:00
Eric Kuck f16f7b6d2c Fixes #205 2017-01-19 12:02:31 -06:00
Eric Kuck f74f8391b6 Fixes #204 (also mentioned in #199) 2017-01-19 11:50:07 -06:00
Eric Kuck 2ce8c0a45d Version bump 2017-01-18 13:00:24 -06:00
Eric Kuck 77ad6b4512 Now sets ClassLoader for view state Bundle - potential fix for #198 2017-01-18 12:18:06 -06:00
Eric Kuck efbdf913bd Fixes #201 2017-01-18 11:54:50 -06:00
Eric Kuck dfb01389f7 Fixes #199 2017-01-17 16:45:56 -06:00
Eric Kuck e390261b53 Fixes #197 2017-01-15 17:33:40 -06:00
Eric Kuck 27f5275172 Now throws an exception when a destroyed controller is pushed in order to make it more obvious that controllers can not be reused. 2016-12-26 15:25:16 -06:00
Eric Kuck d15f2b68ab Added missing files from e7c195d910 2016-12-16 11:35:45 -06:00
Eric Kuck 44ed19858b Fixes #185 2016-12-15 15:22:26 -06:00
Eric Kuck e7c195d910 Now internally ensures that ControllerChangeHandlers aren't reused, unless they're specifically designed to be safe for reuse
Made ControllerChangeHandler's copy() method public
Fixes #179
2016-12-15 15:11:25 -06:00
Eric Kuck 23a4dbbb60 Travis yml fix 2016-12-14 20:20:04 -06:00
Eric Kuck 0ac81767dd Travis.yml licenses fix 2016-12-14 20:05:38 -06:00
Eric Kuck 54cdc51557 Added license to travis.yml 2016-12-14 19:48:55 -06:00
Eric Kuck 09ce640d9c Fixes #183 2016-12-14 19:42:10 -06:00
Eric Kuck 01df673a34 Switched lint checks to the new PSI based api (closes #184) 2016-12-14 19:41:41 -06:00
Eric Kuck 553bae0be5 Updated readme to include mention of RxLifecycle2 2016-12-14 17:53:45 -06:00
Eric Kuck 48dc4abcbe Version bump 2016-12-13 17:09:19 -06:00
Eric Kuck 4a814afb5f Fixes #166 2016-12-13 16:56:22 -06:00
Eric Kuck 9cd225e704 Controllers now throw an exception when the user forgets to pass false for LayoutInflater.inflate's attachToRoot parameter. 2016-12-12 14:31:22 -06:00
Eric Kuck c8640af1ac Remove saveState option for RouterPagerAdapters, as users can configure the page before display anyway. 2016-12-12 13:25:57 -06:00
Eric Kuck 43c825f7c2 - Child backstack is now properly restored when Android kills the process
- Added a RouterPagerAdapter, which allows the use of Routers as pages
2016-12-12 13:09:29 -06:00
Eric Kuck 7334ed5300 ControllerPagerAdapter updates to enable using a per-page router if needed. 2016-12-12 12:24:26 -06:00
Eric Kuck 7ea4872ff8 Updated ordering of calls in backstack to be in line with other backstack-affecting calls 2016-12-08 13:25:11 -06:00
Eric Kuck 9655170bd2 Fixes tests 2016-12-07 16:34:38 -06:00
Eric Kuck acce9b1702 Simplified setRoot implementation 2016-12-07 16:17:32 -06:00
Eric Kuck 95baa8baa3 Fixes #172 2016-12-01 18:00:06 -06:00
Eric Kuck 2388fa2d06 Added a demo for the new RxLifecycle2Controller 2016-12-01 17:56:43 -06:00
Vishnu Rajeevan 285eb59da0 add rxlifecycle2 support, fixes #148 (#171) 2016-12-01 17:31:52 -06:00
Eric Kuck ae42ee1674 Attempted fix for #165 2016-12-01 17:28:15 -06:00
Eric Kuck 638b2ad311 Version bump 2016-11-11 11:10:35 -06:00
Eric Kuck 96e068d348 Fixes a controller's internal backstack when setBackstack is used on a child router 2016-11-11 10:44:37 -06:00
Eric Kuck db359d906b Un-deprecated getChildRouter with a tag. Fixes #160. 2016-11-10 13:34:13 -06:00
Eric Kuck 11185458b3 Fixed nullable annotations for menu callbacks 2016-11-09 16:03:20 -06:00
Eric Kuck 977db6b5bf Merge branch 'develop' of github.com:bluelinelabs/Conductor into develop 2016-11-09 15:32:01 -06:00
Eric Kuck 803c20e093 Added UiThread annotations - closes #145 2016-11-09 15:25:28 -06:00
TMTron 9948cb4652 Navigation Demos: "GO UP" is hidden in "Controller #0" - closes #158 (#159)
* Navigation Demos: "GO UP" is hidden in "Controller #0" - this closes #158

* Multiple Child Routers: "GO UP" is hidden for all - #158
2016-11-09 14:54:27 -06:00
Eric Kuck 07a579b939 Fixed incorrect child router backstack handling if controllers were VERY rapidly added 2016-11-09 11:07:41 -06:00
Eric Kuck 104d96e6e2 Filled out @Nullable and @NonNull annotations throughout the library 2016-11-09 10:09:00 -06:00
Eric Kuck e0f40a9fce Fixes tests 2016-11-02 12:29:58 -05:00
Eric Kuck bc8e0c5b2c Fixes #113 2016-11-02 12:04:53 -05:00
Eric Kuck 2b6e41f895 Fixes #140 2016-10-17 17:32:10 -05:00
Eric Kuck b633523d0e Fixes #138 2016-10-12 12:22:22 -05:00
Eric Kuck c5eb7fc89e Fixes #136 2016-10-12 09:44:26 -05:00
Eric Kuck cf6837a41a Fixes #137 2016-10-12 09:24:29 -05:00
Eric Kuck e297242264 Now handles requesting permissions while now yet fully attached to the host activity 2016-10-10 15:14:06 -05:00
Eric Kuck 550e7e0aa1 Added missing constructor to RestoreViewOnCreateController 2016-10-05 15:16:04 -05:00
Eric Kuck 90f21d99a5 Version bump fix 2016-10-03 14:51:51 -05:00
Eric Kuck 641e0dc43c Version bump 2016-10-03 14:50:38 -05:00
Eric Kuck 91c993b005 Fixes #95 2016-10-03 14:36:41 -05:00
Eric Kuck 39ab4723ff Removes viewState getter and instead adds a controller subclass that can allows access to the saved view state and the time of view creation. 2016-10-03 14:11:00 -05:00
Eric Kuck 3769e706af Fixes #124 2016-10-03 14:05:03 -05:00
Yasuhiro Shimizu 26efe8f062 update to RxLifecycle 0.8.0, RxJava 1.2.0, RxAndroid 1.2.1 (#126) 2016-09-30 21:20:32 -05:00
Eric Kuck 8a890644ee Fixes issues with ControllerChangeHandlers being reused when they should not be. 2016-09-30 18:07:47 -05:00
Eric Kuck b2ffa7f7f6 Fixes #127 2016-09-30 17:38:14 -05:00
Eric Kuck 960b931744 Added a view state getter, which is needed if view state must be obtained at the time of view creation (ex: for Google Maps) 2016-09-30 17:33:54 -05:00
Eric Kuck 47158da05e Fixes tests 2016-09-28 13:16:56 -05:00
Eric Kuck b9c22d267d Fixed issue with no view being attached if orientation changed at the exact same instant as a SimpleSwapChangeHandler being run 2016-09-28 12:34:11 -05:00
Eric Kuck 46e6fac6db Fixed issue with AnimatorChangeHandler crashing if onAnimationEnd is called after onAnimationCancel 2016-09-27 15:57:37 -05:00
Eric Kuck dc68990bff Version bump 2016-09-26 10:32:23 -05:00
Eric Kuck e4f7e9e175 Fixes memory leak in CircularRevealAnimatorChangeHandler (and any other AnimatorChangeHandler that kept a reference to its view) 2016-09-26 09:50:29 -05:00
Eric Kuck 4ab99b68da Fixes #123 2016-09-26 09:34:41 -05:00
Eric Kuck b8bd64e078 Fixed leak in demo app 2016-09-26 09:24:32 -05:00
Eric Kuck 812d1f8911 Fixes issue where controllers that are being animated out, but haven't yet been detached, at the time of an orientation change could be incorrectly attached to the new Activity. 2016-09-24 11:24:13 -05:00
Eric Kuck ac8288fece Fixed issue where views would not detach when rapidly setting the root controller 2016-09-24 00:29:36 -05:00
Eric Kuck d2dd786b72 Fixed issue where setting the root controller twice in a row will cause the first controller's view to remain attached 2016-09-23 17:42:57 -05:00
Eric Kuck 7cf30b820c Travis yml fix 2016-09-06 16:44:45 -05:00
Eric Kuck 1120896438 Fixed some Leak Canary false-positives 2016-09-06 16:12:56 -05:00
Eric Kuck 093238cc52 Should fix #106 (more testing needed) 2016-09-06 16:10:47 -05:00
Eric Kuck c153e29273 Fixes #107 2016-09-06 15:49:30 -05:00
Eric Kuck 2757c7a4b6 Fixes #108 2016-09-06 15:46:25 -05:00
Eric Kuck 46091a7c99 Build tools update 2016-09-06 15:30:02 -05:00
Hannes Struß b0a5da2b82 Remove listeners after animator ends/is canceled (#104) 2016-09-05 10:43:22 -05:00
Adrian Pascu 0026566ba0 Nitpicks (#96)
* [Demo] Remove Butterknife unbinder from MainActivity

* Make deploy_snapshot.sh executable
2016-07-29 15:11:04 -05:00
dimsuz 9f640380bf Document a return value of Router.handleBack() (#93) 2016-07-20 17:49:59 -05:00
Eric Kuck a3faaede61 Fixes #97 and cleans up some tests 2016-07-20 15:41:19 -05:00
Eric Kuck 94d8add220 Fixes #98 2016-07-20 14:56:12 -05:00
Eric Kuck 6d4b5a5ef6 Version bump 2016-07-12 13:20:30 -05:00
Eric Kuck ae27c5e453 Another test for #86 2016-07-11 16:30:31 -05:00
Eric Kuck e4d23a7c74 Added some tests around #86 2016-07-11 16:24:07 -05:00
Eric Kuck 778cdcfd58 Controllers now properly persist their retain view modes 2016-07-11 13:37:38 -05:00
Eric Kuck 5e730947aa Corrected logic for first fix on #86 2016-07-11 13:37:22 -05:00
Eric Kuck 71b10c7365 Fixed back handling on child controllers demo 2016-07-08 15:08:05 -05:00
Eric Kuck 8c323b9613 Fixes issue with demo app trying to reuse change handlers 2016-07-08 14:59:19 -05:00
Eric Kuck af45aae110 Fixes 2nd issue associated with #86 2016-07-08 13:33:47 -05:00
Hannes Dorfmann d4c7e5791e Added oss sonatype snapshot url (#90) 2016-07-08 08:23:30 -05:00
Eric Kuck dc4c3a9709 Fixes at least one cause of #86 2016-07-07 20:59:37 -05:00
Eric Kuck ef84fbd547 AnimatorChangeHandlers are now properly cancelable 2016-07-07 18:32:04 -05:00
Eric Kuck 431569763e First pass at a fix for #85 2016-07-07 17:43:26 -05:00
Mykhailo Shchurov 7b5bab3681 Fixed typo in readme (#83) 2016-06-30 07:25:21 -05:00
Eric Kuck 86b32afdcb Fixed the build 2016-06-27 18:06:30 -05:00
Eric Kuck 557e4c2122 V2 (#80)
* Added test for adding and removing children

* [WIP] First pass at nested routers. Still needs a bunch of refactoring, testing, and documentation.

* Pulled save and restore calls out of the lifecycle, as Activity's callbacks make it impossible to fit into a nice little box (#48)

* [WIP] Removed old way of setting root controller in favor of reusing transactions

* [WIP] Added a bottom navigation demo for testing nested routers. Still have a bunch of issues with it.

* [WIP] Child routers now receive events properly (and don't crash most of the time!)

* Fixed a few leaks + handling of back presses in child routers

* Fixed tests

* Simplified making routers not handle back events

* Fixed onAttach callback for Android < 6

* Several child router bug fixes

* [WIP] Backstack getter and setter now exists (#64)

* Fixed some issues with viewpagers

* Added support for saving and restoring controllers in a pager adapter

* Fixed issue with re-attached child controllers prematurely destroying

* Better demo for multiple child routers + upgraded to butterknife 8

* Added basic master/detail flow demo

* Fixed issue where simultaneously pushing 2 controllers with animated transitions would cause the first controller's child routers to never re-load.

* Doc updates

* Removed ControllerTransaction base class, as everything is now added to routers.
Remove RouterTransaction.Builder and replaced it with a more fluent api

* Doc update

* Fixed tesets

* Doc update (had trouble with last version on maven central)

* Just some minor refactoring

* See ya, hungarian notation (#77)

* Should fix #75

* Adds public getters for RouterTransaction fields (#76)

* Doc updates

* Fixed #78 (deeply nested controllers not correctly restored)

* Fixes #79 (child routers no longer monitored after being restored)

* Final doc updates for v2
2016-06-27 17:57:50 -05:00
Matthew Haughton 8b29c1cd56 add link to javadoc.io from README (#72) 2016-06-24 16:30:43 -05:00
Mykhailo Shchurov 30ef5a187b Added cause to the instantiation exception (#62) 2016-06-11 16:01:10 -05:00
Mykhailo Shchurov ebe69bf98b Target Controller large bitmap issue fix 2016-06-06 13:14:56 -05:00
Mateusz Perlak a907263ab8 #57 - hiding keyboard onDetach (#58)
* hiding keyboard onDetach

* removed not needed isActive check
2016-06-06 13:14:33 -05:00
Eric Kuck 7528437f65 HorizontalChangeHandler now correctly resets the X translation. 2016-05-24 14:45:33 -07:00
adi1133 e2e8260876 Add proguard rules (#51)
* Add proguard rules

* Add default constructor to proguard rules
2016-05-16 15:35:16 -05:00
Eric Kuck 6dfc5839cc Fixed maven central artifacts 2016-05-12 10:36:54 -05:00
Eric Kuck 8cba63328f Travis should now ignore branches that don't need to be built yet [ci skip] 2016-05-11 17:12:55 -05:00
Eric Kuck 531cc3ff58 Version bump 2016-05-11 17:07:41 -05:00
Eric Kuck c7de32584b Fixed memory leak in view pager demo controller 2016-05-09 18:01:00 -05:00
Eric Kuck 625d1f15b6 Updated sonatype auth (#43) 2016-05-02 10:13:01 -05:00
Hannes Dorfmann 251fc42f67 Changed deploy_snaphsot permission (#41) 2016-04-29 09:58:25 -05:00
Hannes Dorfmann 0bf8e47c48 Fixing snapshot dependencies (#38)
* Resolving inner dependencies

* Resolving inner dependencies

* oops
2016-04-28 17:01:43 -05:00
Eric Kuck 7784f74102 Fixed artifact typo 2016-04-28 10:46:22 -05:00
Eric Kuck bfacab984b Added some tests for lifecycle call ordering 2016-04-27 15:45:59 -05:00
Eric Kuck f8a05731d9 Now removes the view's OnAttachStateListener before removing the reference
Fixes ordering of external lifecycle callbacks
2016-04-27 15:11:54 -05:00
Eric Kuck 116b5066c9 Fixed issue where view was not re-created if its old view was still attached. 2016-04-26 14:33:37 -05:00
Eric Kuck 011adca579 Fixed a typo 2016-04-25 13:33:36 -05:00
adi1133 95de69a006 Make getControllerWithInstanceId search recursively (#30)
* Make getControllerWithInstanceId search recursively

* Deprecate getChildControllerWithInstanceId()

* Rename getControllerWithInstanceId to findController making it internal
2016-04-25 13:11:12 -05:00
Eric Kuck 6cea976d10 Added info about snapshot builds to readme 2016-04-19 16:15:39 -05:00
Eric Kuck c573a8961c fixed conflict 2016-04-19 16:07:12 -05:00
Eric Kuck 6c444fecfb Added nexus details to travis.yml 2016-04-19 15:59:20 -05:00
Eric Kuck 29d1fd1c7d Switched to sonatype for deployment + snapshots 2016-04-19 15:52:40 -05:00
Eric Kuck f6493507f4 Options menu now works for child controllers
Added more tests
2016-04-18 14:07:52 -05:00
Eric Kuck b012df262d Dependency version update 2016-04-16 14:35:39 -05:00
Eric Kuck e028ed42da Version bump 2016-04-16 14:22:38 -05:00
Eric Kuck 43dc561ac2 Fixed up some save/restore view state stuff (incl. tests) 2016-04-16 13:51:37 -05:00
Eric Kuck 217b55090a Added test for backgrounding the host activity 2016-04-16 13:18:24 -05:00
Eric Kuck 5c8b78e41d Fixed orientation change test 2016-04-16 12:25:45 -05:00
Eric Kuck 899dd70d50 Merge pull request #25 from sockeqwe/viewStateListener
added methods to lifecyclelistener for saving/restoring viewstate
2016-04-16 12:04:51 -05:00
Eric Kuck d945571d31 Improved controller lifecycle test coverage (and clarity) 2016-04-16 12:04:20 -05:00
Hannes Dorfmann b7a4386d22 Renamed parameter of onRestoreViewState() to savedViewState 2016-04-16 14:01:41 +02:00
Hannes Dorfmann b117307340 added methods to lifecyclelistener for saving/restoring viewstate 2016-04-15 19:52:43 +02:00
Eric Kuck b8ccf3623f Fixed onRestoreState call ordering for controllers with parent/child relationships 2016-04-14 14:20:56 -05:00
Eric Kuck 495145b72b Router, Activity, target controller, etc is all now available in onRestoreInstanceState 2016-04-13 15:39:09 -05:00
Eric Kuck 99e25d65f2 Merge pull request #20 from adi1133/develop
Fix crash caused by recreating static nested classes using reflection
2016-04-12 16:41:05 -05:00
Adi Pascu 2619d13c8d Fix crash caused by recreating static nested classes using reflection 2016-04-12 23:49:10 +03:00
Eric Kuck 62a5a81107 Fixed typo 2016-04-12 14:33:03 -05:00
Eric Kuck d234dd4c75 Added external onActivityResult method to Controllers (for use with things like the Facebook SDK)
Removed CircularRevealChangeHandler from the core project
2016-04-12 14:18:01 -05:00
Eric Kuck a48b49cdbe All demos should now run on API < 21 2016-04-06 12:07:51 -05:00
Eric Kuck f0a488c711 Added options menu support for controllers
Updated demo app to have a toolbar
2016-04-05 13:34:14 -05:00
Eric Kuck 511c229364 Fixed issue with re-attaching when the host Activity never left with window 2016-04-04 23:23:01 -05:00
Eric Kuck b5d0e46740 Now enforces only setting a controller's target one time. 2016-04-04 17:45:29 -05:00
Eric Kuck 8f1be7fe21 Updated readme to reflect latest lifecycle updates 2016-04-04 17:29:22 -05:00
225 changed files with 15187 additions and 5293 deletions
+25
View File
@@ -0,0 +1,25 @@
root = true
[*.{java,kt,kts,xml,gradle}]
charset=utf-8
end_of_line=lf
max_line_length=120
insert_final_newline=true
trim_trailing_whitespace=true
indent_style=space
[*.{java,kt,kts,gradle}]
spaces_around_operators=true
indent_brace_style=K&R
[*.{java,gradle}]
indent_size=4
[*.{kt,kts}]
indent_size=2
continuation_indent_size=2
ij_kotlin_allow_trailing_comma=true
ij_kotlin_allow_trailing_comma_on_call_site=true
[*.xml]
indent_size=2
+38
View File
@@ -0,0 +1,38 @@
name: Test & Publish
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: set up JDK 17
uses: actions/setup-java@v2
with:
distribution: 'adopt'
java-version: '17'
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Test with Gradle
run: ./gradlew test
publish:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/develop'
needs: test
steps:
- uses: actions/checkout@v2
- name: set up JDK 17
uses: actions/setup-java@v2
with:
distribution: 'adopt'
java-version: '17'
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Release with Gradle
run: ./gradlew clean publishAllPublicationsToMavenCentral
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
Executable → Regular
+3 -5
View File
@@ -5,17 +5,17 @@
.checkstyle
# IntelliJ IDEA
.idea
*.iml
*.ipr
*.iws
/.idea/*
!/.idea/scopes/
classes
gen-external-apklibs
# Gradle
.gradle
build
gradle.properties
# Maven
target
@@ -36,6 +36,4 @@ pom.xml.*
local.properties
*.prefs
# The keystore file
app/spothero-release.keystore
.DS_Store
+9
View File
@@ -0,0 +1,9 @@
/libraries
/runConfigurations.xml
/misc.xml
/vcs.xml
/workspace.xml
/caches
/gradle.xml
/modules.xml
/compiler.xml
+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="Encoding">
<file url="PROJECT" charset="UTF-8" />
</component>
</project>
-11
View File
@@ -1,11 +0,0 @@
language: android
android:
components:
- tools
- build-tools-23.0.2
- android-23
- extra-android-m2repository
script:
- ./gradlew test
+70
View File
@@ -0,0 +1,70 @@
# Community Contribution Guidelines
As the creators and maintainers of this project, we want to ensure that the project lives and continues to grow. Not blocked by any singular person's computer time. One of the simplest ways of doing this is by encouraging a larger set of shallow contributors. Through this, we hope to mitigate the problems of a project that needs updates, but there is no-one who has the power to do so.
#### Development Process
We maintain two permanent, protected branches: `master` and `development`.
`master` is for the current release. It has already been distributed to jcenter and can't be modified at this point (except for docs that may be incorrect for the current release!).
`development` is where we stage work for the *next* release. Pull requests should be directed to this branch.
When working on a new feature or fix that may span multiple commits, please do so in a feature branch (ex: `feature/my_cool_thing`). Please clean up these feature branches once merged into `development`.
When a new version is ready to be released, please create a pull request to merge `development` into `master`, named something like "Release 10.0". Then we can have some final discussion before we merge it into `master` and push the release out to the public.
Since `development` is a *shared* branch, it is important not to ever rebase this branch onto `master`. If a bug fix is applied to `master` it can be merged into `development` using good old simple `git checkout development && git merge master`. Yes this will clutter the history a little bit, but it also provides important context to know how/when a patch was applied. Merge commits can be considered necessary historical data, not warts on an idealized history graph.
#### Testing
To run tests locally, just run `./gradlew test`. Tests should always be run before pushing anything to the repo.
#### Ownership
If you get a merged pull-request of substance (ie not just a typo fix), then you are eligible for push access to this repo. Simply request access via a new GitHub issue.
Offhand, it is easy to imagine that this would make code quality suffer, but in reality it offers fresh perspectives to the codebase and encourages ownership from people who are depending on the project. If you are building a project that relies on this codebase, then you probably have the skills to improve it and offer valuable feedback. At the end of the day, there isn't too much risk in this, as the `master` branch is still locked, and jcenter access is still being restricted.
Everyone comes in with their own perspective on what a project could/should look like, and encouraging discussion can help expose good ideas sooner.
#### Why do we give out push access?
It can be overwhelming to be offered the chance to wipe the source code for a project. Do not worry, we do not let you push to master. All code is peer-reviewed, and we have the convention that someone other than the submitter should merge non-trivial pull requests.
As a contributor, you can merge other people's pull requests, or other contributors can merge yours. You will not be assigned a pull request, but you are welcome to jump in and take a code review on topics that interest you.
This project is not continuously deployed, there is space for debate after review too. Offering everyone the chance to revert, or make an amending pull request. If it feels right, merge.
#### How can we help you get comfortable contributing?
It is normal for a first pull request to be a potential fix for a problem, and moving on from there to helping the project's direction can be difficult. We will try to help contributors cross that barrier by offering good first step issues. These issues can be fixed without feeling like you are stepping on toes. Ideally, these are non-critical issues that are well defined. They will be purposely avoided by mature contributors to the project, to make space for others.
We aim to keep all project discussion inside GitHub issues. This is to make sure valuable discussion is accessible via search. If you have questions about how to use the library, or how the project is running - GitHub issues are the goto tool for this project.
#### Our expectations on you as a contributor
To quote [@alloy](https://github.com/alloy) from [this issue](https://github.com/Moya/Moya/issues/135):
> Do not ever feel bad for not contributing to open source.
We want contributors to provide ideas, keep the ship shipping and to take some of the load from others. It is non-obligatory; were here to get things done in an enjoyable way. :trophy:
The fact that you will have push access will allow you to:
- Avoid having to fork the project if you want to submit other pull requests, as you will be able to create branches directly on the project.
- Help triage issues and merge pull requests.
- Pick up the project if other maintainers move their focus elsewhere.
It is up to you to use those superpowers or not though 😉
If someone submits a pull request that is not perfect, and you are reviewing, it is better to think about the PR's motivation rather than the specific implementation. Having braces on the wrong line should not be a blocker. Though we do want to keep test coverage high, we will work with you to figure that out together.
#### What about if you have problems that cannot be discussed in a public issue?
[Eric Kuck](https://github.com/erickuck) has a contactable email on his GitHub profile, and is happy to talk about any problems.
#### This is a different way to handle open source! Where did it come from?
The original source of this document can be found at [https://github.com/moya/contributors](https://github.com/moya/contributors).
+75 -54
View File
@@ -1,11 +1,11 @@
[![Travis Build](https://travis-ci.org/bluelinelabs/Conductor.svg)](https://travis-ci.org/bluelinelabs/Conductor) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Conductor-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/3361)
[![GitHub Actions Workflow](https://github.com/bluelinelabs/conductor/actions/workflows/main.yml/badge.svg)](https://github.com/bluelinelabs/conductor/actions/workflows/main.yml) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Conductor-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/3361) [![Javadocs](http://javadoc.io/badge/com.bluelinelabs/conductor.svg)](http://javadoc.io/doc/com.bluelinelabs/conductor)
# Conductor
A small, yet full-featured framework that allows building View-based Android applications. Conductor provides a light-weight wrapper around standard Android Views that does just about everything you'd want:
| Conductor
------|------------------------------
| | Conductor |
|-----------|-------------|
:tada: | Easy integration
:point_up: | Single Activity apps without using Fragments
:recycle: | Simple but powerful lifecycle management
@@ -13,82 +13,95 @@ A small, yet full-featured framework that allows building View-based Android app
:twisted_rightwards_arrows: | Beautiful transitions between views
:floppy_disk: | State persistence
:phone: | Callbacks for onActivityResult, onRequestPermissionsResult, etc
:european_post_office: | MVP / MVVM / VIPER / MVC ready
:european_post_office: | MVP / MVVM / MVI / VIPER / MVC ready
Conductor is architecture-agnostic and does not try to force any design decisions on the developer. We here at BlueLine Labs tend to use either MVP or MVVM, but it would work equally well with standard MVC or whatever else you want to throw at it.
## Installation
Conductor 4.0 is coming soon. It is already being used in production with many, many millions of users. It is, however, not guaranteed to be API stable. As such, it is being released as a preview rather than a standard release. Preview in this context is _not_ a commentary on stability. It is considered to be up to the same quality standards as the current 3.x stable release.
Changes in Conductor 4 are available in the [GitHub releases](https://github.com/bluelinelabs/Conductor/releases/). In preparation for the release of the next version, there are currently 3 installation options:
### Latest Stable 3.x
```gradle
compile 'com.bluelinelabs:conductor:1.1.0'
def conductorVersion = '3.2.0'
// If you want the components that go along with
// Android's support libraries (currently just a PagerAdapter):
compile 'com.bluelinelabs:conductor-support:1.1.0'
implementation "com.bluelinelabs:conductor:$conductorVersion"
// If you want RxJava/RxAndroid lifecycle support:
compile 'com.bluelinelabs:conductor-rxlifecycle:1.1.0'
// AndroidX Transition change handlers:
implementation "com.bluelinelabs:conductor-androidx-transition:$conductorVersion"
// ViewPager PagerAdapter:
implementation "com.bluelinelabs:conductor-viewpager:$conductorVersion"
// ViewPager2 Adapter:
implementation "com.bluelinelabs:conductor-viewpager2:$conductorVersion"
```
### 4.0 Preview
Use `4.0.0-preview-4` as your version number in any of the dependencies above.
### SNAPSHOT
Use `4.0.0-SNAPSHOT` as your version number in any of the dependencies above and add the url to the snapshot repository:
```gradle
allprojects {
repositories {
maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}
}
```
## Components to Know
| Conductor Components
| | Conductor Components |
------|------------------------------
__Controller__ | The Controller is the View wrapper that will give you all of your lifecycle management features. Think of it as a lighter-weight and more predictable Fragment alternative with an easier to manage lifecycle.
__Router__ | A Router implements navigation and backstack handling for Controllers. Router objects are attached to Activity/containing ViewGroup pairs. Routers do not directly render or push Views to the container ViewGroup, but instead defer this responsibility to the ControllerChangeHandler specified in a given transaction.
__ControllerChangeHandler__ | ControllerChangeHandlers are responsible for swapping the View for one Controller to the View of another. They can be useful for performing animations and transitions between Controllers. Several default ControllerChangeHandlers are included.
__ControllerTransaction__ | Transactions are used to define data about adding Controllers. RouterControllerTransactions are used to push a Controller to a Router with specified ControllerChangeHandlers, while ChildControllerTransactions are used to add child Controllers.
__RouterTransaction__ | Transactions are used to define data about adding Controllers. RouterTransactions are used to push a Controller to a Router with specified ControllerChangeHandlers, while ChildControllerTransactions are used to add child Controllers.
## Getting Started
### Minimal Activity implementation
```java
public class MainActivity extends Activity {
```kotlin
class MainActivity : AppCompatActivity() {
private Router mRouter;
private lateinit var router: Router
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main);
ViewGroup container = (ViewGroup)findViewById(R.id.controller_container)
mRouter = Conductor.attachRouter(this, container, savedInstanceState);
if (!mRouter.hasRootController()) {
mRouter.setRoot(new HomeController());
}
setContentView(R.layout.activity_main)
val container = findViewById<ViewGroup>(R.id.controller_container)
router = Conductor.attachRouter(this, binding.controllerContainer, savedInstanceState)
.setPopRootControllerMode(PopRootControllerMode.NEVER)
.setOnBackPressedDispatcherEnabled(true)
if (!router.hasRootController()) {
router.setRoot(RouterTransaction.with(HomeController()))
}
}
@Override
public void onBackPressed() {
if (!mRouter.handleBack()) {
super.onBackPressed();
}
}
}
```
### Minimal Controller implementation
```java
public class HomeController extends Controller {
@Override
protected View inflateView(@NonNull LayoutInflater inflater, @NonNull ViewGroup container) {
return inflater.inflate(R.layout.controller_home, container, false);
}
@Override
public void onBindView(@NonNull View view) {
super.onBindView(view);
((TextView)view.findViewById(R.id.tv_title)).setText("Hello World");
}
```kotlin
class HomeController : Controller() {
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup,
savedViewState: Bundle?
): View {
val view = inflater.inflate(R.layout.controller_home, container, false)
view.findViewById<TextView>(R.id.tv_title).text = "Hello World"
return view
}
}
```
@@ -100,7 +113,7 @@ public class HomeController extends Controller {
The lifecycle of a Controller is significantly simpler to understand than that of a Fragment. A lifecycle diagram is shown below:
![Controller Lifecycle](docs/Controller Lifecycle.jpg)
![Controller Lifecycle](docs/Controller%20Lifecycle.jpg)
## Advanced Topics
@@ -110,15 +123,23 @@ The lifecycle of a Controller is significantly simpler to understand than that o
### Custom Change Handlers
`ControllerChangeHandler` can be subclassed in order to perform different functions when changing between two `Controllers`. Two convenience `ControllerChangeHandler` subclasses are included to cover most basic needs: `AnimatorChangeHandler`, which will use an `Animator` object to transition between two views, and `TransitionChangeHandler`, which will use Lollipop's `Transition` framework for transitioning between views.
### Child Controllers
`addChildController` can be called on a `Controller` in order to add nested `Controller`s. Child `Controller`s will receive all lifecycle callbacks that parents get.
### Child Routers & Controllers
`getChildRouter` can be called on a `Controller` in order to get a nested `Router` into which child `Controller`s can be pushed. This enables creating advanced layouts, such as Master/Detail.
### RxJava Lifecycle
If the RxLifecycle dependency has been added, there is an `RxController` available that can be used along with the standard [RxLifecycle library](https://github.com/trello/RxLifecycle). There is also a `ControllerLifecycleProvider` available if you do not wish to use this subclass.
If the AutoDispose dependency has been added, there is a `ControllerScopeProvider` available that can be used along with the standard [AutoDispose library](https://github.com/uber/AutoDispose).
## Community Projects
The community has provided several helpful modules to make developing apps with Conductor even easier. Here's a collection of helpful libraries:
* [ConductorGlide](https://github.com/MkhytarMkhoian/ConductorGlide) - Adds Glide lifecycle support to Controllers
* [ConductorDialog](https://github.com/MkhytarMkhoian/ConductorDialog) - Adds a helpful DialogController (a Conductor version of DialogFragment)
* [Mosby-Conductor](https://github.com/sockeqwe/mosby-conductor) - A plugin to integrate Mosby, an MVP/MVI library
## License
```
Copyright 2016 BlueLine Labs, Inc.
Copyright 2020 BlueLine Labs, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
-101
View File
@@ -1,101 +0,0 @@
apply plugin: 'com.github.dcendents.android-maven'
apply plugin: 'com.jfrog.bintray'
group = 'com.bluelinelabs'
version = rootProject.ext.versionName
task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
classifier = 'sources'
}
task javadoc(type: Javadoc) {
source = android.sourceSets.main.java.srcDirs
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
exclude '**/R.java'
exclude '**/internal/**'
failOnError = false
}
task javadocJar(type: Jar, dependsOn: javadoc) {
classifier = 'javadoc'
from javadoc.destinationDir
}
artifacts {
archives javadocJar
archives sourcesJar
}
if (project.hasProperty('pom_name')) {
install {
repositories.mavenInstaller {
pom.project {
name pom_name
description pom_description
url pom_url
packaging pom_packaging
groupId 'com.bluelinelabs'
artifactId project.hasProperty('artifactId') ? project.ext.artifactId : ''
organization {
name 'BlueLine Labs'
url 'http://bluelinelabs.com'
}
licenses {
license {
name 'The Apache Software License, Version 2.0'
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
distribution 'repo'
}
}
scm {
url pom_url
connection pom_git_connection
developerConnection pom_git_connection
}
developers {
developer {
id 'erickuck'
name 'Eric Kuck'
}
}
}
}
}
bintray {
user = project.hasProperty('bintray_username') ? bintray_username : ''
key = project.hasProperty('bintray_api_key') ? bintray_api_key : ''
configurations = ['archives']
dryRun = false
publish = false
pkg {
repo = 'bluelinelabs'
userOrg = 'bluelinelabs'
name = pom_name
desc = pom_description
websiteUrl = pom_url
issueTrackerUrl = pom_issue_tracker_url
vcsUrl = pom_url
licenses = ['Apache-2.0']
labels = pom_labels
version {
name = project.version
gpg {
sign = true
passphrase = project.hasProperty('bintray_gpg_passphrase') ? bintray_gpg_passphrase : ''
}
mavenCentralSync {
sync = false
user = project.hasProperty('maven_central_username') ? maven_central_username : ''
password = project.hasProperty('maven_central_password') ? maven_central_password : ''
close = '1'
}
}
}
}
}
Executable → Regular
+19 -16
View File
@@ -1,26 +1,29 @@
buildscript {
repositories {
jcenter()
mavenCentral()
google()
}
dependencies {
classpath 'com.android.tools.build:gradle:1.5.0'
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
classpath libs.agp
classpath libs.kotlin.plugin
classpath libs.dokka
}
}
plugins {
id "com.jfrog.bintray" version "1.5"
}
allprojects {
repositories {
jcenter()
mavenLocal()
if (project.hasProperty('maven_publish_url')) {
pluginManager.withPlugin("com.vanniktech.maven.publish") {
publishing {
repositories {
maven {
url = maven_publish_url
credentials {
username = maven_publish_username
password = maven_publish_password
}
}
}
}
}
}
}
task wrapper(type: Wrapper) {
gradleVersion = '2.10'
}
apply from: rootProject.file('dependencies.gradle')
+9 -8
View File
@@ -1,20 +1,21 @@
apply plugin: 'java'
apply plugin: 'kotlin'
configurations {
lintChecks
libs.lint.checks
}
dependencies {
compile rootProject.ext.lintapi
compile rootProject.ext.lintchecks
compileOnly libs.lint.api
compileOnly libs.lint.checks
compileOnly libs.kotlin.stdlib
lintChecks files(jar)
testImplementation libs.junit
testImplementation libs.lint
testImplementation libs.lint.tests
}
jar {
manifest {
attributes('Lint-Registry': 'com.bluelinelabs.conductor.lint.IssueRegistry')
attributes('Lint-Registry-v2': 'com.bluelinelabs.conductor.lint.IssueRegistry')
}
}
apply from: rootProject.file('dependencies.gradle')
@@ -1,7 +1,7 @@
package com.bluelinelabs.conductor.lint;
import com.android.annotations.NonNull;
import com.android.tools.lint.client.api.JavaParser.ResolvedClass;
import com.android.tools.lint.client.api.JavaEvaluator;
import com.android.tools.lint.client.api.UElementHandler;
import com.android.tools.lint.detector.api.Category;
import com.android.tools.lint.detector.api.Detector;
import com.android.tools.lint.detector.api.Implementation;
@@ -9,92 +9,80 @@ import com.android.tools.lint.detector.api.Issue;
import com.android.tools.lint.detector.api.JavaContext;
import com.android.tools.lint.detector.api.Scope;
import com.android.tools.lint.detector.api.Severity;
import com.android.tools.lint.detector.api.Speed;
import java.lang.reflect.Modifier;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.uast.UClass;
import org.jetbrains.uast.UElement;
import org.jetbrains.uast.UMethod;
import java.util.Collections;
import java.util.List;
import lombok.ast.ClassDeclaration;
import lombok.ast.ConstructorDeclaration;
import lombok.ast.Node;
import lombok.ast.NormalTypeBody;
import lombok.ast.StrictListAccessor;
import lombok.ast.TypeMember;
import lombok.ast.VariableDefinition;
@SuppressWarnings("UnstableApiUsage")
public final class ControllerChangeHandlerIssueDetector extends Detector implements Detector.UastScanner {
public final class ControllerChangeHandlerIssueDetector extends Detector implements Detector.JavaScanner, Detector.ClassScanner {
public static final Issue ISSUE =
static final Issue ISSUE =
Issue.create("ValidControllerChangeHandler", "ControllerChangeHandler not instantiatable",
"Non-abstract ControllerChangeHandler instances must have a default constructor for the"
+ " system to re-create them in the case of the process being killed.",
Category.CORRECTNESS, 6, Severity.FATAL,
new Implementation(ControllerChangeHandlerIssueDetector.class, Scope.JAVA_FILE_SCOPE));
public ControllerChangeHandlerIssueDetector() { }
private static final String CLASS_NAME = "com.bluelinelabs.conductor.ControllerChangeHandler";
@NonNull
@Override
public Speed getSpeed() {
return Speed.FAST;
public List<Class<? extends UElement>> getApplicableUastTypes() {
return Collections.<Class<? extends UElement>>singletonList(UClass.class);
}
@Override
public List<String> applicableSuperClasses() {
return Collections.singletonList("com.bluelinelabs.conductor.ControllerChangeHandler");
}
public UElementHandler createUastHandler(final JavaContext context) {
final JavaEvaluator evaluator = context.getEvaluator();
@Override
public void checkClass(@NonNull JavaContext context, ClassDeclaration node,
@NonNull Node declarationOrAnonymous, @NonNull ResolvedClass cls) {
return new UElementHandler() {
if (node == null) {
return;
}
@Override
public void visitClass(@NotNull UClass node) {
if (evaluator.isAbstract(node)) {
return;
}
final int flags = node.astModifiers().getEffectiveModifierFlags();
if ((flags & Modifier.ABSTRACT) != 0) {
return;
}
final boolean hasSuperType = evaluator.extendsClass(node.getPsi(), CLASS_NAME, true);
if (!hasSuperType) {
return;
}
if ((flags & Modifier.PUBLIC) == 0) {
String message = String.format("This ControllerChangeHandler class should be public (%1$s)", cls.getName());
context.report(ISSUE, node, context.getLocation(node.astName()), message);
return;
}
if (!evaluator.isPublic(node)) {
String message = String.format("This ControllerChangeHandler class should be public (%1$s)", node.getQualifiedName());
context.report(ISSUE, node, context.getLocation((UElement) node), message);
return;
}
if (cls.getContainingClass() != null && (flags & Modifier.STATIC) == 0) {
String message = String.format("This ControllerChangeHandler inner class should be static (%1$s)", cls.getName());
context.report(ISSUE, node, context.getLocation(node.astName()), message);
return;
}
if (node.getContainingClass() != null && !evaluator.isStatic(node)) {
String message = String.format("This ControllerChangeHandler inner class should be static (%1$s)", node.getQualifiedName());
context.report(ISSUE, node, context.getLocation((UElement) node), message);
return;
}
boolean hasConstructor = false;
boolean hasDefaultConstructor = false;
NormalTypeBody body = node.astBody();
if (body != null) {
for (TypeMember member : body.astMembers()) {
if (member instanceof ConstructorDeclaration) {
hasConstructor = true;
ConstructorDeclaration constructor = (ConstructorDeclaration)member;
if (constructor.astModifiers().isPublic()) {
StrictListAccessor<VariableDefinition, ConstructorDeclaration> params = constructor.astParameters();
if (params.isEmpty()) {
boolean hasConstructor = false;
boolean hasDefaultConstructor = false;
for (UMethod method : node.getMethods()) {
if (method.isConstructor()) {
hasConstructor = true;
if (evaluator.isPublic(method) && method.getUastParameters().size() == 0) {
hasDefaultConstructor = true;
break;
}
}
}
}
}
if (hasConstructor && !hasDefaultConstructor) {
String message = String.format(
"This ControllerChangeHandler needs to have a public default constructor (`%1$s`)",
cls.getName());
context.report(ISSUE, node, context.getLocation(node.astName()), message);
}
if (hasConstructor && !hasDefaultConstructor) {
String message = String.format(
"This ControllerChangeHandler needs to have a public default constructor (`%1$s`)", node.getQualifiedName());
context.report(ISSUE, node, context.getLocation((UElement) node), message);
}
}
};
}
}
}
@@ -1,8 +1,8 @@
package com.bluelinelabs.conductor.lint;
import com.android.SdkConstants;
import com.android.annotations.NonNull;
import com.android.tools.lint.client.api.JavaParser.ResolvedClass;
import com.android.tools.lint.client.api.JavaEvaluator;
import com.android.tools.lint.client.api.UElementHandler;
import com.android.tools.lint.detector.api.Category;
import com.android.tools.lint.detector.api.Detector;
import com.android.tools.lint.detector.api.Implementation;
@@ -10,99 +10,90 @@ import com.android.tools.lint.detector.api.Issue;
import com.android.tools.lint.detector.api.JavaContext;
import com.android.tools.lint.detector.api.Scope;
import com.android.tools.lint.detector.api.Severity;
import com.android.tools.lint.detector.api.Speed;
import java.lang.reflect.Modifier;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.uast.UClass;
import org.jetbrains.uast.UElement;
import org.jetbrains.uast.UMethod;
import org.jetbrains.uast.UParameter;
import java.util.Collections;
import java.util.List;
import lombok.ast.ClassDeclaration;
import lombok.ast.ConstructorDeclaration;
import lombok.ast.Node;
import lombok.ast.NormalTypeBody;
import lombok.ast.StrictListAccessor;
import lombok.ast.TypeMember;
import lombok.ast.VariableDefinition;
@SuppressWarnings("UnstableApiUsage")
public final class ControllerIssueDetector extends Detector implements Detector.UastScanner {
public final class ControllerIssueDetector extends Detector implements Detector.JavaScanner, Detector.ClassScanner {
public static final Issue ISSUE =
static final Issue ISSUE =
Issue.create("ValidController", "Controller not instantiatable",
"Non-abstract Controller instances must have a default or single-argument constructor"
+ " that takes a Bundle in order for the system to re-create them in the"
+ " case of the process being killed.", Category.CORRECTNESS, 6, Severity.FATAL,
new Implementation(ControllerIssueDetector.class, Scope.JAVA_FILE_SCOPE));
public ControllerIssueDetector() { }
private static final String CLASS_NAME = "com.bluelinelabs.conductor.Controller";
@NonNull
@Override
public Speed getSpeed() {
return Speed.FAST;
public List<Class<? extends UElement>> getApplicableUastTypes() {
return Collections.singletonList(UClass.class);
}
@Override
public List<String> applicableSuperClasses() {
return Collections.singletonList("com.bluelinelabs.conductor.Controller");
}
public UElementHandler createUastHandler(final JavaContext context) {
final JavaEvaluator evaluator = context.getEvaluator();
@Override
public void checkClass(@NonNull JavaContext context, ClassDeclaration node,
@NonNull Node declarationOrAnonymous, @NonNull ResolvedClass cls) {
return new UElementHandler() {
@Override
public void visitClass(@NotNull UClass node) {
if (evaluator.isAbstract(node)) {
return;
}
if (node == null) {
return;
}
final boolean hasSuperType = evaluator.extendsClass(node.getPsi(), CLASS_NAME, true);
if (!hasSuperType) {
return;
}
final int flags = node.astModifiers().getEffectiveModifierFlags();
if ((flags & Modifier.ABSTRACT) != 0) {
return;
}
if (!evaluator.isPublic(node)) {
String message = String.format("This Controller class should be public (%1$s)", node.getQualifiedName());
context.report(ISSUE, node, context.getLocation((UElement) node), message);
return;
}
if ((flags & Modifier.PUBLIC) == 0) {
String message = String.format("This Controller class should be public (%1$s)", cls.getName());
context.report(ISSUE, node, context.getLocation(node.astName()), message);
return;
}
if (node.getContainingClass() != null && !evaluator.isStatic(node)) {
String message = String.format("This Controller inner class should be static (%1$s)", node.getQualifiedName());
context.report(ISSUE, node, context.getLocation((UElement) node), message);
return;
}
if (cls.getContainingClass() != null && (flags & Modifier.STATIC) == 0) {
String message = String.format("This Controller inner class should be static (%1$s)", cls.getName());
context.report(ISSUE, node, context.getLocation(node.astName()), message);
return;
}
boolean hasConstructor = false;
boolean hasDefaultConstructor = false;
boolean hasBundleConstructor = false;
NormalTypeBody body = node.astBody();
if (body != null) {
for (TypeMember member : body.astMembers()) {
if (member instanceof ConstructorDeclaration) {
hasConstructor = true;
ConstructorDeclaration constructor = (ConstructorDeclaration)member;
if (constructor.astModifiers().isPublic()) {
StrictListAccessor<VariableDefinition, ConstructorDeclaration> params = constructor.astParameters();
if (params.isEmpty()) {
hasDefaultConstructor = true;
break;
} else if (params.size() == 1 &&
(params.first().astTypeReference().getTypeName().equals(SdkConstants.CLASS_BUNDLE)) ||
params.first().astTypeReference().getTypeName().equals("Bundle")) {
hasBundleConstructor = true;
break;
boolean hasConstructor = false;
boolean hasDefaultConstructor = false;
boolean hasBundleConstructor = false;
for (UMethod method : node.getMethods()) {
if (method.isConstructor()) {
hasConstructor = true;
if (evaluator.isPublic(method)) {
List<UParameter> parameters = method.getUastParameters();
if (parameters.size() == 0) {
hasDefaultConstructor = true;
break;
} else if (parameters.size() == 1 &&
(parameters.get(0).getType().equalsToText(SdkConstants.CLASS_BUNDLE)) ||
parameters.get(0).getType().equalsToText("Bundle")) {
hasBundleConstructor = true;
}
}
}
}
}
}
if (hasConstructor && !hasDefaultConstructor && !hasBundleConstructor) {
String message = String.format(
"This Controller needs to have either a public default constructor or a" +
" public single-argument constructor that takes a Bundle. (`%1$s`)",
cls.getName());
context.report(ISSUE, node, context.getLocation(node.astName()), message);
}
if (hasConstructor && !hasDefaultConstructor && !hasBundleConstructor) {
String message = String.format(
"This Controller needs to have either a public default constructor or a" +
" public single-argument constructor that takes a Bundle. (`%1$s`)",
node.getQualifiedName());
context.report(ISSUE, node, context.getLocation((UElement) node), message);
}
}
};
}
}
}
@@ -1,14 +0,0 @@
package com.bluelinelabs.conductor.lint;
import com.android.tools.lint.detector.api.Issue;
import java.util.Arrays;
import java.util.List;
public final class IssueRegistry extends com.android.tools.lint.client.api.IssueRegistry {
@Override public List<Issue> getIssues() {
return Arrays.asList(
ControllerIssueDetector.ISSUE,
ControllerChangeHandlerIssueDetector.ISSUE);
}
}
@@ -0,0 +1,24 @@
package com.bluelinelabs.conductor.lint
import com.android.tools.lint.client.api.Vendor
import com.android.tools.lint.detector.api.CURRENT_API
import com.android.tools.lint.client.api.IssueRegistry as LintIssueRegistry
@Suppress("UnstableApiUsage", "unused")
class IssueRegistry : LintIssueRegistry() {
override val issues = listOf(
ControllerIssueDetector.ISSUE,
ControllerChangeHandlerIssueDetector.ISSUE
)
override val api: Int = CURRENT_API
private val githubIssueLink = "https://github.com/bluelinelabs/Conductor/issues/new"
override val vendor = Vendor(
vendorName = "Conductor",
feedbackUrl = githubIssueLink,
contact = githubIssueLink
)
}
@@ -0,0 +1,137 @@
package com.bluelinelabs.conductor.lint;
import static com.android.tools.lint.checks.infrastructure.TestFiles.java;
import static com.android.tools.lint.checks.infrastructure.TestLintTask.lint;
import com.android.tools.lint.checks.infrastructure.TestFile;
import org.intellij.lang.annotations.Language;
import org.junit.Test;
@SuppressWarnings("UnstableApiUsage")
public class ControllerChangeHandlerDetectorTest {
private static final String CONSTRUCTOR =
"src/test/SampleHandler.java:2: Error: This ControllerChangeHandler needs to have a public default constructor (test.SampleHandler) [ValidControllerChangeHandler]\n"
+ "public class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ "^\n"
+ "1 errors, 0 warnings\n";
private final TestFile controllerChangeHandlerStub = java(
"package com.bluelinelabs.conductor;\n"
+ "abstract class ControllerChangeHandler {}"
);
@Test
public void testWithNoConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ "}";
lint()
.files(controllerChangeHandlerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expectClean();
}
@Test
public void testWithEmptyConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ " public SampleHandler() { }\n"
+ "}";
lint()
.files(controllerChangeHandlerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expectClean();
}
@Test
public void testWithInvalidConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ " public SampleHandler(int number) { }\n"
+ "}";
lint()
.files(controllerChangeHandlerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect(CONSTRUCTOR);
}
@Test
public void testWithEmptyAndInvalidConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ " public SampleHandler() { }\n"
+ " public SampleHandler(int number) { }\n"
+ "}";
lint()
.files(controllerChangeHandlerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expectClean();
}
@Test
public void testWithPrivateConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ " private SampleHandler() { }\n"
+ "}";
lint()
.files(controllerChangeHandlerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect(CONSTRUCTOR);
}
@Test
public void testWithPrivateClass() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "private class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ " public SampleHandler() { }\n"
+ "}";
lint()
.files(controllerChangeHandlerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect("src/test/SampleHandler.java:2: Error: This ControllerChangeHandler class should be public (test.SampleHandler) [ValidControllerChangeHandler]\n"
+ "private class SampleHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {\n"
+ "^\n"
+ "1 errors, 0 warnings\n");
}
@Test
public void testWithPrivateClassOfBaseClass() {
@Language("JAVA") String baseClass = ""
+ "package test;\n"
+ "abstract class BaseChangeHandler extends com.bluelinelabs.conductor.ControllerChangeHandler {}";
@Language("JAVA") String source = ""
+ "package test;\n"
+ "private class SampleHandler extends test.BaseChangeHandler {}";
lint()
.files(controllerChangeHandlerStub, java(baseClass), java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect("src/test/SampleHandler.java:2: Error: This ControllerChangeHandler class should be public (test.SampleHandler) [ValidControllerChangeHandler]\n" +
"private class SampleHandler extends test.BaseChangeHandler {}\n" +
"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" +
"1 errors, 0 warnings");
}
}
@@ -0,0 +1,147 @@
package com.bluelinelabs.conductor.lint;
import static com.android.tools.lint.checks.infrastructure.TestFiles.java;
import static com.android.tools.lint.checks.infrastructure.TestLintTask.lint;
import com.android.tools.lint.checks.infrastructure.TestFile;
import org.intellij.lang.annotations.Language;
import org.junit.Test;
@SuppressWarnings("UnstableApiUsage")
public class ControllerDetectorTest {
private static final String CONSTRUCTOR_ERROR =
"src/test/SampleController.java:2: Error: This Controller needs to have either a public default constructor or a public single-argument constructor that takes a Bundle. (test.SampleController) [ValidController]\n"
+ "public class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ "^\n"
+ "1 errors, 0 warnings\n";
private static final String CLASS_ERROR =
"src/test/SampleController.java:2: Error: This Controller class should be public (test.SampleController) [ValidController]\n"
+ "private class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ "^\n"
+ "1 errors, 0 warnings\n";
private final TestFile controllerStub = java(
"package com.bluelinelabs.conductor;\n"
+ "abstract class Controller {}"
);
@Test
public void testWithNoConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ "}";
lint()
.files(controllerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expectClean();
}
@Test
public void testWithEmptyConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ " public SampleController() { }\n"
+ "}";
lint()
.files(controllerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expectClean();
}
@Test
public void testWithInvalidConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ " public SampleController(int number) { }\n"
+ "}";
lint()
.files(controllerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect(CONSTRUCTOR_ERROR);
}
@Test
public void testWithEmptyAndInvalidConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ " public SampleController() { }\n"
+ " public SampleController(int number) { }\n"
+ "}";
lint()
.files(controllerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expectClean();
}
@Test
public void testWithBaseClassAndPrivateConstructor() {
@Language("JAVA")
String baseClass = ""
+ "package test;\n"
+ "public class BaseController extends com.bluelinelabs.conductor.Controller {}";
@Language("JAVA")
String source = ""
+ "package test;\n"
+ "public class SampleController extends BaseController {\n"
+ " private SampleController() { }\n"
+ "}";
lint()
.files(controllerStub, java(baseClass), java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect(
"src/test/SampleController.java:2: Error: This Controller needs to have either a public default constructor or a public single-argument constructor that takes a Bundle. (test.SampleController) [ValidController]\n" +
"public class SampleController extends BaseController {\n" +
"^\n" +
"1 errors, 0 warnings"
);
}
@Test
public void testWithPrivateConstructor() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "public class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ " private SampleController() { }\n"
+ "}";
lint()
.files(controllerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect(CONSTRUCTOR_ERROR);
}
@Test
public void testWithPrivateClass() {
@Language("JAVA") String source = ""
+ "package test;\n"
+ "private class SampleController extends com.bluelinelabs.conductor.Controller {\n"
+ " public SampleController() { }\n"
+ "}";
lint()
.files(controllerStub, java(source))
.issues(ControllerIssueDetector.ISSUE, ControllerChangeHandlerIssueDetector.ISSUE)
.run()
.expect(CLASS_ERROR);
}
}
@@ -0,0 +1,31 @@
plugins {
id("com.android.library")
alias(libs.plugins.mvnpublish)
}
android {
compileSdk libs.versions.compilesdk.get() as Integer
compileOptions {
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_11
}
defaultConfig {
minSdkVersion libs.versions.minsdk.get()
targetSdkVersion libs.versions.targetsdk.get()
versionCode Integer.parseInt(project.VERSION_CODE)
versionName project.VERSION_NAME
}
namespace "com.bluelinelabs.conductor.androidxtransition"
}
dependencies {
implementation libs.androidx.appcompat
implementation libs.androidx.collection
api libs.androidx.transition
implementation project(':conductor')
}
ext.artifactId = 'conductor-androidx-transition'
@@ -0,0 +1,3 @@
POM_NAME=Conductor AndroidX Transition Extensions
POM_ARTIFACT_ID=conductor-androidx-transition
POM_PACKAGING=aar
@@ -0,0 +1,656 @@
package com.bluelinelabs.conductor.changehandler.androidxtransition;
import android.graphics.Rect;
import android.view.View;
import android.view.ViewGroup;
import android.view.ViewTreeObserver;
import android.view.ViewTreeObserver.OnPreDrawListener;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.collection.ArrayMap;
import androidx.core.app.SharedElementCallback;
import androidx.core.view.ViewCompat;
import androidx.core.view.ViewGroupCompat;
import androidx.transition.Transition;
import androidx.transition.TransitionSet;
import com.bluelinelabs.conductor.Controller;
import com.bluelinelabs.conductor.ControllerChangeHandler;
import com.bluelinelabs.conductor.internal.TransitionUtils;
import java.util.ArrayList;
import java.util.List;
/**
* A TransitionChangeHandler that facilitates using different Transitions for the entering view, the exiting view,
* and shared elements between the two.
* <p/>
* Note that this class uses the <b>androidx</b> {@link Transition}. If you're using Android's platform transitions,
* consider using the {@code SharedElementTransitionChangeHandler} provided by the {@code android-transitions} Conductor module.
*/
// Much of this class is based on FragmentTransition.java and FragmentTransitionCompat21.java from the Android support library
public abstract class SharedElementTransitionChangeHandler extends TransitionChangeHandler {
// A map of from -> to names. Generally these will be the same.
@NonNull final ArrayMap<String, String> sharedElementNames = new ArrayMap<>();
@NonNull final List<String> waitForTransitionNames = new ArrayList<>();
@NonNull final List<ViewParentPair> removedViews = new ArrayList<>();
@Nullable Transition exitTransition;
@Nullable Transition enterTransition;
@Nullable Transition sharedElementTransition;
@Nullable private SharedElementCallback exitTransitionCallback;
@Nullable private SharedElementCallback enterTransitionCallback;
@NonNull
@Override
protected final Transition getTransition(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush) {
exitTransition = getExitTransition(container, from, to, isPush);
enterTransition = getEnterTransition(container, from, to, isPush);
sharedElementTransition = getSharedElementTransition(container, from, to, isPush);
exitTransitionCallback = getExitTransitionCallback(container, from, to, isPush);
enterTransitionCallback = getEnterTransitionCallback(container, from, to, isPush);
if (enterTransition == null && sharedElementTransition == null && exitTransition == null) {
throw new IllegalStateException("SharedElementTransitionChangeHandler must have at least one transaction.");
}
return mergeTransitions(isPush);
}
@Override
public void prepareForTransition(@NonNull final ViewGroup container, @Nullable final View from, @Nullable final View to, @NonNull final Transition transition, final boolean isPush, @NonNull final OnTransitionPreparedListener onTransitionPreparedListener) {
OnTransitionPreparedListener listener = new OnTransitionPreparedListener() {
@Override
public void onPrepared() {
configureTransition(container, from, to, transition, isPush);
onTransitionPreparedListener.onPrepared();
}
};
configureSharedElements(container, from, to, isPush);
if (to != null && to.getParent() == null && waitForTransitionNames.size() > 0) {
waitOnAllTransitionNames(to, listener);
container.addView(to);
} else {
listener.onPrepared();
}
}
@Override
public final void executePropertyChanges(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, @Nullable Transition transition, boolean isPush) {
if (to != null && removedViews.size() > 0) {
to.setVisibility(View.VISIBLE);
for (ViewParentPair removedView : removedViews) {
removedView.parent.addView(removedView.view);
}
removedViews.clear();
}
super.executePropertyChanges(container, from, to, transition, isPush);
}
@Override
public void onAbortPush(@NonNull ControllerChangeHandler newHandler, @Nullable Controller newTop) {
super.onAbortPush(newHandler, newTop);
removedViews.clear();
}
void configureTransition(@NonNull final ViewGroup container, @Nullable View from, @Nullable View to, @NonNull final Transition transition, boolean isPush) {
final View nonExistentView = new View(container.getContext());
List<View> fromSharedElements = new ArrayList<>();
List<View> toSharedElements = new ArrayList<>();
configureSharedElements(container, nonExistentView, to, from, isPush, fromSharedElements, toSharedElements);
List<View> exitingViews = exitTransition != null ? configureEnteringExitingViews(exitTransition, from, fromSharedElements, nonExistentView) : null;
if (exitingViews == null || exitingViews.isEmpty()) {
exitTransition = null;
}
if (enterTransition != null) {
enterTransition.addTarget(nonExistentView);
}
final List<View> enteringViews = new ArrayList<>();
scheduleRemoveTargets(transition, enterTransition, enteringViews, exitTransition, exitingViews, sharedElementTransition, toSharedElements);
scheduleTargetChange(container, to, nonExistentView, toSharedElements, enteringViews, exitingViews);
setNameOverrides(container, toSharedElements);
scheduleNameReset(container, toSharedElements);
}
private void waitOnAllTransitionNames(@NonNull final View to, @NonNull final OnTransitionPreparedListener onTransitionPreparedListener) {
OnPreDrawListener onPreDrawListener = new OnPreDrawListener() {
boolean addedSubviewListeners;
@Override
public boolean onPreDraw() {
List<View> foundViews = new ArrayList<>();
boolean allViewsFound = true;
for (String transitionName : waitForTransitionNames) {
View namedView = TransitionUtils.findNamedView(to, transitionName);
if (namedView != null) {
foundViews.add(TransitionUtils.findNamedView(to, transitionName));
} else {
allViewsFound = false;
break;
}
}
if (allViewsFound && !addedSubviewListeners) {
addedSubviewListeners = true;
waitOnChildTransitionNames(to, foundViews, this, onTransitionPreparedListener);
}
return false;
}
};
to.getViewTreeObserver().addOnPreDrawListener(onPreDrawListener);
}
void waitOnChildTransitionNames(@NonNull final View to, @NonNull List<View> foundViews, @NonNull final OnPreDrawListener parentPreDrawListener, @NonNull final OnTransitionPreparedListener onTransitionPreparedListener) {
for (final View view : foundViews) {
OneShotPreDrawListener.add(true, view, new Runnable() {
@Override
public void run() {
waitForTransitionNames.remove(ViewCompat.getTransitionName(view));
removedViews.add(new ViewParentPair(view, (ViewGroup)view.getParent()));
((ViewGroup)view.getParent()).removeView(view);
if (waitForTransitionNames.size() == 0) {
to.getViewTreeObserver().removeOnPreDrawListener(parentPreDrawListener);
to.setVisibility(View.INVISIBLE);
onTransitionPreparedListener.onPrepared();
}
}
});
}
}
private void scheduleTargetChange(@NonNull final ViewGroup container, @Nullable final View to, @NonNull final View nonExistentView,
@NonNull final List<View> toSharedElements, @NonNull final List<View> enteringViews, @Nullable final List<View> exitingViews) {
OneShotPreDrawListener.add(true, container, new Runnable() {
@Override
public void run() {
if (enterTransition != null) {
enterTransition.removeTarget(nonExistentView);
List<View> views = configureEnteringExitingViews(enterTransition, to, toSharedElements, nonExistentView);
enteringViews.addAll(views);
}
if (exitingViews != null) {
if (exitTransition != null) {
List<View> tempExiting = new ArrayList<>();
tempExiting.add(nonExistentView);
TransitionUtils.replaceTargets(exitTransition, exitingViews, tempExiting);
}
exitingViews.clear();
exitingViews.add(nonExistentView);
}
}
});
}
private Transition mergeTransitions(boolean isPush) {
boolean overlap = enterTransition == null || exitTransition == null || allowTransitionOverlap(isPush);
if (overlap) {
return TransitionUtils.mergeTransitions(TransitionSet.ORDERING_TOGETHER, exitTransition, enterTransition, sharedElementTransition);
} else {
Transition staggered = TransitionUtils.mergeTransitions(TransitionSet.ORDERING_SEQUENTIAL, exitTransition, enterTransition);
return TransitionUtils.mergeTransitions(TransitionSet.ORDERING_TOGETHER, staggered, sharedElementTransition);
}
}
@NonNull List<View> configureEnteringExitingViews(@NonNull Transition transition, @Nullable View view, @NonNull List<View> sharedElements, @NonNull View nonExistentView) {
List<View> viewList = new ArrayList<>();
if (view != null) {
captureTransitioningViews(viewList, view);
}
viewList.removeAll(sharedElements);
if (!viewList.isEmpty()) {
viewList.add(nonExistentView);
TransitionUtils.addTargets(transition, viewList);
}
return viewList;
}
private void configureSharedElements(@NonNull ViewGroup container, @NonNull final View nonExistentView, @Nullable final View to, @Nullable View from,
final boolean isPush, @NonNull final List<View> fromSharedElements, @NonNull final List<View> toSharedElements) {
if (to == null || from == null) {
return;
}
ArrayMap<String, View> capturedFromSharedElements = captureFromSharedElements(from);
if (sharedElementNames.isEmpty()) {
sharedElementTransition = null;
} else if (capturedFromSharedElements != null) {
fromSharedElements.addAll(capturedFromSharedElements.values());
}
if (enterTransition == null && exitTransition == null && sharedElementTransition == null) {
return;
}
callSharedElementStartEnd(capturedFromSharedElements, true);
final Rect toEpicenter;
if (sharedElementTransition != null) {
toEpicenter = new Rect();
TransitionUtils.setTargets(sharedElementTransition, nonExistentView, fromSharedElements);
setFromEpicenter(capturedFromSharedElements);
if (enterTransition != null) {
enterTransition.setEpicenterCallback(new Transition.EpicenterCallback() {
@Override
public Rect onGetEpicenter(Transition transition) {
if (toEpicenter.isEmpty()) {
return null;
}
return toEpicenter;
}
});
}
} else {
toEpicenter = null;
}
OneShotPreDrawListener.add(true, container, new Runnable() {
@Override
public void run() {
ArrayMap<String, View> capturedToSharedElements = captureToSharedElements(to, isPush);
if (capturedToSharedElements != null) {
toSharedElements.addAll(capturedToSharedElements.values());
toSharedElements.add(nonExistentView);
}
callSharedElementStartEnd(capturedToSharedElements, false);
if (sharedElementTransition != null) {
sharedElementTransition.getTargets().clear();
sharedElementTransition.getTargets().addAll(toSharedElements);
TransitionUtils.replaceTargets(sharedElementTransition, fromSharedElements, toSharedElements);
final View toEpicenterView = getToEpicenterView(capturedToSharedElements);
if (toEpicenterView != null && toEpicenter != null) {
TransitionUtils.getBoundsOnScreen(toEpicenterView, toEpicenter);
}
}
}
});
}
@Nullable View getToEpicenterView(@Nullable ArrayMap<String, View> toSharedElements) {
if (enterTransition != null && sharedElementNames.size() > 0 && toSharedElements != null) {
return toSharedElements.get(sharedElementNames.valueAt(0));
}
return null;
}
private void setFromEpicenter(@Nullable ArrayMap<String, View> fromSharedElements) {
if (sharedElementNames.size() > 0 && fromSharedElements != null) {
final View fromEpicenterView = fromSharedElements.get(sharedElementNames.keyAt(0));
if (sharedElementTransition != null) {
TransitionUtils.setEpicenter(sharedElementTransition, fromEpicenterView);
}
if (exitTransition != null) {
TransitionUtils.setEpicenter(exitTransition, fromEpicenterView);
}
}
}
@Nullable ArrayMap<String, View> captureToSharedElements(@Nullable final View to, boolean isPush) {
if (sharedElementNames.isEmpty() || sharedElementTransition == null || to == null) {
sharedElementNames.clear();
return null;
}
final ArrayMap<String, View> toSharedElements = new ArrayMap<>();
TransitionUtils.findNamedViews(toSharedElements, to);
for (ViewParentPair removedView : removedViews) {
toSharedElements.put(ViewCompat.getTransitionName(removedView.view), removedView.view);
}
final List<String> names = new ArrayList<>(sharedElementNames.values());
toSharedElements.retainAll(names);
if (enterTransitionCallback != null) {
enterTransitionCallback.onMapSharedElements(names, toSharedElements);
for (int i = names.size() - 1; i >= 0; i--) {
String name = names.get(i);
View view = toSharedElements.get(name);
if (view == null) {
String key = findKeyForValue(sharedElementNames, name);
if (key != null) {
sharedElementNames.remove(key);
}
} else if (!name.equals(ViewCompat.getTransitionName(view))) {
String key = findKeyForValue(sharedElementNames, name);
if (key != null) {
sharedElementNames.put(key, ViewCompat.getTransitionName(view));
}
}
}
} else {
for (int i = sharedElementNames.size() - 1; i >= 0; i--) {
final String targetName = sharedElementNames.valueAt(i);
if (!toSharedElements.containsKey(targetName)) {
sharedElementNames.removeAt(i);
}
}
}
return toSharedElements;
}
@Nullable String findKeyForValue(@NonNull ArrayMap<String, String> map, @NonNull String value) {
final int numElements = map.size();
for (int i = 0; i < numElements; i++) {
if (value.equals(map.valueAt(i))) {
return map.keyAt(i);
}
}
return null;
}
@Nullable
private ArrayMap<String, View> captureFromSharedElements(@NonNull View from) {
if (sharedElementNames.isEmpty() || sharedElementTransition == null) {
sharedElementNames.clear();
return null;
}
final ArrayMap<String, View> fromSharedElements = new ArrayMap<>();
TransitionUtils.findNamedViews(fromSharedElements, from);
final List<String> names = new ArrayList<>(sharedElementNames.keySet());
fromSharedElements.retainAll(names);
if (exitTransitionCallback != null) {
exitTransitionCallback.onMapSharedElements(names, fromSharedElements);
for (int i = names.size() - 1; i >= 0; i--) {
String name = names.get(i);
View view = fromSharedElements.get(name);
if (view == null) {
sharedElementNames.remove(name);
} else if (!name.equals(ViewCompat.getTransitionName(view))) {
String targetValue = sharedElementNames.remove(name);
sharedElementNames.put(ViewCompat.getTransitionName(view), targetValue);
}
}
} else {
sharedElementNames.retainAll(fromSharedElements.keySet());
}
return fromSharedElements;
}
void callSharedElementStartEnd(@Nullable ArrayMap<String, View> sharedElements, boolean isStart) {
if (enterTransitionCallback != null) {
final int count = sharedElements == null ? 0 : sharedElements.size();
List<View> views = new ArrayList<>(count);
List<String> names = new ArrayList<>(count);
for (int i = 0; i < count; i++) {
names.add(sharedElements.keyAt(i));
views.add(sharedElements.valueAt(i));
}
if (isStart) {
enterTransitionCallback.onSharedElementStart(names, views, null);
} else {
enterTransitionCallback.onSharedElementEnd(names, views, null);
}
}
}
private void captureTransitioningViews(@NonNull List<View> transitioningViews, @NonNull View view) {
if (view.getVisibility() == View.VISIBLE) {
if (view instanceof ViewGroup) {
ViewGroup viewGroup = (ViewGroup) view;
if (ViewGroupCompat.isTransitionGroup(viewGroup)) {
transitioningViews.add(viewGroup);
} else {
int count = viewGroup.getChildCount();
for (int i = 0; i < count; i++) {
View child = viewGroup.getChildAt(i);
captureTransitioningViews(transitioningViews, child);
}
}
} else {
transitioningViews.add(view);
}
}
}
private void scheduleRemoveTargets(@NonNull final Transition overallTransition,
@Nullable final Transition enterTransition, @Nullable final List<View> enteringViews,
@Nullable final Transition exitTransition, @Nullable final List<View> exitingViews,
@Nullable final Transition sharedElementTransition, @Nullable final List<View> toSharedElements) {
overallTransition.addListener(new Transition.TransitionListener() {
@Override
public void onTransitionStart(Transition transition) {
if (enterTransition != null && enteringViews != null) {
TransitionUtils.replaceTargets(enterTransition, enteringViews, null);
}
if (exitTransition != null && exitingViews != null) {
TransitionUtils.replaceTargets(exitTransition, exitingViews, null);
}
if (sharedElementTransition != null && toSharedElements != null) {
TransitionUtils.replaceTargets(sharedElementTransition, toSharedElements, null);
}
}
@Override
public void onTransitionEnd(Transition transition) { }
@Override
public void onTransitionCancel(Transition transition) { }
@Override
public void onTransitionPause(Transition transition) { }
@Override
public void onTransitionResume(Transition transition) { }
});
}
private void setNameOverrides(@NonNull final View container, @NonNull final List<View> toSharedElements) {
OneShotPreDrawListener.add(true, container, new Runnable() {
@Override
public void run() {
final int numSharedElements = toSharedElements.size();
for (int i = 0; i < numSharedElements; i++) {
View view = toSharedElements.get(i);
String name = ViewCompat.getTransitionName(view);
if (name != null) {
String inName = findKeyForValue(sharedElementNames, name);
ViewCompat.setTransitionName(view, inName);
}
}
}
});
}
private void scheduleNameReset(@NonNull final ViewGroup container, @NonNull final List<View> toSharedElements) {
OneShotPreDrawListener.add(true, container, new Runnable() {
@Override
public void run() {
final int numSharedElements = toSharedElements.size();
for (int i = 0; i < numSharedElements; i++) {
final View view = toSharedElements.get(i);
final String name = ViewCompat.getTransitionName(view);
final String inName = sharedElementNames.get(name);
ViewCompat.setTransitionName(view, inName);
}
}
});
}
/**
* Will be called when views are ready to have their shared elements configured. Within this method one of the addSharedElement methods
* should be called for each shared element that will be used. If one or more of these shared elements will not instantly be available in
* the incoming view (for ex, in a RecyclerView), waitOnSharedElementNamed can be called to delay the transition until everything is available.
*/
public abstract void configureSharedElements(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush);
/**
* Should return the transition that will be used on the exiting ("from") view, if one is desired.
*/
@Nullable
public abstract Transition getExitTransition(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush);
/**
* Should return the transition that will be used on shared elements between the from and to views.
*/
@Nullable
public abstract Transition getSharedElementTransition(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush);
/**
* Should return the transition that will be used on the entering ("to") view, if one is desired.
*/
@Nullable
public abstract Transition getEnterTransition(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush);
/**
* Should return a callback that can be used to customize transition behavior of the shared element transition for the "from" view.
*/
@Nullable
public SharedElementCallback getExitTransitionCallback(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush) {
return null;
}
/**
* Should return a callback that can be used to customize transition behavior of the shared element transition for the "to" view.
*/
@Nullable
public SharedElementCallback getEnterTransitionCallback(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush) {
return null;
}
/**
* Should return whether or not the the exit transition and enter transition should overlap. If true,
* the enter transition will start as soon as possible. Otherwise, the enter transition will wait until the
* completion of the exit transition. Defaults to true.
*/
public boolean allowTransitionOverlap(boolean isPush) {
return true;
}
/**
* Used to register an element that will take part in the shared element transition.
*
* @param name The transition name that is used for both the entering and exiting views.
*/
protected final void addSharedElement(@NonNull String name) {
sharedElementNames.put(name, name);
}
/**
* Used to register an element that will take part in the shared element transition. Maps the name used in the
* "from" view to the name used in the "to" view if they are not the same.
*
* @param fromName The transition name used in the "from" view
* @param toName The transition name used in the "to" view
*/
protected final void addSharedElement(@NonNull String fromName, @NonNull String toName) {
sharedElementNames.put(fromName, toName);
}
/**
* Used to register an element that will take part in the shared element transition. Maps the name used in the
* "from" view to the name used in the "to" view if they are not the same.
*
* @param sharedElement The view from the "from" view that will take part in the shared element transition
* @param toName The transition name used in the "to" view
*/
protected final void addSharedElement(@NonNull View sharedElement, @NonNull String toName) {
String transitionName = ViewCompat.getTransitionName(sharedElement);
if (transitionName == null) {
throw new IllegalArgumentException("Unique transitionNames are required for all sharedElements");
}
sharedElementNames.put(transitionName, toName);
}
/**
* The transition will be delayed until the view with the name passed in is available in the "to" hierarchy. This is
* particularly useful for views that don't load instantly, like RecyclerViews. Note that using this method can
* potentially lock up your app indefinitely if the view never loads!
*/
protected final void waitOnSharedElementNamed(@NonNull String name) {
if (!sharedElementNames.values().contains(name)) {
throw new IllegalStateException("Can't wait on a shared element that hasn't been registered using addSharedElement");
}
waitForTransitionNames.add(name);
}
private static class OneShotPreDrawListener implements OnPreDrawListener, View.OnAttachStateChangeListener {
private final View view;
private ViewTreeObserver viewTreeObserver;
private final Runnable runnable;
private final boolean preDrawReturnValue;
private OneShotPreDrawListener(boolean preDrawReturnValue, @NonNull View view, @NonNull Runnable runnable) {
this.preDrawReturnValue = preDrawReturnValue;
this.view = view;
viewTreeObserver = view.getViewTreeObserver();
this.runnable = runnable;
}
@NonNull
public static OneShotPreDrawListener add(boolean preDrawReturnValue, @NonNull View view, @NonNull Runnable runnable) {
OneShotPreDrawListener listener = new OneShotPreDrawListener(preDrawReturnValue, view, runnable);
view.getViewTreeObserver().addOnPreDrawListener(listener);
view.addOnAttachStateChangeListener(listener);
return listener;
}
@Override
public boolean onPreDraw() {
removeListener();
runnable.run();
return preDrawReturnValue;
}
private void removeListener() {
if (viewTreeObserver.isAlive()) {
viewTreeObserver.removeOnPreDrawListener(this);
} else {
view.getViewTreeObserver().removeOnPreDrawListener(this);
}
view.removeOnAttachStateChangeListener(this);
}
@Override
public void onViewAttachedToWindow(View v) {
viewTreeObserver = v.getViewTreeObserver();
}
@Override
public void onViewDetachedFromWindow(View v) {
removeListener();
}
}
private static class ViewParentPair {
@NonNull final View view;
@NonNull final ViewGroup parent;
ViewParentPair(@NonNull View view, ViewGroup parent) {
this.view = view;
this.parent = parent;
}
}
}
@@ -0,0 +1,153 @@
package com.bluelinelabs.conductor.changehandler.androidxtransition;
import android.view.View;
import android.view.ViewGroup;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.transition.Transition;
import androidx.transition.TransitionManager;
import com.bluelinelabs.conductor.Controller;
import com.bluelinelabs.conductor.ControllerChangeHandler;
/**
* A base {@link ControllerChangeHandler} that facilitates using {@link Transition}s to replace Controller Views.
* <p/>
* Note that this class uses the <b>androidx</b> {@link Transition}. If you're using Android's platform transitions,
* consider using the {@code TransitionChangeHandler} provided by the {@code android-transitions} Conductor module.
*/
public abstract class TransitionChangeHandler extends ControllerChangeHandler {
public interface OnTransitionPreparedListener {
void onPrepared();
}
boolean canceled;
private boolean needsImmediateCompletion;
/**
* Should be overridden to return the Transition to use while replacing Views.
*
* @param container The container these Views are hosted in
* @param from The previous View in the container or {@code null} if there was no Controller before this transition
* @param to The next View that should be put in the container or {@code null} if no Controller is being transitioned to
* @param isPush True if this is a push transaction, false if it's a pop
*/
@NonNull
protected abstract Transition getTransition(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, boolean isPush);
@Override
public void onAbortPush(@NonNull ControllerChangeHandler newHandler, @Nullable Controller newTop) {
super.onAbortPush(newHandler, newTop);
canceled = true;
}
@Override
public void completeImmediately() {
super.completeImmediately();
needsImmediateCompletion = true;
}
@Nullable
private ControllerChangeCompletedListener listener;
@Override
public void performChange(@NonNull final ViewGroup container, @Nullable final View from, @Nullable final View to, final boolean isPush, @NonNull final ControllerChangeCompletedListener changeListener) {
listener = changeListener;
if (canceled) {
changeListener.onChangeCompleted();
return;
}
if (needsImmediateCompletion) {
executePropertyChanges(container, from, to, null, isPush);
changeListener.onChangeCompleted();
return;
}
final Runnable onTransitionNotStarted = new Runnable() {
@Override
public void run() {
changeListener.onChangeCompleted();
}
};
final Transition transition = getTransition(container, from, to, isPush);
transition.addListener(new Transition.TransitionListener() {
@Override
public void onTransitionStart(Transition transition) {
container.removeCallbacks(onTransitionNotStarted);
}
@Override
public void onTransitionEnd(Transition transition) {
listener.onChangeCompleted();
listener = null;
}
@Override
public void onTransitionCancel(Transition transition) {
listener.onChangeCompleted();
listener = null;
}
@Override
public void onTransitionPause(Transition transition) { }
@Override
public void onTransitionResume(Transition transition) { }
});
prepareForTransition(container, from, to, transition, isPush, new OnTransitionPreparedListener() {
@Override
public void onPrepared() {
if (!canceled) {
TransitionManager.beginDelayedTransition(container, transition);
executePropertyChanges(container, from, to, transition, isPush);
container.post(onTransitionNotStarted);
}
}
});
}
@Override
public boolean getRemovesFromViewOnPush() {
return true;
}
/**
* Called before a transition occurs. This can be used to reorder views, set their transition names, etc. The transition will begin
* when {@code onTransitionPreparedListener} is called.
*
* @param container The container these Views are hosted in
* @param from The previous View in the container or {@code null} if there was no Controller before this transition
* @param to The next View that should be put in the container or {@code null} if no Controller is being transitioned to
* @param transition The transition that is being prepared for
* @param isPush True if this is a push transaction, false if it's a pop
*/
public void prepareForTransition(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, @NonNull Transition transition, boolean isPush, @NonNull OnTransitionPreparedListener onTransitionPreparedListener) {
onTransitionPreparedListener.onPrepared();
}
/**
* This should set all view properties needed for the transition to work properly. By default it removes the "from" view
* and adds the "to" view.
*
* @param container The container these Views are hosted in
* @param from The previous View in the container or {@code null} if there was no Controller before this transition
* @param to The next View that should be put in the container or {@code null} if no Controller is being transitioned to
* @param transition The transition with which {@code TransitionManager.beginDelayedTransition} has been called. This will be null only if another ControllerChangeHandler immediately overrides this one.
* @param isPush True if this is a push transaction, false if it's a pop
*/
public void executePropertyChanges(@NonNull ViewGroup container, @Nullable View from, @Nullable View to, @Nullable Transition transition, boolean isPush) {
if (from != null && (getRemovesFromViewOnPush() || !isPush) && from.getParent() == container) {
container.removeView(from);
}
if (to != null && to.getParent() == null) {
container.addView(to);
}
}
}
@@ -0,0 +1,184 @@
package com.bluelinelabs.conductor.internal;
import android.graphics.Rect;
import android.view.View;
import android.view.ViewGroup;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.core.view.ViewCompat;
import androidx.transition.Transition;
import androidx.transition.TransitionSet;
import java.util.List;
import java.util.Map;
public class TransitionUtils {
public static void findNamedViews(@NonNull Map<String, View> namedViews, View view) {
if (view.getVisibility() == View.VISIBLE) {
String transitionName = ViewCompat.getTransitionName(view);
if (transitionName != null) {
namedViews.put(transitionName, view);
}
if (view instanceof ViewGroup) {
ViewGroup viewGroup = (ViewGroup) view;
int childCount = viewGroup.getChildCount();
for (int i = 0; i < childCount; i++) {
View child = viewGroup.getChildAt(i);
findNamedViews(namedViews, child);
}
}
}
}
@Nullable
public static View findNamedView(@NonNull View view, @NonNull String transitionName) {
if (transitionName.equals(ViewCompat.getTransitionName(view))) {
return view;
}
if (view instanceof ViewGroup) {
ViewGroup viewGroup = (ViewGroup) view;
int childCount = viewGroup.getChildCount();
for (int i = 0; i < childCount; i++) {
View viewWithTransitionName = findNamedView(viewGroup.getChildAt(i), transitionName);
if (viewWithTransitionName != null) {
return viewWithTransitionName;
}
}
}
return null;
}
public static void setEpicenter(@NonNull Transition transition, @Nullable View view) {
if (view != null) {
final Rect epicenter = new Rect();
getBoundsOnScreen(view, epicenter);
transition.setEpicenterCallback(new Transition.EpicenterCallback() {
@Override
public Rect onGetEpicenter(Transition transition) {
return epicenter;
}
});
}
}
public static void getBoundsOnScreen(@NonNull View view, @NonNull Rect epicenter) {
int[] loc = new int[2];
view.getLocationOnScreen(loc);
epicenter.set(loc[0], loc[1], loc[0] + view.getWidth(), loc[1] + view.getHeight());
}
public static void setTargets(@NonNull Transition transition, @NonNull View nonExistentView, @NonNull List<View> sharedViews) {
final List<View> views = transition.getTargets();
views.clear();
final int count = sharedViews.size();
for (int i = 0; i < count; i++) {
final View view = sharedViews.get(i);
bfsAddViewChildren(views, view);
}
views.add(nonExistentView);
sharedViews.add(nonExistentView);
addTargets(transition, sharedViews);
}
public static void addTargets(@Nullable Transition transition, @NonNull List<View> views) {
if (transition == null) {
return;
}
if (transition instanceof TransitionSet) {
TransitionSet set = (TransitionSet) transition;
int numTransitions = set.getTransitionCount();
for (int i = 0; i < numTransitions; i++) {
Transition child = set.getTransitionAt(i);
addTargets(child, views);
}
} else if (!hasSimpleTarget(transition)) {
List<View> targets = transition.getTargets();
if (isNullOrEmpty(targets)) {
int numViews = views.size();
for (int i = 0; i < numViews; i++) {
transition.addTarget(views.get(i));
}
}
}
}
public static void replaceTargets(@NonNull Transition transition, @NonNull List<View> oldTargets, @Nullable List<View> newTargets) {
if (transition instanceof TransitionSet) {
TransitionSet set = (TransitionSet) transition;
int numTransitions = set.getTransitionCount();
for (int i = 0; i < numTransitions; i++) {
Transition child = set.getTransitionAt(i);
replaceTargets(child, oldTargets, newTargets);
}
} else if (!TransitionUtils.hasSimpleTarget(transition)) {
List<View> targets = transition.getTargets();
if (targets != null && targets.size() == oldTargets.size() && targets.containsAll(oldTargets)) {
final int targetCount = newTargets == null ? 0 : newTargets.size();
for (int i = 0; i < targetCount; i++) {
transition.addTarget(newTargets.get(i));
}
for (int i = oldTargets.size() - 1; i >= 0; i--) {
transition.removeTarget(oldTargets.get(i));
}
}
}
}
private static void bfsAddViewChildren(@NonNull final List<View> views, @NonNull final View startView) {
final int startIndex = views.size();
if (containedBeforeIndex(views, startView, startIndex)) {
return; // This child is already in the list, so all its children are also.
}
views.add(startView);
for (int index = startIndex; index < views.size(); index++) {
final View view = views.get(index);
if (view instanceof ViewGroup) {
ViewGroup viewGroup = (ViewGroup) view;
final int childCount = viewGroup.getChildCount();
for (int childIndex = 0; childIndex < childCount; childIndex++) {
final View child = viewGroup.getChildAt(childIndex);
if (!containedBeforeIndex(views, child, startIndex)) {
views.add(child);
}
}
}
}
}
private static boolean containedBeforeIndex(@NonNull List<View> views, View view, int maxIndex) {
for (int i = 0; i < maxIndex; i++) {
if (views.get(i) == view) {
return true;
}
}
return false;
}
public static boolean hasSimpleTarget(@NonNull Transition transition) {
return !isNullOrEmpty(transition.getTargetIds())
|| !isNullOrEmpty(transition.getTargetNames())
|| !isNullOrEmpty(transition.getTargetTypes());
}
private static boolean isNullOrEmpty(@Nullable List list) {
return list == null || list.isEmpty();
}
@NonNull
public static TransitionSet mergeTransitions(int ordering, Transition... transitions) {
TransitionSet transitionSet = new TransitionSet();
for (Transition transition : transitions) {
if (transition != null) {
transitionSet.addTransition(transition);
}
}
transitionSet.setOrdering(ordering);
return transitionSet;
}
}
+37
View File
@@ -0,0 +1,37 @@
plugins {
id("com.android.library")
id("kotlin-android")
alias(libs.plugins.mvnpublish)
}
android {
compileSdk libs.versions.compilesdk.get() as Integer
compileOptions {
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_11
}
kotlinOptions {
jvmTarget = "11"
}
defaultConfig {
minSdkVersion libs.versions.minsdk.get()
targetSdkVersion libs.versions.targetsdk.get()
versionCode Integer.parseInt(project.VERSION_CODE)
versionName project.VERSION_NAME
}
namespace "com.bluelinelabs.conductor.viewpager"
}
dependencies {
testImplementation libs.junit
testImplementation libs.robolectric
implementation libs.androidx.appcompat
implementation project(':conductor')
}
ext.artifactId = 'conductor-viewpager'
@@ -0,0 +1,3 @@
POM_NAME=Conductor PagerAdapter
POM_ARTIFACT_ID=conductor-viewpager
POM_PACKAGING=aar
@@ -0,0 +1,211 @@
package com.bluelinelabs.conductor.viewpager;
import android.os.Bundle;
import android.os.Parcelable;
import android.util.SparseArray;
import android.view.View;
import android.view.ViewGroup;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.viewpager.widget.PagerAdapter;
import com.bluelinelabs.conductor.Controller;
import com.bluelinelabs.conductor.Router;
import com.bluelinelabs.conductor.RouterTransaction;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* An ViewPager adapter that uses Routers as pages
*/
public abstract class RouterPagerAdapter extends PagerAdapter {
private static final String KEY_SAVED_PAGES = "RouterPagerAdapter.savedStates";
private static final String KEY_TAGS_KEYS = "RouterPagerAdapter.tags.keys";
private static final String KEY_TAGS_VALUES = "RouterPagerAdapter.tags.values";
private static final String KEY_MAX_PAGES_TO_STATE_SAVE = "RouterPagerAdapter.maxPagesToStateSave";
private static final String KEY_SAVE_PAGE_HISTORY = "RouterPagerAdapter.savedPageHistory";
private final Controller host;
private int maxPagesToStateSave = Integer.MAX_VALUE;
private final Map<Integer, String> tags = new HashMap<>();
private SparseArray<Bundle> savedPages = new SparseArray<>();
private final SparseArray<Router> visibleRouters = new SparseArray<>();
private ArrayList<Integer> savedPageHistory = new ArrayList<>();
private Router currentPrimaryRouter;
/**
* Creates a new RouterPagerAdapter using the passed host.
*/
public RouterPagerAdapter(@NonNull Controller host) {
this.host = host;
}
/**
* Called when a router is instantiated. Here the router's root should be set if needed.
*
* @param router The router used for the page
* @param position The page position to be instantiated.
*/
public abstract void configureRouter(@NonNull Router router, int position);
/**
* Sets the maximum number of pages that will have their states saved. When this number is exceeded,
* the page that was state saved least recently will have its state removed from the save data.
*/
public void setMaxPagesToStateSave(int maxPagesToStateSave) {
if (maxPagesToStateSave < 0) {
throw new IllegalArgumentException("Only positive integers may be passed for maxPagesToStateSave.");
}
this.maxPagesToStateSave = maxPagesToStateSave;
ensurePagesSaved();
}
@Override
public Object instantiateItem(ViewGroup container, int position) {
final String name = makeRouterName(container.getId(), getItemId(position));
// Ensure we don't try to restore state for a router with a different ID just because
// the position was reused. Fixes https://github.com/bluelinelabs/Conductor/issues/582
if (tags.get(position) != null && !tags.get(position).equals(name)) {
savedPages.remove(position);
}
Router router = host.getChildRouter(container, name)
.setPopRootControllerMode(Router.PopRootControllerMode.NEVER);
if (!router.hasRootController()) {
Bundle routerSavedState = savedPages.get(position);
if (routerSavedState != null) {
router.restoreInstanceState(routerSavedState);
savedPages.remove(position);
savedPageHistory.remove((Integer) position);
}
}
router.rebindIfNeeded();
configureRouter(router, position);
if (router != currentPrimaryRouter) {
for (RouterTransaction transaction : router.getBackstack()) {
transaction.controller().setOptionsMenuHidden(true);
}
}
tags.put(position, name);
visibleRouters.put(position, router);
return router;
}
@Override
public void destroyItem(@NonNull ViewGroup container, int position, @NonNull Object object) {
Router router = (Router)object;
Bundle savedState = new Bundle();
router.saveInstanceState(savedState);
savedPages.put(position, savedState);
savedPageHistory.remove((Integer) position);
savedPageHistory.add(position);
ensurePagesSaved();
host.removeChildRouter(router);
visibleRouters.remove(position);
}
@Override
public void setPrimaryItem(@NonNull ViewGroup container, int position, @NonNull Object object) {
Router router = (Router) object;
if (router != currentPrimaryRouter) {
if (currentPrimaryRouter != null) {
for (RouterTransaction transaction : currentPrimaryRouter.getBackstack()) {
transaction.controller().setOptionsMenuHidden(true);
}
}
if (router != null) {
for (RouterTransaction transaction : router.getBackstack()) {
transaction.controller().setOptionsMenuHidden(false);
}
}
currentPrimaryRouter = router;
}
}
@Override
public boolean isViewFromObject(@NonNull View view, @NonNull Object object) {
Router router = (Router)object;
final List<RouterTransaction> backstack = router.getBackstack();
for (RouterTransaction transaction : backstack) {
if (transaction.controller().getView() == view) {
return true;
}
}
return false;
}
@Override
public Parcelable saveState() {
Bundle bundle = new Bundle();
bundle.putSparseParcelableArray(KEY_SAVED_PAGES, savedPages);
bundle.putIntegerArrayList(KEY_TAGS_KEYS, new ArrayList<>(tags.keySet()));
bundle.putStringArrayList(KEY_TAGS_VALUES, new ArrayList<>(tags.values()));
bundle.putInt(KEY_MAX_PAGES_TO_STATE_SAVE, maxPagesToStateSave);
bundle.putIntegerArrayList(KEY_SAVE_PAGE_HISTORY, savedPageHistory);
return bundle;
}
@Override
public void restoreState(Parcelable state, ClassLoader loader) {
Bundle bundle = (Bundle)state;
if (state != null) {
savedPages = bundle.getSparseParcelableArray(KEY_SAVED_PAGES);
maxPagesToStateSave = bundle.getInt(KEY_MAX_PAGES_TO_STATE_SAVE);
savedPageHistory = bundle.getIntegerArrayList(KEY_SAVE_PAGE_HISTORY);
List<Integer> tagsKeys = bundle.getIntegerArrayList(KEY_TAGS_KEYS);
List<String> tagsValues = bundle.getStringArrayList(KEY_TAGS_VALUES);
if (tagsKeys != null && tagsValues != null && tagsKeys.size() == tagsValues.size()) {
for (int i = 0; i < tagsKeys.size(); i++) {
tags.put(tagsKeys.get(i), tagsValues.get(i));
}
}
}
}
/**
* Returns the already instantiated Router in the specified position or {@code null} if there
* is no router associated with this position.
*/
@Nullable
public Router getRouter(int position) {
return visibleRouters.get(position);
}
public long getItemId(int position) {
return position;
}
SparseArray<Bundle> getSavedPages() {
return savedPages;
}
private void ensurePagesSaved() {
while (savedPages.size() > maxPagesToStateSave) {
int positionToRemove = savedPageHistory.remove(0);
savedPages.remove(positionToRemove);
}
}
private static String makeRouterName(int viewId, long id) {
return viewId + ":" + id;
}
}
@@ -0,0 +1,78 @@
package com.bluelinelabs.conductor.viewpager
import com.bluelinelabs.conductor.viewpager.util.TestActivity
import org.junit.Assert.assertEquals
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.Robolectric
import org.robolectric.RobolectricTestRunner
import org.robolectric.annotation.Config
@RunWith(RobolectricTestRunner::class)
@Config(manifest = Config.NONE)
class StateSaveTests {
private val testController = Robolectric.buildActivity(TestActivity::class.java)
.setup()
.get()
.testController()
private val pagerAdapter = testController.pagerAdapter
private val pager = testController.pager
private val destroyedItems = testController.destroyedItems
@Test
fun testNoMaxSaves() {
// Load all pages
for (i in 0 until pagerAdapter.count) {
pager.currentItem = i
}
// Ensure all non-visible pages are saved
assertEquals(
destroyedItems.size,
pagerAdapter.savedPages.size()
)
}
@Test
fun testMaxSavedSet() {
val maxPages = 3
pagerAdapter.setMaxPagesToStateSave(maxPages)
// Load all pages
for (i in 0 until pagerAdapter.count) {
pager.currentItem = i
}
val firstSelectedItem = pagerAdapter.count / 2
for (i in pagerAdapter.count downTo firstSelectedItem) {
pager.currentItem = i
}
var savedPages = pagerAdapter.savedPages
// Ensure correct number of pages are saved
assertEquals(maxPages, savedPages.size())
// Ensure correct pages are saved
assertEquals(destroyedItems[destroyedItems.lastIndex], savedPages.keyAt(0))
assertEquals(destroyedItems[destroyedItems.lastIndex - 1], savedPages.keyAt(1))
assertEquals(destroyedItems[destroyedItems.lastIndex - 2], savedPages.keyAt(2))
val secondSelectedItem = 1
for (i in firstSelectedItem downTo secondSelectedItem) {
pager.currentItem = i
}
savedPages = pagerAdapter.savedPages
// Ensure correct number of pages are saved
assertEquals(maxPages, savedPages.size())
// Ensure correct pages are saved
assertEquals(destroyedItems[destroyedItems.lastIndex], savedPages.keyAt(0))
assertEquals(destroyedItems[destroyedItems.lastIndex - 1], savedPages.keyAt(1))
assertEquals(destroyedItems[destroyedItems.lastIndex - 2], savedPages.keyAt(2))
}
}
@@ -0,0 +1,85 @@
package com.bluelinelabs.conductor.viewpager.util
import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import android.widget.FrameLayout
import androidx.core.view.ViewCompat
import androidx.fragment.app.FragmentActivity
import androidx.viewpager.widget.ViewPager
import com.bluelinelabs.conductor.Conductor
import com.bluelinelabs.conductor.Controller
import com.bluelinelabs.conductor.Router
import com.bluelinelabs.conductor.RouterTransaction
import com.bluelinelabs.conductor.asTransaction
import com.bluelinelabs.conductor.viewpager.RouterPagerAdapter
class TestActivity : FragmentActivity() {
private lateinit var router: Router
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
router = Conductor.attachRouter(
this,
findViewById(android.R.id.content),
savedInstanceState
)
if (!router.hasRootController()) {
router.setRoot(TestController().asTransaction())
}
}
fun testController(): TestController {
return router.backstack.single().controller as TestController
}
}
class TestController : Controller() {
val destroyedItems = mutableListOf<Int>()
lateinit var pagerAdapter: RouterPagerAdapter
lateinit var pager: ViewPager
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup,
savedViewState: Bundle?
): View {
pager = ViewPager(container.context).also {
it.id = ViewCompat.generateViewId()
}
pager.offscreenPageLimit = 1
pagerAdapter = object : RouterPagerAdapter(this) {
override fun configureRouter(router: Router, position: Int) {
if (!router.hasRootController()) {
router.setRoot(RouterTransaction.with(PageController()))
}
}
override fun getCount(): Int {
return 20
}
override fun destroyItem(container: ViewGroup, position: Int, `object`: Any) {
super.destroyItem(container, position, `object`)
destroyedItems.add(position)
}
}
pager.adapter = pagerAdapter
return pager
}
}
class PageController : Controller() {
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup,
savedViewState: Bundle?
): View {
return FrameLayout(container.context)
}
}
+45
View File
@@ -0,0 +1,45 @@
plugins {
id("com.android.library")
id("kotlin-android")
id("kotlin-parcelize")
alias(libs.plugins.mvnpublish)
}
android {
compileSdk libs.versions.compilesdk.get() as Integer
compileOptions {
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_11
}
kotlinOptions {
jvmTarget = "11"
}
defaultConfig {
minSdkVersion libs.versions.minsdk.get()
targetSdkVersion libs.versions.targetsdk.get()
versionCode Integer.parseInt(project.VERSION_CODE)
versionName project.VERSION_NAME
}
testOptions {
unitTests {
includeAndroidResources = true
}
}
namespace "com.bluelinelabs.conductor.viewpager2"
}
dependencies {
testImplementation libs.junit
testImplementation libs.robolectric
implementation libs.androidx.appcompat
implementation libs.androidx.viewpager2
implementation project(':conductor')
}
ext.artifactId = 'conductor-viewpager2'
@@ -0,0 +1,3 @@
POM_NAME=Conductor ViewPager2 Adapter
POM_ARTIFACT_ID=conductor-viewpager2
POM_PACKAGING=aar
@@ -0,0 +1,256 @@
package com.bluelinelabs.conductor.viewpager2
import android.os.Bundle
import android.os.Parcelable
import android.util.LongSparseArray
import android.util.SparseArray
import android.view.ViewGroup
import androidx.recyclerview.widget.RecyclerView
import androidx.viewpager2.adapter.StatefulAdapter
import androidx.viewpager2.widget.ViewPager2
import com.bluelinelabs.conductor.Controller
import com.bluelinelabs.conductor.Router
import kotlinx.parcelize.Parcelize
/**
* An ViewPager2 adapter that uses Routers as pages
*/
abstract class RouterStateAdapter(private val host: Controller) :
RecyclerView.Adapter<RouterViewHolder>(), StatefulAdapter {
private var savedPages = LongSparseArray<Bundle>()
internal var savedPageHistory = mutableListOf<Long>()
private var maxPagesToStateSave = Int.MAX_VALUE
private val visibleRouters = SparseArray<Router>()
private var currentPrimaryRouterPosition = 0
private var primaryItemCallback: PrimaryItemCallback? = null
init {
super.setHasStableIds(true)
}
/**
* Called when a router is instantiated. Here the router's root should be set if needed.
*
* @param router The router used for the page
* @param position The page position to be instantiated.
*/
abstract fun configureRouter(router: Router, position: Int)
/**
* Sets the maximum number of pages that will have their states saved. When this number is exceeded,
* the page that was state saved least recently will have its state removed from the save data.
*/
open fun setMaxPagesToStateSave(maxPagesToStateSave: Int) {
require(maxPagesToStateSave >= 0) { "Only positive integers may be passed for maxPagesToStateSave." }
this.maxPagesToStateSave = maxPagesToStateSave
ensurePagesSaved()
}
private fun inferViewPager(recyclerView: RecyclerView): ViewPager2 {
return recyclerView.parent as? ViewPager2
?: error("Expected ViewPager2 instance. Got: ${recyclerView.parent}")
}
override fun onAttachedToRecyclerView(recyclerView: RecyclerView) {
val viewPager = inferViewPager(recyclerView)
primaryItemCallback = PrimaryItemCallback().also {
viewPager.registerOnPageChangeCallback(it)
}
}
override fun onDetachedFromRecyclerView(recyclerView: RecyclerView) {
val viewPager = inferViewPager(recyclerView)
primaryItemCallback?.let {
viewPager.unregisterOnPageChangeCallback(it)
}
primaryItemCallback = null
}
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RouterViewHolder {
return RouterViewHolder(parent)
}
override fun onBindViewHolder(holder: RouterViewHolder, position: Int) {
holder.currentItemPosition = position
attachRouter(holder, position)
}
override fun onViewAttachedToWindow(holder: RouterViewHolder) {
super.onViewAttachedToWindow(holder)
if (!holder.attached) {
attachRouter(holder, holder.currentItemPosition)
}
}
override fun onViewDetachedFromWindow(holder: RouterViewHolder) {
super.onViewDetachedFromWindow(holder)
detachRouter(holder)
// Controller has fully detached and destroyed its view reference by now. Remove the leftover
// view from the container.
holder.container.removeAllViews()
}
override fun onViewRecycled(holder: RouterViewHolder) {
super.onViewRecycled(holder)
detachRouter(holder)
holder.currentRouter?.let { router ->
host.removeChildRouter(router)
holder.currentRouter = null
}
}
override fun onFailedToRecycleView(holder: RouterViewHolder): Boolean {
return true
}
override fun getItemId(position: Int): Long {
return position.toLong()
}
override fun setHasStableIds(hasStableIds: Boolean) {
throw UnsupportedOperationException("Stable Ids are required for the adapter to function properly")
}
override fun saveState(): Parcelable {
// Ensure all visible pages are saved, starting at the outermost pages and working our way in
val visiblePositions = (0 until visibleRouters.size())
.map { visibleRouters.keyAt(it) }.toMutableList()
while (visiblePositions.isNotEmpty()) {
val lastPosition = visiblePositions.removeAt(visiblePositions.lastIndex)
savePage(getItemId(lastPosition), visibleRouters[lastPosition])
if (visiblePositions.isNotEmpty()) {
val firstPosition = visiblePositions.removeAt(0)
savePage(getItemId(firstPosition), visibleRouters[firstPosition])
}
}
return SavedState(
savedPagesKeys = (0 until savedPages.size()).map { savedPages.keyAt(it) },
savedPagesValues = (0 until savedPages.size()).map { savedPages.valueAt(it) },
savedPageHistory = savedPageHistory,
maxPagesToStateSave = maxPagesToStateSave
)
}
override fun restoreState(state: Parcelable) {
if (state !is SavedState) return
savedPages = LongSparseArray()
state.savedPagesKeys.indices.forEach { index ->
savedPages.put(state.savedPagesKeys[index], state.savedPagesValues[index])
}
savedPageHistory = state.savedPageHistory.toMutableList()
maxPagesToStateSave = state.maxPagesToStateSave
}
private fun attachRouter(holder: RouterViewHolder, position: Int) {
val itemId = getItemId(position)
val router = host.getChildRouter(holder.container, "$itemId", true, false)!!
.setPopRootControllerMode(Router.PopRootControllerMode.NEVER)
// This should have already been handled by onViewRecycled, but it seems like this wasn't
// always reliably called
if (router != holder.currentRouter) {
holder.currentRouter?.let { host.removeChildRouter(it) }
}
holder.currentRouter = router
holder.currentItemId = itemId
if (!router.hasRootController()) {
val routerSavedState = savedPages[itemId]
if (routerSavedState != null) {
router.restoreInstanceState(routerSavedState)
savedPages.remove(itemId)
savedPageHistory.remove(itemId)
}
}
router.rebindIfNeeded()
configureRouter(router, position)
if (position != currentPrimaryRouterPosition) {
for (transaction in router.backstack) {
transaction.controller.setOptionsMenuHidden(true)
}
}
visibleRouters.put(position, router)
holder.attached = true
}
private fun detachRouter(holder: RouterViewHolder) {
if (!holder.attached) {
return
}
holder.currentRouter?.let { router ->
router.prepareForHostDetach()
savePage(holder.currentItemId, router)
if (visibleRouters[holder.currentItemPosition] == router) {
visibleRouters.remove(holder.currentItemPosition)
}
}
holder.attached = false
}
private fun savePage(itemId: Long, router: Router) {
val savedState = Bundle()
router.saveInstanceState(savedState)
savedPages.put(itemId, savedState)
savedPageHistory.remove(itemId)
savedPageHistory.add(itemId)
ensurePagesSaved()
}
private fun ensurePagesSaved() {
while (savedPages.size() > maxPagesToStateSave) {
val routerIdToRemove = savedPageHistory.removeAt(0)
savedPages.remove(routerIdToRemove)
}
}
/**
* Returns the already instantiated Router in the specified position or `null` if there
* is no router associated with this position.
*/
fun getRouter(position: Int): Router? {
return visibleRouters[position]
}
inner class PrimaryItemCallback : ViewPager2.OnPageChangeCallback() {
override fun onPageSelected(position: Int) {
val router = visibleRouters[position]
if (position != currentPrimaryRouterPosition) {
val previousRouter = visibleRouters[currentPrimaryRouterPosition]
previousRouter?.backstack?.forEach { it.controller.setOptionsMenuHidden(true) }
router?.backstack?.forEach { it.controller.setOptionsMenuHidden(false) }
currentPrimaryRouterPosition = position
}
}
}
@Parcelize
private data class SavedState(
val savedPagesKeys: List<Long>,
val savedPagesValues: List<Bundle>,
val savedPageHistory: List<Long>,
val maxPagesToStateSave: Int
) : Parcelable
}
@@ -0,0 +1,27 @@
package com.bluelinelabs.conductor.viewpager2
import android.view.ViewGroup
import androidx.core.view.ViewCompat
import androidx.recyclerview.widget.RecyclerView.ViewHolder
import com.bluelinelabs.conductor.ChangeHandlerFrameLayout
import com.bluelinelabs.conductor.Router
class RouterViewHolder private constructor(val container: ChangeHandlerFrameLayout) : ViewHolder(container) {
var currentRouter: Router? = null
var currentItemPosition = 0
var currentItemId = 0L
var attached = false
companion object {
operator fun invoke(parent: ViewGroup): RouterViewHolder {
val container = ChangeHandlerFrameLayout(parent.context)
container.id = ViewCompat.generateViewId()
container.layoutParams = ViewGroup.LayoutParams(
ViewGroup.LayoutParams.MATCH_PARENT,
ViewGroup.LayoutParams.MATCH_PARENT
)
container.isSaveEnabled = false
return RouterViewHolder(container)
}
}
}
@@ -0,0 +1,119 @@
package com.bluelinelabs.conductor.viewpager2
import android.os.Looper.getMainLooper
import android.widget.FrameLayout
import androidx.core.view.ViewCompat
import androidx.fragment.app.FragmentActivity
import androidx.viewpager2.widget.ViewPager2
import com.bluelinelabs.conductor.Conductor
import com.bluelinelabs.conductor.Router
import com.bluelinelabs.conductor.RouterTransaction.Companion.with
import com.bluelinelabs.conductor.viewpager2.util.TestController
import org.junit.Assert.assertEquals
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.Robolectric
import org.robolectric.RobolectricTestRunner
import org.robolectric.Shadows.shadowOf
import org.robolectric.annotation.Config
@RunWith(RobolectricTestRunner::class)
@Config(manifest = Config.NONE)
class StateSaveTests {
private val pager: ViewPager2
private val adapter: RouterStateAdapter
private val destroyedItems = mutableListOf<Int>()
init {
val activityController = Robolectric.buildActivity(FragmentActivity::class.java).setup()
val layout = FrameLayout(activityController.get())
activityController.get().setContentView(layout)
val router = Conductor.attachRouter(activityController.get(), FrameLayout(activityController.get()), null)
val controller = TestController()
router.setRoot(with(controller))
pager = ViewPager2(activityController.get()).also {
it.id = ViewCompat.generateViewId()
}
layout.addView(pager)
pager.offscreenPageLimit = 1
adapter = object : RouterStateAdapter(controller) {
override fun configureRouter(router: Router, position: Int) {
if (!router.hasRootController()) {
router.setRoot(with(TestController()))
}
}
override fun getItemCount(): Int {
return 20
}
override fun onViewDetachedFromWindow(holder: RouterViewHolder) {
super.onViewDetachedFromWindow(holder)
destroyedItems.add(holder.currentItemPosition)
}
}
pager.adapter = adapter
shadowOf(getMainLooper()).idle()
}
@Test
fun testNoMaxSaves() {
// Load all pages
for (i in 0 until adapter.itemCount) {
pager.setCurrentItem(i, false)
shadowOf(getMainLooper()).idle()
}
// Ensure all non-visible pages are saved
assertEquals(
destroyedItems.size,
adapter.savedPageHistory.size
)
}
@Test
fun testMaxSavedSet() {
val maxPages = 3
adapter.setMaxPagesToStateSave(maxPages)
// Load all pages
for (i in 0 until adapter.itemCount) {
pager.setCurrentItem(i, false)
shadowOf(getMainLooper()).idle()
}
val firstSelectedItem = adapter.itemCount / 2
for (i in adapter.itemCount downTo firstSelectedItem) {
pager.setCurrentItem(i, false)
shadowOf(getMainLooper()).idle()
}
var savedPages = adapter.savedPageHistory
// Ensure correct number of pages are saved
assertEquals(maxPages, savedPages.size)
// Ensure correct pages are saved
assertEquals(destroyedItems[destroyedItems.lastIndex], savedPages[savedPages.lastIndex].toInt())
assertEquals(destroyedItems[destroyedItems.lastIndex - 1], savedPages[savedPages.lastIndex - 1].toInt())
assertEquals(destroyedItems[destroyedItems.lastIndex - 2], savedPages[savedPages.lastIndex - 2].toInt())
val secondSelectedItem = 1
for (i in adapter.itemCount downTo secondSelectedItem) {
pager.setCurrentItem(i, false)
shadowOf(getMainLooper()).idle()
}
savedPages = adapter.savedPageHistory
// Ensure correct number of pages are saved
assertEquals(maxPages, savedPages.size)
// Ensure correct pages are saved
assertEquals(destroyedItems[destroyedItems.lastIndex], savedPages[savedPages.lastIndex].toInt())
assertEquals(destroyedItems[destroyedItems.lastIndex - 1], savedPages[savedPages.lastIndex - 1].toInt())
assertEquals(destroyedItems[destroyedItems.lastIndex - 2], savedPages[savedPages.lastIndex - 2].toInt())
}
}
@@ -0,0 +1,21 @@
package com.bluelinelabs.conductor.viewpager2.util;
import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.FrameLayout;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.bluelinelabs.conductor.Controller;
public class TestController extends Controller {
@Override @NonNull
protected View onCreateView(@NonNull LayoutInflater inflater, @NonNull ViewGroup container, @Nullable Bundle savedViewState) {
return new FrameLayout(inflater.getContext());
}
}
-35
View File
@@ -1,35 +0,0 @@
apply plugin: 'com.android.library'
android {
compileSdkVersion rootProject.ext.compileSdkVersion
buildToolsVersion rootProject.ext.buildToolsVersion
lintOptions {
abortOnError false
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_7
targetCompatibility JavaVersion.VERSION_1_7
}
defaultConfig {
minSdkVersion rootProject.ext.minSdkVersion
targetSdkVersion rootProject.ext.targetSdkVersion
versionCode rootProject.ext.versionCode
versionName rootProject.ext.versionName
}
}
dependencies {
compile rootProject.ext.rxJava
compile rootProject.ext.rxAndroid
compile rootProject.ext.rxLifecycle
compile project(':conductor')
}
ext.artifactId = 'conductor-rxlifecycle'
apply from: rootProject.file('dependencies.gradle')
apply from: rootProject.file('bll-gradle-push.gradle')
@@ -1,3 +0,0 @@
<manifest package="com.bluelinelabs.conductor.rxlifecycle">
<application />
</manifest>
@@ -1,12 +0,0 @@
package com.bluelinelabs.conductor.rxlifecycle;
public enum ControllerEvent {
CREATE,
CREATE_VIEW,
ATTACH,
DETACH,
DESTROY_VIEW,
DESTROY
}
@@ -1,38 +0,0 @@
package com.bluelinelabs.conductor.rxlifecycle;
import android.support.annotation.CheckResult;
import android.support.annotation.NonNull;
import rx.Observable;
/**
* Interface used for RxController. Can also be used if writing your own Controller component without subclassing RxController.
*/
public interface ControllerLifecycleProvider {
/**
* @return An observable that will have all {@link com.bluelinelabs.conductor.Controller} lifecycle events
*/
@NonNull
@CheckResult
Observable<ControllerEvent> lifecycle();
/**
* Will bind the source until a specific {@link ControllerEvent} occurs.
*
* @param event The {@link ControllerEvent} that should cause onComplete to be called
* @return A {@link rx.Observable.Transformer} that will call onComplete when the event occurs.
*/
@NonNull
@CheckResult
<T> Observable.Transformer<T, T> bindUntilEvent(@NonNull ControllerEvent event);
/**
* Will bind the source until the next reasonable {@link ControllerEvent} occurs.
* @return A {@link rx.Observable.Transformer} that will call onComplete when the event occurs.
*/
@NonNull
@CheckResult
<T> Observable.Transformer<T, T> bindToLifecycle();
}
@@ -1,52 +0,0 @@
package com.bluelinelabs.conductor.rxlifecycle;
import android.support.annotation.NonNull;
import android.view.View;
import com.bluelinelabs.conductor.Controller;
import com.bluelinelabs.conductor.Controller.LifecycleListener;
import rx.subjects.BehaviorSubject;
/**
* A simple utility class that will create a {@link BehaviorSubject} that calls onNext when events
* occur in your {@link Controller}
*/
public class ControllerLifecycleSubjectHelper {
private ControllerLifecycleSubjectHelper() { }
public static BehaviorSubject<ControllerEvent> create(Controller controller) {
final BehaviorSubject<ControllerEvent> subject = BehaviorSubject.create(ControllerEvent.CREATE);
controller.addLifecycleListener(new LifecycleListener() {
@Override
public void preCreateView(@NonNull Controller controller) {
subject.onNext(ControllerEvent.CREATE_VIEW);
}
@Override
public void preAttach(@NonNull Controller controller, @NonNull View view) {
subject.onNext(ControllerEvent.ATTACH);
}
@Override
public void preDetach(@NonNull Controller controller, @NonNull View view) {
subject.onNext(ControllerEvent.DETACH);
}
@Override
public void preDestroyView(@NonNull Controller controller, @NonNull View view) {
subject.onNext(ControllerEvent.DESTROY_VIEW);
}
@Override
public void preDestroy(@NonNull Controller controller) {
subject.onNext(ControllerEvent.DESTROY);
}
});
return subject;
}
}
@@ -1,50 +0,0 @@
package com.bluelinelabs.conductor.rxlifecycle;
import android.os.Bundle;
import android.support.annotation.CheckResult;
import android.support.annotation.NonNull;
import com.bluelinelabs.conductor.Controller;
import com.trello.rxlifecycle.RxLifecycle;
import rx.Observable;
import rx.subjects.BehaviorSubject;
/**
* A base {@link Controller} that can be used to expose lifecycle events using RxJava
*/
public abstract class RxController extends Controller implements ControllerLifecycleProvider {
private final BehaviorSubject<ControllerEvent> mLifecycleSubject;
public RxController() {
this(null);
}
public RxController(Bundle args) {
super(args);
mLifecycleSubject = ControllerLifecycleSubjectHelper.create(this);
}
@Override
@NonNull
@CheckResult
public final Observable<ControllerEvent> lifecycle() {
return mLifecycleSubject.asObservable();
}
@Override
@NonNull
@CheckResult
public final <T> Observable.Transformer<T, T> bindUntilEvent(@NonNull ControllerEvent event) {
return RxLifecycle.bindUntilEvent(mLifecycleSubject, event);
}
@Override
@NonNull
@CheckResult
public final <T> Observable.Transformer<T, T> bindToLifecycle() {
return RxControllerLifecycle.bindController(mLifecycleSubject);
}
}
@@ -1,45 +0,0 @@
package com.bluelinelabs.conductor.rxlifecycle;
import android.support.annotation.CheckResult;
import android.support.annotation.NonNull;
import com.trello.rxlifecycle.OutsideLifecycleException;
import com.trello.rxlifecycle.RxLifecycle;
import rx.Observable;
import rx.functions.Func1;
public class RxControllerLifecycle {
/**
* Binds the given source to a Controller lifecycle. This is the Controller version of
* {@link com.trello.rxlifecycle.RxLifecycle#bindFragment(Observable)}.
*
* @param lifecycle the lifecycle sequence of a Controller
* @return a reusable {@link Observable.Transformer} that unsubscribes the source during the Controller lifecycle
*/
@NonNull
@CheckResult
public static <T> Observable.Transformer<T, T> bindController(@NonNull final Observable<ControllerEvent> lifecycle) {
return RxLifecycle.bind(lifecycle, CONTROLLER_LIFECYCLE);
}
private static final Func1<ControllerEvent, ControllerEvent> CONTROLLER_LIFECYCLE =
new Func1<ControllerEvent, ControllerEvent>() {
@Override
public ControllerEvent call(ControllerEvent lastEvent) {
switch (lastEvent) {
case CREATE:
return ControllerEvent.DESTROY;
case ATTACH:
return ControllerEvent.DETACH;
case CREATE_VIEW:
return ControllerEvent.DESTROY_VIEW;
case DETACH:
return ControllerEvent.DESTROY;
default:
throw new OutsideLifecycleException("Cannot bind to Controller lifecycle when outside of it.");
}
}
};
}
-32
View File
@@ -1,32 +0,0 @@
apply plugin: 'com.android.library'
android {
compileSdkVersion rootProject.ext.compileSdkVersion
buildToolsVersion rootProject.ext.buildToolsVersion
lintOptions {
abortOnError false
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_7
targetCompatibility JavaVersion.VERSION_1_7
}
defaultConfig {
minSdkVersion rootProject.ext.minSdkVersion
targetSdkVersion rootProject.ext.targetSdkVersion
versionCode rootProject.ext.versionCode
versionName rootProject.ext.versionName
}
}
dependencies {
compile rootProject.ext.supportAppCompat
compile project(':conductor')
}
ext.artifactId = 'conductor-support'
apply from: rootProject.file('dependencies.gradle')
apply from: rootProject.file('bll-gradle-push.gradle')
@@ -1,3 +0,0 @@
<manifest package="com.bluelinelabs.conductor.support">
<application />
</manifest>
@@ -1,63 +0,0 @@
package com.bluelinelabs.conductor.support;
import android.support.v4.view.PagerAdapter;
import android.view.View;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.ChildControllerTransaction;
import com.bluelinelabs.conductor.Controller;
/**
* An adapter for ViewPagers that will handle adding and removing Controllers
*/
public abstract class ControllerPagerAdapter extends PagerAdapter {
private final Controller mHost;
/**
* Creates a new ControllerPagerAdapter using the passed host.
*/
public ControllerPagerAdapter(Controller host) {
mHost = host;
}
/**
* Return the Controller associated with a specified position.
*/
public abstract Controller getItem(int position);
@Override
public Object instantiateItem(ViewGroup container, int position) {
final String name = makeControllerName(container.getId(), getItemId(position));
Controller controller = mHost.getChildController(name);
if (controller == null) {
controller = getItem(position);
mHost.addChildController(ChildControllerTransaction.builder(controller, container.getId())
.tag(name)
.build());
}
return controller;
}
@Override
public void destroyItem(ViewGroup container, int position, Object object) {
mHost.removeChildController((Controller)object);
}
@Override
public boolean isViewFromObject(View view, Object object) {
return ((Controller)object).getView() == view;
}
public long getItemId(int position) {
return position;
}
private static String makeControllerName(int viewId, long id) {
return viewId + ":" + id;
}
}
Executable → Regular
+28 -51
View File
@@ -1,70 +1,47 @@
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'de.mobilej.unmock:UnMockPlugin:0.3.6'
}
plugins {
id("com.android.library")
id("kotlin-android")
id("kotlin-parcelize")
alias(libs.plugins.mvnpublish)
}
apply plugin: 'com.android.library'
apply plugin: 'de.mobilej.unmock'
android {
compileSdkVersion rootProject.ext.compileSdkVersion
buildToolsVersion rootProject.ext.buildToolsVersion
lintOptions {
abortOnError false
}
compileSdk libs.versions.compilesdk.get() as Integer
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_7
targetCompatibility JavaVersion.VERSION_1_7
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_11
}
kotlinOptions {
jvmTarget = "11"
}
defaultConfig {
minSdkVersion rootProject.ext.minSdkVersion
targetSdkVersion rootProject.ext.targetSdkVersion
versionCode rootProject.ext.versionCode
versionName rootProject.ext.versionName
minSdkVersion libs.versions.minsdk.get()
targetSdkVersion libs.versions.targetsdk.get()
versionCode Integer.parseInt(project.VERSION_CODE)
versionName project.VERSION_NAME
consumerProguardFiles 'proguard-rules.txt'
}
}
configurations {
lintChecks
namespace "com.bluelinelabs.conductor"
}
dependencies {
testCompile rootProject.ext.junit
testCompile rootProject.ext.roboelectric
api libs.androidx.activity
api libs.androidx.appcompat
api libs.androidx.savedstate.ktx
testImplementation libs.junit
testImplementation libs.robolectric
testImplementation libs.kotest
compile rootProject.ext.supportAnnotations
api libs.androidx.lifecycle.runtime
lintChecks project(path: ':conductor-lint', configuration: 'lintChecks')
}
api libs.androidx.annotation
api libs.kotlin.stdlib
unMock {
downloadFrom 'https://oss.sonatype.org/content/groups/public/org/robolectric/android-all/4.3_r2-robolectric-0/android-all-4.3_r2-robolectric-0.jar'
keep "android.os.Bundle"
keep "android.os.BaseBundle"
keep "android.text.TextUtils"
}
task copyLintJar(type: Copy) {
from(configurations.lintChecks) {
rename { 'lint.jar' }
}
into 'build/intermediates/lint/'
}
project.afterEvaluate {
def compileLintTask = project.tasks.find { it.name == 'compileLint' }
compileLintTask.dependsOn(copyLintJar)
lintPublish project(':conductor-lint')
}
ext.artifactId = 'conductor'
apply from: rootProject.file('dependencies.gradle')
apply from: rootProject.file('bll-gradle-push.gradle')
+3
View File
@@ -0,0 +1,3 @@
POM_NAME=Conductor
POM_ARTIFACT_ID=conductor
POM_PACKAGING=aar
+8
View File
@@ -0,0 +1,8 @@
# Retain constructor that is called by using reflection to recreate the Controller
-keepclassmembers public class * extends com.bluelinelabs.conductor.Controller {
public <init>();
public <init>(android.os.Bundle);
}
-keepclassmembers public class * extends com.bluelinelabs.conductor.ControllerChangeHandler {
public <init>();
}
-3
View File
@@ -1,3 +0,0 @@
<manifest package="com.bluelinelabs.conductor">
<application />
</manifest>
@@ -0,0 +1,146 @@
package com.bluelinelabs.conductor;
import android.app.Activity;
import android.content.Intent;
import android.content.IntentSender;
import android.content.IntentSender.SendIntentException;
import android.os.Bundle;
import android.view.ViewGroup;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.bluelinelabs.conductor.ControllerChangeHandler.ControllerChangeListener;
import com.bluelinelabs.conductor.internal.LifecycleHandler;
import com.bluelinelabs.conductor.internal.TransactionIndexer;
import java.util.List;
public class ActivityHostedRouter extends Router {
private LifecycleHandler lifecycleHandler;
private final TransactionIndexer transactionIndexer = new TransactionIndexer();
public ActivityHostedRouter() {
popRootControllerMode = PopRootControllerMode.NEVER;
}
public final void setHost(@NonNull LifecycleHandler lifecycleHandler, @NonNull ViewGroup container) {
if (this.lifecycleHandler != lifecycleHandler || this.container != container) {
if (this.container != null && this.container instanceof ControllerChangeListener) {
removeChangeListener((ControllerChangeListener)this.container);
}
if (container instanceof ControllerChangeListener) {
addChangeListener((ControllerChangeListener)container);
}
this.lifecycleHandler = lifecycleHandler;
this.container = container;
watchContainerAttach();
}
}
@Override
public void saveInstanceState(@NonNull Bundle outState) {
super.saveInstanceState(outState);
transactionIndexer.saveInstanceState(outState);
}
@Override
public void restoreInstanceState(@NonNull Bundle savedInstanceState) {
super.restoreInstanceState(savedInstanceState);
transactionIndexer.restoreInstanceState(savedInstanceState);
}
@Override @Nullable
public Activity getActivity() {
return lifecycleHandler != null ? lifecycleHandler.getLifecycleActivity() : null;
}
@Override
public void onActivityDestroyed(@NonNull Activity activity, boolean isConfigurationChange) {
super.onActivityDestroyed(activity, isConfigurationChange);
if (!isConfigurationChange) {
lifecycleHandler = null;
}
}
@Override
public final void invalidateOptionsMenu() {
if (lifecycleHandler != null && getActivity() != null) {
getActivity().invalidateOptionsMenu();
}
}
@Override
public void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
lifecycleHandler.onActivityResult(requestCode, resultCode, data);
}
@Override
void startActivity(@NonNull Intent intent) {
lifecycleHandler.startActivity(intent);
}
@Override
void startActivityForResult(@NonNull String instanceId, @NonNull Intent intent, int requestCode) {
lifecycleHandler.startActivityForResult(instanceId, intent, requestCode, null);
}
@Override
void startActivityForResult(@NonNull String instanceId, @NonNull Intent intent, int requestCode, @Nullable Bundle options) {
lifecycleHandler.startActivityForResult(instanceId, intent, requestCode, options);
}
@Override
void startIntentSenderForResult(@NonNull String instanceId, @NonNull IntentSender intent, int requestCode, @Nullable Intent fillInIntent,
int flagsMask, int flagsValues, int extraFlags, @Nullable Bundle options) throws SendIntentException {
lifecycleHandler.startIntentSenderForResult(instanceId, intent, requestCode, fillInIntent, flagsMask, flagsValues, extraFlags, options);
}
@Override
void registerForActivityResult(@NonNull String instanceId, int requestCode) {
lifecycleHandler.registerForActivityResult(instanceId, requestCode);
}
@Override
void unregisterForActivityResults(@NonNull String instanceId) {
lifecycleHandler.unregisterForActivityResults(instanceId);
}
@Override
void requestPermissions(@NonNull String instanceId, @NonNull String[] permissions, int requestCode) {
lifecycleHandler.requestPermissions(instanceId, permissions, requestCode);
}
@Override
boolean hasHost() {
return lifecycleHandler != null;
}
@Override @NonNull
List<Router> getSiblingRouters() {
return lifecycleHandler.getRouters();
}
@Override @NonNull
Router getRootRouter() {
return this;
}
@Override @NonNull
TransactionIndexer getTransactionIndexer() {
return transactionIndexer;
}
@Override
public void onContextAvailable() {
super.onContextAvailable();
}
}
@@ -1,96 +0,0 @@
package com.bluelinelabs.conductor;
import android.os.Bundle;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
class Backstack implements Iterable<RouterTransaction> {
private static final String KEY_ENTRIES = "Backstack.entries";
private final ArrayDeque<RouterTransaction> mBackStack = new ArrayDeque<>();
@SuppressWarnings("BooleanMethodIsAlwaysInverted")
public boolean isEmpty() {
return mBackStack.isEmpty();
}
public int size() {
return mBackStack.size();
}
public RouterTransaction root() {
return mBackStack.size() > 0 ? mBackStack.getLast() : null;
}
@Override
public Iterator<RouterTransaction> iterator() {
return mBackStack.iterator();
}
public Iterator<RouterTransaction> reverseIterator() {
return mBackStack.descendingIterator();
}
public List<RouterTransaction> popTo(RouterTransaction transaction) {
List<RouterTransaction> popped = new ArrayList<>();
if (mBackStack.contains(transaction)) {
while (mBackStack.peek() != transaction) {
RouterTransaction poppedTransaction = pop();
popped.add(poppedTransaction);
}
} else {
throw new RuntimeException("Tried to pop to a transaction that was not on the back stack");
}
return popped;
}
public RouterTransaction pop() {
RouterTransaction popped = mBackStack.pop();
popped.getController().destroy();
return popped;
}
public RouterTransaction peek() {
return mBackStack.peek();
}
public void remove(RouterTransaction transaction) {
mBackStack.removeFirstOccurrence(transaction);
}
public void push(RouterTransaction transaction) {
mBackStack.push(transaction);
}
public List<RouterTransaction> popAll() {
List<RouterTransaction> list = new ArrayList<>();
while (!isEmpty()) {
list.add(pop());
}
return list;
}
public void detachAndSaveInstanceState(Bundle outState) {
ArrayList<Bundle> entryBundles = new ArrayList<>(mBackStack.size());
for (RouterTransaction entry : mBackStack) {
entryBundles.add(entry.detachAndSaveInstanceState());
}
outState.putParcelableArrayList(KEY_ENTRIES, entryBundles);
}
public void restoreInstanceState(Bundle savedInstanceState) {
ArrayList<Bundle> entryBundles = savedInstanceState.getParcelableArrayList(KEY_ENTRIES);
if (entryBundles != null) {
Collections.reverse(entryBundles);
for (Bundle transactionBundle : entryBundles) {
mBackStack.push(new RouterTransaction(transactionBundle));
}
}
}
}
@@ -0,0 +1,102 @@
package com.bluelinelabs.conductor
import android.os.Bundle
import java.util.ArrayDeque
import java.util.Deque
internal class Backstack : Iterable<RouterTransaction> {
private val backstack: Deque<RouterTransaction> = ArrayDeque()
val isEmpty: Boolean get() = backstack.isEmpty()
val size: Int get() = backstack.size
var onBackstackUpdatedListener: OnBackstackUpdatedListener? = null
fun root(): RouterTransaction? = backstack.lastOrNull()
override fun iterator(): Iterator<RouterTransaction> = backstack.toTypedArray().iterator()
fun reverseIterator(): Iterator<RouterTransaction> = backstack.reversed().iterator()
fun remove(transaction: RouterTransaction) = backstack.remove(transaction)
fun popTo(transaction: RouterTransaction): List<RouterTransaction> {
if (transaction in backstack) {
val popped: MutableList<RouterTransaction> = ArrayList()
while (backstack.peek() != transaction) {
val poppedTransaction = pop()
popped.add(poppedTransaction)
}
return popped
} else {
throw RuntimeException("Tried to pop to a transaction that was not on the back stack")
}
}
fun pop(): RouterTransaction {
return backstack.pop().also {
onBackstackUpdatedListener?.onBackstackUpdated()
it.controller.destroy()
}
}
fun peek(): RouterTransaction? = backstack.peek()
fun push(transaction: RouterTransaction) {
backstack.push(transaction)
onBackstackUpdatedListener?.onBackstackUpdated()
}
fun popAll(): List<RouterTransaction> {
val list: MutableList<RouterTransaction> = ArrayList()
while (!isEmpty) {
list.add(pop())
}
return list
}
fun setBackstack(backstack: List<RouterTransaction>) {
this.backstack.clear()
backstack.forEach { transaction ->
this.backstack.push(transaction)
}
onBackstackUpdatedListener?.onBackstackUpdated()
}
operator fun contains(controller: Controller): Boolean {
return backstack.any {
it.controller == controller
}
}
fun saveInstanceState(outState: Bundle) {
val entryBundles = ArrayList<Bundle>(backstack.size)
backstack.mapTo(entryBundles) {
it.saveInstanceState()
}
outState.putParcelableArrayList(KEY_ENTRIES, entryBundles)
}
fun restoreInstanceState(savedInstanceState: Bundle) {
val entryBundles = savedInstanceState.getParcelableArrayList<Bundle?>(KEY_ENTRIES)
if (entryBundles != null) {
entryBundles.reverse()
for (transactionBundle in entryBundles) {
backstack.push(RouterTransaction(transactionBundle!!))
}
}
onBackstackUpdatedListener?.onBackstackUpdated()
}
fun interface OnBackstackUpdatedListener {
fun onBackstackUpdated()
}
companion object {
private const val KEY_ENTRIES = "Backstack.entries"
}
}
@@ -1,54 +0,0 @@
package com.bluelinelabs.conductor;
import android.annotation.TargetApi;
import android.content.Context;
import android.os.Build;
import android.util.AttributeSet;
import android.view.MotionEvent;
import android.view.ViewGroup;
import android.widget.FrameLayout;
import com.bluelinelabs.conductor.ControllerChangeHandler.ControllerChangeListener;
/**
* A FrameLayout implementation that can be used to block user interactions while
* {@link ControllerChangeHandler}s are performing changes. It is not required to use this
* ViewGroup, but it can be helpful.
*/
public class ChangeHandlerFrameLayout extends FrameLayout implements ControllerChangeListener {
private int mInProgressTransactionCount;
public ChangeHandlerFrameLayout(Context context) {
super(context);
}
public ChangeHandlerFrameLayout(Context context, AttributeSet attrs) {
super(context, attrs);
}
public ChangeHandlerFrameLayout(Context context, AttributeSet attrs, int defStyleAttr) {
super(context, attrs, defStyleAttr);
}
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public ChangeHandlerFrameLayout(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
super(context, attrs, defStyleAttr, defStyleRes);
}
@Override
public boolean onInterceptTouchEvent(MotionEvent ev) {
return (mInProgressTransactionCount > 0) || super.onInterceptTouchEvent(ev);
}
@Override
public void onChangeStarted(Controller to, Controller from, boolean isPush, ViewGroup container, ControllerChangeHandler handler) {
mInProgressTransactionCount++;
}
@Override
public void onChangeCompleted(Controller to, Controller from, boolean isPush, ViewGroup container, ControllerChangeHandler handler) {
mInProgressTransactionCount--;
}
}
@@ -0,0 +1,60 @@
package com.bluelinelabs.conductor
import android.annotation.TargetApi
import android.content.Context
import android.os.Build
import android.util.AttributeSet
import android.view.MotionEvent
import android.view.ViewGroup
import android.widget.FrameLayout
import com.bluelinelabs.conductor.ControllerChangeHandler.ControllerChangeListener
/**
* A FrameLayout implementation that can be used to block user interactions while
* [ControllerChangeHandler]s are performing changes. It is not required to use this
* ViewGroup, but it can be helpful.
*/
open class ChangeHandlerFrameLayout : FrameLayout, ControllerChangeListener {
private var inProgressTransactionCount = 0
constructor(context: Context) : super(context)
constructor(context: Context, attrs: AttributeSet?) : super(context, attrs)
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(
context,
attrs,
defStyleAttr
)
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int, defStyleRes: Int) : super(
context,
attrs,
defStyleAttr,
defStyleRes
)
override fun onInterceptTouchEvent(ev: MotionEvent): Boolean {
return inProgressTransactionCount > 0 || super.onInterceptTouchEvent(ev)
}
override fun onChangeStarted(
to: Controller?,
from: Controller?,
isPush: Boolean,
container: ViewGroup,
handler: ControllerChangeHandler
) {
inProgressTransactionCount++
}
override fun onChangeCompleted(
to: Controller?,
from: Controller?,
isPush: Boolean,
container: ViewGroup,
handler: ControllerChangeHandler
) {
inProgressTransactionCount--
}
}
@@ -1,79 +0,0 @@
package com.bluelinelabs.conductor;
import android.os.Bundle;
import android.support.annotation.IdRes;
import android.support.annotation.NonNull;
/**
* A {@link ControllerTransaction} implementation used for adding child {@link Controller}s.
*/
public class ChildControllerTransaction extends ControllerTransaction {
private static final String KEY_CONTAINER_ID = "ChildControllerTransaction.containerId";
private static final String KEY_ADD_TO_LOCAL_BACKSTACK = "ChildControllerTransaction.addToLocalBackstack";
/** The ID of the ViewGroup that the child {@link Controller} will be added to */
public final int containerId;
/** If true, the hosting {@link Controller} will be responsible for reversing this transaction if the user presses the back button */
public final boolean addToLocalBackstack;
ChildControllerTransaction(Builder builder) {
super(builder);
containerId = builder.containerId;
addToLocalBackstack = builder.addToLocalBackstack;
}
ChildControllerTransaction(@NonNull Bundle bundle) {
super(bundle);
containerId = bundle.getInt(KEY_CONTAINER_ID);
addToLocalBackstack = bundle.getBoolean(KEY_ADD_TO_LOCAL_BACKSTACK);
}
@Override
public Bundle detachAndSaveInstanceState() {
Bundle bundle = super.detachAndSaveInstanceState();
bundle.putInt(KEY_CONTAINER_ID, containerId);
bundle.putBoolean(KEY_ADD_TO_LOCAL_BACKSTACK, addToLocalBackstack);
return bundle;
}
/**
* Creates a new Builder
*
* @param controller The Controller to add as a child
* @param containerId The ID of the ViewGroup to which the controller's view should be added
*/
public static Builder builder(@NonNull Controller controller, @IdRes int containerId) {
return new Builder(controller, containerId);
}
/**
* A {@link ControllerTransaction.Builder} implementation used for adding child {@link Controller}s.
*/
public static class Builder extends ControllerTransaction.Builder<Builder> {
@IdRes final int containerId;
boolean addToLocalBackstack;
Builder(@NonNull Controller controller, @IdRes int containerId) {
super(controller);
this.containerId = containerId;
}
/**
* If true, the hosting {@link Controller} will be responsible for reversing this transaction if the user presses the back button.
*/
public Builder addToLocalBackstack(boolean addToLocalBackstack) {
this.addToLocalBackstack = addToLocalBackstack;
return this;
}
/** Creates the transaction */
public ChildControllerTransaction build() {
return new ChildControllerTransaction(this);
}
}
}
@@ -1,38 +0,0 @@
package com.bluelinelabs.conductor;
import android.app.Activity;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.internal.LifecycleHandler;
/**
* Point of initial interaction with Conductor. Used to attach a {@link Router} to your Activity.
*/
public final class Conductor {
private Conductor(){}
/**
* Conductor will create a {@link Router} that has been initialized for your Activity and containing ViewGroup.
* If an existing {@link Router} is already associated with this Activity/ViewGroup pair, either in memory
* or in the savedInstanceState, that router will be used and rebound instead of creating a new one with
* an empty backstack.
*
* @param activity The Activity that will host the {@link Router} being attached.
* @param container The ViewGroup in which the {@link Router}'s {@link Controller} views will be hosted
* @param savedInstanceState The savedInstanceState passed into the hosting Activity's onCreate method. Used
* for restoring the Router's state if possible.
* @return A fully configured {@link Router} instance for use with this Activity/ViewGroup pair.
*/
public static Router attachRouter(@NonNull Activity activity, @NonNull ViewGroup container, Bundle savedInstanceState) {
LifecycleHandler lifecycleHandler = LifecycleHandler.install(activity);
Router router = lifecycleHandler.getRouter(container, savedInstanceState);
router.rebindIfNeeded();
return router;
}
}
@@ -0,0 +1,41 @@
package com.bluelinelabs.conductor
import android.app.Activity
import android.os.Bundle
import android.view.ViewGroup
import androidx.annotation.UiThread
import com.bluelinelabs.conductor.internal.LifecycleHandler
import com.bluelinelabs.conductor.internal.ensureMainThread
object Conductor {
/**
* Conductor will create a [Router] that has been initialized for your Activity and containing ViewGroup.
* If an existing [Router] is already associated with this Activity/ViewGroup pair, either in memory
* or in the savedInstanceState, that router will be used and rebound instead of creating a new one with
* an empty backstack.
*
* @param activity The Activity that will host the [Router] being attached.
* @param container The ViewGroup in which the [Router]'s [Controller] views will be hosted
* @param savedInstanceState The savedInstanceState passed into the hosting Activity's onCreate method. Used
* for restoring the Router's state if possible.
* @param allowExperimentalAndroidXBacking Use AndroidX backing if true and if the activity parameter is a
* FragmentActivity.
* @return A fully configured [Router] instance for use with this Activity/ViewGroup pair.
*/
@UiThread
@JvmStatic
@JvmOverloads
fun attachRouter(
activity: Activity,
container: ViewGroup,
savedInstanceState: Bundle?,
allowExperimentalAndroidXBacking: Boolean = true,
): Router {
ensureMainThread()
return LifecycleHandler.install(activity, allowAndroidXBacking = allowExperimentalAndroidXBacking)
.getRouter(container, savedInstanceState)
.also { it.rebindIfNeeded() }
.setPopRootControllerMode(Router.PopRootControllerMode.NEVER)
}
}
File diff suppressed because it is too large Load Diff
@@ -1,172 +0,0 @@
package com.bluelinelabs.conductor;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.view.View;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.ControllerTransaction.ControllerChangeType;
import com.bluelinelabs.conductor.changehandler.SimpleSwapChangeHandler;
import com.bluelinelabs.conductor.internal.ClassUtils;
import java.util.ArrayList;
import java.util.List;
/**
* ControllerChangeHandlers are responsible for swapping the View for one Controller to the View
* of another. They can be useful for performing animations and transitions between Controllers. Several
* default ControllerChangeHandlers are included.
*/
public abstract class ControllerChangeHandler {
private static final String KEY_CLASS_NAME = "ControllerChangeHandler.className";
private static final String KEY_SAVED_STATE = "ControllerChangeHandler.savedState";
/**
* Responsible for swapping Views from one Controller to another.
*
* @param container The container these Views are hosted in.
* @param from The previous View in the container, if any.
* @param to The next View that should be put in the container, if any.
* @param isPush True if this is a push transaction, false if it's a pop.
* @param changeListener This listener must be called when any transitions or animations are completed.
*/
public abstract void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener);
public ControllerChangeHandler() {
ensureDefaultConstructor();
}
/**
* Saves any data about this handler to a Bundle in case the application is killed.
*
* @param bundle The Bundle into which data should be stored.
*/
public void saveToBundle(@NonNull Bundle bundle) { }
/**
* Restores data that was saved in the {@link #saveToBundle(Bundle bundle)} method.
*
* @param bundle The bundle that has data to be restored
*/
public void restoreFromBundle(@NonNull Bundle bundle) { }
final Bundle toBundle() {
Bundle bundle = new Bundle();
bundle.putString(KEY_CLASS_NAME, getClass().getCanonicalName());
Bundle savedState = new Bundle();
saveToBundle(savedState);
bundle.putBundle(KEY_SAVED_STATE, savedState);
return bundle;
}
private void ensureDefaultConstructor() {
try {
getClass().getConstructor();
} catch (Exception e) {
throw new RuntimeException(getClass() + " does not have a default constructor.");
}
}
public static ControllerChangeHandler fromBundle(@Nullable Bundle bundle) {
if (bundle != null) {
String className = bundle.getString(KEY_CLASS_NAME);
ControllerChangeHandler changeHandler = ClassUtils.newInstance(className);
//noinspection ConstantConditions
changeHandler.restoreFromBundle(bundle.getBundle(KEY_SAVED_STATE));
return changeHandler;
} else {
return null;
}
}
public static void executeChange(final Controller to, final Controller from, boolean isPush, ViewGroup container, ControllerChangeHandler inHandler) {
executeChange(to, from, isPush, container, inHandler, new ArrayList<ControllerChangeListener>());
}
public static void executeChange(final Controller to, final Controller from, final boolean isPush, final ViewGroup container, final ControllerChangeHandler inHandler, @NonNull final List<ControllerChangeListener> listeners) {
if (container != null) {
for (ControllerChangeListener listener : listeners) {
listener.onChangeStarted(to, from, isPush, container, inHandler);
}
final ControllerChangeType toChangeType = isPush ? ControllerChangeType.PUSH_ENTER : ControllerChangeType.POP_ENTER;
final ControllerChangeType fromChangeType = isPush ? ControllerChangeType.PUSH_EXIT : ControllerChangeType.POP_EXIT;
final ControllerChangeHandler handler = inHandler != null ? inHandler : new SimpleSwapChangeHandler();
final View toView;
if (to != null) {
toView = to.inflate(container);
to.changeStarted(handler, toChangeType);
} else {
toView = null;
}
final View fromView;
if (from != null) {
fromView = from.getView();
from.changeStarted(handler, fromChangeType);
} else {
fromView = null;
}
handler.performChange(container, fromView, toView, isPush, new ControllerChangeCompletedListener() {
@Override
public void onChangeCompleted() {
if (from != null) {
from.changeEnded(handler, fromChangeType);
}
if (to != null) {
to.changeEnded(handler, toChangeType);
}
for (ControllerChangeListener listener : listeners) {
listener.onChangeCompleted(to, from, isPush, container, inHandler);
}
}
});
}
}
/**
* A listener interface useful for allowing external classes to be notified of change events.
*/
public interface ControllerChangeListener {
/**
* Called when a {@link ControllerChangeHandler} has started changing {@link Controller}s
*
* @param to The new Controller
* @param from The old Controller
* @param isPush True if this is a push operation, or false if it's a pop.
* @param container The containing ViewGroup
* @param handler The change handler being used.
*/
void onChangeStarted(Controller to, Controller from, boolean isPush, ViewGroup container, ControllerChangeHandler handler);
/**
* Called when a {@link ControllerChangeHandler} has completed changing {@link Controller}s
* @param to The new Controller
* @param from The old Controller
* @param isPush True if this was a push operation, or false if it's a pop.
* @param container The containing ViewGroup
* @param handler The change handler that was used.
*/
void onChangeCompleted(Controller to, Controller from, boolean isPush, ViewGroup container, ControllerChangeHandler handler);
}
/**
* A simplified listener for being notified when the change is complete. This MUST be called by any custom
* ControllerChangeHandlers in order to ensure that {@link Controller}s will be notified of this change.
*/
public interface ControllerChangeCompletedListener {
/**
* Called when the change is complete.
*/
void onChangeCompleted();
}
}
@@ -0,0 +1,332 @@
package com.bluelinelabs.conductor
import android.os.Bundle
import android.view.View
import android.view.ViewGroup
import androidx.activity.BackEventCompat
import androidx.annotation.RestrictTo
import com.bluelinelabs.conductor.changehandler.SimpleSwapChangeHandler
import com.bluelinelabs.conductor.internal.ClassUtils
/**
* ControllerChangeHandlers are responsible for swapping the View for one Controller to the View
* of another. They can be useful for performing animations and transitions between Controllers. Several
* default ControllerChangeHandlers are included.
*/
abstract class ControllerChangeHandler {
private var forceRemoveViewOnPush = false
/**
* Returns whether or not this is a reusable ControllerChangeHandler. Defaults to false and should
* ONLY be overridden if there are absolutely no side effects to using this handler more than once.
* In the case that a handler is not reusable, it will be copied using the [.copy] method
* prior to use.
*/
open val isReusable: Boolean = false
/**
* Returns whether or not this handler removes the `from` view from the container when performing a push.
*
* 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 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 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
* to the user, while allowing the previous controller's view to be destroyed to reclaim resources.
* If instead, the previous controller should still be visible after the new controller is pushed,
* using a change handler with [removesFromViewOnPush] false will keep the previous controller's
* view in the view hierarchy, where it can still be seen (and even interacted with).
*/
open val removesFromViewOnPush: Boolean = true
private var hasBeenUsed = false
open val enableOnBackGestureCallbacks = false
init {
try {
javaClass.getConstructor()
} catch (e: Throwable) {
throw RuntimeException("$javaClass does not have a default constructor.")
}
}
/**
* Responsible for swapping Views from one Controller to another.
*
* @param container The container these Views are hosted in.
* @param from The previous View in the container or `null` if there was no Controller before this transition
* @param to The next View that should be put in the container or `null` if no Controller is being transitioned to
* @param isPush True if this is a push transaction, false if it's a pop.
* @param changeListener This listener must be called when any transitions or animations are completed.
*/
abstract fun performChange(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
changeListener: ControllerChangeCompletedListener,
)
/**
* Saves any data about this handler to a Bundle in case the application is killed.
*
* @param bundle The Bundle into which data should be stored.
*/
open fun saveToBundle(bundle: Bundle) {}
/**
* Restores data that was saved in the [.saveToBundle] method.
*
* @param bundle The bundle that has data to be restored
*/
open fun restoreFromBundle(bundle: Bundle) {}
/**
* Will be called on change handlers that push a controller if the controller being pushed is
* popped before it has completed.
*
* @param newHandler The change handler that has caused this push to be aborted
* @param newTop The Controller that will now be at the top of the backstack or `null`
* if there will be no new Controller at the top
*/
open fun onAbortPush(newHandler: ControllerChangeHandler, newTop: Controller?) {}
/**
* Will be called on change handlers that push a controller if the controller being pushed is
* needs to be attached immediately, without any animations or transitions.
*/
open fun completeImmediately() {}
/**
* Returns a copy of this ControllerChangeHandler. This method is internally used by the library, so
* ensure it will return an exact copy of your handler if overriding. If not overriding, the handler
* will be saved and restored from the Bundle format.
*/
open fun copy(): ControllerChangeHandler = fromBundle(toBundle())!!
open fun handleOnBackStarted(container: ViewGroup, to: View?, from: View, event: BackEventCompat) {}
open fun handleOnBackProgressed(container: ViewGroup, to: View?, from: View, event: BackEventCompat) {}
open fun handleOnBackCancelled(container: ViewGroup, to: View?, from: View) {}
protected open fun onEnd() {}
fun toBundle(): Bundle {
val bundle = Bundle()
bundle.putString(KEY_CLASS_NAME, javaClass.name)
val savedState = Bundle()
saveToBundle(savedState)
bundle.putBundle(KEY_SAVED_STATE, savedState)
return bundle
}
// Internal modifier plays weirdly with Java, which is what Router is still written in.
@RestrictTo(RestrictTo.Scope.LIBRARY)
fun setForceRemoveViewOnPush(forceRemoveViewOnPush: Boolean) {
this.forceRemoveViewOnPush = forceRemoveViewOnPush
}
/**
* A listener interface useful for allowing external classes to be notified of change events.
*/
interface ControllerChangeListener {
/**
* Called when a [ControllerChangeHandler] has started changing [Controller]s
*
* @param to The new Controller or `null` if no Controller is being transitioned to
* @param from The old Controller or `null` if there was no Controller before this transition
* @param isPush True if this is a push operation, or false if it's a pop.
* @param container The containing ViewGroup
* @param handler The change handler being used.
*/
fun onChangeStarted(
to: Controller?,
from: Controller?,
isPush: Boolean,
container: ViewGroup,
handler: ControllerChangeHandler,
)
/**
* Called when a [ControllerChangeHandler] has completed changing [Controller]s
*
* @param to The new Controller or `null` if no Controller is being transitioned to
* @param from The old Controller or `null` if there was no Controller before this transition
* @param isPush True if this was a push operation, or false if it's a pop
* @param container The containing ViewGroup
* @param handler The change handler that was used.
*/
fun onChangeCompleted(
to: Controller?,
from: Controller?,
isPush: Boolean,
container: ViewGroup,
handler: ControllerChangeHandler,
)
}
class ChangeTransaction(
@JvmField val to: Controller?,
@JvmField val from: Controller?,
@JvmField val isPush: Boolean,
@JvmField val container: ViewGroup?,
@JvmField val changeHandler: ControllerChangeHandler?,
@JvmField val listeners: List<ControllerChangeListener>,
)
/**
* A simplified listener for being notified when the change is complete. This MUST be called by any custom
* ControllerChangeHandlers in order to ensure that [Controller]s will be notified of this change.
*/
interface ControllerChangeCompletedListener {
/**
* Called when the change is complete.
*/
fun onChangeCompleted()
}
class ChangeHandlerData(val changeHandler: ControllerChangeHandler, val isPush: Boolean)
companion object {
private const val KEY_CLASS_NAME = "ControllerChangeHandler.className"
private const val KEY_SAVED_STATE = "ControllerChangeHandler.savedState"
val inProgressChangeHandlers: MutableMap<String, ChangeHandlerData> = HashMap()
@JvmStatic
fun fromBundle(bundle: Bundle?): ControllerChangeHandler? {
val bundle = bundle ?: return null
val className = bundle.getString(KEY_CLASS_NAME) ?: return null
val savedState = bundle.getBundle(KEY_SAVED_STATE) ?: return null
return ClassUtils.newInstance<ControllerChangeHandler>(className)?.also {
it.restoreFromBundle(savedState)
}
}
@JvmStatic
fun completeHandlerImmediately(controllerInstanceId: String): Boolean {
inProgressChangeHandlers[controllerInstanceId]?.let { changeHandlerData ->
changeHandlerData.changeHandler.completeImmediately()
inProgressChangeHandlers.remove(controllerInstanceId)
return true
}
return false
}
fun abortOrComplete(toAbort: Controller, newController: Controller?, newChangeHandler: ControllerChangeHandler) {
inProgressChangeHandlers[toAbort.getInstanceId()]?.let { changeHandlerData ->
if (changeHandlerData.isPush) {
changeHandlerData.changeHandler.onAbortPush(newChangeHandler, newController)
} else {
changeHandlerData.changeHandler.completeImmediately()
}
inProgressChangeHandlers.remove(toAbort.getInstanceId())
}
}
@JvmStatic
fun executeChange(transaction: ChangeTransaction) {
executeChange(
to = transaction.to,
from = transaction.from,
isPush = transaction.isPush,
container = transaction.container,
inHandler = transaction.changeHandler,
listeners = transaction.listeners,
)
}
private fun executeChange(
to: Controller?,
from: Controller?,
isPush: Boolean,
container: ViewGroup?,
inHandler: ControllerChangeHandler?,
listeners: List<ControllerChangeListener>,
) {
container ?: return
val handler: ControllerChangeHandler = if (inHandler == null) {
SimpleSwapChangeHandler()
} else if (inHandler.hasBeenUsed && !inHandler.isReusable) {
inHandler.copy()
} else {
inHandler
}
handler.hasBeenUsed = true
if (from != null) {
if (isPush) {
completeHandlerImmediately(from.getInstanceId())
} else {
abortOrComplete(from, to, handler)
}
}
if (to != null) {
inProgressChangeHandlers[to.getInstanceId()] = ChangeHandlerData(handler, isPush)
}
listeners.forEach { it.onChangeStarted(to, from, isPush, container, handler) }
val toChangeType = if (isPush) ControllerChangeType.PUSH_ENTER else ControllerChangeType.POP_ENTER
val fromChangeType = if (isPush) ControllerChangeType.PUSH_EXIT else ControllerChangeType.POP_EXIT
val toView = to?.let {
it.inflate(container).also {
to.changeStarted(handler, toChangeType)
}
}
val fromView = from?.let {
from.getView().also {
from.changeStarted(handler, fromChangeType)
}
}
handler.performChange(
container = container,
from = fromView,
to = toView,
isPush = isPush,
changeListener = object : ControllerChangeCompletedListener {
override fun onChangeCompleted() {
from?.changeEnded(handler, fromChangeType)
to?.let {
inProgressChangeHandlers.remove(it.getInstanceId())
it.changeEnded(handler, toChangeType)
}
listeners.forEach { it.onChangeCompleted(to, from, isPush, container, handler) }
if (handler.forceRemoveViewOnPush) {
(fromView?.parent as? ViewGroup)?.let {
it.removeView(fromView)
}
}
if (handler.removesFromViewOnPush) {
from?.needsAttach = false
}
}
},
)
}
}
}
@@ -0,0 +1,18 @@
package com.bluelinelabs.conductor
/**
* All possible types of [Controller] changes to be used in [ControllerChangeHandler]s
*/
enum class ControllerChangeType(@JvmField val isPush: Boolean, @JvmField val isEnter: Boolean) {
/** The Controller is being pushed to the host container */
PUSH_ENTER(true, true),
/** The Controller is being pushed to the backstack as another Controller is pushed to the host container */
PUSH_EXIT(true, false),
/** The Controller is being popped from the backstack and placed in the host container as another Controller is popped */
POP_ENTER(false, true),
/** The Controller is being popped from the host container */
POP_EXIT(false, false);
}
@@ -0,0 +1,299 @@
package com.bluelinelabs.conductor;
import android.app.Activity;
import android.content.Intent;
import android.content.IntentSender;
import android.content.IntentSender.SendIntentException;
import android.os.Bundle;
import android.text.TextUtils;
import android.view.ViewGroup;
import androidx.annotation.IdRes;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.bluelinelabs.conductor.ControllerChangeHandler.ControllerChangeListener;
import com.bluelinelabs.conductor.internal.TransactionIndexer;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
class ControllerHostedRouter extends Router {
private final String KEY_HOST_ID = "ControllerHostedRouter.hostId";
private final String KEY_TAG = "ControllerHostedRouter.tag";
private final String KEY_BOUND_TO_CONTAINER = "ControllerHostedRouter.boundToContainer";
private Controller hostController;
@IdRes private int hostId;
private String tag;
private boolean isDetachFrozen;
private boolean boundToContainer;
ControllerHostedRouter() {
popRootControllerMode = PopRootControllerMode.POP_ROOT_CONTROLLER_BUT_NOT_VIEW;
}
ControllerHostedRouter(int hostId, @Nullable String tag, boolean boundToContainer) {
this();
if (!boundToContainer && tag == null) {
throw new IllegalStateException("ControllerHostedRouter can't be created without a tag if not bounded to its container");
}
this.hostId = hostId;
this.tag = tag;
this.boundToContainer = boundToContainer;
}
final void setHostController(@NonNull Controller controller) {
if (hostController == null) {
hostController = controller;
setOnBackPressedDispatcherEnabled(controller.onBackPressedDispatcherEnabled);
}
}
final void setHostContainer(@NonNull Controller controller, @NonNull ViewGroup container) {
if (hostController != controller || this.container != container) {
removeHost();
if (container instanceof ControllerChangeListener) {
addChangeListener((ControllerChangeListener) container);
}
hostController = controller;
this.container = container;
setOnBackPressedDispatcherEnabled(controller.onBackPressedDispatcherEnabled);
for (RouterTransaction transaction : backstack) {
transaction.controller().setParentController(controller);
}
watchContainerAttach();
}
}
final void removeHost() {
if (container != null && container instanceof ControllerChangeListener) {
removeChangeListener((ControllerChangeListener) container);
}
final List<Controller> controllersToDestroy = new ArrayList<>(destroyingControllers);
for (Controller controller : controllersToDestroy) {
if (controller.getView() != null) {
controller.detach(controller.getView(), true, false);
}
}
for (RouterTransaction transaction : backstack) {
if (transaction.controller().getView() != null) {
transaction.controller().detach(transaction.controller().getView(), true, false);
}
}
prepareForContainerRemoval();
container = null;
}
final void setDetachFrozen(boolean frozen) {
isDetachFrozen = frozen;
for (RouterTransaction transaction : backstack) {
transaction.controller().setDetachFrozen(frozen);
}
}
@Override
void destroy(boolean popViews) {
setDetachFrozen(false);
super.destroy(popViews);
}
@Override
protected void pushToBackstack(@NonNull RouterTransaction entry) {
if (isDetachFrozen) {
entry.controller().setDetachFrozen(true);
}
super.pushToBackstack(entry);
}
@Override
public void setBackstack(@NonNull List<RouterTransaction> newBackstack, @Nullable ControllerChangeHandler changeHandler) {
if (isDetachFrozen) {
for (RouterTransaction transaction : newBackstack) {
transaction.controller().setDetachFrozen(true);
}
}
super.setBackstack(newBackstack, changeHandler);
}
@Override
void performControllerChange(@Nullable RouterTransaction to, @Nullable RouterTransaction from, boolean isPush) {
super.performControllerChange(to, from, isPush);
// If we're pushing a transaction that will detach controllers to an unattached child
// router, we need mark all other controllers as NOT needing to be reattached.
if (to != null && !hostController.isAttached()) {
if (to.pushChangeHandler() == null || to.pushChangeHandler().getRemovesFromViewOnPush()) {
for (RouterTransaction transaction : backstack) {
transaction.controller().setNeedsAttach(false);
}
}
}
}
@Override @Nullable
public Activity getActivity() {
return hostController != null ? hostController.getActivity() : null;
}
@Override
public void onActivityDestroyed(@NonNull Activity activity, boolean isConfigurationChange) {
super.onActivityDestroyed(activity, isConfigurationChange);
removeHost();
}
@Override
public void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().onActivityResult(requestCode, resultCode, data);
}
}
@Override
public void invalidateOptionsMenu() {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().invalidateOptionsMenu();
}
}
@Override
void startActivity(@NonNull Intent intent) {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().startActivity(intent);
}
}
@Override
void startActivityForResult(@NonNull String instanceId, @NonNull Intent intent, int requestCode) {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().startActivityForResult(instanceId, intent, requestCode);
}
}
@Override
void startActivityForResult(@NonNull String instanceId, @NonNull Intent intent, int requestCode, @Nullable Bundle options) {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().startActivityForResult(instanceId, intent, requestCode, options);
}
}
@Override
void startIntentSenderForResult(@NonNull String instanceId, @NonNull IntentSender intent, int requestCode, @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, @Nullable Bundle options) throws SendIntentException {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().startIntentSenderForResult(instanceId, intent, requestCode, fillInIntent, flagsMask, flagsValues, extraFlags, options);
}
}
@Override
void registerForActivityResult(@NonNull String instanceId, int requestCode) {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().registerForActivityResult(instanceId, requestCode);
}
}
@Override
void unregisterForActivityResults(@NonNull String instanceId) {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().unregisterForActivityResults(instanceId);
}
}
@Override
void requestPermissions(@NonNull String instanceId, @NonNull String[] permissions, int requestCode) {
if (hostController != null && hostController.getRouter() != null) {
hostController.getRouter().requestPermissions(instanceId, permissions, requestCode);
}
}
@Override
boolean hasHost() {
return hostController != null && container != null;
}
@Override
public void saveInstanceState(@NonNull Bundle outState) {
super.saveInstanceState(outState);
outState.putInt(KEY_HOST_ID, hostId);
outState.putBoolean(KEY_BOUND_TO_CONTAINER, boundToContainer);
outState.putString(KEY_TAG, tag);
}
@Override
public void restoreInstanceState(@NonNull Bundle savedInstanceState) {
super.restoreInstanceState(savedInstanceState);
hostId = savedInstanceState.getInt(KEY_HOST_ID);
boundToContainer = savedInstanceState.getBoolean(KEY_BOUND_TO_CONTAINER);
tag = savedInstanceState.getString(KEY_TAG);
}
@Override
void setRouterOnController(@NonNull Controller controller) {
controller.setParentController(hostController);
super.setRouterOnController(controller);
}
int getHostId() {
return hostId;
}
boolean matches(int hostId, @Nullable String tag) {
if (!boundToContainer && container == null) {
if (this.tag == null) {
throw new IllegalStateException("Host ID can't be variable with a null tag");
}
if (this.tag.equals(tag)) {
this.hostId = hostId;
return true;
}
}
return this.hostId == hostId && TextUtils.equals(tag, this.tag);
}
@Override @NonNull
List<Router> getSiblingRouters() {
List<Router> list = new ArrayList<>();
list.addAll(hostController.getChildRouters());
list.addAll(hostController.getRouter().getSiblingRouters());
return list;
}
@Override @NonNull
Router getRootRouter() {
if (hostController != null && hostController.getRouter() != null) {
return hostController.getRouter().getRootRouter();
} else {
return this;
}
}
@Override @NonNull
TransactionIndexer getTransactionIndexer() {
Router rootRouter = getRootRouter();
if (rootRouter == this) {
String debugInfo;
if (hostController != null) {
debugInfo = String.format(Locale.ENGLISH, "%s (attached? %b, destroyed? %b, parent: %s)",
hostController.getClass().getSimpleName(), hostController.isAttached(), hostController.isBeingDestroyed, hostController.getParentController());
} else {
debugInfo = "null host controller";
}
throw new IllegalStateException("Unable to retrieve TransactionIndexer from " + debugInfo);
} else {
return getRootRouter().getTransactionIndexer();
}
}
}
@@ -1,148 +0,0 @@
package com.bluelinelabs.conductor;
import android.os.Bundle;
import android.support.annotation.NonNull;
/**
* Metadata used to transition between {@link Controller}s.
*/
public class ControllerTransaction {
/**
* All possible types of {@link Controller} changes to be used in {@link ControllerChangeHandler}s
*/
public enum ControllerChangeType {
/** The Controller is being pushed to the host container */
PUSH_ENTER,
/** The Controller is being pushed to the backstack as another Controller is pushed to the host container */
PUSH_EXIT,
/** The Controller is being popped from the backstack and placed in the host container as another Controller is popped */
POP_ENTER,
/** The Controller is being popped from the host contianer */
POP_EXIT
}
private static final String KEY_VIEW_CONTROLLER_BUNDLE = "ControllerTransaction.controller.bundle";
private static final String KEY_PUSH_TRANSITION = "ControllerTransaction.pushControllerChangeHandler";
private static final String KEY_POP_TRANSITION = "ControllerTransaction.popControllerChangeHandler";
private static final String KEY_TAG = "ControllerTransaction.tag";
public final Controller controller;
public final String tag;
private final ControllerChangeHandler mPushControllerChangeHandler;
private final ControllerChangeHandler mPopControllerChangeHandler;
ControllerTransaction(Builder builder) {
controller = builder.controller;
tag = builder.tag;
mPushControllerChangeHandler = builder.pushControllerChangeHandler;
mPopControllerChangeHandler = builder.popControllerChangeHandler;
}
ControllerTransaction(@NonNull Bundle bundle) {
controller = Controller.newInstance(bundle.getBundle(KEY_VIEW_CONTROLLER_BUNDLE));
mPushControllerChangeHandler = ControllerChangeHandler.fromBundle(bundle.getBundle(KEY_PUSH_TRANSITION));
mPopControllerChangeHandler = ControllerChangeHandler.fromBundle(bundle.getBundle(KEY_POP_TRANSITION));
tag = bundle.getString(KEY_TAG);
}
public Controller getController() {
return controller;
}
public String getTag() {
return tag;
}
public ControllerChangeHandler getPushControllerChangeHandler() {
ControllerChangeHandler handler = controller.getOverriddenPushHandler();
if (handler == null) {
handler = mPushControllerChangeHandler;
}
return handler;
}
public ControllerChangeHandler getPopControllerChangeHandler() {
ControllerChangeHandler handler = controller.getOverriddenPopHandler();
if (handler == null) {
handler = mPopControllerChangeHandler;
}
return handler;
}
/**
* Used to serialize this transaction into a Bundle
*/
public Bundle detachAndSaveInstanceState() {
Bundle bundle = new Bundle();
bundle.putBundle(KEY_VIEW_CONTROLLER_BUNDLE, controller.detachAndSaveInstanceState());
if (mPushControllerChangeHandler != null) {
bundle.putBundle(KEY_PUSH_TRANSITION, mPushControllerChangeHandler.toBundle());
}
if (mPopControllerChangeHandler != null) {
bundle.putBundle(KEY_POP_TRANSITION, mPopControllerChangeHandler.toBundle());
}
bundle.putString(KEY_TAG, tag);
return bundle;
}
/**
* Builder used to create transactions.
*/
public static class Builder<T extends Builder<T>> {
final Controller controller;
ControllerChangeHandler pushControllerChangeHandler;
ControllerChangeHandler popControllerChangeHandler;
String tag;
public Builder(@NonNull Controller controller) {
this.controller = controller;
}
/**
* The {@link ControllerChangeHandler} that will be used when the {@link Controller} is pushed
* to the screen.
*/
@SuppressWarnings("unchecked")
public T pushChangeHandler(ControllerChangeHandler pushControllerChangeHandler) {
this.pushControllerChangeHandler = pushControllerChangeHandler;
return (T)this;
}
/**
* The {@link ControllerChangeHandler} that will be used when the {@link Controller} is popped
* from the screen.
*/
@SuppressWarnings("unchecked")
public T popChangeHandler(ControllerChangeHandler popControllerChangeHandler) {
this.popControllerChangeHandler = popControllerChangeHandler;
return (T)this;
}
/**
* The tag to use for this transaction. Tags can be used for finding transactions later on.
*/
@SuppressWarnings("unchecked")
public T tag(String tag) {
this.tag = tag;
return (T)this;
}
/**
* Creates the transaction.
*/
public ControllerTransaction build() {
return new ControllerTransaction(this);
}
}
}
File diff suppressed because it is too large Load Diff
@@ -1,44 +0,0 @@
package com.bluelinelabs.conductor;
import android.os.Bundle;
import android.support.annotation.NonNull;
/**
* A {@link ControllerTransaction} implementation used for adding {@link Controller}s to a {@link Router}.
*/
public class RouterTransaction extends ControllerTransaction {
private RouterTransaction(Builder builder) {
super(builder);
}
RouterTransaction(@NonNull Bundle bundle) {
super(bundle);
}
/**
* Creates a new Builder
*
* @param controller The {@link Controller} to add to the {@link Router}
*/
public static Builder builder(@NonNull Controller controller) {
return new Builder(controller);
}
/**
* A {@link ControllerTransaction.Builder} implementation used for adding {@link Controller}s to a {@link Router}.
*/
public static class Builder extends ControllerTransaction.Builder<Builder> {
Builder(@NonNull Controller controller) {
super(controller);
}
/** Creates the transaction */
public RouterTransaction build() {
return new RouterTransaction(this);
}
}
}
@@ -0,0 +1,122 @@
package com.bluelinelabs.conductor
import android.os.Bundle
import androidx.annotation.RestrictTo
import androidx.annotation.RestrictTo.Scope.LIBRARY
import com.bluelinelabs.conductor.internal.TransactionIndexer
private const val INVALID_INDEX = -1
private const val KEY_VIEW_CONTROLLER_BUNDLE = "RouterTransaction.controller.bundle"
private const val KEY_PUSH_TRANSITION = "RouterTransaction.pushControllerChangeHandler"
private const val KEY_POP_TRANSITION = "RouterTransaction.popControllerChangeHandler"
private const val KEY_TAG = "RouterTransaction.tag"
private const val KEY_INDEX = "RouterTransaction.transactionIndex"
private const val KEY_ATTACHED_TO_ROUTER = "RouterTransaction.attachedToRouter"
/**
* Metadata used for adding [Controller]s to a [Router].
*/
class RouterTransaction private constructor(
@get:JvmName("controller")
val controller: Controller,
private var tag: String? = null,
private var pushControllerChangeHandler: ControllerChangeHandler? = null,
private var popControllerChangeHandler: ControllerChangeHandler? = null,
private var attachedToRouter: Boolean = false,
@get:RestrictTo(LIBRARY)
@set:RestrictTo(LIBRARY)
var transactionIndex: Int = INVALID_INDEX
) {
@RestrictTo(LIBRARY)
internal constructor(bundle: Bundle) : this(
controller = Controller.newInstance(bundle.getBundle(KEY_VIEW_CONTROLLER_BUNDLE)!!),
pushControllerChangeHandler = ControllerChangeHandler.fromBundle(
bundle.getBundle(
KEY_PUSH_TRANSITION
)
),
popControllerChangeHandler = ControllerChangeHandler.fromBundle(
bundle.getBundle(
KEY_POP_TRANSITION
)
),
tag = bundle.getString(KEY_TAG),
transactionIndex = bundle.getInt(KEY_INDEX),
attachedToRouter = bundle.getBoolean(KEY_ATTACHED_TO_ROUTER)
)
fun onAttachedToRouter() {
attachedToRouter = true
}
fun tag(): String? = tag
fun tag(tag: String?): RouterTransaction {
return if (!attachedToRouter) {
this.tag = tag
this
} else {
throw RuntimeException(javaClass.simpleName + "s can not be modified after being added to a Router.")
}
}
fun pushChangeHandler(): ControllerChangeHandler? {
return controller.overriddenPushHandler ?: pushControllerChangeHandler
}
fun pushChangeHandler(handler: ControllerChangeHandler?): RouterTransaction {
return if (!attachedToRouter) {
pushControllerChangeHandler = handler
this
} else {
throw RuntimeException("${javaClass.simpleName}s can not be modified after being added to a Router.")
}
}
fun popChangeHandler(): ControllerChangeHandler? {
return controller.overriddenPopHandler ?: popControllerChangeHandler
}
fun popChangeHandler(handler: ControllerChangeHandler?): RouterTransaction {
return if (!attachedToRouter) {
popControllerChangeHandler = handler
this
} else {
throw RuntimeException("${javaClass.simpleName}s can not be modified after being added to a Router.")
}
}
fun ensureValidIndex(indexer: TransactionIndexer) {
if (transactionIndex == INVALID_INDEX) {
transactionIndex = indexer.nextIndex()
}
}
/**
* Used to serialize this transaction into a Bundle
*/
fun saveInstanceState(): Bundle = Bundle().apply {
putBundle(KEY_VIEW_CONTROLLER_BUNDLE, controller.saveInstanceState())
pushControllerChangeHandler?.let { putBundle(KEY_PUSH_TRANSITION, it.toBundle()) }
popControllerChangeHandler?.let { putBundle(KEY_POP_TRANSITION, it.toBundle()) }
putString(KEY_TAG, tag)
putInt(KEY_INDEX, transactionIndex)
putBoolean(KEY_ATTACHED_TO_ROUTER, attachedToRouter)
}
companion object {
@JvmStatic
fun with(controller: Controller): RouterTransaction = RouterTransaction(controller)
}
}
fun Controller.asTransaction(
popChangeHandler: ControllerChangeHandler? = null,
pushChangeHandler: ControllerChangeHandler? = null
): RouterTransaction {
return RouterTransaction.with(this)
.pushChangeHandler(pushChangeHandler)
.popChangeHandler(popChangeHandler)
}
@@ -1,143 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.animation.Animator;
import android.animation.AnimatorListenerAdapter;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
import android.view.ViewTreeObserver;
import com.bluelinelabs.conductor.ControllerChangeHandler;
/**
* A base {@link ControllerChangeHandler} that facilitates using {@link android.animation.Animator}s to replace Controller Views
*/
public abstract class AnimatorChangeHandler extends ControllerChangeHandler {
private static final String KEY_DURATION = "AnimatorChangeHandler.duration";
private static final String KEY_REMOVES_FROM_ON_PUSH = "AnimatorChangeHandler.removesFromViewOnPush";
public static final long DEFAULT_ANIMATION_DURATION = -1;
private long mAnimationDuration;
private boolean mRemovesFromViewOnPush;
public AnimatorChangeHandler() {
this(DEFAULT_ANIMATION_DURATION, true);
}
public AnimatorChangeHandler(boolean removesFromViewOnPush) {
this(DEFAULT_ANIMATION_DURATION, removesFromViewOnPush);
}
public AnimatorChangeHandler(long duration) {
this(duration, true);
}
public AnimatorChangeHandler(long duration, boolean removesFromViewOnPush) {
mAnimationDuration = duration;
mRemovesFromViewOnPush = removesFromViewOnPush;
}
@Override
public void saveToBundle(@NonNull Bundle bundle) {
super.saveToBundle(bundle);
bundle.putLong(KEY_DURATION, mAnimationDuration);
bundle.putBoolean(KEY_REMOVES_FROM_ON_PUSH, mRemovesFromViewOnPush);
}
@Override
public void restoreFromBundle(@NonNull Bundle bundle) {
super.restoreFromBundle(bundle);
mAnimationDuration = bundle.getLong(KEY_DURATION);
mRemovesFromViewOnPush = bundle.getBoolean(KEY_REMOVES_FROM_ON_PUSH);
}
public long getAnimationDuration() {
return mAnimationDuration;
}
public boolean removesFromViewOnPush() {
return mRemovesFromViewOnPush;
}
/**
* Should be overridden to return the Animator to use while replacing Views.
*
* @param container The container these Views are hosted in.
* @param from The previous View in the container, if any.
* @param to The next View that should be put in the container, if any.
* @param isPush True if this is a push transaction, false if it's a pop.
* @param toAddedToContainer True if the "to" view was added to the container as a part of this ChangeHandler. False if it was already in the hierarchy.
*/
protected abstract Animator getAnimator(@NonNull ViewGroup container, View from, View to, boolean isPush, boolean toAddedToContainer);
/**
* Will be called after the animation is complete to reset the View that was removed to its pre-animation state.
*/
protected abstract void resetFromView(@NonNull View from);
@Override
public final void performChange(@NonNull final ViewGroup container, final View from, final View to, final boolean isPush, @NonNull final ControllerChangeCompletedListener changeListener) {
boolean readyToAnimate = true;
final boolean addingToView = to != null && to.getParent() == null;
if (addingToView) {
if (isPush || from == null) {
container.addView(to);
} else {
container.addView(to, container.indexOfChild(from));
}
if (to.getWidth() <= 0 && to.getHeight() <= 0) {
readyToAnimate = false;
to.getViewTreeObserver().addOnPreDrawListener(new ViewTreeObserver.OnPreDrawListener() {
@Override
public boolean onPreDraw() {
final ViewTreeObserver observer = to.getViewTreeObserver();
if (observer.isAlive()) {
observer.removeOnPreDrawListener(this);
}
performAnimation(container, from, to, isPush, addingToView, changeListener);
return true;
}
});
}
}
if (readyToAnimate) {
performAnimation(container, from, to, isPush, addingToView, changeListener);
}
}
private void performAnimation(@NonNull final ViewGroup container, final View from, View to, final boolean isPush, final boolean toAddedToContainer, @NonNull final ControllerChangeCompletedListener changeListener) {
Animator animator = getAnimator(container, from, to, isPush, toAddedToContainer);
if (mAnimationDuration > 0) {
animator.setDuration(mAnimationDuration);
}
animator.addListener(new AnimatorListenerAdapter() {
@Override
public void onAnimationCancel(Animator animation) {
changeListener.onChangeCompleted();
}
@Override
public void onAnimationEnd(Animator animation) {
if (from != null && (!isPush || mRemovesFromViewOnPush)) {
container.removeView(from);
}
changeListener.onChangeCompleted();
if (isPush && from != null) {
resetFromView(from);
}
}
});
animator.start();
}
}
@@ -0,0 +1,228 @@
package com.bluelinelabs.conductor.changehandler
import android.animation.Animator
import android.animation.AnimatorListenerAdapter
import android.os.Bundle
import android.view.View
import android.view.ViewGroup
import android.view.ViewTreeObserver
import com.bluelinelabs.conductor.Controller
import com.bluelinelabs.conductor.ControllerChangeHandler
/**
* A base [ControllerChangeHandler] that facilitates using [android.animation.Animator]s to replace Controller Views
*/
abstract class AnimatorChangeHandler @JvmOverloads constructor(
animationDuration: Long = DEFAULT_ANIMATION_DURATION,
removesFromViewOnPush: Boolean = true,
) : ControllerChangeHandler() {
var animationDuration: Long = animationDuration
private set
private var canceled = false
private var needsImmediateCompletion = false
private var completed = false
private var animator: Animator? = null
private var onAnimationReadyOrAbortedListener: OnAnimationReadyOrAbortedListener? = null
private var _removesFromViewOnPush = removesFromViewOnPush
override val removesFromViewOnPush: Boolean
get() = _removesFromViewOnPush
constructor(removesFromViewOnPush: Boolean = true) : this(
animationDuration = DEFAULT_ANIMATION_DURATION,
removesFromViewOnPush = removesFromViewOnPush,
)
override fun saveToBundle(bundle: Bundle) {
super.saveToBundle(bundle)
bundle.putLong(KEY_DURATION, animationDuration)
bundle.putBoolean(KEY_REMOVES_FROM_ON_PUSH, removesFromViewOnPush)
}
override fun restoreFromBundle(bundle: Bundle) {
super.restoreFromBundle(bundle)
animationDuration = bundle.getLong(KEY_DURATION)
_removesFromViewOnPush = bundle.getBoolean(KEY_REMOVES_FROM_ON_PUSH)
}
override fun onAbortPush(newHandler: ControllerChangeHandler, newTop: Controller?) {
super.onAbortPush(newHandler, newTop)
canceled = true
if (animator != null) {
animator!!.cancel()
} else if (onAnimationReadyOrAbortedListener != null) {
onAnimationReadyOrAbortedListener!!.onReadyOrAborted()
}
}
override fun completeImmediately() {
super.completeImmediately()
needsImmediateCompletion = true
if (animator != null) {
animator!!.end()
} else if (onAnimationReadyOrAbortedListener != null) {
onAnimationReadyOrAbortedListener!!.onReadyOrAborted()
}
}
/**
* Should be overridden to return the Animator to use while replacing Views.
*
* @param container The container these Views are hosted in.
* @param from The previous View in the container or `null` if there was no Controller before this transition
* @param to The next View that should be put in the container or `null` if no Controller is being transitioned to
* @param isPush True if this is a push transaction, false if it's a pop.
* @param toAddedToContainer True if the "to" view was added to the container as a part of this ChangeHandler. False if it was already in the hierarchy.
*/
protected abstract fun getAnimator(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
toAddedToContainer: Boolean,
): Animator
/**
* Will be called after the animation is complete to reset the View that was removed to its pre-animation state.
*/
protected abstract fun resetFromView(from: View)
override fun performChange(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
changeListener: ControllerChangeCompletedListener,
) {
var readyToAnimate = true
val addingToView = to != null && to.parent == null
if (addingToView) {
if (isPush || from == null) {
container.addView(to)
} else if (to!!.parent == null) {
container.addView(to, container.indexOfChild(from))
}
if (to!!.width <= 0 && to.height <= 0) {
readyToAnimate = false
onAnimationReadyOrAbortedListener = OnAnimationReadyOrAbortedListener(container, from, to, isPush, true, changeListener)
to.viewTreeObserver.addOnPreDrawListener(onAnimationReadyOrAbortedListener)
}
}
if (readyToAnimate) {
performAnimation(container, from, to, isPush, addingToView, changeListener)
}
}
fun complete(changeListener: ControllerChangeCompletedListener, animatorListener: Animator.AnimatorListener?) {
if (!completed) {
completed = true
changeListener.onChangeCompleted()
}
if (animator != null) {
if (animatorListener != null) {
animator!!.removeListener(animatorListener)
}
animator!!.cancel()
animator = null
}
onAnimationReadyOrAbortedListener = null
}
fun performAnimation(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
toAddedToContainer: Boolean,
changeListener: ControllerChangeCompletedListener,
) {
if (canceled) {
complete(changeListener, null)
return
}
if (needsImmediateCompletion) {
if (from != null && (!isPush || removesFromViewOnPush)) {
container.removeView(from)
}
complete(changeListener, null)
if (isPush && from != null) {
resetFromView(from)
}
return
}
animator = getAnimator(container, from, to, isPush, toAddedToContainer)
if (animationDuration > 0) {
animator!!.duration = animationDuration
}
animator!!.addListener(
object : AnimatorListenerAdapter() {
override fun onAnimationCancel(animation: Animator) {
from?.let { resetFromView(it) }
if (to != null && to.parent === container) {
container.removeView(to)
}
complete(changeListener, this)
}
override fun onAnimationEnd(animation: Animator) {
if (!canceled && animator != null) {
if (from != null && (!isPush || removesFromViewOnPush)) {
container.removeView(from)
}
complete(changeListener, this)
if (isPush && from != null) {
resetFromView(from)
}
}
}
},
)
animator!!.start()
}
private inner class OnAnimationReadyOrAbortedListener constructor(
val container: ViewGroup,
val from: View?,
val to: View?,
val isPush: Boolean,
val addingToView: Boolean,
val changeListener: ControllerChangeCompletedListener,
) : ViewTreeObserver.OnPreDrawListener {
private var hasRun = false
override fun onPreDraw(): Boolean {
onReadyOrAborted()
return true
}
fun onReadyOrAborted() {
if (!hasRun) {
hasRun = true
if (to != null) {
val observer = to.viewTreeObserver
if (observer.isAlive) {
observer.removeOnPreDrawListener(this)
}
}
performAnimation(container, from, to, isPush, addingToView, changeListener)
}
}
}
companion object {
private const val KEY_DURATION = "AnimatorChangeHandler.duration"
private const val KEY_REMOVES_FROM_ON_PUSH = "AnimatorChangeHandler.removesFromViewOnPush"
const val DEFAULT_ANIMATION_DURATION: Long = -1
}
}
@@ -1,23 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.annotation.TargetApi;
import android.os.Build;
import android.support.annotation.NonNull;
import android.transition.AutoTransition;
import android.transition.Transition;
import android.view.View;
import android.view.ViewGroup;
/**
* A change handler that will use an AutoTransition.
*/
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public class AutoTransitionChangeHandler extends TransitionChangeHandler {
@Override
@NonNull
protected Transition getTransition(@NonNull ViewGroup container, View from, View to, boolean isPush) {
return new AutoTransition();
}
}
@@ -1,47 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.animation.Animator;
import android.animation.AnimatorSet;
import android.animation.ObjectAnimator;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
/**
* An {@link AnimatorChangeHandler} that will cross fade two views
*/
public class FadeChangeHandler extends AnimatorChangeHandler {
public FadeChangeHandler() { }
public FadeChangeHandler(boolean removesFromViewOnPush) {
super(removesFromViewOnPush);
}
public FadeChangeHandler(long duration) {
super(duration);
}
public FadeChangeHandler(long duration, boolean removesFromViewOnPush) {
super(duration, removesFromViewOnPush);
}
@Override
protected Animator getAnimator(@NonNull ViewGroup container, View from, View to, boolean isPush, boolean toAddedToContainer) {
AnimatorSet animator = new AnimatorSet();
if (to != null && toAddedToContainer) {
animator.play(ObjectAnimator.ofFloat(to, View.ALPHA, 0, 1));
}
if (from != null) {
animator.play(ObjectAnimator.ofFloat(from, View.ALPHA, 0));
}
return animator;
}
@Override
protected void resetFromView(@NonNull View from) {
from.setAlpha(1);
}
}
@@ -0,0 +1,42 @@
package com.bluelinelabs.conductor.changehandler
import android.animation.Animator
import android.animation.AnimatorSet
import android.animation.ObjectAnimator
import android.view.View
import android.view.ViewGroup
import com.bluelinelabs.conductor.ControllerChangeHandler
/**
* An [AnimatorChangeHandler] that will cross fade two views
*/
class FadeChangeHandler : AnimatorChangeHandler {
constructor() : super()
constructor(removesFromViewOnPush: Boolean) : super(removesFromViewOnPush)
constructor(duration: Long) : super(duration)
constructor(duration: Long, removesFromViewOnPush: Boolean) : super(duration, removesFromViewOnPush)
override fun getAnimator(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
toAddedToContainer: Boolean,
): Animator {
val animator = AnimatorSet()
if (to != null) {
val start = if (toAddedToContainer) 0F else to.alpha
animator.play(ObjectAnimator.ofFloat(to, View.ALPHA, start, 1f))
}
if (from != null && (!isPush || removesFromViewOnPush)) {
animator.play(ObjectAnimator.ofFloat(from, View.ALPHA, 0f))
}
return animator
}
override fun resetFromView(from: View) {
from.alpha = 1f
}
override fun copy(): ControllerChangeHandler = FadeChangeHandler(animationDuration, removesFromViewOnPush)
}
@@ -1,56 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.animation.Animator;
import android.animation.AnimatorSet;
import android.animation.ObjectAnimator;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
/**
* An {@link AnimatorChangeHandler} that will slide the views left or right, depending on if it's a push or pop.
*/
public class HorizontalChangeHandler extends AnimatorChangeHandler {
public HorizontalChangeHandler() { }
public HorizontalChangeHandler(boolean removesFromViewOnPush) {
super(removesFromViewOnPush);
}
public HorizontalChangeHandler(long duration) {
super(duration);
}
public HorizontalChangeHandler(long duration, boolean removesFromViewOnPush) {
super(duration, removesFromViewOnPush);
}
@Override
protected Animator getAnimator(@NonNull ViewGroup container, View from, View to, boolean isPush, boolean toAddedToContainer) {
AnimatorSet animatorSet = new AnimatorSet();
if (isPush) {
if (from != null) {
animatorSet.play(ObjectAnimator.ofFloat(from, View.TRANSLATION_X, -from.getWidth()));
}
if (to != null) {
animatorSet.play(ObjectAnimator.ofFloat(to, View.TRANSLATION_X, to.getWidth(), 0));
}
} else {
if (from != null) {
animatorSet.play(ObjectAnimator.ofFloat(from, View.TRANSLATION_X, from.getWidth()));
}
if (to != null) {
animatorSet.play(ObjectAnimator.ofFloat(to, View.TRANSLATION_X, -to.getWidth(), 0));
}
}
return animatorSet;
}
@Override
protected void resetFromView(@NonNull View from) {
from.setTranslationY(0);
}
}
@@ -0,0 +1,52 @@
package com.bluelinelabs.conductor.changehandler
import android.animation.Animator
import android.animation.AnimatorSet
import android.animation.ObjectAnimator
import android.view.View
import android.view.ViewGroup
import com.bluelinelabs.conductor.ControllerChangeHandler
/**
* An [AnimatorChangeHandler] that will slide the views left or right, depending on if it's a push or pop.
*/
class HorizontalChangeHandler : AnimatorChangeHandler {
constructor() : super()
constructor(removesFromViewOnPush: Boolean) : super(removesFromViewOnPush)
constructor(duration: Long) : super(duration)
constructor(duration: Long, removesFromViewOnPush: Boolean) : super(duration, removesFromViewOnPush)
override fun getAnimator(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
toAddedToContainer: Boolean,
): Animator {
val animatorSet = AnimatorSet()
if (isPush) {
if (from != null) {
animatorSet.play(ObjectAnimator.ofFloat(from, View.TRANSLATION_X, -from.width.toFloat()))
}
if (to != null) {
animatorSet.play(ObjectAnimator.ofFloat(to, View.TRANSLATION_X, to.width.toFloat(), 0f))
}
} else {
if (from != null) {
animatorSet.play(ObjectAnimator.ofFloat(from, View.TRANSLATION_X, from.width.toFloat()))
}
if (to != null) {
// Allow this to have a nice transition when coming off an aborted push animation
val fromLeft = from?.translationX ?: 0F
animatorSet.play(ObjectAnimator.ofFloat(to, View.TRANSLATION_X, fromLeft - to.width, 0f))
}
}
return animatorSet
}
override fun resetFromView(from: View) {
from.translationX = 0f
}
override fun copy(): ControllerChangeHandler = HorizontalChangeHandler(animationDuration, removesFromViewOnPush)
}
@@ -1,52 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.ControllerChangeHandler;
/**
* A {@link ControllerChangeHandler} that will instantly swap Views with no animations or transitions.
*/
public class SimpleSwapChangeHandler extends ControllerChangeHandler {
private static final String KEY_REMOVES_FROM_ON_PUSH = "SimpleSwapChangeHandler.removesFromViewOnPush";
private boolean mRemovesFromViewOnPush;
public SimpleSwapChangeHandler() {
this(true);
}
public SimpleSwapChangeHandler(boolean removesFromViewOnPush) {
mRemovesFromViewOnPush = removesFromViewOnPush;
}
@Override
public void saveToBundle(@NonNull Bundle bundle) {
super.saveToBundle(bundle);
bundle.putBoolean(KEY_REMOVES_FROM_ON_PUSH, mRemovesFromViewOnPush);
}
@Override
public void restoreFromBundle(@NonNull Bundle bundle) {
super.restoreFromBundle(bundle);
mRemovesFromViewOnPush = bundle.getBoolean(KEY_REMOVES_FROM_ON_PUSH);
}
@Override
public void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull final ControllerChangeCompletedListener changeListener) {
if (from != null && (!isPush || mRemovesFromViewOnPush)) {
container.removeView(from);
}
if (to != null && to.getParent() == null) {
container.addView(to);
}
changeListener.onChangeCompleted();
}
}
@@ -0,0 +1,88 @@
package com.bluelinelabs.conductor.changehandler
import android.os.Bundle
import android.view.View
import android.view.ViewGroup
import com.bluelinelabs.conductor.Controller
import com.bluelinelabs.conductor.ControllerChangeHandler
/**
* A [ControllerChangeHandler] that will instantly swap Views with no animations or transitions.
*/
class SimpleSwapChangeHandler @JvmOverloads constructor(
removesFromViewOnPush: Boolean = true,
) : ControllerChangeHandler(), View.OnAttachStateChangeListener {
private var _removesFromViewOnPush = removesFromViewOnPush
override val removesFromViewOnPush: Boolean
get() = _removesFromViewOnPush
override val isReusable = true
private var canceled = false
private var container: ViewGroup? = null
private var changeListener: ControllerChangeCompletedListener? = null
override fun saveToBundle(bundle: Bundle) {
super.saveToBundle(bundle)
bundle.putBoolean(KEY_REMOVES_FROM_ON_PUSH, removesFromViewOnPush)
}
override fun restoreFromBundle(bundle: Bundle) {
super.restoreFromBundle(bundle)
_removesFromViewOnPush = bundle.getBoolean(KEY_REMOVES_FROM_ON_PUSH)
}
override fun onAbortPush(newHandler: ControllerChangeHandler, newTop: Controller?) {
super.onAbortPush(newHandler, newTop)
canceled = true
}
override fun completeImmediately() {
changeListener?.onChangeCompleted()
changeListener = null
container?.removeOnAttachStateChangeListener(this)
container = null
}
override fun performChange(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
changeListener: ControllerChangeCompletedListener,
) {
if (canceled) return
if (from != null && (!isPush || removesFromViewOnPush)) {
container.removeView(from)
}
if (to != null && to.parent == null) {
container.addView(to)
}
if (container.windowToken != null) {
changeListener.onChangeCompleted()
} else {
this.changeListener = changeListener
this.container = container
container.addOnAttachStateChangeListener(this)
}
}
override fun onViewAttachedToWindow(v: View) {
v.removeOnAttachStateChangeListener(this)
changeListener?.onChangeCompleted()
changeListener = null
container?.removeOnAttachStateChangeListener(this)
container = null
}
override fun onViewDetachedFromWindow(v: View) = Unit
override fun copy(): ControllerChangeHandler = SimpleSwapChangeHandler(removesFromViewOnPush)
}
private const val KEY_REMOVES_FROM_ON_PUSH = "SimpleSwapChangeHandler.removesFromViewOnPush"
@@ -1,64 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.annotation.TargetApi;
import android.os.Build;
import android.support.annotation.NonNull;
import android.transition.Transition;
import android.transition.Transition.TransitionListener;
import android.transition.TransitionManager;
import android.view.View;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.ControllerChangeHandler;
/**
* A base {@link ControllerChangeHandler} that facilitates using {@link android.transition.Transition}s to replace Controller Views.
*/
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public abstract class TransitionChangeHandler extends ControllerChangeHandler {
/**
* Should be overridden to return the Transition to use while replacing Views.
*
* @param container The container these Views are hosted in.
* @param from The previous View in the container, if any.
* @param to The next View that should be put in the container, if any.
* @param isPush True if this is a push transaction, false if it's a pop.
*/
@NonNull
protected abstract Transition getTransition(@NonNull ViewGroup container, View from, View to, boolean isPush);
@Override
public void performChange(@NonNull final ViewGroup container, View from, View to, boolean isPush, @NonNull final ControllerChangeCompletedListener changeListener) {
Transition transition = getTransition(container, from, to, isPush);
transition.addListener(new TransitionListener() {
@Override
public void onTransitionStart(Transition transition) { }
@Override
public void onTransitionEnd(Transition transition) {
changeListener.onChangeCompleted();
}
@Override
public void onTransitionCancel(Transition transition) {
changeListener.onChangeCompleted();
}
@Override
public void onTransitionPause(Transition transition) { }
@Override
public void onTransitionResume(Transition transition) { }
});
TransitionManager.beginDelayedTransition(container, transition);
if (from != null) {
container.removeView(from);
}
if (to != null) {
container.addView(to);
}
}
}
@@ -1,80 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.os.Build;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.ControllerChangeHandler;
import com.bluelinelabs.conductor.internal.ClassUtils;
/**
* A base {@link ControllerChangeHandler} that facilitates using {@link android.transition.Transition}s to replace Controller Views.
* If the target device is running on a version of Android that doesn't support transitions, a fallback {@link ControllerChangeHandler} will be used.
*/
public class TransitionChangeHandlerCompat extends ControllerChangeHandler {
private static final String KEY_TRANSITION_HANDLER_CLASS = "TransitionChangeHandlerCompat.transitionChangeHandler.class";
private static final String KEY_FALLBACK_HANDLER_CLASS = "TransitionChangeHandlerCompat.fallbackChangeHandler.class";
private static final String KEY_TRANSITION_HANDLER_STATE = "TransitionChangeHandlerCompat.transitionChangeHandler.state";
private static final String KEY_FALLBACK_HANDLER_STATE = "TransitionChangeHandlerCompat.fallbackChangeHandler.state";
private TransitionChangeHandler mTransitionChangeHandler;
private ControllerChangeHandler mFallbackChangeHandler;
public TransitionChangeHandlerCompat() { }
/**
* Constructor that takes a {@link TransitionChangeHandler} for use with compatible devices, as well as a fallback
* {@link ControllerChangeHandler} for use with older devices.
*
* @param transitionChangeHandler The change handler that will be used on API 21 and above
* @param fallbackChangeHandler The change handler that will be used on APIs below 21
*/
public TransitionChangeHandlerCompat(TransitionChangeHandler transitionChangeHandler, ControllerChangeHandler fallbackChangeHandler) {
mTransitionChangeHandler = transitionChangeHandler;
mFallbackChangeHandler = fallbackChangeHandler;
}
@Override
public void performChange(@NonNull final ViewGroup container, View from, View to, boolean isPush, @NonNull final ControllerChangeCompletedListener changeListener) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
mTransitionChangeHandler.performChange(container, from, to, isPush, changeListener);
} else {
mFallbackChangeHandler.performChange(container, from, to, isPush, changeListener);
}
}
@Override
public void saveToBundle(@NonNull Bundle bundle) {
super.saveToBundle(bundle);
bundle.putString(KEY_TRANSITION_HANDLER_CLASS, mTransitionChangeHandler.getClass().getCanonicalName());
bundle.putString(KEY_FALLBACK_HANDLER_CLASS, mFallbackChangeHandler.getClass().getCanonicalName());
Bundle transitionBundle = new Bundle();
mTransitionChangeHandler.saveToBundle(transitionBundle);
bundle.putBundle(KEY_TRANSITION_HANDLER_STATE, transitionBundle);
Bundle fallbackBundle = new Bundle();
mFallbackChangeHandler.saveToBundle(fallbackBundle);
bundle.putBundle(KEY_FALLBACK_HANDLER_STATE, fallbackBundle);
}
@Override
public void restoreFromBundle(@NonNull Bundle bundle) {
super.restoreFromBundle(bundle);
String transitionClassName = bundle.getString(KEY_TRANSITION_HANDLER_CLASS);
mTransitionChangeHandler = ClassUtils.newInstance(transitionClassName);
//noinspection ConstantConditions
mTransitionChangeHandler.restoreFromBundle(bundle.getBundle(KEY_TRANSITION_HANDLER_STATE));
String fallbackClassName = bundle.getString(KEY_FALLBACK_HANDLER_CLASS);
mFallbackChangeHandler = ClassUtils.newInstance(fallbackClassName);
//noinspection ConstantConditions
mFallbackChangeHandler.restoreFromBundle(bundle.getBundle(KEY_FALLBACK_HANDLER_STATE));
}
}
@@ -1,51 +0,0 @@
package com.bluelinelabs.conductor.changehandler;
import android.animation.Animator;
import android.animation.AnimatorSet;
import android.animation.ObjectAnimator;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
import java.util.ArrayList;
import java.util.List;
/**
* An {@link AnimatorChangeHandler} that will slide either slide a new View up or slide an old View down,
* depending on whether a push or pop change is happening.
*/
public class VerticalChangeHandler extends AnimatorChangeHandler {
public VerticalChangeHandler() { }
public VerticalChangeHandler(boolean removesFromViewOnPush) {
super(removesFromViewOnPush);
}
public VerticalChangeHandler(long duration) {
super(duration);
}
public VerticalChangeHandler(long duration, boolean removesFromViewOnPush) {
super(duration, removesFromViewOnPush);
}
@Override
protected Animator getAnimator(@NonNull ViewGroup container, View from, View to, boolean isPush, boolean toAddedToContainer) {
AnimatorSet animator = new AnimatorSet();
List<Animator> viewAnimators = new ArrayList<>();
if (isPush && to != null) {
viewAnimators.add(ObjectAnimator.ofFloat(to, View.TRANSLATION_Y, to.getHeight(), 0));
} else if (!isPush && from != null) {
viewAnimators.add(ObjectAnimator.ofFloat(from, View.TRANSLATION_Y, from.getHeight()));
}
animator.playTogether(viewAnimators);
return animator;
}
@Override
protected void resetFromView(@NonNull View from) { }
}
@@ -0,0 +1,43 @@
package com.bluelinelabs.conductor.changehandler
import android.animation.Animator
import android.animation.AnimatorSet
import android.animation.ObjectAnimator
import android.view.View
import android.view.ViewGroup
import com.bluelinelabs.conductor.ControllerChangeHandler
/**
* An [AnimatorChangeHandler] that will slide either slide a new View up or slide an old View down,
* depending on whether a push or pop change is happening.
*/
class VerticalChangeHandler : AnimatorChangeHandler {
constructor() : super()
constructor(removesFromViewOnPush: Boolean) : super(removesFromViewOnPush)
constructor(duration: Long) : super(duration)
constructor(duration: Long, removesFromViewOnPush: Boolean) : super(duration, removesFromViewOnPush)
override fun getAnimator(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
toAddedToContainer: Boolean,
): Animator {
val animator = AnimatorSet()
val viewAnimators: MutableList<Animator> = ArrayList()
if (isPush && to != null) {
viewAnimators.add(ObjectAnimator.ofFloat(to, View.TRANSLATION_Y, to.height.toFloat(), 0f))
} else if (!isPush && from != null) {
viewAnimators.add(ObjectAnimator.ofFloat(from, View.TRANSLATION_Y, from.height.toFloat()))
}
animator.playTogether(viewAnimators)
return animator
}
override fun resetFromView(from: View) = Unit
override fun copy(): ControllerChangeHandler = VerticalChangeHandler(animationDuration, removesFromViewOnPush)
}
@@ -0,0 +1,15 @@
package com.bluelinelabs.conductor.internal
import android.view.View
import com.bluelinelabs.conductor.Controller
class BackGestureViewState(
val fromView: View,
val toViews: List<BackGestureControllerView>,
)
class BackGestureControllerView(
val controller: Controller,
val view: View,
val inflatedForGesture: Boolean,
)
@@ -1,16 +1,13 @@
package com.bluelinelabs.conductor.internal;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import android.text.TextUtils;
public class ClassUtils {
@SuppressWarnings("unchecked")
public static <T> Class<? extends T> classForName(String className) {
return classForName(className, true);
}
@SuppressWarnings("unchecked")
public static <T> Class<? extends T> classForName(String className, boolean allowEmptyName) {
@Nullable @SuppressWarnings("unchecked")
public static <T> Class<? extends T> classForName(@NonNull String className, boolean allowEmptyName) {
if (allowEmptyName && TextUtils.isEmpty(className)) {
return null;
}
@@ -22,10 +19,10 @@ public class ClassUtils {
}
}
@SuppressWarnings("unchecked")
public static <T> T newInstance(String className) {
@Nullable @SuppressWarnings("unchecked")
public static <T> T newInstance(@NonNull String className) {
try {
Class<? extends T> cls = classForName(className);
Class<? extends T> cls = classForName(className, true);
return cls != null ? cls.newInstance() : null;
} catch (Exception e) {
throw new RuntimeException("An exception occurred while creating a new instance of " + className + ". " + e.getMessage());
@@ -0,0 +1,53 @@
package com.bluelinelabs.conductor.internal
import android.content.Context
import android.view.View
import androidx.lifecycle.Lifecycle
import androidx.lifecycle.LifecycleOwner
import androidx.lifecycle.LifecycleRegistry
import com.bluelinelabs.conductor.Controller
import com.bluelinelabs.conductor.Controller.LifecycleListener
class ControllerLifecycleOwner(lifecycleController: Controller) : LifecycleOwner {
private val lifecycleRegistry: LifecycleRegistry = LifecycleRegistry(this) // --> State.INITIALIZED
override val lifecycle: Lifecycle
get() = lifecycleRegistry
init {
lifecycleController.addLifecycleListener(
object : LifecycleListener() {
override fun postContextAvailable(controller: Controller, context: Context) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_CREATE) // --> State.CREATED;
}
override fun postCreateView(controller: Controller, view: View) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_START) // --> State.STARTED;
}
override fun postAttach(controller: Controller, view: View) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_RESUME) // --> State.RESUMED;
}
override fun preDetach(controller: Controller, view: View) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_PAUSE) // --> State.STARTED;
}
override fun preDestroyView(controller: Controller, view: View) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_STOP) // --> State.CREATED;
}
override fun preContextUnavailable(controller: Controller, context: Context) {
// do nothing
}
override fun preDestroy(controller: Controller) {
// Only act on Controllers that have had at least the onContextAvailable call made on them.
if (lifecycleRegistry.currentState != Lifecycle.State.INITIALIZED) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY) // --> State.DESTROYED;
}
}
},
)
}
}
@@ -1,228 +0,0 @@
package com.bluelinelabs.conductor.internal;
import android.annotation.TargetApi;
import android.app.Activity;
import android.app.Application.ActivityLifecycleCallbacks;
import android.app.Fragment;
import android.content.Intent;
import android.os.Build;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.util.SparseArray;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.Router;
import java.util.HashMap;
import java.util.Map;
public class LifecycleHandler extends Fragment implements ActivityLifecycleCallbacks {
private static final String FRAGMENT_TAG = "LifecycleHandler";
private static final String KEY_PERMISSION_REQUEST_CODES = "LifecycleHandler.permissionRequests";
private static final String KEY_ACTIVITY_REQUEST_CODES = "LifecycleHandler.activityRequests";
private Activity mActivity;
private boolean mHasRegisteredCallbacks;
private SparseArray<String> mPermissionRequestMap = new SparseArray<>();
private SparseArray<String> mActivityRequestMap = new SparseArray<>();
private final Map<Integer, Router> mRouterMap = new HashMap<>();
public LifecycleHandler() {
setRetainInstance(true);
}
private static LifecycleHandler findInActivity(Activity activity) {
LifecycleHandler lifecycleHandler = (LifecycleHandler)activity.getFragmentManager().findFragmentByTag(FRAGMENT_TAG);
if (lifecycleHandler != null) {
lifecycleHandler.registerActivityListener(activity);
}
return lifecycleHandler;
}
public static LifecycleHandler install(Activity activity) {
LifecycleHandler lifecycleHandler = findInActivity(activity);
if (lifecycleHandler == null) {
lifecycleHandler = new LifecycleHandler();
activity.getFragmentManager().beginTransaction().add(lifecycleHandler, FRAGMENT_TAG).commit();
}
lifecycleHandler.registerActivityListener(activity);
return lifecycleHandler;
}
public Router getRouter(ViewGroup container, Bundle savedInstanceState) {
Router router = mRouterMap.get(getRouterHashKey(container));
if (router == null) {
router = new Router();
if (savedInstanceState != null) {
router.onRestoreInstanceState(savedInstanceState);
}
mRouterMap.put(getRouterHashKey(container), router);
}
router.setHost(this, container);
return router;
}
public Activity getLifecycleActivity() {
return mActivity;
}
private static int getRouterHashKey(ViewGroup viewGroup) {
return viewGroup.getId();
}
private void registerActivityListener(Activity activity) {
mActivity = activity;
if (!mHasRegisteredCallbacks) {
mHasRegisteredCallbacks = true;
activity.getApplication().registerActivityLifecycleCallbacks(this);
}
}
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
if (savedInstanceState != null) {
StringSparseArrayParceler permissionParcel = savedInstanceState.getParcelable(KEY_PERMISSION_REQUEST_CODES);
mPermissionRequestMap = permissionParcel != null ? permissionParcel.getStringSparseArray() : null;
StringSparseArrayParceler activityParcel = savedInstanceState.getParcelable(KEY_ACTIVITY_REQUEST_CODES);
mActivityRequestMap = activityParcel != null ? activityParcel.getStringSparseArray() : null;
}
}
@Override
public void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
outState.putParcelable(KEY_PERMISSION_REQUEST_CODES, new StringSparseArrayParceler(mPermissionRequestMap));
outState.putParcelable(KEY_ACTIVITY_REQUEST_CODES, new StringSparseArrayParceler(mActivityRequestMap));
}
@Override
public void onDestroy() {
super.onDestroy();
if (mActivity != null) {
mActivity.getApplication().unregisterActivityLifecycleCallbacks(this);
for (Router router : mRouterMap.values()) {
router.onActivityDestroyed(mActivity);
}
mActivity = null;
}
}
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
String instanceId = mActivityRequestMap.get(requestCode);
if (instanceId != null) {
for (Router router : mRouterMap.values()) {
router.onActivityResult(instanceId, requestCode, resultCode, data);
}
}
}
@Override
public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults);
String instanceId = mPermissionRequestMap.get(requestCode);
if (instanceId != null) {
for (Router router : mRouterMap.values()) {
router.onRequestPermissionsResult(instanceId, requestCode, permissions, grantResults);
}
}
}
@Override
public boolean shouldShowRequestPermissionRationale(@NonNull String permission) {
for (Router router : mRouterMap.values()) {
Boolean handled = router.handleRequestedPermission(permission);
if (handled != null) {
return handled;
}
}
return super.shouldShowRequestPermissionRationale(permission);
}
public void startActivityForResult(String instanceId, Intent intent, int requestCode) {
mActivityRequestMap.put(requestCode, instanceId);
startActivityForResult(intent, requestCode);
}
public void startActivityForResult(String instanceId, Intent intent, int requestCode, Bundle options) {
mActivityRequestMap.put(requestCode, instanceId);
startActivityForResult(intent, requestCode, options);
}
@TargetApi(Build.VERSION_CODES.M)
public void requestPermissions(String instanceId, String[] permissions, int requestCode) {
mPermissionRequestMap.put(requestCode, instanceId);
requestPermissions(permissions, requestCode);
}
@Override
public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
if (mActivity == null && findInActivity(activity) == LifecycleHandler.this) {
mActivity = activity;
}
}
@Override
public void onActivityStarted(Activity activity) {
if (mActivity == activity) {
for (Router router : mRouterMap.values()) {
router.onActivityStarted(activity);
}
}
}
@Override
public void onActivityResumed(Activity activity) {
if (mActivity == activity) {
for (Router router : mRouterMap.values()) {
router.onActivityResumed(activity);
}
}
}
@Override
public void onActivityPaused(Activity activity) {
if (mActivity == activity) {
for (Router router : mRouterMap.values()) {
router.onActivityPaused(activity);
}
}
}
@Override
public void onActivityStopped(Activity activity) {
if (mActivity == activity) {
for (Router router : mRouterMap.values()) {
router.onActivityStopped(activity);
}
}
}
@Override
public void onActivitySaveInstanceState(Activity activity, Bundle outState) {
if (mActivity == activity) {
for (Router router : mRouterMap.values()) {
router.onActivitySaveInstanceState(activity, outState);
}
}
}
@Override
public void onActivityDestroyed(Activity activity) { }
}
@@ -0,0 +1,605 @@
package com.bluelinelabs.conductor.internal
import android.app.Activity
import android.app.Application.ActivityLifecycleCallbacks
import android.content.Context
import android.content.Intent
import android.content.IntentSender
import android.os.Build
import android.os.Bundle
import android.os.Parcelable
import android.util.SparseArray
import android.view.Menu
import android.view.MenuInflater
import android.view.MenuItem
import android.view.ViewGroup
import androidx.annotation.RequiresApi
import androidx.fragment.app.FragmentActivity
import com.bluelinelabs.conductor.ActivityHostedRouter
import com.bluelinelabs.conductor.Router
import kotlinx.parcelize.Parcelize
internal interface LifecycleHandler {
val routers: List<Router>
val lifecycleActivity: Activity?
fun getRouter(container: ViewGroup, savedInstanceState: Bundle?): Router
fun registerActivityListener(activity: Activity)
fun registerForActivityResult(instanceId: String, requestCode: Int)
fun unregisterForActivityResults(instanceId: String)
fun startActivity(intent: Intent?)
fun startActivityForResult(instanceId: String, intent: Intent, requestCode: Int, options: Bundle? = null)
@Throws(IntentSender.SendIntentException::class)
fun startIntentSenderForResult(
instanceId: String,
intent: IntentSender,
requestCode: Int,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int,
options: Bundle?,
)
fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)
fun requestPermissions(instanceId: String, permissions: Array<String>, requestCode: Int)
companion object {
fun install(activity: Activity, allowAndroidXBacking: Boolean = true): LifecycleHandler {
var lifecycleHandler = findInActivity(activity, allowAndroidXBacking)
if (lifecycleHandler == null) {
if (allowAndroidXBacking && activity is FragmentActivity) {
lifecycleHandler = AndroidXLifecycleHandlerImpl()
activity.supportFragmentManager.beginTransaction().add(lifecycleHandler, FRAGMENT_TAG).commit()
} else {
lifecycleHandler = PlatformLifecycleHandlerImpl()
@Suppress("DEPRECATION")
activity.fragmentManager.beginTransaction().add(lifecycleHandler, FRAGMENT_TAG).commit()
}
}
lifecycleHandler.registerActivityListener(activity)
return lifecycleHandler
}
}
}
internal class AndroidXLifecycleHandlerImpl : androidx.fragment.app.Fragment(), LifecycleHandler, LifecycleHandlerDelegate {
override val data: LifecycleHandlerData = LifecycleHandlerData(isAndroidXLifecycleHandler = true)
override val routers: List<Router>
get() = data.routerMap.values.toList()
override val lifecycleActivity: Activity?
get() = data.activity
init {
@Suppress("DEPRECATION")
retainInstance = true
setHasOptionsMenu(true)
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
handleOnCreate(savedInstanceState)
}
override fun onSaveInstanceState(outState: Bundle) {
super.onSaveInstanceState(outState)
handleOnSaveInstanceState(outState)
}
override fun onAttach(context: Context) {
super.onAttach(context)
handleOnAttach(context)
}
@Suppress("DEPRECATION")
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
handleOnActivityResult(requestCode, resultCode, data)
}
@Suppress("DEPRECATION", "OVERRIDE_DEPRECATION")
override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<String>, grantResults: IntArray) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults)
handleOnRequestPermissionsResult(requestCode, permissions, grantResults)
}
override fun shouldShowRequestPermissionRationale(permission: String): Boolean {
return handleShouldShowRequestPermissionRationale(permission) {
super.shouldShowRequestPermissionRationale(permission)
}
}
override fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
super.onCreateOptionsMenu(menu, inflater)
handleOnCreateOptionsMenu(menu, inflater)
}
override fun onPrepareOptionsMenu(menu: Menu) {
super.onPrepareOptionsMenu(menu)
handleOnPrepareOptionsMenu(menu)
}
override fun onOptionsItemSelected(item: MenuItem): Boolean {
return handleOnOptionsItemSelected(item) {
super.onOptionsItemSelected(item)
}
}
override fun getRouter(container: ViewGroup, savedInstanceState: Bundle?): Router {
return getRouter(container, savedInstanceState, this)
}
override fun registerActivityListener(activity: Activity) {
handleRegisterActivityListener(activity, this)
}
override fun registerForActivityResult(instanceId: String, requestCode: Int) {
handleRegisterForActivityResult(instanceId, requestCode)
}
override fun unregisterForActivityResults(instanceId: String) {
handleUnregisterForActivityResults(instanceId)
}
override fun startActivityForResult(instanceId: String, intent: Intent, requestCode: Int, options: Bundle?) {
handleStartActivityForResult(instanceId, intent, requestCode, options)
}
@Suppress("DEPRECATION")
override fun startIntentSenderForResult(
instanceId: String,
intent: IntentSender,
requestCode: Int,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int,
options: Bundle?,
) {
handleStartIntentSenderForResult(
instanceId = instanceId,
intent = intent,
requestCode = requestCode,
fillInIntent = fillInIntent,
flagsMask = flagsMask,
flagsValues = flagsValues,
extraFlags = extraFlags,
options = options,
) {
startIntentSenderForResult(intent, requestCode, fillInIntent, flagsMask, flagsValues, extraFlags, options)
}
}
override fun requestPermissions(instanceId: String, permissions: Array<String>, requestCode: Int) {
handleRequestPermissions(instanceId, permissions, requestCode)
}
override fun onDetach() {
super.onDetach()
handleOnDetach()
}
override fun onDestroy() {
super.onDestroy()
handleOnDestroy()
}
}
@Suppress("DEPRECATION", "OVERRIDE_DEPRECATION")
internal class PlatformLifecycleHandlerImpl : android.app.Fragment(), LifecycleHandler, LifecycleHandlerDelegate {
override val data: LifecycleHandlerData = LifecycleHandlerData(isAndroidXLifecycleHandler = false)
override val routers: List<Router>
get() = data.routerMap.values.toList()
override val lifecycleActivity: Activity?
get() = data.activity
init {
retainInstance = true
setHasOptionsMenu(true)
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
handleOnCreate(savedInstanceState)
}
override fun onSaveInstanceState(outState: Bundle) {
super.onSaveInstanceState(outState)
handleOnSaveInstanceState(outState)
}
override fun onAttach(activity: Activity) {
super.onAttach(activity)
handleOnAttach(activity)
}
override fun onAttach(context: Context) {
super.onAttach(context)
handleOnAttach(context)
}
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
handleOnActivityResult(requestCode, resultCode, data)
}
override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<String>, grantResults: IntArray) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults)
handleOnRequestPermissionsResult(requestCode, permissions, grantResults)
}
override fun shouldShowRequestPermissionRationale(permission: String): Boolean {
return handleShouldShowRequestPermissionRationale(permission) {
super.shouldShowRequestPermissionRationale(permission)
}
}
override fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
super.onCreateOptionsMenu(menu, inflater)
handleOnCreateOptionsMenu(menu, inflater)
}
override fun onPrepareOptionsMenu(menu: Menu) {
super.onPrepareOptionsMenu(menu)
handleOnPrepareOptionsMenu(menu)
}
override fun onOptionsItemSelected(item: MenuItem): Boolean {
return handleOnOptionsItemSelected(item) {
super.onOptionsItemSelected(item)
}
}
override fun getRouter(container: ViewGroup, savedInstanceState: Bundle?): Router {
return getRouter(container, savedInstanceState, this)
}
override fun registerActivityListener(activity: Activity) {
handleRegisterActivityListener(activity, this)
}
override fun registerForActivityResult(instanceId: String, requestCode: Int) {
handleRegisterForActivityResult(instanceId, requestCode)
}
override fun unregisterForActivityResults(instanceId: String) {
handleUnregisterForActivityResults(instanceId)
}
override fun startActivityForResult(instanceId: String, intent: Intent, requestCode: Int, options: Bundle?) {
handleStartActivityForResult(instanceId, intent, requestCode, options)
}
@RequiresApi(Build.VERSION_CODES.N)
override fun startIntentSenderForResult(
instanceId: String,
intent: IntentSender,
requestCode: Int,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int,
options: Bundle?,
) {
handleStartIntentSenderForResult(
instanceId = instanceId,
intent = intent,
requestCode = requestCode,
fillInIntent = fillInIntent,
flagsMask = flagsMask,
flagsValues = flagsValues,
extraFlags = extraFlags,
options = options,
) {
startIntentSenderForResult(intent, requestCode, fillInIntent, flagsMask, flagsValues, extraFlags, options)
}
}
override fun requestPermissions(instanceId: String, permissions: Array<String>, requestCode: Int) {
handleRequestPermissions(instanceId, permissions, requestCode)
}
override fun onDetach() {
super.onDetach()
handleOnDetach()
}
override fun onDestroy() {
super.onDestroy()
handleOnDestroy()
}
}
private interface LifecycleHandlerDelegate : ActivityLifecycleCallbacks {
val data: LifecycleHandlerData
private val routers: List<ActivityHostedRouter>
get() = data.routerMap.values.toList()
fun handleOnCreate(savedInstanceState: Bundle?) {
savedInstanceState ?: return
data.permissionRequestMap = savedInstanceState.getParcelable<StringSparseArrayParceler>(KEY_PERMISSION_REQUEST_CODES)
?.stringSparseArray
?: SparseArray()
data.activityRequestMap = savedInstanceState.getParcelable<StringSparseArrayParceler>(KEY_ACTIVITY_REQUEST_CODES)
?.stringSparseArray
?: SparseArray()
data.pendingPermissionRequests = savedInstanceState.getParcelableArrayList(KEY_PENDING_PERMISSION_REQUESTS)
?: ArrayList()
}
fun handleOnSaveInstanceState(outState: Bundle) {
outState.putParcelable(KEY_PERMISSION_REQUEST_CODES, StringSparseArrayParceler(data.permissionRequestMap))
outState.putParcelable(KEY_ACTIVITY_REQUEST_CODES, StringSparseArrayParceler(data.activityRequestMap))
outState.putParcelableArrayList(KEY_PENDING_PERMISSION_REQUESTS, data.pendingPermissionRequests)
}
fun handleOnDestroy() {
data.activity?.let { activity ->
activity.application.unregisterActivityLifecycleCallbacks(this)
activeLifecycleHandlers.remove(activity)
destroyRouters(false)
data.activity = null
}
data.routerMap.clear()
}
fun getRouter(container: ViewGroup, savedInstanceState: Bundle?, handler: LifecycleHandler): Router {
data.routerMap[routerHashKey(container)]?.let {
it.setHost(handler, container)
return it
}
val router = ActivityHostedRouter()
router.setHost(handler, container)
savedInstanceState?.getBundle("$KEY_ROUTER_STATE_PREFIX${router.containerId}")?.let {
router.restoreInstanceState(it)
}
data.routerMap[routerHashKey(container)] = router
return router
}
fun handleRegisterActivityListener(activity: Activity, handler: LifecycleHandler) {
data.activity = activity
if (!data.hasRegisteredCallbacks) {
data.hasRegisteredCallbacks = true
activity.application.registerActivityLifecycleCallbacks(this)
// Since Fragment transactions are async, we have to keep an <Activity, LifecycleHandler> map in addition
// to trying to find the LifecycleHandler fragment in the Activity to handle the case of the developer
// trying to immediately get > 1 router in the same Activity. See issue #299.
activeLifecycleHandlers[activity] = handler
}
}
fun requestPermissions(permissions: Array<String>, requestCode: Int)
fun handleOnAttach(context: Context) {
if (context is Activity) {
data.activity = context
}
data.destroyed = false
if (!data.attached) {
data.attached = true
for (i in data.pendingPermissionRequests.indices.reversed()) {
val request = data.pendingPermissionRequests.removeAt(i)
handleRequestPermissions(request.instanceId, request.permissions, request.requestCode)
}
routers.forEach { it.onContextAvailable() }
}
}
fun handleOnDetach() {
data.attached = false
data.activity?.let { destroyRouters(it.isChangingConfigurations) }
}
private fun destroyRouters(configurationChange: Boolean) {
if (!data.destroyed) {
data.destroyed = true
data.activity?.let { activity ->
routers.forEach { it.onActivityDestroyed(activity, configurationChange) }
}
}
}
fun handleOnActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
this.data.activityRequestMap[requestCode]?.let { instanceId ->
routers.forEach { it.onActivityResult(instanceId, requestCode, resultCode, data) }
}
}
fun handleOnRequestPermissionsResult(requestCode: Int, permissions: Array<String>, grantResults: IntArray) {
data.permissionRequestMap[requestCode]?.let { instanceId ->
routers.forEach { it.onRequestPermissionsResult(instanceId, requestCode, permissions, grantResults) }
}
}
fun handleShouldShowRequestPermissionRationale(permission: String, callSuper: () -> Boolean): Boolean {
for (router in routers) {
val handled = router.handleRequestedPermission(permission)
if (handled != null) {
return handled
}
}
return callSuper()
}
fun handleOnCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
routers.forEach { it.onCreateOptionsMenu(menu, inflater) }
}
fun handleOnPrepareOptionsMenu(menu: Menu) {
routers.forEach { it.onPrepareOptionsMenu(menu) }
}
fun handleOnOptionsItemSelected(item: MenuItem, callSuper: () -> Boolean): Boolean {
return routers.any { it.onOptionsItemSelected(item) } || callSuper()
}
fun handleRegisterForActivityResult(instanceId: String, requestCode: Int) {
data.activityRequestMap.put(requestCode, instanceId)
}
fun startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)
fun handleStartActivityForResult(instanceId: String, intent: Intent, requestCode: Int, options: Bundle?) {
handleRegisterForActivityResult(instanceId, requestCode)
startActivityForResult(intent, requestCode, options)
}
fun handleStartIntentSenderForResult(
instanceId: String,
intent: IntentSender,
requestCode: Int,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int,
options: Bundle?,
startIntentSender: () -> Unit,
) {
handleRegisterForActivityResult(instanceId, requestCode)
startIntentSender()
}
fun handleUnregisterForActivityResults(instanceId: String) {
for (i in data.activityRequestMap.size() - 1 downTo 0) {
if (instanceId == data.activityRequestMap[data.activityRequestMap.keyAt(i)]) {
data.activityRequestMap.removeAt(i)
}
}
}
fun handleRequestPermissions(
instanceId: String,
permissions: Array<String>,
requestCode: Int,
) {
if (data.attached) {
data.permissionRequestMap.put(requestCode, instanceId)
requestPermissions(permissions, requestCode)
} else {
data.pendingPermissionRequests.add(PendingPermissionRequest(instanceId, permissions, requestCode))
}
}
override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) {
if (findInActivity(activity, data.isAndroidXLifecycleHandler) === this) {
data.activity = activity
data.routerMap.values.toList().forEach { it.onContextAvailable() }
}
}
override fun onActivityStarted(activity: Activity) {
if (data.activity === activity) {
data.hasPreparedForHostDetach = false
routers.forEach { it.onActivityStarted(activity) }
}
}
override fun onActivityResumed(activity: Activity) {
if (data.activity === activity) {
routers.forEach { it.onActivityResumed(activity) }
}
}
override fun onActivityPaused(activity: Activity) {
if (data.activity === activity) {
routers.forEach { it.onActivityPaused(activity) }
}
}
override fun onActivityStopped(activity: Activity) {
if (data.activity === activity) {
prepareForHostDetachIfNeeded()
routers.forEach { it.onActivityStopped(activity) }
}
}
override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) {
if (data.activity === activity) {
prepareForHostDetachIfNeeded()
routers.forEach {
val bundle = Bundle()
it.saveInstanceState(bundle)
outState.putBundle("$KEY_ROUTER_STATE_PREFIX${it.containerId}", bundle)
}
}
}
override fun onActivityPreDestroyed(activity: Activity) {
if (data.activity === activity && !activity.isChangingConfigurations) {
handleOnDestroy()
}
}
override fun onActivityDestroyed(activity: Activity) {
activeLifecycleHandlers.remove(activity)
}
private fun prepareForHostDetachIfNeeded() {
if (!data.hasPreparedForHostDetach) {
data.hasPreparedForHostDetach = true
routers.forEach { it.prepareForHostDetach() }
}
}
}
@Parcelize
internal class PendingPermissionRequest(
val instanceId: String,
val permissions: Array<String>,
val requestCode: Int,
) : Parcelable
internal class LifecycleHandlerData(
val isAndroidXLifecycleHandler: Boolean,
var activity: Activity? = null,
var hasRegisteredCallbacks: Boolean = false,
var destroyed: Boolean = false,
var attached: Boolean = false,
var hasPreparedForHostDetach: Boolean = false,
var permissionRequestMap: SparseArray<String> = SparseArray(),
var activityRequestMap: SparseArray<String> = SparseArray(),
var pendingPermissionRequests: ArrayList<PendingPermissionRequest> = arrayListOf(),
val routerMap: MutableMap<Int, ActivityHostedRouter> = mutableMapOf(),
)
private fun findInActivity(activity: Activity, allowAndroidXBacking: Boolean): LifecycleHandler? {
var lifecycleHandler = activeLifecycleHandlers[activity]
if (lifecycleHandler == null) {
lifecycleHandler = if (allowAndroidXBacking && activity is FragmentActivity) {
activity.supportFragmentManager.findFragmentByTag(FRAGMENT_TAG) as? LifecycleHandler
} else {
@Suppress("DEPRECATION")
activity.fragmentManager.findFragmentByTag(FRAGMENT_TAG) as? LifecycleHandler
}
}
lifecycleHandler?.registerActivityListener(activity)
return lifecycleHandler
}
private fun routerHashKey(viewGroup: ViewGroup) = viewGroup.id
private val activeLifecycleHandlers = mutableMapOf<Activity, LifecycleHandler>()
private const val FRAGMENT_TAG = "LifecycleHandler"
private const val KEY_PENDING_PERMISSION_REQUESTS = "LifecycleHandler.pendingPermissionRequests"
private const val KEY_PERMISSION_REQUEST_CODES = "LifecycleHandler.permissionRequests"
private const val KEY_ACTIVITY_REQUEST_CODES = "LifecycleHandler.activityRequests"
private const val KEY_ROUTER_STATE_PREFIX = "LifecycleHandler.routerState"
@@ -1,16 +0,0 @@
package com.bluelinelabs.conductor.internal;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
import com.bluelinelabs.conductor.ControllerChangeHandler;
public class NoOpControllerChangeHandler extends ControllerChangeHandler {
@Override
public void performChange(@NonNull ViewGroup container, @NonNull View from, @NonNull View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener) {
changeListener.onChangeCompleted();
}
}
@@ -0,0 +1,22 @@
package com.bluelinelabs.conductor.internal
import android.view.View
import android.view.ViewGroup
import com.bluelinelabs.conductor.ControllerChangeHandler
class NoOpControllerChangeHandler : ControllerChangeHandler() {
override val isReusable = true
override fun performChange(
container: ViewGroup,
from: View?,
to: View?,
isPush: Boolean,
changeListener: ControllerChangeCompletedListener
) {
changeListener.onChangeCompleted()
}
override fun copy(): ControllerChangeHandler = NoOpControllerChangeHandler()
}
@@ -0,0 +1,248 @@
package com.bluelinelabs.conductor.internal
import android.content.Context
import android.os.Bundle
import android.view.View
import androidx.lifecycle.Lifecycle
import androidx.lifecycle.LifecycleOwner
import androidx.lifecycle.LifecycleRegistry
import androidx.lifecycle.setViewTreeLifecycleOwner
import androidx.savedstate.SavedStateRegistry
import androidx.savedstate.SavedStateRegistryController
import androidx.savedstate.SavedStateRegistryOwner
import androidx.savedstate.setViewTreeSavedStateRegistryOwner
import com.bluelinelabs.conductor.Controller
import com.bluelinelabs.conductor.ControllerChangeHandler
import com.bluelinelabs.conductor.ControllerChangeType
/**
* This class sets the [ViewTreeLifecycleOwner] and [ViewTreeSavedStateRegistryOwner] which is
* necessary for Jetpack Compose. By setting these, the view state restoration and compose lifecycle
* play together with the lifecycle of the [Controller].
*/
internal class OwnViewTreeLifecycleAndRegistry private constructor(
controller: Controller
) : LifecycleOwner, SavedStateRegistryOwner {
private lateinit var lifecycleRegistry: LifecycleRegistry
private lateinit var savedStateRegistryController: SavedStateRegistryController
private var hasSavedState = false
private var savedRegistryState = Bundle.EMPTY
override val lifecycle: LifecycleRegistry
get() = lifecycleRegistry
override val savedStateRegistry: SavedStateRegistry get() = savedStateRegistryController.savedStateRegistry
init {
controller.addLifecycleListener(object : Controller.LifecycleListener() {
override fun preCreateView(controller: Controller) {
hasSavedState = false
lifecycleRegistry = LifecycleRegistry(this@OwnViewTreeLifecycleAndRegistry)
savedStateRegistryController = SavedStateRegistryController.create(
this@OwnViewTreeLifecycleAndRegistry
)
savedStateRegistryController.performRestore(savedRegistryState)
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_CREATE)
}
override fun postCreateView(controller: Controller, view: View) {
/**
* If the consumer of the library already has its own [ViewTreeLifecycleOwner] or
* [ViewTreeSavedStateRegistryOwner] set, don't overwrite it but assume that they're doing
* it on purpose.
*/
if (
view.getTag(androidx.lifecycle.runtime.R.id.view_tree_lifecycle_owner) == null &&
view.getTag(androidx.savedstate.R.id.view_tree_saved_state_registry_owner) == null
) {
view.setViewTreeLifecycleOwner(this@OwnViewTreeLifecycleAndRegistry)
view.setViewTreeSavedStateRegistryOwner(this@OwnViewTreeLifecycleAndRegistry)
}
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_START)
}
override fun postAttach(controller: Controller, view: View) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
}
override fun onChangeEnd(
changeController: Controller,
changeHandler: ControllerChangeHandler,
changeType: ControllerChangeType
) {
// Should only happen if pushing another controller over this one was aborted
if (
controller === changeController &&
changeType.isEnter &&
changeHandler.removesFromViewOnPush &&
changeController.view?.windowToken != null &&
lifecycleRegistry.currentState == Lifecycle.State.STARTED
) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
}
}
override fun onChangeStart(
changeController: Controller,
changeHandler: ControllerChangeHandler,
changeType: ControllerChangeType,
) {
pauseOnChangeStart(
targetController = controller,
changeController = changeController,
changeHandler = changeHandler,
changeType = changeType,
)
GlobalChangeStartListener.onChangeStart(changeController, changeHandler, changeType)
}
override fun preDetach(controller: Controller, view: View) {
// Should only happen if pushing this controller was aborted
if (lifecycleRegistry.currentState == Lifecycle.State.RESUMED) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_PAUSE)
}
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_STOP)
}
override fun onSaveInstanceState(controller: Controller, outState: Bundle) {
outState.putBundle(KEY_SAVED_STATE, savedRegistryState)
}
override fun onSaveViewState(controller: Controller, outState: Bundle) {
if (!hasSavedState) {
savedRegistryState = Bundle()
savedStateRegistryController.performSave(savedRegistryState)
}
}
override fun onRestoreInstanceState(controller: Controller, savedInstanceState: Bundle) {
savedRegistryState = savedInstanceState.getBundle(KEY_SAVED_STATE)
}
override fun preDestroyView(controller: Controller, view: View) {
if (controller.isBeingDestroyed && controller.router.backstackSize == 0) {
val parent = view.parent as? View
parent?.addOnAttachStateChangeListener(object : View.OnAttachStateChangeListener {
override fun onViewAttachedToWindow(v: View) = Unit
override fun onViewDetachedFromWindow(v: View) {
parent.removeOnAttachStateChangeListener(this)
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
}
})
} else {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
}
}
override fun postContextAvailable(controller: Controller, context: Context) {
listenForAncestorChangeStart(controller)
}
override fun preContextUnavailable(controller: Controller, context: Context) {
stopListeningForAncestorChangeStart(controller)
}
})
}
private fun listenForAncestorChangeStart(controller: Controller) {
GlobalChangeStartListener.subscribe(controller, controller.ancestors()) { ancestor, changeHandler, changeType ->
// No-op on the case where we (the child controller) hasn't yet created a View as our parent is being
// changed out.
if (::lifecycleRegistry.isInitialized) {
pauseOnChangeStart(
targetController = ancestor,
changeController = ancestor,
changeHandler = changeHandler,
changeType = changeType,
)
}
}
}
private fun stopListeningForAncestorChangeStart(controller: Controller) {
GlobalChangeStartListener.unsubscribe(controller)
}
// AbstractComposeView adds its own OnAttachStateChangeListener by default. Since it
// does this on init, its detach callbacks get called before ours, which prevents us
// from saving state in onDetach. The if statement in here should detect upcoming
// detachment.
private fun pauseOnChangeStart(
targetController: Controller,
changeController: Controller,
changeHandler: ControllerChangeHandler,
changeType: ControllerChangeType,
) {
if (
targetController === changeController &&
!changeType.isEnter &&
changeHandler.removesFromViewOnPush &&
changeController.view != null &&
lifecycleRegistry.currentState == Lifecycle.State.RESUMED
) {
lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_PAUSE)
savedRegistryState = Bundle()
savedStateRegistryController.performSave(savedRegistryState)
hasSavedState = true
}
}
private fun Controller.ancestors(): Collection<String> {
return buildList {
var ancestor = parentController
while (ancestor != null) {
add(ancestor.instanceId)
ancestor = ancestor.parentController
}
}
}
companion object {
private const val KEY_SAVED_STATE = "Registry.savedState"
fun own(target: Controller): OwnViewTreeLifecycleAndRegistry {
return OwnViewTreeLifecycleAndRegistry(target)
}
}
}
// In order to prevent child controllers from having strong references to all of their ancestors, some of which may
// break their connection before the child is made aware, this shared listener is used to call all interested parties
// when a controller begins transitioning.
private object GlobalChangeStartListener {
private val listeners = mutableMapOf<String, Listener>()
fun subscribe(
controller: Controller,
targetControllers: Collection<String>,
listener: (Controller, ControllerChangeHandler, ControllerChangeType) -> Unit,
) {
listeners[controller.instanceId] = Listener(targetControllers, listener)
}
fun unsubscribe(controller: Controller) {
listeners.remove(controller.instanceId)
}
fun onChangeStart(controller: Controller, changeHandler: ControllerChangeHandler, changeType: ControllerChangeType) {
listeners.values.forEach { it.call(controller, changeHandler, changeType) }
}
private class Listener(
private val targetControllers: Collection<String>,
private val listener: (Controller, ControllerChangeHandler, ControllerChangeType) -> Unit,
) {
fun call(controller: Controller, changeHandler: ControllerChangeHandler, changeType: ControllerChangeType) {
if (targetControllers.contains(controller.instanceId)) {
listener(controller, changeHandler, changeType)
}
}
}
}
@@ -0,0 +1,9 @@
package com.bluelinelabs.conductor.internal
import androidx.annotation.RestrictTo
import androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP
@RestrictTo(LIBRARY_GROUP)
interface RouterRequiringFunc {
fun execute()
}
@@ -1,56 +0,0 @@
package com.bluelinelabs.conductor.internal;
import android.os.Parcel;
import android.os.Parcelable;
import android.util.SparseArray;
public class StringSparseArrayParceler implements Parcelable {
private final SparseArray<String> mStringSparseArray;
public StringSparseArrayParceler(SparseArray<String> stringSparseArray) {
mStringSparseArray = stringSparseArray;
}
private StringSparseArrayParceler(Parcel in) {
mStringSparseArray = new SparseArray<>();
final int size = in.readInt();
for (int i = 0; i < size; i++) {
mStringSparseArray.put(in.readInt(), in.readString());
}
}
public SparseArray<String> getStringSparseArray() {
return mStringSparseArray;
}
public int describeContents() {
return 0;
}
public void writeToParcel(Parcel out, int flags) {
final int size = mStringSparseArray.size();
out.writeInt(size);
for (int i = 0; i < size; i++) {
int key = mStringSparseArray.keyAt(i);
out.writeInt(key);
out.writeString(mStringSparseArray.get(key));
}
}
public static final Parcelable.Creator<StringSparseArrayParceler> CREATOR = new Parcelable.Creator<StringSparseArrayParceler>() {
public StringSparseArrayParceler createFromParcel(Parcel in) {
return new StringSparseArrayParceler(in);
}
public StringSparseArrayParceler[] newArray(int size) {
return new StringSparseArrayParceler[size];
}
};
}
@@ -0,0 +1,39 @@
package com.bluelinelabs.conductor.internal
import android.os.Parcel
import android.os.Parcelable
import android.util.SparseArray
internal class StringSparseArrayParceler(val stringSparseArray: SparseArray<String>) : Parcelable {
override fun describeContents(): Int = 0
override fun writeToParcel(out: Parcel, flags: Int) {
val size = stringSparseArray.size()
out.writeInt(size)
for (i in 0 until size) {
val key = stringSparseArray.keyAt(i)
out.writeInt(key)
out.writeString(stringSparseArray[key])
}
}
companion object {
@Suppress("unused")
@JvmField
val CREATOR: Parcelable.Creator<StringSparseArrayParceler> =
object : Parcelable.Creator<StringSparseArrayParceler> {
override fun createFromParcel(parcel: Parcel): StringSparseArrayParceler {
val stringSparseArray = SparseArray<String>()
val size = parcel.readInt()
for (i in 0 until size) {
stringSparseArray.put(parcel.readInt(), parcel.readString())
}
return StringSparseArrayParceler(stringSparseArray)
}
override fun newArray(size: Int): Array<StringSparseArrayParceler?> = arrayOfNulls(size)
}
}
}
@@ -0,0 +1,17 @@
@file:JvmName("ThreadUtils")
package com.bluelinelabs.conductor.internal
import android.os.Looper
import android.util.AndroidRuntimeException
import androidx.annotation.RestrictTo
import androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP
@RestrictTo(LIBRARY_GROUP)
internal fun ensureMainThread() {
if (Looper.getMainLooper().thread !== Thread.currentThread()) {
throw CalledFromWrongThreadException("Methods that affect the view hierarchy can can only be called from the main thread.")
}
}
private class CalledFromWrongThreadException(msg: String?) : AndroidRuntimeException(msg)
@@ -0,0 +1,25 @@
package com.bluelinelabs.conductor.internal
import android.os.Bundle
import androidx.annotation.RestrictTo
import androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP
@RestrictTo(LIBRARY_GROUP)
class TransactionIndexer {
private var currentIndex = 0
fun nextIndex(): Int {
return ++currentIndex
}
fun saveInstanceState(outState: Bundle) {
outState.putInt(KEY_INDEX, currentIndex)
}
fun restoreInstanceState(savedInstanceState: Bundle) {
currentIndex = savedInstanceState.getInt(KEY_INDEX)
}
}
private const val KEY_INDEX = "TransactionIndexer.currentIndex"
@@ -0,0 +1,151 @@
package com.bluelinelabs.conductor.internal;
import android.view.View;
import android.view.View.OnAttachStateChangeListener;
import android.view.ViewGroup;
public class ViewAttachHandler implements OnAttachStateChangeListener {
private enum ReportedState {
VIEW_DETACHED,
ACTIVITY_STOPPED,
ATTACHED
}
public interface ViewAttachListener {
void onAttached();
void onDetached(boolean fromActivityStop);
void onViewDetachAfterStop();
}
private interface ChildAttachListener {
void onAttached();
}
private boolean rootAttached = false;
boolean childrenAttached = false;
private boolean activityStopped = false;
private ReportedState reportedState = ReportedState.VIEW_DETACHED;
private ViewAttachListener attachListener;
OnAttachStateChangeListener childOnAttachStateChangeListener;
public ViewAttachHandler(ViewAttachListener attachListener) {
this.attachListener = attachListener;
}
@Override
public void onViewAttachedToWindow(final View v) {
if (rootAttached) {
return;
}
rootAttached = true;
listenForDeepestChildAttach(v, new ChildAttachListener() {
@Override
public void onAttached() {
childrenAttached = true;
reportAttached();
}
});
}
@Override
public void onViewDetachedFromWindow(View v) {
rootAttached = false;
if (childrenAttached) {
childrenAttached = false;
reportDetached(false);
}
}
public void listenForAttach(final View view) {
view.addOnAttachStateChangeListener(this);
}
public void unregisterAttachListener(View view) {
view.removeOnAttachStateChangeListener(this);
if (childOnAttachStateChangeListener != null && view instanceof ViewGroup) {
findDeepestChild((ViewGroup)view).removeOnAttachStateChangeListener(childOnAttachStateChangeListener);
childOnAttachStateChangeListener = null;
}
}
public void onActivityStarted() {
activityStopped = false;
reportAttached();
}
public void onActivityStopped() {
activityStopped = true;
reportDetached(true);
}
void reportAttached() {
if (rootAttached && childrenAttached && !activityStopped && reportedState != ReportedState.ATTACHED) {
reportedState = ReportedState.ATTACHED;
attachListener.onAttached();
}
}
private void reportDetached(boolean detachedForActivity) {
boolean wasDetachedForActivity = reportedState == ReportedState.ACTIVITY_STOPPED;
if (detachedForActivity) {
reportedState = ReportedState.ACTIVITY_STOPPED;
} else {
reportedState = ReportedState.VIEW_DETACHED;
}
if (wasDetachedForActivity && !detachedForActivity) {
attachListener.onViewDetachAfterStop();
} else {
attachListener.onDetached(detachedForActivity);
}
}
private void listenForDeepestChildAttach(final View view, final ChildAttachListener attachListener) {
if (!(view instanceof ViewGroup)) {
attachListener.onAttached();
return;
}
ViewGroup viewGroup = (ViewGroup)view;
if (viewGroup.getChildCount() == 0) {
attachListener.onAttached();
return;
}
childOnAttachStateChangeListener = new OnAttachStateChangeListener() {
boolean attached = false;
@Override
public void onViewAttachedToWindow(View v) {
if (!attached && childOnAttachStateChangeListener != null) {
attached = true;
attachListener.onAttached();
v.removeOnAttachStateChangeListener(this);
childOnAttachStateChangeListener = null;
}
}
@Override
public void onViewDetachedFromWindow(View v) { }
};
findDeepestChild(viewGroup).addOnAttachStateChangeListener(childOnAttachStateChangeListener);
}
private View findDeepestChild(ViewGroup viewGroup) {
if (viewGroup.getChildCount() == 0) {
return viewGroup;
}
View lastChild = viewGroup.getChildAt(viewGroup.getChildCount() - 1);
if (lastChild instanceof ViewGroup) {
return findDeepestChild((ViewGroup)lastChild);
} else {
return lastChild;
}
}
}
@@ -0,0 +1,9 @@
-keepclassmembers public class * extends com.bluelinelabs.conductor.Controller {
public <init>();
public <init>(android.os.Bundle);
}
-keepclassmembers public class * extends com.bluelinelabs.conductor.ControllerChangeHandler {
public <init>();
}
@@ -1,66 +0,0 @@
package com.bluelinelabs.conductor;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
public class BackstackTests {
private Backstack mBackstack;
@Before
public void setup() {
mBackstack = new Backstack();
}
@Test
public void testPush() {
Assert.assertEquals(0, mBackstack.size());
mBackstack.push(RouterTransaction.builder(new TestController()).build());
Assert.assertEquals(1, mBackstack.size());
}
@Test
public void testPop() {
mBackstack.push(RouterTransaction.builder(new TestController()).build());
mBackstack.push(RouterTransaction.builder(new TestController()).build());
Assert.assertEquals(2, mBackstack.size());
mBackstack.pop();
Assert.assertEquals(1, mBackstack.size());
mBackstack.pop();
Assert.assertEquals(0, mBackstack.size());
}
@Test
public void testPeek() {
RouterTransaction transaction1 = RouterTransaction.builder(new TestController()).build();
RouterTransaction transaction2 = RouterTransaction.builder(new TestController()).build();
mBackstack.push(transaction1);
Assert.assertEquals(transaction1, mBackstack.peek());
mBackstack.push(transaction2);
Assert.assertEquals(transaction2, mBackstack.peek());
mBackstack.pop();
Assert.assertEquals(transaction1, mBackstack.peek());
}
@Test
public void testPopTo() {
RouterTransaction transaction1 = RouterTransaction.builder(new TestController()).build();
RouterTransaction transaction2 = RouterTransaction.builder(new TestController()).build();
RouterTransaction transaction3 = RouterTransaction.builder(new TestController()).build();
mBackstack.push(transaction1);
mBackstack.push(transaction2);
mBackstack.push(transaction3);
Assert.assertEquals(3, mBackstack.size());
mBackstack.popTo(transaction1);
Assert.assertEquals(1, mBackstack.size());
Assert.assertEquals(transaction1, mBackstack.peek());
}
}
@@ -0,0 +1,60 @@
package com.bluelinelabs.conductor
import org.junit.Assert.assertEquals
import org.junit.Test
class BackstackTests {
private val backstack = Backstack()
@Test
fun testPush() {
assertEquals(0, backstack.size.toLong())
backstack.push(TestController().asTransaction())
assertEquals(1, backstack.size.toLong())
}
@Test
fun testPop() {
backstack.push(TestController().asTransaction())
backstack.push(TestController().asTransaction())
assertEquals(2, backstack.size.toLong())
backstack.pop()
assertEquals(1, backstack.size.toLong())
backstack.pop()
assertEquals(0, backstack.size.toLong())
}
@Test
fun testPeek() {
val transaction1 = TestController().asTransaction()
val transaction2 = TestController().asTransaction()
backstack.push(transaction1)
assertEquals(transaction1, backstack.peek())
backstack.push(transaction2)
assertEquals(transaction2, backstack.peek())
backstack.pop()
assertEquals(transaction1, backstack.peek())
}
@Test
fun testPopTo() {
val transaction1 = TestController().asTransaction()
val transaction2 = TestController().asTransaction()
val transaction3 = TestController().asTransaction()
backstack.push(transaction1)
backstack.push(transaction2)
backstack.push(transaction3)
assertEquals(3, backstack.size.toLong())
backstack.popTo(transaction1)
assertEquals(1, backstack.size.toLong())
assertEquals(transaction1, backstack.peek())
}
}
@@ -1,11 +1,15 @@
package com.bluelinelabs.conductor;
import static org.junit.Assert.assertEquals;
import com.bluelinelabs.conductor.changehandler.FadeChangeHandler;
import com.bluelinelabs.conductor.changehandler.HorizontalChangeHandler;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
@RunWith(RobolectricTestRunner.class)
public class ControllerChangeHandlerTests {
@Test
@@ -13,26 +17,25 @@ public class ControllerChangeHandlerTests {
HorizontalChangeHandler horizontalChangeHandler = new HorizontalChangeHandler();
FadeChangeHandler fadeChangeHandler = new FadeChangeHandler(120, false);
RouterTransaction transaction = RouterTransaction.builder(new TestController())
RouterTransaction transaction = RouterTransaction.with(new TestController())
.pushChangeHandler(horizontalChangeHandler)
.popChangeHandler(fadeChangeHandler)
.build();
RouterTransaction restoredTransaction = new RouterTransaction(transaction.detachAndSaveInstanceState());
.popChangeHandler(fadeChangeHandler);
RouterTransaction restoredTransaction = new RouterTransaction(transaction.saveInstanceState());
ControllerChangeHandler restoredHorizontal = restoredTransaction.getPushControllerChangeHandler();
ControllerChangeHandler restoredFade = restoredTransaction.getPopControllerChangeHandler();
ControllerChangeHandler restoredHorizontal = restoredTransaction.pushChangeHandler();
ControllerChangeHandler restoredFade = restoredTransaction.popChangeHandler();
Assert.assertEquals(horizontalChangeHandler.getClass(), restoredHorizontal.getClass());
Assert.assertEquals(fadeChangeHandler.getClass(), restoredFade.getClass());
assertEquals(horizontalChangeHandler.getClass(), restoredHorizontal.getClass());
assertEquals(fadeChangeHandler.getClass(), restoredFade.getClass());
HorizontalChangeHandler restoredHorizontalCast = (HorizontalChangeHandler)restoredHorizontal;
FadeChangeHandler restoredFadeCast = (FadeChangeHandler)restoredFade;
HorizontalChangeHandler restoredHorizontalCast = (HorizontalChangeHandler) restoredHorizontal;
FadeChangeHandler restoredFadeCast = (FadeChangeHandler) restoredFade;
Assert.assertEquals(horizontalChangeHandler.getAnimationDuration(), restoredHorizontalCast.getAnimationDuration());
Assert.assertEquals(horizontalChangeHandler.removesFromViewOnPush(), restoredHorizontalCast.removesFromViewOnPush());
assertEquals(horizontalChangeHandler.getAnimationDuration(), restoredHorizontalCast.getAnimationDuration());
assertEquals(horizontalChangeHandler.getRemovesFromViewOnPush(), restoredHorizontalCast.getRemovesFromViewOnPush());
Assert.assertEquals(fadeChangeHandler.getAnimationDuration(), restoredFadeCast.getAnimationDuration());
Assert.assertEquals(fadeChangeHandler.removesFromViewOnPush(), restoredFadeCast.removesFromViewOnPush());
assertEquals(fadeChangeHandler.getAnimationDuration(), restoredFadeCast.getAnimationDuration());
assertEquals(fadeChangeHandler.getRemovesFromViewOnPush(), restoredFadeCast.getRemovesFromViewOnPush());
}
}
@@ -0,0 +1,255 @@
package com.bluelinelabs.conductor
import android.os.Looper.getMainLooper
import android.view.View
import com.bluelinelabs.conductor.Controller.LifecycleListener
import com.bluelinelabs.conductor.util.MockChangeHandler
import com.bluelinelabs.conductor.util.TestActivity
import org.junit.Assert
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.Robolectric
import org.robolectric.RobolectricTestRunner
import org.robolectric.Shadows.shadowOf
import org.robolectric.annotation.Config
@RunWith(RobolectricTestRunner::class)
@Config(manifest = Config.NONE)
class ControllerLifecycleActivityReferenceTests {
private val activityController = Robolectric.buildActivity(TestActivity::class.java).setup()
private val activity = activityController.get()
@Test
fun testSingleControllerActivityOnPush() {
val controller = TestController()
Assert.assertNull(controller.activity)
val listener = ActivityReferencingLifecycleListener()
controller.addLifecycleListener(listener)
activity.router.pushController(
controller.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
Assert.assertEquals(listOf(true), listener.changeEndReferences)
Assert.assertEquals(listOf(true), listener.postCreateViewReferences)
Assert.assertEquals(listOf(true), listener.postAttachReferences)
Assert.assertEquals(emptyList<Any>(), listener.postDetachReferences)
Assert.assertEquals(emptyList<Any>(), listener.postDestroyViewReferences)
Assert.assertEquals(emptyList<Any>(), listener.postDestroyReferences)
}
@Test
fun testChildControllerActivityOnPush() {
val parent = TestController()
activity.router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
Assert.assertNull(child.activity)
val listener = ActivityReferencingLifecycleListener()
child.addLifecycleListener(listener)
val childRouter = parent.getChildRouter((parent.view!!.findViewById(TestController.VIEW_ID)))
childRouter.pushController(
child.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
Assert.assertEquals(listOf(true), listener.changeEndReferences)
Assert.assertEquals(listOf(true), listener.postCreateViewReferences)
Assert.assertEquals(listOf(true), listener.postAttachReferences)
Assert.assertEquals(emptyList<Any>(), listener.postDetachReferences)
Assert.assertEquals(emptyList<Any>(), listener.postDestroyViewReferences)
Assert.assertEquals(emptyList<Any>(), listener.postDestroyReferences)
}
@Test
fun testSingleControllerActivityOnPop() {
val controller = TestController()
val listener = ActivityReferencingLifecycleListener()
controller.addLifecycleListener(listener)
activity.router.pushController(
controller.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
activity.router.popCurrentController()
Assert.assertEquals(listOf(true, true), listener.changeEndReferences)
Assert.assertEquals(listOf(true), listener.postCreateViewReferences)
Assert.assertEquals(listOf(true), listener.postAttachReferences)
Assert.assertEquals(listOf(true), listener.postDetachReferences)
Assert.assertEquals(listOf(true), listener.postDestroyViewReferences)
Assert.assertEquals(listOf(true), listener.postDestroyReferences)
}
@Test
fun testChildControllerActivityOnPop() {
val parent = TestController()
activity.router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
val listener = ActivityReferencingLifecycleListener()
child.addLifecycleListener(listener)
val childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.setPopRootControllerMode(Router.PopRootControllerMode.POP_ROOT_CONTROLLER_AND_VIEW)
childRouter.pushController(
child.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
childRouter.popCurrentController()
shadowOf(getMainLooper()).idle()
Assert.assertEquals(listOf(true, true), listener.changeEndReferences)
Assert.assertEquals(listOf(true), listener.postCreateViewReferences)
Assert.assertEquals(listOf(true), listener.postAttachReferences)
Assert.assertEquals(listOf(true), listener.postDetachReferences)
Assert.assertEquals(listOf(true), listener.postDestroyViewReferences)
Assert.assertEquals(listOf(true), listener.postDestroyReferences)
}
@Test
fun testChildControllerActivityOnParentPop() {
val parent = TestController()
activity.router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
val listener = ActivityReferencingLifecycleListener()
child.addLifecycleListener(listener)
val childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.setPopRootControllerMode(Router.PopRootControllerMode.POP_ROOT_CONTROLLER_AND_VIEW)
childRouter.pushController(
child.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
activity.router.popCurrentController()
Assert.assertEquals(listOf(true, true), listener.changeEndReferences)
Assert.assertEquals(listOf(true), listener.postCreateViewReferences)
Assert.assertEquals(listOf(true), listener.postAttachReferences)
Assert.assertEquals(listOf(true), listener.postDetachReferences)
Assert.assertEquals(listOf(true), listener.postDestroyViewReferences)
Assert.assertEquals(listOf(true), listener.postDestroyReferences)
}
@Test
fun testSingleControllerActivityOnDestroy() {
val controller = TestController()
val listener = ActivityReferencingLifecycleListener()
controller.addLifecycleListener(listener)
activity.router.pushController(
controller.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
activityController.pause().stop().destroy()
Assert.assertEquals(listOf(true), listener.changeEndReferences)
Assert.assertEquals(listOf(true), listener.postCreateViewReferences)
Assert.assertEquals(listOf(true), listener.postAttachReferences)
Assert.assertEquals(listOf(true), listener.postDetachReferences)
Assert.assertEquals(listOf(true), listener.postDestroyViewReferences)
Assert.assertEquals(listOf(true), listener.postDestroyReferences)
}
@Test
fun testChildControllerActivityOnDestroy() {
val parent = TestController()
activity.router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
val listener = ActivityReferencingLifecycleListener()
child.addLifecycleListener(listener)
val childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.setPopRootControllerMode(Router.PopRootControllerMode.POP_ROOT_CONTROLLER_AND_VIEW)
childRouter.pushController(
child.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
activityController.pause().stop().destroy()
Assert.assertEquals(listOf(true, true), listener.changeEndReferences)
Assert.assertEquals(listOf(true), listener.postCreateViewReferences)
Assert.assertEquals(listOf(true), listener.postAttachReferences)
Assert.assertEquals(listOf(true), listener.postDetachReferences)
Assert.assertEquals(listOf(true), listener.postDestroyViewReferences)
Assert.assertEquals(listOf(true), listener.postDestroyReferences)
}
internal class ActivityReferencingLifecycleListener : LifecycleListener() {
val changeEndReferences = mutableListOf<Boolean>()
val postCreateViewReferences = mutableListOf<Boolean>()
val postAttachReferences = mutableListOf<Boolean>()
val postDetachReferences = mutableListOf<Boolean>()
val postDestroyViewReferences = mutableListOf<Boolean>()
val postDestroyReferences = mutableListOf<Boolean>()
override fun onChangeEnd(
controller: Controller,
changeHandler: ControllerChangeHandler,
changeType: ControllerChangeType
) {
changeEndReferences.add(controller.activity != null)
}
override fun postCreateView(controller: Controller, view: View) {
postCreateViewReferences.add(controller.activity != null)
}
override fun postAttach(controller: Controller, view: View) {
postAttachReferences.add(controller.activity != null)
}
override fun postDetach(controller: Controller, view: View) {
postDetachReferences.add(controller.activity != null)
}
override fun postDestroyView(controller: Controller) {
postDestroyViewReferences.add(controller.activity != null)
}
override fun postDestroy(controller: Controller) {
postDestroyReferences.add(controller.activity != null)
}
}
}
@@ -0,0 +1,704 @@
package com.bluelinelabs.conductor
import android.content.Context
import android.os.Bundle
import android.os.Looper.getMainLooper
import android.view.View
import com.bluelinelabs.conductor.Controller.LifecycleListener
import com.bluelinelabs.conductor.Controller.RetainViewMode
import com.bluelinelabs.conductor.changehandler.SimpleSwapChangeHandler
import com.bluelinelabs.conductor.util.CallState
import com.bluelinelabs.conductor.util.MockChangeHandler
import com.bluelinelabs.conductor.util.MockChangeHandler.ChangeHandlerListener
import com.bluelinelabs.conductor.util.TestActivity
import com.bluelinelabs.conductor.util.ViewUtils
import org.junit.Assert
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.Robolectric
import org.robolectric.RobolectricTestRunner
import org.robolectric.Shadows.shadowOf
import org.robolectric.android.controller.ActivityController
import org.robolectric.annotation.Config
@RunWith(RobolectricTestRunner::class)
@Config(manifest = Config.NONE)
class ControllerLifecycleCallbacksTests {
private lateinit var activityController: ActivityController<TestActivity>
private lateinit var currentCallState: CallState
private fun createActivityController(savedInstanceState: Bundle?, includeStartAndResume: Boolean) {
activityController = Robolectric.buildActivity(TestActivity::class.java)
activityController.create(savedInstanceState)
if (savedInstanceState != null) {
activityController.restoreInstanceState(savedInstanceState)
}
if (includeStartAndResume) {
activityController
.start()
.postCreate(savedInstanceState)
.resume()
.visible()
}
if (!activityController.get().router.hasRootController()) {
activityController.get().router.setRoot(TestController().asTransaction())
}
}
@Before
fun setup() {
createActivityController(null, true)
currentCallState = CallState(false)
}
@Test
fun testNormalLifecycle() {
val controller = TestController()
attachLifecycleListener(controller)
val expectedCallState = CallState(false)
assertCalls(expectedCallState, controller)
activityController.get().router.pushController(
controller.asTransaction(
pushChangeHandler = getPushHandler(expectedCallState, controller),
popChangeHandler = getPopHandler(expectedCallState, controller)
)
)
assertCalls(expectedCallState, controller)
activityController.get().router.popCurrentController()
Assert.assertNull(controller.view)
assertCalls(expectedCallState, controller)
}
@Test
fun testLifecycleWithActivityStop() {
val controller = TestController()
attachLifecycleListener(controller)
val expectedCallState = CallState(false)
assertCalls(expectedCallState, controller)
activityController.get().router.pushController(
controller.asTransaction(
pushChangeHandler = getPushHandler(expectedCallState, controller)
)
)
assertCalls(expectedCallState, controller)
activityController.get().destroying = true
activityController.pause()
assertCalls(expectedCallState, controller)
activityController.stop()
expectedCallState.detachCalls++
assertCalls(expectedCallState, controller)
Assert.assertNotNull(controller.view)
ViewUtils.reportAttached(controller.view, false)
expectedCallState.saveViewStateCalls++
expectedCallState.destroyViewCalls++
assertCalls(expectedCallState, controller)
}
@Test
fun testLifecycleWithActivityDestroy() {
val controller = TestController()
attachLifecycleListener(controller)
val expectedCallState = CallState(false)
assertCalls(expectedCallState, controller)
activityController.get().router.pushController(
controller.asTransaction(
pushChangeHandler = getPushHandler(expectedCallState, controller)
)
)
assertCalls(expectedCallState, controller)
activityController.get().destroying = true
activityController.pause()
assertCalls(expectedCallState, controller)
activityController.stop()
expectedCallState.detachCalls++
assertCalls(expectedCallState, controller)
activityController.destroy()
expectedCallState.destroyViewCalls++
expectedCallState.contextUnavailableCalls++
expectedCallState.destroyCalls++
assertCalls(expectedCallState, controller)
}
@Test
fun testLifecycleWithActivityConfigurationChange() {
var controller = TestController()
attachLifecycleListener(controller)
val expectedCallState = CallState(false)
assertCalls(expectedCallState, controller)
activityController.get().router.pushController(
RouterTransaction.with(controller)
.pushChangeHandler(getPushHandler(expectedCallState, controller))
.tag("root")
)
assertCalls(expectedCallState, controller)
activityController.get().changingConfigurations = true
val bundle = Bundle()
activityController.saveInstanceState(bundle)
expectedCallState.saveViewStateCalls++
expectedCallState.saveInstanceStateCalls++
assertCalls(expectedCallState, controller)
activityController.pause()
assertCalls(expectedCallState, controller)
activityController.stop()
expectedCallState.detachCalls++
assertCalls(expectedCallState, controller)
activityController.destroy()
expectedCallState.destroyViewCalls++
expectedCallState.contextUnavailableCalls++
assertCalls(expectedCallState, controller)
createActivityController(bundle, false)
controller = activityController.get().router.getControllerWithTag("root") as TestController
expectedCallState.contextAvailableCalls++
expectedCallState.restoreInstanceStateCalls++
expectedCallState.restoreViewStateCalls++
expectedCallState.changeStartCalls++
expectedCallState.createViewCalls++
// Lifecycle listener isn't attached during restore, grab the current views from the controller for this stuff...
currentCallState.restoreInstanceStateCalls = controller.currentCallState.restoreInstanceStateCalls
currentCallState.restoreViewStateCalls = controller.currentCallState.restoreViewStateCalls
currentCallState.changeStartCalls = controller.currentCallState.changeStartCalls
currentCallState.changeEndCalls = controller.currentCallState.changeEndCalls
currentCallState.createViewCalls = controller.currentCallState.createViewCalls
currentCallState.attachCalls = controller.currentCallState.attachCalls
currentCallState.contextAvailableCalls = controller.currentCallState.contextAvailableCalls
assertCalls(expectedCallState, controller)
activityController
.start()
.postCreate(bundle)
.resume()
.visible()
currentCallState.changeEndCalls = controller.currentCallState.changeEndCalls
currentCallState.attachCalls = controller.currentCallState.attachCalls
expectedCallState.changeEndCalls++
expectedCallState.attachCalls++
assertCalls(expectedCallState, controller)
activityController.resume()
assertCalls(expectedCallState, controller)
}
@Test
fun testLifecycleWithActivityBackground() {
val controller = TestController()
attachLifecycleListener(controller)
val expectedCallState = CallState(false)
assertCalls(expectedCallState, controller)
activityController.get().router.pushController(
controller.asTransaction(
pushChangeHandler = getPushHandler(expectedCallState, controller)
)
)
assertCalls(expectedCallState, controller)
activityController.pause()
val bundle = Bundle()
activityController.saveInstanceState(bundle)
expectedCallState.saveInstanceStateCalls++
expectedCallState.saveViewStateCalls++
assertCalls(expectedCallState, controller)
activityController.resume()
assertCalls(expectedCallState, controller)
}
@Test
fun testLifecycleCallOrder() {
val testController = TestController()
val callState = CallState(false)
testController.addLifecycleListener(object : LifecycleListener() {
override fun preCreateView(controller: Controller) {
callState.createViewCalls++
Assert.assertEquals(1, callState.createViewCalls)
Assert.assertEquals(0, testController.currentCallState.createViewCalls)
Assert.assertEquals(0, callState.attachCalls)
Assert.assertEquals(0, testController.currentCallState.attachCalls)
Assert.assertEquals(0, callState.detachCalls)
Assert.assertEquals(0, testController.currentCallState.detachCalls)
Assert.assertEquals(0, callState.destroyViewCalls)
Assert.assertEquals(0, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun postCreateView(controller: Controller, view: View) {
callState.createViewCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(0, callState.attachCalls)
Assert.assertEquals(0, testController.currentCallState.attachCalls)
Assert.assertEquals(0, callState.detachCalls)
Assert.assertEquals(0, testController.currentCallState.detachCalls)
Assert.assertEquals(0, callState.destroyViewCalls)
Assert.assertEquals(0, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun preAttach(controller: Controller, view: View) {
callState.attachCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(1, callState.attachCalls)
Assert.assertEquals(0, testController.currentCallState.attachCalls)
Assert.assertEquals(0, callState.detachCalls)
Assert.assertEquals(0, testController.currentCallState.detachCalls)
Assert.assertEquals(0, callState.destroyViewCalls)
Assert.assertEquals(0, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun postAttach(controller: Controller, view: View) {
callState.attachCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(1, testController.currentCallState.attachCalls)
Assert.assertEquals(0, callState.detachCalls)
Assert.assertEquals(0, testController.currentCallState.detachCalls)
Assert.assertEquals(0, callState.destroyViewCalls)
Assert.assertEquals(0, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun preDetach(controller: Controller, view: View) {
callState.detachCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(1, testController.currentCallState.attachCalls)
Assert.assertEquals(1, callState.detachCalls)
Assert.assertEquals(0, testController.currentCallState.detachCalls)
Assert.assertEquals(0, callState.destroyViewCalls)
Assert.assertEquals(0, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun postDetach(controller: Controller, view: View) {
callState.detachCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(1, testController.currentCallState.attachCalls)
Assert.assertEquals(2, callState.detachCalls)
Assert.assertEquals(1, testController.currentCallState.detachCalls)
Assert.assertEquals(0, callState.destroyViewCalls)
Assert.assertEquals(0, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun preDestroyView(controller: Controller, view: View) {
callState.destroyViewCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(1, testController.currentCallState.attachCalls)
Assert.assertEquals(2, callState.detachCalls)
Assert.assertEquals(1, testController.currentCallState.detachCalls)
Assert.assertEquals(1, callState.destroyViewCalls)
Assert.assertEquals(0, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun postDestroyView(controller: Controller) {
callState.destroyViewCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(1, testController.currentCallState.attachCalls)
Assert.assertEquals(2, callState.detachCalls)
Assert.assertEquals(1, testController.currentCallState.detachCalls)
Assert.assertEquals(2, callState.destroyViewCalls)
Assert.assertEquals(1, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(0, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun preDestroy(controller: Controller) {
callState.destroyCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(1, testController.currentCallState.attachCalls)
Assert.assertEquals(2, callState.detachCalls)
Assert.assertEquals(1, testController.currentCallState.detachCalls)
Assert.assertEquals(2, callState.destroyViewCalls)
Assert.assertEquals(1, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(1, callState.destroyCalls)
Assert.assertEquals(0, testController.currentCallState.destroyCalls)
}
override fun postDestroy(controller: Controller) {
callState.destroyCalls++
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(1, testController.currentCallState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(1, testController.currentCallState.attachCalls)
Assert.assertEquals(2, callState.detachCalls)
Assert.assertEquals(1, testController.currentCallState.detachCalls)
Assert.assertEquals(2, callState.destroyViewCalls)
Assert.assertEquals(1, testController.currentCallState.destroyViewCalls)
Assert.assertEquals(2, callState.destroyCalls)
Assert.assertEquals(1, testController.currentCallState.destroyCalls)
}
})
activityController.get().router.pushController(
testController.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
activityController.get().router.popController(testController)
Assert.assertEquals(2, callState.createViewCalls)
Assert.assertEquals(2, callState.attachCalls)
Assert.assertEquals(2, callState.detachCalls)
Assert.assertEquals(2, callState.destroyViewCalls)
Assert.assertEquals(2, callState.destroyCalls)
}
@Test
fun testLifecycleWhenPopNonCurrentController() {
val controller1Tag = "controller1"
val controller2Tag = "controller2"
val controller3Tag = "controller3"
val controller1 = TestController()
val controller2 = TestController()
val controller3 = TestController()
activityController.get().router.pushController(
RouterTransaction.with(controller1).tag(controller1Tag)
)
activityController.get().router.pushController(
RouterTransaction.with(controller2).tag(controller2Tag)
)
activityController.get().router.pushController(
RouterTransaction.with(controller3).tag(controller3Tag)
)
activityController.get().router.popController(controller2)
Assert.assertEquals(1, controller2.currentCallState.attachCalls)
Assert.assertEquals(1, controller2.currentCallState.createViewCalls)
Assert.assertEquals(1, controller2.currentCallState.detachCalls)
Assert.assertEquals(1, controller2.currentCallState.destroyViewCalls)
Assert.assertEquals(1, controller2.currentCallState.destroyCalls)
Assert.assertEquals(1, controller2.currentCallState.contextAvailableCalls)
Assert.assertEquals(1, controller2.currentCallState.contextUnavailableCalls)
Assert.assertEquals(1, controller2.currentCallState.saveViewStateCalls)
Assert.assertEquals(0, controller2.currentCallState.restoreViewStateCalls)
}
@Test
fun testChildLifecycle() {
val parent = TestController()
activityController.get().router.pushController(
parent.asTransaction(pushChangeHandler = MockChangeHandler.defaultHandler())
)
val child = TestController()
attachLifecycleListener(child)
val expectedCallState = CallState(false)
assertCalls(expectedCallState, child)
val childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.setRoot(
child.asTransaction(
pushChangeHandler = getPushHandler(expectedCallState, child),
popChangeHandler = getPopHandler(expectedCallState, child)
)
)
assertCalls(expectedCallState, child)
parent.removeChildRouter(childRouter)
assertCalls(expectedCallState, child)
}
@Test
fun testChildLifecycle2() {
val parent = TestController()
activityController.get().router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
attachLifecycleListener(child)
val expectedCallState = CallState(false)
assertCalls(expectedCallState, child)
val childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.setRoot(
child.asTransaction(
pushChangeHandler = getPushHandler(expectedCallState, child),
popChangeHandler = getPopHandler(expectedCallState, child)
)
)
assertCalls(expectedCallState, child)
activityController.get().router.popCurrentController()
expectedCallState.changeStartCalls++
expectedCallState.changeEndCalls++
expectedCallState.detachCalls++
expectedCallState.destroyViewCalls++
expectedCallState.contextUnavailableCalls++
expectedCallState.destroyCalls++
assertCalls(expectedCallState, child)
}
@Test
fun testChildLifecycleOrderingAfterUnexpectedAttach() {
val parent = TestController()
parent.retainViewMode = RetainViewMode.RETAIN_DETACH
activityController.get().router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
child.retainViewMode = RetainViewMode.RETAIN_DETACH
val childRouter = parent.getChildRouter(parent.getView()!!.findViewById(TestController.VIEW_ID))
childRouter.setRoot(
child.asTransaction(
pushChangeHandler = SimpleSwapChangeHandler(),
popChangeHandler = SimpleSwapChangeHandler()
)
)
Assert.assertTrue(parent.isAttached)
Assert.assertTrue(child.isAttached)
ViewUtils.reportAttached(parent.view, false, true)
Assert.assertFalse(parent.isAttached)
Assert.assertFalse(child.isAttached)
ViewUtils.reportAttached(child.view, true)
Assert.assertFalse(parent.isAttached)
Assert.assertFalse(child.isAttached)
ViewUtils.reportAttached(parent.view, true)
Assert.assertTrue(parent.isAttached)
Assert.assertTrue(child.isAttached)
}
@Test
fun testChildLifecycleAfterPushAndPop() {
val parent = TestController()
parent.retainViewMode = RetainViewMode.RETAIN_DETACH
activityController.get().router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
val childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.setRoot(
child.asTransaction(
pushChangeHandler = SimpleSwapChangeHandler(),
popChangeHandler = SimpleSwapChangeHandler()
)
)
val nextController = TestController()
activityController.get().router.pushController(nextController.asTransaction())
activityController.get().router.popCurrentController()
shadowOf(getMainLooper()).idle()
Assert.assertTrue(parent.isAttached)
Assert.assertTrue(child.isAttached)
}
@Test
fun testChildLifecycleAfterPushPopPush() {
val parent = TestController()
parent.retainViewMode = RetainViewMode.RETAIN_DETACH
activityController.get().router.pushController(
parent.asTransaction(
pushChangeHandler = MockChangeHandler.defaultHandler(),
popChangeHandler = MockChangeHandler.defaultHandler()
)
)
val child = TestController()
val childRouter = parent.getChildRouter(parent.getView()!!.findViewById(TestController.VIEW_ID))
childRouter.setRoot(
child.asTransaction(
pushChangeHandler = SimpleSwapChangeHandler(),
popChangeHandler = SimpleSwapChangeHandler()
)
)
val nextController = TestController()
activityController.get().router.pushController(nextController.asTransaction())
val child2 = TestController()
childRouter.pushController(child2.asTransaction())
activityController.get().router.popCurrentController()
shadowOf(getMainLooper()).idle()
Assert.assertTrue(parent.isAttached)
Assert.assertFalse(child.isAttached)
Assert.assertTrue(child2.isAttached)
}
private fun getPushHandler(
expectedCallState: CallState,
controller: TestController
): MockChangeHandler {
return MockChangeHandler.listeningChangeHandler(object : ChangeHandlerListener() {
override fun willStartChange() {
expectedCallState.contextAvailableCalls++
expectedCallState.changeStartCalls++
expectedCallState.createViewCalls++
assertCalls(expectedCallState, controller)
}
override fun didAttachOrDetach() {
expectedCallState.attachCalls++
assertCalls(expectedCallState, controller)
}
override fun didEndChange() {
expectedCallState.changeEndCalls++
assertCalls(expectedCallState, controller)
}
})
}
private fun getPopHandler(
expectedCallState: CallState,
controller: TestController
): MockChangeHandler {
return MockChangeHandler.listeningChangeHandler(object : ChangeHandlerListener() {
override fun willStartChange() {
expectedCallState.changeStartCalls++
assertCalls(expectedCallState, controller)
}
override fun didAttachOrDetach() {
expectedCallState.destroyViewCalls++
expectedCallState.detachCalls++
expectedCallState.contextUnavailableCalls++
expectedCallState.destroyCalls++
assertCalls(expectedCallState, controller)
}
override fun didEndChange() {
expectedCallState.changeEndCalls++
assertCalls(expectedCallState, controller)
}
})
}
private fun assertCalls(callState: CallState, controller: TestController) {
shadowOf(getMainLooper()).idle()
Assert.assertEquals(
"Expected call counts and controller call counts do not match.",
callState,
controller.currentCallState
)
Assert.assertEquals(
"Expected call counts and lifecycle call counts do not match.",
callState,
currentCallState
)
}
private fun attachLifecycleListener(controller: Controller?) {
controller!!.addLifecycleListener(object : LifecycleListener() {
override fun onChangeStart(
controller: Controller,
changeHandler: ControllerChangeHandler,
changeType: ControllerChangeType
) {
currentCallState.changeStartCalls++
}
override fun onChangeEnd(
controller: Controller,
changeHandler: ControllerChangeHandler,
changeType: ControllerChangeType
) {
currentCallState.changeEndCalls++
}
override fun postContextAvailable(controller: Controller, context: Context) {
currentCallState.contextAvailableCalls++
}
override fun postContextUnavailable(controller: Controller) {
currentCallState.contextUnavailableCalls++
}
override fun postCreateView(controller: Controller, view: View) {
currentCallState.createViewCalls++
}
override fun postAttach(controller: Controller, view: View) {
currentCallState.attachCalls++
}
override fun postDestroyView(controller: Controller) {
currentCallState.destroyViewCalls++
}
override fun postDetach(controller: Controller, view: View) {
currentCallState.detachCalls++
}
override fun postDestroy(controller: Controller) {
currentCallState.destroyCalls++
}
override fun onSaveInstanceState(controller: Controller, outState: Bundle) {
currentCallState.saveInstanceStateCalls++
}
override fun onRestoreInstanceState(controller: Controller, savedInstanceState: Bundle) {
currentCallState.restoreInstanceStateCalls++
}
override fun onSaveViewState(controller: Controller, outState: Bundle) {
currentCallState.saveViewStateCalls++
}
override fun onRestoreViewState(controller: Controller, savedViewState: Bundle) {
currentCallState.restoreViewStateCalls++
}
})
}
}
@@ -1,296 +0,0 @@
package com.bluelinelabs.conductor;
import android.app.Activity;
import android.support.annotation.NonNull;
import android.view.View;
import android.view.ViewGroup;
import android.widget.FrameLayout;
import com.bluelinelabs.conductor.Controller.LifecycleListener;
import com.bluelinelabs.conductor.Controller.RetainViewMode;
import com.bluelinelabs.conductor.ControllerChangeHandler.ControllerChangeCompletedListener;
import com.bluelinelabs.conductor.ControllerTransaction.ControllerChangeType;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.Robolectric;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.annotation.Config;
import org.robolectric.util.ActivityController;
@RunWith(RobolectricTestRunner.class)
@Config(manifest = Config.NONE)
public class ControllerTests {
private ActivityController<TestActivity> mActivityController;
private Router mRouter;
private int mChangeStartCalls;
private int mChangeEndCalls;
private int mCreateViewCalls;
private int mAttachCalls;
private int mDestroyViewCalls;
private int mDetachCalls;
private int mDestroyCalls;
@Before
public void setup() {
mActivityController = Robolectric.buildActivity(TestActivity.class).create();
Activity activity = mActivityController.get();
mRouter = Conductor.attachRouter(activity, new FrameLayout(activity), null);
mRouter.setRoot(new TestController());
mChangeStartCalls = 0;
mChangeEndCalls = 0;
mCreateViewCalls = 0;
mAttachCalls = 0;
mDestroyViewCalls = 0;
mDestroyCalls = 0;
mDestroyCalls = 0;
}
@Test
public void testNormalLifecycle() {
Controller controller = new TestController();
attachLifecycleListener(controller);
assertCalls(0, 0, 0, 0, 0, 0, 0);
mRouter.pushController(RouterTransaction.builder(controller)
.pushChangeHandler(getPushHandler(0, 0, 0, 0, 0, 0, 0))
.popChangeHandler(getPopHandler(1, 1, 1, 1, 0, 0, 0))
.build()
);
assertCalls(1, 1, 1, 1, 0, 0, 0);
mRouter.popCurrentController();
Assert.assertNull(controller.getView());
assertCalls(2, 2, 1, 1, 1, 1, 1);
}
@Test
public void testLifecycleWithActivityDestroy() {
Controller controller = new TestController();
attachLifecycleListener(controller);
assertCalls(0, 0, 0, 0, 0, 0, 0);
mRouter.pushController(RouterTransaction.builder(controller)
.pushChangeHandler(getPushHandler(0, 0, 0, 0, 0, 0, 0))
.build()
);
assertCalls(1, 1, 1, 1, 0, 0, 0);
mActivityController.pause();
assertCalls(1, 1, 1, 1, 0, 0, 0);
mActivityController.stop();
assertCalls(1, 1, 1, 1, 0, 0, 0);
mActivityController.destroy();
assertCalls(1, 1, 1, 1, 1, 1, 1);
}
@Test
public void testChildLifecycle() {
Controller parent = new TestController();
mRouter.pushController(RouterTransaction.builder(parent)
.pushChangeHandler(new ChangeHandler(new ChangeHandlerListener() {
@Override
public void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener) {
container.addView(to);
ViewUtils.setAttached(to, true);
changeListener.onChangeCompleted();
}
}))
.build());
Controller child = new TestController();
attachLifecycleListener(child);
assertCalls(0, 0, 0, 0, 0, 0, 0);
parent.addChildController(ChildControllerTransaction.builder(child, TestController.VIEW_ID)
.pushChangeHandler(getPushHandler(0, 0, 0, 0, 0, 0, 0))
.popChangeHandler(getPopHandler(1, 1, 1, 1, 0, 0, 0))
.build()
);
assertCalls(1, 1, 1, 1, 0, 0, 0);
parent.removeChildController(child);
assertCalls(2, 2, 1, 1, 1, 1, 1);
}
@Test
public void testChildLifecycle2() {
Controller parent = new TestController();
mRouter.pushController(RouterTransaction.builder(parent)
.pushChangeHandler(new ChangeHandler(new ChangeHandlerListener() {
@Override
public void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener) {
container.addView(to);
ViewUtils.setAttached(to, true);
changeListener.onChangeCompleted();
}
}))
.popChangeHandler(new ChangeHandler(new ChangeHandlerListener() {
@Override
public void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener) {
container.removeView(from);
ViewUtils.setAttached(from, false);
changeListener.onChangeCompleted();
}
}))
.build());
Controller child = new TestController();
attachLifecycleListener(child);
assertCalls(0, 0, 0, 0, 0, 0, 0);
parent.addChildController(ChildControllerTransaction.builder(child, TestController.VIEW_ID)
.pushChangeHandler(getPushHandler(0, 0, 0, 0, 0, 0, 0))
.popChangeHandler(getPopHandler(1, 1, 1, 1, 0, 0, 0))
.build()
);
assertCalls(1, 1, 1, 1, 0, 0, 0);
mRouter.popCurrentController();
ViewUtils.setAttached(child.getView(), false);
assertCalls(1, 1, 1, 1, 1, 1, 1);
}
@Test
public void testViewRetention() {
Controller controller = new TestController();
// Test View getting released w/ RELEASE_DETACH
controller.setRetainViewMode(RetainViewMode.RELEASE_DETACH);
Assert.assertNull(controller.getView());
View view = controller.inflate(new FrameLayout(mRouter.getActivity()));
Assert.assertNotNull(controller.getView());
ViewUtils.setAttached(view, true);
Assert.assertNotNull(controller.getView());
ViewUtils.setAttached(view, false);
Assert.assertNull(controller.getView());
// Test View getting retained w/ RETAIN_DETACH
controller.setRetainViewMode(RetainViewMode.RETAIN_DETACH);
view = controller.inflate(new FrameLayout(mRouter.getActivity()));
Assert.assertNotNull(controller.getView());
ViewUtils.setAttached(view, true);
Assert.assertNotNull(controller.getView());
ViewUtils.setAttached(view, false);
Assert.assertNotNull(controller.getView());
// Ensure re-setting RELEASE_DETACH releases
controller.setRetainViewMode(RetainViewMode.RELEASE_DETACH);
Assert.assertNull(controller.getView());
}
private ChangeHandler getPushHandler(final int changeStart, final int changeEnd, final int bindView, final int attach, final int unbindView, final int detach, final int destroy) {
return new ChangeHandler(new ChangeHandlerListener() {
@Override
public void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener) {
assertCalls(changeStart + 1, changeEnd, bindView + 1, attach, unbindView, detach, destroy);
container.addView(to);
ViewUtils.setAttached(to, true);
assertCalls(changeStart + 1, changeEnd, bindView + 1, attach + 1, unbindView, detach, destroy);
changeListener.onChangeCompleted();
}
});
}
private ChangeHandler getPopHandler(final int changeStart, final int changeEnd, final int bindView, final int attach, final int unbindView, final int detach, final int destroy) {
return new ChangeHandler(new ChangeHandlerListener() {
@Override
public void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener) {
assertCalls(changeStart + 1, changeEnd, bindView, attach, unbindView, detach, destroy);
container.removeView(from);
ViewUtils.setAttached(from, false);
assertCalls(changeStart + 1, changeEnd, bindView, attach, unbindView + 1, detach + 1, destroy + 1);
changeListener.onChangeCompleted();
}
});
}
private void assertCalls(int changeStart, int changeEnd, int bindView, int attach, int unbindView, int detach, int destroy) {
Assert.assertEquals(changeStart, mChangeStartCalls);
Assert.assertEquals(changeEnd, mChangeEndCalls);
Assert.assertEquals(bindView, mCreateViewCalls);
Assert.assertEquals(attach, mAttachCalls);
Assert.assertEquals(unbindView, mDestroyViewCalls);
Assert.assertEquals(detach, mDetachCalls);
Assert.assertEquals(destroy, mDestroyCalls);
}
private void attachLifecycleListener(Controller controller) {
controller.addLifecycleListener(new LifecycleListener() {
@Override
public void onChangeStart(@NonNull Controller controller, @NonNull ControllerChangeHandler changeHandler, @NonNull ControllerChangeType changeType) {
mChangeStartCalls++;
}
@Override
public void onChangeEnd(@NonNull Controller controller, @NonNull ControllerChangeHandler changeHandler, @NonNull ControllerChangeType changeType) {
mChangeEndCalls++;
}
@Override
public void postCreateView(@NonNull Controller controller, @NonNull View view) {
mCreateViewCalls++;
}
@Override
public void postAttach(@NonNull Controller controller, @NonNull View view) {
mAttachCalls++;
}
@Override
public void postDestroyView(@NonNull Controller controller) {
mDestroyViewCalls++;
}
@Override
public void postDetach(@NonNull Controller controller, @NonNull View view) {
mDetachCalls++;
}
@Override
public void postDestroy(@NonNull Controller controller) {
mDestroyCalls++;
}
});
}
interface ChangeHandlerListener {
void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener);
}
public static class ChangeHandler extends ControllerChangeHandler {
private ChangeHandlerListener mListener;
public ChangeHandler() { }
public ChangeHandler(ChangeHandlerListener listener) {
mListener = listener;
}
@Override
public void performChange(@NonNull ViewGroup container, View from, View to, boolean isPush, @NonNull ControllerChangeCompletedListener changeListener) {
mListener.performChange(container, from, to, isPush, changeListener);
}
}
}
@@ -0,0 +1,513 @@
package com.bluelinelabs.conductor
import android.app.Activity
import android.content.ComponentName
import android.content.Context
import android.content.Intent
import android.os.Bundle
import android.os.Looper
import android.view.KeyEvent
import android.view.Menu
import android.view.MenuInflater
import android.view.MenuItem
import android.view.SubMenu
import com.bluelinelabs.conductor.Controller.RetainViewMode
import com.bluelinelabs.conductor.util.AttachFakingFrameLayout
import com.bluelinelabs.conductor.util.CallState
import com.bluelinelabs.conductor.util.TestActivity
import com.bluelinelabs.conductor.util.ViewUtils
import org.junit.Assert
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.Robolectric
import org.robolectric.RobolectricTestRunner
import org.robolectric.Shadows.shadowOf
import org.robolectric.annotation.Config
@RunWith(RobolectricTestRunner::class)
@Config(manifest = Config.NONE)
class ControllerTests {
private val router = Robolectric.buildActivity(TestActivity::class.java)
.setup()
.get()
.router
@Test
fun testViewRetention() {
val controller = TestController()
controller.setRouter(router)
// Test View getting released w/ RELEASE_DETACH
controller.retainViewMode = RetainViewMode.RELEASE_DETACH
Assert.assertNull(controller.getView())
var view = controller.inflate(router.container)
Assert.assertNotNull(controller.getView())
ViewUtils.reportAttached(view, true)
Assert.assertNotNull(controller.getView())
ViewUtils.reportAttached(view, false)
Assert.assertNull(controller.getView())
// Test View getting retained w/ RETAIN_DETACH
controller.retainViewMode = RetainViewMode.RETAIN_DETACH
view = controller.inflate(router.container)
Assert.assertNotNull(controller.getView())
ViewUtils.reportAttached(view, true)
Assert.assertNotNull(controller.getView())
ViewUtils.reportAttached(view, false)
Assert.assertNotNull(controller.getView())
// Ensure re-setting RELEASE_DETACH releases
controller.retainViewMode = RetainViewMode.RELEASE_DETACH
Assert.assertNull(controller.getView())
}
@Test
fun testActivityResult() {
val controller = TestController()
val expectedCallState = CallState(true)
router.pushController(controller.asTransaction())
// Ensure that calling onActivityResult w/o requesting a result doesn't do anything
router.onActivityResult(1, Activity.RESULT_OK, null)
assertCalls(expectedCallState, controller)
// Ensure starting an activity for result gets us the result back
controller.startActivityForResult(Intent("action"), 1)
router.onActivityResult(1, Activity.RESULT_OK, null)
expectedCallState.onActivityResultCalls++
assertCalls(expectedCallState, controller)
// Ensure requesting a result w/o calling startActivityForResult works
controller.registerForActivityResult(2)
router.onActivityResult(2, Activity.RESULT_OK, null)
expectedCallState.onActivityResultCalls++
assertCalls(expectedCallState, controller)
}
@Test
fun testActivityResultForChild() {
val parent = TestController()
val child = TestController()
router.pushController(parent.asTransaction())
val childContainer = parent.view!!.findViewById<AttachFakingFrameLayout>(TestController.VIEW_ID)
childContainer.setAttached(true)
parent.getChildRouter(childContainer)
.setRoot(child.asTransaction())
val childExpectedCallState = CallState(true)
val parentExpectedCallState = CallState(true)
// Ensure that calling onActivityResult w/o requesting a result doesn't do anything
router.onActivityResult(1, Activity.RESULT_OK, null)
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure starting an activity for result gets us the result back
child.startActivityForResult(Intent("action"), 1)
router.onActivityResult(1, Activity.RESULT_OK, null)
childExpectedCallState.onActivityResultCalls++
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure requesting a result w/o calling startActivityForResult works
child.registerForActivityResult(2)
router.onActivityResult(2, Activity.RESULT_OK, null)
childExpectedCallState.onActivityResultCalls++
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
}
@Test
fun testPermissionResult() {
val requestedPermissions = arrayOf("test")
val controller = TestController()
val expectedCallState = CallState(true)
router.pushController(controller.asTransaction())
// Ensure that calling handleRequestedPermission w/o requesting a result doesn't do anything
router.onRequestPermissionsResult("anotherId", 1, requestedPermissions, intArrayOf(1))
assertCalls(expectedCallState, controller)
// Ensure requesting the permission gets us the result back
controller.requestPermissions(requestedPermissions, 1)
expectedCallState.onRequestPermissionsResultCalls++
assertCalls(expectedCallState, controller)
}
@Test
fun testPermissionResultForChild() {
val requestedPermissions = arrayOf("test")
val parent = TestController()
val child = TestController()
router.pushController(parent.asTransaction())
val childContainer = parent.view!!.findViewById<AttachFakingFrameLayout>(TestController.VIEW_ID)
childContainer.setAttached(true)
parent.getChildRouter(childContainer)
.setRoot(child.asTransaction())
val childExpectedCallState = CallState(true)
val parentExpectedCallState = CallState(true)
// Ensure that calling handleRequestedPermission w/o requesting a result doesn't do anything
router.onRequestPermissionsResult("anotherId", 1, requestedPermissions, intArrayOf(1))
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure requesting the permission gets us the result back
child.requestPermissions(requestedPermissions, 1)
childExpectedCallState.onRequestPermissionsResultCalls++
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
}
@Test
fun testOptionsMenu() {
val controller = TestController()
val expectedCallState = CallState(true)
router.pushController(controller.asTransaction())
// Ensure that calling onCreateOptionsMenu w/o declaring that we have one doesn't do anything
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
assertCalls(expectedCallState, controller)
// Ensure calling onCreateOptionsMenu with a menu works
controller.setHasOptionsMenu(true)
expectedCallState.createOptionsMenuCalls++
assertCalls(expectedCallState, controller)
// Ensure it'll still get called back next time onCreateOptionsMenu is called
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
expectedCallState.createOptionsMenuCalls++
assertCalls(expectedCallState, controller)
// Ensure we stop getting them when we hide it
controller.setOptionsMenuHidden(true)
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
assertCalls(expectedCallState, controller)
// Ensure we get the callback them when we un-hide it
controller.setOptionsMenuHidden(false)
expectedCallState.createOptionsMenuCalls++
assertCalls(expectedCallState, controller)
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
expectedCallState.createOptionsMenuCalls++
assertCalls(expectedCallState, controller)
// Ensure we don't get the callback when we no longer have a menu
controller.setHasOptionsMenu(false)
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
assertCalls(expectedCallState, controller)
}
@Test
fun testOptionsMenuForChild() {
val parent = TestController()
val child = TestController()
router.pushController(parent.asTransaction())
val childContainer = parent.view!!.findViewById<AttachFakingFrameLayout>(TestController.VIEW_ID)
childContainer.setAttached(true)
parent.getChildRouter(childContainer)
.setRoot(child.asTransaction())
val childExpectedCallState = CallState(true)
val parentExpectedCallState = CallState(true)
// Ensure that calling onCreateOptionsMenu w/o declaring that we have one doesn't do anything
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure calling onCreateOptionsMenu with a menu works
child.setHasOptionsMenu(true)
childExpectedCallState.createOptionsMenuCalls++
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure it'll still get called back next time onCreateOptionsMenu is called
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
childExpectedCallState.createOptionsMenuCalls++
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure we stop getting them when we hide it
child.setOptionsMenuHidden(true)
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure we get the callback them when we un-hide it
child.setOptionsMenuHidden(false)
childExpectedCallState.createOptionsMenuCalls++
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
childExpectedCallState.createOptionsMenuCalls++
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
// Ensure we don't get the callback when we no longer have a menu
child.setHasOptionsMenu(false)
router.onCreateOptionsMenu(menu(), menuInflater(router.activity!!))
assertCalls(childExpectedCallState, child)
assertCalls(parentExpectedCallState, parent)
}
@Test
fun testAddRemoveChildControllers() {
val parent = TestController()
val child1 = TestController()
val child2 = TestController()
router.pushController(parent.asTransaction())
Assert.assertEquals(0, parent.childRouters.size)
Assert.assertNull(child1.parentController)
Assert.assertNull(child2.parentController)
var childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.setPopRootControllerMode(Router.PopRootControllerMode.POP_ROOT_CONTROLLER_AND_VIEW)
childRouter.setRoot(child1.asTransaction())
Assert.assertEquals(1, parent.childRouters.size)
Assert.assertEquals(childRouter, parent.childRouters[0])
Assert.assertEquals(1, childRouter.backstackSize)
Assert.assertEquals(child1, childRouter.controllers[0])
Assert.assertEquals(parent, child1.parentController)
Assert.assertNull(child2.parentController)
childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.VIEW_ID))
childRouter.pushController(child2.asTransaction())
Assert.assertEquals(1, parent.childRouters.size)
Assert.assertEquals(childRouter, parent.childRouters[0])
Assert.assertEquals(2, childRouter.backstackSize)
Assert.assertEquals(child1, childRouter.controllers[0])
Assert.assertEquals(child2, childRouter.controllers[1])
Assert.assertEquals(parent, child1.parentController)
Assert.assertEquals(parent, child2.parentController)
childRouter.popController(child2)
Assert.assertEquals(1, parent.childRouters.size)
Assert.assertEquals(childRouter, parent.childRouters[0])
Assert.assertEquals(1, childRouter.backstackSize)
Assert.assertEquals(child1, childRouter.controllers[0])
Assert.assertEquals(parent, child1.parentController)
Assert.assertNull(child2.parentController)
childRouter.popController(child1)
shadowOf(Looper.getMainLooper()).idle()
Assert.assertEquals(1, parent.childRouters.size)
Assert.assertEquals(childRouter, parent.childRouters[0])
Assert.assertEquals(0, childRouter.backstackSize)
Assert.assertNull(child1.parentController)
Assert.assertNull(child2.parentController)
}
@Test
fun testAddRemoveChildRouters() {
val parent = TestController()
val child1 = TestController()
val child2 = TestController()
router.pushController(parent.asTransaction())
Assert.assertEquals(0, parent.childRouters.size)
Assert.assertNull(child1.parentController)
Assert.assertNull(child2.parentController)
val childRouter1 = parent.getChildRouter(parent.view!!.findViewById(TestController.CHILD_VIEW_ID_1))
val childRouter2 = parent.getChildRouter(parent.view!!.findViewById(TestController.CHILD_VIEW_ID_2))
childRouter1.setRoot(child1.asTransaction())
childRouter2.setRoot(child2.asTransaction())
Assert.assertEquals(2, parent.childRouters.size)
Assert.assertEquals(childRouter1, parent.childRouters[0])
Assert.assertEquals(childRouter2, parent.childRouters[1])
Assert.assertEquals(1, childRouter1.backstackSize)
Assert.assertEquals(1, childRouter2.backstackSize)
Assert.assertEquals(child1, childRouter1.controllers[0])
Assert.assertEquals(child2, childRouter2.controllers[0])
Assert.assertEquals(parent, child1.parentController)
Assert.assertEquals(parent, child2.parentController)
parent.removeChildRouter(childRouter2)
shadowOf(Looper.getMainLooper()).idle()
Assert.assertEquals(1, parent.childRouters.size)
Assert.assertEquals(childRouter1, parent.childRouters[0])
Assert.assertEquals(1, childRouter1.backstackSize)
Assert.assertEquals(0, childRouter2.backstackSize)
Assert.assertEquals(child1, childRouter1.controllers[0])
Assert.assertEquals(parent, child1.parentController)
Assert.assertNull(child2.parentController)
parent.removeChildRouter(childRouter1)
Assert.assertEquals(0, parent.childRouters.size)
Assert.assertEquals(0, childRouter1.backstackSize)
Assert.assertEquals(0, childRouter2.backstackSize)
Assert.assertNull(child1.parentController)
Assert.assertNull(child2.parentController)
}
@Test
fun testRestoredChildRouterBackstack() {
val parent = TestController()
router.pushController(parent.asTransaction())
ViewUtils.reportAttached(parent.view, true)
val childTransaction1 = TestController().asTransaction()
val childTransaction2 = TestController().asTransaction()
var childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.CHILD_VIEW_ID_1))
childRouter.setPopRootControllerMode(Router.PopRootControllerMode.POP_ROOT_CONTROLLER_AND_VIEW)
childRouter.setRoot(childTransaction1)
childRouter.pushController(childTransaction2)
val savedState = Bundle()
childRouter.saveInstanceState(savedState)
parent.removeChildRouter(childRouter)
childRouter = parent.getChildRouter(parent.view!!.findViewById(TestController.CHILD_VIEW_ID_1))
Assert.assertEquals(0, childRouter.backstackSize)
childRouter.restoreInstanceState(savedState)
childRouter.rebindIfNeeded()
Assert.assertEquals(2, childRouter.backstackSize)
val restoredChildTransaction1 = childRouter.getBackstack()[0]
val restoredChildTransaction2 = childRouter.getBackstack()[1]
Assert.assertEquals(
childTransaction1.transactionIndex,
restoredChildTransaction1.transactionIndex
)
Assert.assertEquals(
childTransaction1.controller.getInstanceId(),
restoredChildTransaction1.controller.getInstanceId()
)
Assert.assertEquals(
childTransaction2.transactionIndex,
restoredChildTransaction2.transactionIndex
)
Assert.assertEquals(
childTransaction2.controller.getInstanceId(),
restoredChildTransaction2.controller.getInstanceId()
)
Assert.assertTrue(parent.handleBack())
Assert.assertEquals(1, childRouter.backstackSize)
Assert.assertEquals(restoredChildTransaction1, childRouter.getBackstack()[0])
Assert.assertTrue(parent.handleBack())
Assert.assertEquals(0, childRouter.backstackSize)
}
private fun assertCalls(callState: CallState, controller: TestController) {
shadowOf(Looper.getMainLooper()).idle()
Assert.assertEquals(
"Expected call counts and controller call counts do not match.",
callState,
controller.currentCallState
)
}
private fun menu(): Menu {
return object : Menu {
override fun add(p0: CharSequence?): MenuItem {
TODO("Not yet implemented")
}
override fun add(p0: Int): MenuItem {
TODO("Not yet implemented")
}
override fun add(p0: Int, p1: Int, p2: Int, p3: CharSequence?): MenuItem {
TODO("Not yet implemented")
}
override fun add(p0: Int, p1: Int, p2: Int, p3: Int): MenuItem {
TODO("Not yet implemented")
}
override fun addSubMenu(p0: CharSequence?): SubMenu {
TODO("Not yet implemented")
}
override fun addSubMenu(p0: Int): SubMenu {
TODO("Not yet implemented")
}
override fun addSubMenu(p0: Int, p1: Int, p2: Int, p3: CharSequence?): SubMenu {
TODO("Not yet implemented")
}
override fun addSubMenu(p0: Int, p1: Int, p2: Int, p3: Int): SubMenu {
TODO("Not yet implemented")
}
override fun addIntentOptions(
p0: Int,
p1: Int,
p2: Int,
p3: ComponentName?,
p4: Array<out Intent>?,
p5: Intent?,
p6: Int,
p7: Array<out MenuItem>?
): Int {
TODO("Not yet implemented")
}
override fun removeItem(p0: Int) {
TODO("Not yet implemented")
}
override fun removeGroup(p0: Int) {
TODO("Not yet implemented")
}
override fun clear() {
TODO("Not yet implemented")
}
override fun setGroupCheckable(p0: Int, p1: Boolean, p2: Boolean) {
TODO("Not yet implemented")
}
override fun setGroupVisible(p0: Int, p1: Boolean) {
TODO("Not yet implemented")
}
override fun setGroupEnabled(p0: Int, p1: Boolean) {
TODO("Not yet implemented")
}
override fun hasVisibleItems(): Boolean {
TODO("Not yet implemented")
}
override fun findItem(p0: Int): MenuItem {
TODO("Not yet implemented")
}
override fun size(): Int {
TODO("Not yet implemented")
}
override fun getItem(p0: Int): MenuItem {
TODO("Not yet implemented")
}
override fun close() {
TODO("Not yet implemented")
}
override fun performShortcut(p0: Int, p1: KeyEvent?, p2: Int): Boolean {
TODO("Not yet implemented")
}
override fun isShortcutKey(p0: Int, p1: KeyEvent?): Boolean {
TODO("Not yet implemented")
}
override fun performIdentifierAction(p0: Int, p1: Int): Boolean {
TODO("Not yet implemented")
}
override fun setQwertyMode(p0: Boolean) {
TODO("Not yet implemented")
}
}
}
private fun menuInflater(context: Context): MenuInflater {
return MenuInflater(context)
}
}
@@ -1,52 +1,33 @@
package com.bluelinelabs.conductor;
import android.os.Bundle;
import android.support.annotation.IdRes;
import com.bluelinelabs.conductor.changehandler.HorizontalChangeHandler;
import com.bluelinelabs.conductor.changehandler.VerticalChangeHandler;
import junit.framework.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import static org.junit.Assert.assertEquals;
@RunWith(RobolectricTestRunner.class)
public class ControllerTransactionTests {
@Test
public void testRouterSaveRestore() {
RouterTransaction transaction = RouterTransaction.builder(new TestController())
RouterTransaction transaction = RouterTransaction.with(new TestController())
.pushChangeHandler(new HorizontalChangeHandler())
.popChangeHandler(new VerticalChangeHandler())
.tag("Test Tag")
.build();
.tag("Test Tag");
Bundle bundle = transaction.detachAndSaveInstanceState();
Bundle bundle = transaction.saveInstanceState();
RouterTransaction restoredTransaction = new RouterTransaction(bundle);
Assert.assertEquals(transaction.getController().getClass(), restoredTransaction.getController().getClass());
Assert.assertEquals(transaction.getPushControllerChangeHandler().getClass(), restoredTransaction.getPushControllerChangeHandler().getClass());
Assert.assertEquals(transaction.getPopControllerChangeHandler().getClass(), restoredTransaction.getPopControllerChangeHandler().getClass());
Assert.assertEquals(transaction.getTag(), restoredTransaction.getTag());
}
@Test
public void testChildSaveRestore() {
@IdRes int layoutId = 234;
ChildControllerTransaction transaction = ChildControllerTransaction.builder(new TestController(), layoutId)
.pushChangeHandler(new HorizontalChangeHandler())
.popChangeHandler(new VerticalChangeHandler())
.tag("Test Tag")
.build();
Bundle bundle = transaction.detachAndSaveInstanceState();
ChildControllerTransaction restoredTransaction = new ChildControllerTransaction(bundle);
Assert.assertEquals(transaction.containerId, restoredTransaction.containerId);
Assert.assertEquals(transaction.getController().getClass(), restoredTransaction.getController().getClass());
Assert.assertEquals(transaction.getPushControllerChangeHandler().getClass(), restoredTransaction.getPushControllerChangeHandler().getClass());
Assert.assertEquals(transaction.getPopControllerChangeHandler().getClass(), restoredTransaction.getPopControllerChangeHandler().getClass());
Assert.assertEquals(transaction.getTag(), restoredTransaction.getTag());
assertEquals(transaction.controller().getClass(), restoredTransaction.controller().getClass());
assertEquals(transaction.pushChangeHandler().getClass(), restoredTransaction.pushChangeHandler().getClass());
assertEquals(transaction.popChangeHandler().getClass(), restoredTransaction.popChangeHandler().getClass());
assertEquals(transaction.tag(), restoredTransaction.tag());
}
}

Some files were not shown because too many files have changed in this diff Show More