Compare commits
35 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 192e35ca71 | |||
| ff77162654 | |||
| 82256a9785 | |||
| bbd27daee3 | |||
| 4a54fc1dd4 | |||
| 4fc5b26980 | |||
| daef586461 | |||
| 7a862cb061 | |||
| f2de564600 | |||
| 4c674c2583 | |||
| 22182bddb8 | |||
| ae9f4aea70 | |||
| edfc5b5300 | |||
| ee2dd68f09 | |||
| c3873c6e9d | |||
| f44410fcfe | |||
| 608a32c3be | |||
| 17428f0189 | |||
| 1701bc4f36 | |||
| 9c9c56bc9b | |||
| 3da8fe52ca | |||
| a943aab08e | |||
| 86ac421fb8 | |||
| f7009f53e8 | |||
| 994c497147 | |||
| bb13ace1c9 | |||
| dbe065275d | |||
| 2ebbc98a99 | |||
| ba7eea60f5 | |||
| 6347fe7d95 | |||
| 2b6e2ee874 | |||
| f50a4d8106 | |||
| 3535f491f5 | |||
| 1c5b89d2ec | |||
| 127cce1fe4 |
+4
-1
@@ -10,4 +10,7 @@ local.properties
|
||||
**/*.iml
|
||||
|
||||
# Mac OS
|
||||
.DS_Store
|
||||
.DS_Store
|
||||
|
||||
# GPG keys
|
||||
*.gpg
|
||||
@@ -1,20 +1,44 @@
|
||||
# Cicerone
|
||||
[](https://bintray.com/terrakok/terramaven/cicerone-kotlin/_latestVersion)
|
||||
[](https://repo1.maven.org/maven2/com/github/terrakok/cicerone/)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
[](https://android-arsenal.com/details/1/4700)
|
||||
[](http://androidweekly.net/issues/issue-250)
|
||||
[](http://androidweekly.net/issues/issue-271)
|
||||
|
||||

|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<img src="https://github.com/terrakok/Cicerone/raw/master/media/navigation.gif" width="256"/>
|
||||
</td>
|
||||
<td>
|
||||
<img src="https://github.com/terrakok/Cicerone/raw/master/media/insta_tabs.gif" width="256"/>
|
||||
</td>
|
||||
<td>
|
||||
<img src="https://github.com/terrakok/Cicerone/raw/master/media/animations.gif" width="256"/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
Power navigation
|
||||
</td>
|
||||
<td>
|
||||
Multibackstack
|
||||
</td>
|
||||
<td>
|
||||
Result listeners
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Cicerone (a guide, one who conducts sightseers) is a lightweight library that makes the navigation in an Android app easy.
|
||||
Cicerone (means - a guide, one who conducts sightseers) is a lightweight library that makes the navigation in an Android app easy.
|
||||
It was designed to be used with the MVP/MVVM/MVI patterns but will work great with any architecture.
|
||||
|
||||
## Main advantages
|
||||
+ is not tied to Fragments
|
||||
+ not a framework
|
||||
+ not a framework (very lightweight)
|
||||
+ short navigation calls (no builders)
|
||||
+ static typed checks for screen parameters!
|
||||
+ lifecycle-safe!
|
||||
+ functionality is simple to extend
|
||||
+ suitable for Unit Testing
|
||||
@@ -109,13 +133,13 @@ override fun onPause() {
|
||||
## Navigation commands
|
||||
This commands set will fulfill the needs of the most applications. But if you need something special - just add it!
|
||||
+ Forward - Opens new screen
|
||||

|
||||

|
||||
+ Back - Rolls back the last transition
|
||||

|
||||

|
||||
+ BackTo - Rolls back to the needed screen in the screens chain
|
||||

|
||||

|
||||
+ Replace - Replaces the current screen
|
||||

|
||||

|
||||
|
||||
## Predefined navigator
|
||||
The library provides predefined navigator for _Fragments_ and _Activity_.
|
||||
@@ -147,21 +171,22 @@ private val navigator = object : AppNavigator(this, R.id.container) {
|
||||
Describe your screens as you like e.g. create Kotlin `object` with all application screens:
|
||||
```kotlin
|
||||
object Screens {
|
||||
val Main = FragmentScreen("MainFragment") { MainFragment() }
|
||||
val AddressSearch = FragmentScreen("AddressSearchFragment") { AddressSearchFragment() }
|
||||
fun Profile(userId: Long) = FragmentScreen("ProfileFragment") { ProfileFragment(userId) }
|
||||
fun Main() = FragmentScreen { MainFragment() }
|
||||
fun AddressSearch() = FragmentScreen { AddressSearchFragment() }
|
||||
fun Profile(userId: Long) = FragmentScreen("Profile_$userId") { ProfileFragment(userId) }
|
||||
fun Browser(url: String) = ActivityScreen { Intent(Intent.ACTION_VIEW, Uri.parse(url)) }
|
||||
}
|
||||
```
|
||||
|
||||
Additional you can use `FragmentFactory` for creating your screens:
|
||||
```kotlin
|
||||
val SomeScreen = FragmentScreen("SomeScreenId") { factory: FragmentFactory -> ... }
|
||||
fun SomeScreen() = FragmentScreen { factory: FragmentFactory -> ... }
|
||||
```
|
||||
|
||||
## Screen parameters and result listener
|
||||
```kotlin
|
||||
//you have to specify screen parameters via new FragmentScreen creation
|
||||
fun SelectPhoto(resultKey: String) = FragmentScreen("SelectPhoto") {
|
||||
fun SelectPhoto(resultKey: String) = FragmentScreen {
|
||||
SelectPhotoFragment.getNewInstance(resultKey)
|
||||
}
|
||||
```
|
||||
@@ -188,9 +213,16 @@ To see how to add, initialize and use the library and predefined navigators see
|
||||
|
||||
For more complex use case check out the [GitFox (Android GitLab client)](https://gitlab.com/terrakok/gitlab-client)
|
||||
|
||||

|
||||

|
||||

|
||||
## Applications with Cicerone inside
|
||||
<a href="https://play.google.com/store/apps/details?id=ru.foodfox.client"><img src="https://play-lh.googleusercontent.com/gWYedIqy8QujCQOn0kzEIBEkGLBSpuKvFm-fMcfkWnJ1Oirtv847xAE4OyhAaohdcp5V=s360" width="64" /> Яндекс.Еда — доставка еды/продуктов. Food delivery</a><br>
|
||||
<a href="https://play.google.com/store/apps/details?id=com.foodient.whisk"><img src="https://play-lh.googleusercontent.com/eKotZjJcZOU2_L9t2l34EEY7aGl5zhvKVuEbF0Kc4MRs_pAC2SJgOnWMkMTFjR_e9EY=s360" width="64" /> Whisk: Recipe Saver, Meal Planner & Grocery List</a><br>
|
||||
<a href="https://play.google.com/store/apps/details?id=kz.beeline.odp"><img src="https://play-lh.googleusercontent.com/hzgjpQQpy6Z-Byye0aVKSv9P7h8yx58i6pVkQtiM6jB99iWFXjYfKeaPqJ3wm6Rtb38=s360" width="64" /> Мой Beeline (Казахстан)</a><br>
|
||||
<a href="https://play.google.com/store/apps/details?id=com.mercuryo.app"><img src="https://play-lh.googleusercontent.com/FKulXdc15r5PWX6hTZi2i3iaJjcQHwd9xParp6YPiQ2KiBqza7jwEt_b_tqLwXpyEHg=s360" width="64" /> Mercuryo Bitcoin Cryptowallet</a><br>
|
||||
<a href="https://play.google.com/store/apps/details?id=com.warefly.checkscan"><img src="https://play-lh.googleusercontent.com/2c2uuiSl2vwGgp-vdI-VArQEMdSSXk1neUK5A-Udc0WANPcvp5kBJFEugrFiXnxUc7k=s360" width="64" /> ЧекСкан - кэшбэк за чеки, цены и акции в магазинах</a><br>
|
||||
<a href="https://github.com/eduard1abdulmanov123/News"><img src="https://raw.githubusercontent.com/eduard1abdulmanov123/News/dev/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png" width="64" /> RSS Reader для Вести.Ru</a><br>
|
||||
<a href="https://play.google.com/store/apps/details?id=com.epam.connect.android"><img src="https://play-lh.googleusercontent.com/aN7R6BiR7yt7b3oEoBI30pVwzsdzaWe3TWpw8c9igqoOj79Pm2xVh4_C4qwjSKwjVio=s360" width="64" /> EPAM Connect</a><br>
|
||||
<a href="https://play.google.com/store/apps/details?id=org.consumerreports.ratings"><img src="https://play-lh.googleusercontent.com/dEdOwZOjXAdamytxY1TgY8LS-Hc9FKCcit5HP1RyaKqRAWjDJEyFSQS1XlqQPpeY5UI=s360" width="64" /> Consumer Reports: Product Reviews & Ratings</a><br>
|
||||
<a href="https://play.google.com/store/apps/details?id=ru.zakaz.android"><img src="https://play-lh.googleusercontent.com/jj18yK2dB2MHZ_QdO21aXyznGXteIF2q4mgxY4ubLhFv9gwZqHVDeu1i2FmanS-0Furm=s360" width="64" /> Zakaz.ru</a><br>
|
||||
|
||||
## Participants
|
||||
+ idea and code - Konstantin Tskhovrebov (@terrakok)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
apply plugin: 'com.github.dcendents.android-maven'
|
||||
|
||||
group = publishedGroupId // Maven Group ID for the artifact
|
||||
|
||||
install {
|
||||
repositories.mavenInstaller {
|
||||
// This generates POM.xml with proper parameters
|
||||
pom.project {
|
||||
packaging 'jar'
|
||||
groupId publishedGroupId
|
||||
artifactId artifact
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
apply plugin: 'com.jfrog.bintray'
|
||||
|
||||
version = libraryVersion // Library version
|
||||
|
||||
Properties properties = new Properties()
|
||||
properties.load(project.rootProject.file('local.properties').newDataInputStream())
|
||||
|
||||
bintray {
|
||||
// User and ApiKey stored in local.properties
|
||||
user = properties.getProperty("bintrayUser")
|
||||
key = properties.getProperty("bintrayApiKey")
|
||||
configurations = ['archives']
|
||||
// Package info for Bintray
|
||||
pkg {
|
||||
repo = bintrayRepo
|
||||
name = bintrayName
|
||||
licenses = allLicenses
|
||||
vcsUrl = gitUrl
|
||||
publish = true
|
||||
}
|
||||
}
|
||||
|
||||
// Dependency to call only bintrayUpload task
|
||||
bintrayUpload.dependsOn install
|
||||
+4
-42
@@ -1,5 +1,4 @@
|
||||
apply plugin: 'kotlin'
|
||||
apply plugin: 'maven-publish'
|
||||
|
||||
// This is important even if Android Studio claims it isn't
|
||||
// used. Android can't interpret Java 8 byte code.
|
||||
@@ -13,49 +12,12 @@ dependencies {
|
||||
}
|
||||
|
||||
ext {
|
||||
// This params is for the library uploading to the Bintray
|
||||
bintrayRepo = 'terramaven'
|
||||
bintrayName = 'cicerone-kotlin'
|
||||
publishedGroupId = 'com.github.terrakok'
|
||||
artifact = 'cicerone'
|
||||
libraryVersion = '6.2'
|
||||
gitUrl = 'https://github.com/terrakok/Cicerone'
|
||||
allLicenses = ['MIT']
|
||||
libraryVersion = '7.0'
|
||||
}
|
||||
|
||||
// Configuration of the library uploading to the Bintray
|
||||
// Note: Call 'bintrayUpload' task (it will execute 'install' task first)
|
||||
// I try to include as little properties as possible in these files
|
||||
project.archivesBaseName = 'cicerone' // to fix that project name different from artifact name
|
||||
apply from: 'androidmaven.gradle'
|
||||
apply from: 'bintray.gradle'
|
||||
project.archivesBaseName = artifact // to fix that project name different from artifact name
|
||||
|
||||
// Tasks for sources and javadocs jars
|
||||
task sourcesJar(type: Jar) {
|
||||
from sourceSets.main.kotlin.srcDirs
|
||||
classifier = 'sources'
|
||||
}
|
||||
|
||||
task javadocJar(type: Jar, dependsOn: javadoc) {
|
||||
classifier = 'javadoc'
|
||||
from javadoc.destinationDir
|
||||
}
|
||||
|
||||
artifacts {
|
||||
archives javadocJar
|
||||
archives sourcesJar
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
maven(MavenPublication) {
|
||||
groupId = publishedGroupId
|
||||
artifactId = artifact
|
||||
version = libraryVersion
|
||||
|
||||
artifact sourcesJar
|
||||
artifact javadocJar
|
||||
from components.java
|
||||
}
|
||||
}
|
||||
}
|
||||
//apply from: 'publish-mavencentral.gradle'
|
||||
//for publication use './gradlew publishReleasePublicationToSonatypeRepository'
|
||||
@@ -0,0 +1,94 @@
|
||||
apply plugin: 'maven-publish'
|
||||
apply plugin: 'signing'
|
||||
|
||||
Properties properties = new Properties()
|
||||
properties.load(project.rootProject.file('local.properties').newDataInputStream())
|
||||
properties.each { name, value -> ext[name] = value }
|
||||
|
||||
group = publishedGroupId
|
||||
version = libraryVersion
|
||||
|
||||
task sourcesJar(type: Jar) {
|
||||
from sourceSets.main.kotlin.srcDirs
|
||||
classifier = 'sources'
|
||||
}
|
||||
|
||||
task javadocJar(type: Jar, dependsOn: javadoc) {
|
||||
classifier = 'javadoc'
|
||||
from javadoc.destinationDir
|
||||
}
|
||||
|
||||
artifacts {
|
||||
archives javadocJar
|
||||
archives sourcesJar
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
release(MavenPublication) {
|
||||
groupId = publishedGroupId
|
||||
artifactId = artifact
|
||||
version = libraryVersion
|
||||
|
||||
artifact("$buildDir/libs/${artifact}-${version}.jar")
|
||||
artifact sourcesJar
|
||||
artifact javadocJar
|
||||
|
||||
pom {
|
||||
name = artifact
|
||||
description = 'Cicerone is a lightweight library that makes the navigation in an Android app easy.'
|
||||
url = 'https://github.com/terrakok/Cicerone'
|
||||
|
||||
licenses {
|
||||
license {
|
||||
name = "MIT"
|
||||
url = "https://opensource.org/licenses/MIT"
|
||||
}
|
||||
}
|
||||
|
||||
developers {
|
||||
developer {
|
||||
id = 'terrakok'
|
||||
name = 'Konstantin Tskhovrebov'
|
||||
email = 'terrakok@gmail.com'
|
||||
}
|
||||
}
|
||||
|
||||
scm {
|
||||
developerConnection = 'scm:git:ssh://github.com/terrakok/Cicerone.git'
|
||||
url = 'https://github.com/terrakok/Cicerone'
|
||||
}
|
||||
|
||||
// A slightly hacky fix so that your POM will include any transitive dependencies
|
||||
// that your library builds upon
|
||||
withXml {
|
||||
def dependenciesNode = asNode().appendNode('dependencies')
|
||||
|
||||
project.configurations.implementation.allDependencies.each {
|
||||
def dependencyNode = dependenciesNode.appendNode('dependency')
|
||||
dependencyNode.appendNode('groupId', it.group)
|
||||
dependencyNode.appendNode('artifactId', it.name)
|
||||
dependencyNode.appendNode('version', it.version)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
repositories {
|
||||
maven {
|
||||
name = "sonatype"
|
||||
url = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
|
||||
credentials {
|
||||
username = ossrhUsername
|
||||
password = ossrhPassword
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
signing {
|
||||
sign publishing.publications
|
||||
}
|
||||
|
||||
tasks.getByName("publishReleasePublicationToSonatypeRepository").dependsOn("assemble", "sourcesJar", "javadocJar")
|
||||
@@ -10,12 +10,16 @@ abstract class BaseRouter {
|
||||
private val resultWire = ResultWire()
|
||||
|
||||
/**
|
||||
* Sets data listener with given key.
|
||||
* Sets data listener with given key
|
||||
* and returns [ResultListenerHandler] for availability to dispose subscription.
|
||||
*
|
||||
* After first call listener will be removed.
|
||||
*/
|
||||
fun setResultListener(key: String, listener: (data: Any) -> Unit) {
|
||||
resultWire.setResultListener(key, listener)
|
||||
fun setResultListener(
|
||||
key: String,
|
||||
listener: ResultListener
|
||||
): ResultListenerHandler {
|
||||
return resultWire.setResultListener(key, listener)
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -32,6 +36,5 @@ abstract class BaseRouter {
|
||||
*/
|
||||
protected fun executeCommands(vararg commands: Command) {
|
||||
commandBuffer.executeCommands(commands)
|
||||
resultWire.flush()
|
||||
}
|
||||
}
|
||||
@@ -17,12 +17,14 @@ class Cicerone<T : BaseRouter> private constructor(val router: T) {
|
||||
/**
|
||||
* Creates the Cicerone instance with the default [Router]
|
||||
*/
|
||||
@JvmStatic
|
||||
fun create() = create(Router())
|
||||
|
||||
/**
|
||||
* Creates the Cicerone instance with the custom router.
|
||||
* @param customRouter the custom router extending [BaseRouter]
|
||||
*/
|
||||
@JvmStatic
|
||||
fun <T : BaseRouter> create(customRouter: T) = Cicerone(customRouter)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,23 +1,30 @@
|
||||
package com.github.terrakok.cicerone
|
||||
|
||||
import java.lang.ref.WeakReference
|
||||
/**
|
||||
* Interface definition for a result callback.
|
||||
*/
|
||||
fun interface ResultListener {
|
||||
fun onResult(data: Any)
|
||||
}
|
||||
|
||||
/**
|
||||
* Handler for manual delete subscription and avoid leak
|
||||
*/
|
||||
fun interface ResultListenerHandler {
|
||||
fun dispose()
|
||||
}
|
||||
|
||||
internal class ResultWire {
|
||||
private val listeners = mutableMapOf<String, WeakReference<(Any) -> Unit>>()
|
||||
private val listeners = mutableMapOf<String, ResultListener>()
|
||||
|
||||
fun setResultListener(key: String, listener: (data: Any) -> Unit) {
|
||||
listeners[key] = WeakReference(listener)
|
||||
}
|
||||
|
||||
fun sendResult(key: String, data: Any) {
|
||||
listeners.remove(key)?.get()?.let { listener ->
|
||||
listener(data)
|
||||
fun setResultListener(key: String, listener: ResultListener): ResultListenerHandler {
|
||||
listeners[key] = listener
|
||||
return ResultListenerHandler {
|
||||
listeners.remove(key)
|
||||
}
|
||||
}
|
||||
|
||||
fun flush() {
|
||||
listeners.entries
|
||||
.filter { it.value.get() == null }
|
||||
.forEach { listeners.remove(it.key) }
|
||||
fun sendResult(key: String, data: Any) {
|
||||
listeners.remove(key)?.onResult(data)
|
||||
}
|
||||
}
|
||||
@@ -12,10 +12,9 @@ open class Router : BaseRouter() {
|
||||
* Open new screen and add it to the screens chain.
|
||||
*
|
||||
* @param screen screen
|
||||
* @param clearContainer if FALSE then new screen shows over previous
|
||||
*/
|
||||
fun navigateTo(screen: Screen, clearContainer: Boolean = true) {
|
||||
executeCommands(Forward(screen, clearContainer))
|
||||
fun navigateTo(screen: Screen) {
|
||||
executeCommands(Forward(screen))
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -56,10 +55,9 @@ open class Router : BaseRouter() {
|
||||
* Opens several screens inside single transaction.
|
||||
*
|
||||
* @param screens
|
||||
* @param showOnlyTopScreenView if FALSE then all screen views show together
|
||||
*/
|
||||
fun newChain(vararg screens: Screen, showOnlyTopScreenView: Boolean = true) {
|
||||
val commands = screens.map { Forward(it, showOnlyTopScreenView) }
|
||||
fun newChain(vararg screens: Screen) {
|
||||
val commands = screens.map { Forward(it) }
|
||||
executeCommands(*commands.toTypedArray())
|
||||
}
|
||||
|
||||
@@ -67,14 +65,13 @@ open class Router : BaseRouter() {
|
||||
* Clear current stack and open several screens inside single transaction.
|
||||
*
|
||||
* @param screens
|
||||
* @param showOnlyTopScreenView if FALSE then all screen views show together
|
||||
*/
|
||||
fun newRootChain(vararg screens: Screen, showOnlyTopScreenView: Boolean = true) {
|
||||
fun newRootChain(vararg screens: Screen) {
|
||||
val commands = screens.mapIndexed { index, screen ->
|
||||
if (index == 0)
|
||||
Replace(screen)
|
||||
else
|
||||
Forward(screen, showOnlyTopScreenView)
|
||||
Forward(screen)
|
||||
}
|
||||
executeCommands(BackTo(null), *commands.toTypedArray())
|
||||
}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
package com.github.terrakok.cicerone
|
||||
|
||||
/**
|
||||
* Screen is class for description application screen.
|
||||
* Screen is interface for description application screen.
|
||||
*/
|
||||
abstract class Screen {
|
||||
open val screenKey: String = this::class.qualifiedName!!
|
||||
interface Screen {
|
||||
val screenKey: String get() = this::class.java.name
|
||||
}
|
||||
@@ -1,10 +1,11 @@
|
||||
package com.github.terrakok.cicerone.androidx
|
||||
|
||||
import android.content.ActivityNotFoundException
|
||||
import android.content.Intent
|
||||
import android.os.Handler
|
||||
import android.os.Looper
|
||||
import androidx.fragment.app.*
|
||||
import com.github.terrakok.cicerone.*
|
||||
import com.github.terrakok.cicerone.androidx.TransactionInfo.Type.ADD
|
||||
import com.github.terrakok.cicerone.androidx.TransactionInfo.Type.REPLACE
|
||||
|
||||
/**
|
||||
* Navigator implementation for launch fragments and activities.
|
||||
@@ -13,16 +14,23 @@ import com.github.terrakok.cicerone.androidx.TransactionInfo.Type.REPLACE
|
||||
*
|
||||
* Recommendation: most useful for Single-Activity application.
|
||||
*/
|
||||
open class AppNavigator constructor(
|
||||
open class AppNavigator @JvmOverloads constructor(
|
||||
protected val activity: FragmentActivity,
|
||||
protected val containerId: Int,
|
||||
protected val fragmentManager: FragmentManager = activity.supportFragmentManager,
|
||||
protected val fragmentFactory: FragmentFactory = FragmentFactory()
|
||||
protected val fragmentFactory: FragmentFactory = fragmentManager.fragmentFactory
|
||||
) : Navigator {
|
||||
|
||||
protected val localStackCopy = mutableListOf<TransactionInfo>()
|
||||
protected val localStackCopy = mutableListOf<String>()
|
||||
private val mainHandler = Handler(Looper.getMainLooper())
|
||||
|
||||
override fun applyCommands(commands: Array<out Command>) {
|
||||
mainHandler.post {
|
||||
applyCommandsSync(commands)
|
||||
}
|
||||
}
|
||||
|
||||
protected open fun applyCommandsSync(commands: Array<out Command>) {
|
||||
fragmentManager.executePendingTransactions()
|
||||
|
||||
//copy stack before apply commands
|
||||
@@ -40,8 +48,7 @@ open class AppNavigator constructor(
|
||||
private fun copyStackToLocal() {
|
||||
localStackCopy.clear()
|
||||
for (i in 0 until fragmentManager.backStackEntryCount) {
|
||||
val str = fragmentManager.getBackStackEntryAt(i).name
|
||||
localStackCopy.add(TransactionInfo.fromString(str))
|
||||
localStackCopy.add(fragmentManager.getBackStackEntryAt(i).name)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -60,19 +67,18 @@ open class AppNavigator constructor(
|
||||
}
|
||||
|
||||
protected open fun forward(command: Forward) {
|
||||
when (val screen = command.screen as AppScreen) {
|
||||
when (val screen = command.screen) {
|
||||
is ActivityScreen -> {
|
||||
checkAndStartActivity(screen)
|
||||
}
|
||||
is FragmentScreen -> {
|
||||
val type = if (command.clearContainer) REPLACE else ADD
|
||||
commitNewFragmentScreen(screen, type, true)
|
||||
commitNewFragmentScreen(screen, true)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
protected open fun replace(command: Replace) {
|
||||
when (val screen = command.screen as AppScreen) {
|
||||
when (val screen = command.screen) {
|
||||
is ActivityScreen -> {
|
||||
checkAndStartActivity(screen)
|
||||
activity.finish()
|
||||
@@ -80,10 +86,10 @@ open class AppNavigator constructor(
|
||||
is FragmentScreen -> {
|
||||
if (localStackCopy.isNotEmpty()) {
|
||||
fragmentManager.popBackStack()
|
||||
val removed = localStackCopy.removeAt(localStackCopy.lastIndex)
|
||||
commitNewFragmentScreen(screen, removed.type, true)
|
||||
localStackCopy.removeAt(localStackCopy.lastIndex)
|
||||
commitNewFragmentScreen(screen, true)
|
||||
} else {
|
||||
commitNewFragmentScreen(screen, REPLACE, false)
|
||||
commitNewFragmentScreen(screen, false)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -104,24 +110,25 @@ open class AppNavigator constructor(
|
||||
|
||||
protected open fun commitNewFragmentScreen(
|
||||
screen: FragmentScreen,
|
||||
type: TransactionInfo.Type,
|
||||
addToBackStack: Boolean
|
||||
) {
|
||||
val fragment = screen.createFragment(fragmentFactory)
|
||||
val transaction = fragmentManager.beginTransaction()
|
||||
transaction.setReorderingAllowed(true)
|
||||
setupFragmentTransaction(
|
||||
screen,
|
||||
transaction,
|
||||
fragmentManager.findFragmentById(containerId),
|
||||
fragment
|
||||
)
|
||||
when (type) {
|
||||
ADD -> transaction.add(containerId, fragment, screen.screenKey)
|
||||
REPLACE -> transaction.replace(containerId, fragment, screen.screenKey)
|
||||
if (screen.clearContainer) {
|
||||
transaction.replace(containerId, fragment, screen.screenKey)
|
||||
} else {
|
||||
transaction.add(containerId, fragment, screen.screenKey)
|
||||
}
|
||||
if (addToBackStack) {
|
||||
val transactionInfo = TransactionInfo(screen.screenKey, type)
|
||||
transaction.addToBackStack(transactionInfo.toString())
|
||||
localStackCopy.add(transactionInfo)
|
||||
transaction.addToBackStack(screen.screenKey)
|
||||
localStackCopy.add(screen.screenKey)
|
||||
}
|
||||
transaction.commit()
|
||||
}
|
||||
@@ -134,13 +141,13 @@ open class AppNavigator constructor(
|
||||
backToRoot()
|
||||
} else {
|
||||
val screenKey = command.screen.screenKey
|
||||
val index = localStackCopy.indexOfFirst { it.screenKey == screenKey }
|
||||
val index = localStackCopy.indexOfFirst { it == screenKey }
|
||||
if (index != -1) {
|
||||
val forRemove = localStackCopy.subList(index, localStackCopy.size)
|
||||
fragmentManager.popBackStack(forRemove.first().toString(), 0)
|
||||
forRemove.clear()
|
||||
} else {
|
||||
backToUnexisting(command.screen as AppScreen)
|
||||
backToUnexisting(command.screen)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -160,9 +167,10 @@ open class AppNavigator constructor(
|
||||
* @param nextFragment next screen fragment
|
||||
*/
|
||||
protected open fun setupFragmentTransaction(
|
||||
screen: FragmentScreen,
|
||||
fragmentTransaction: FragmentTransaction,
|
||||
currentFragment: Fragment?,
|
||||
nextFragment: Fragment?
|
||||
nextFragment: Fragment
|
||||
) {
|
||||
// Do nothing by default
|
||||
}
|
||||
@@ -170,9 +178,9 @@ open class AppNavigator constructor(
|
||||
private fun checkAndStartActivity(screen: ActivityScreen) {
|
||||
// Check if we can start activity
|
||||
val activityIntent = screen.createIntent(activity)
|
||||
if (activityIntent.resolveActivity(activity.packageManager) != null) {
|
||||
try {
|
||||
activity.startActivity(activityIntent, screen.startActivityOptions)
|
||||
} else {
|
||||
} catch (e: ActivityNotFoundException) {
|
||||
unexistingActivity(screen, activityIntent)
|
||||
}
|
||||
}
|
||||
@@ -196,7 +204,7 @@ open class AppNavigator constructor(
|
||||
*
|
||||
* @param screen screen
|
||||
*/
|
||||
protected open fun backToUnexisting(screen: AppScreen) {
|
||||
protected open fun backToUnexisting(screen: Screen) {
|
||||
backToRoot()
|
||||
}
|
||||
|
||||
|
||||
@@ -7,16 +7,40 @@ import androidx.fragment.app.Fragment
|
||||
import androidx.fragment.app.FragmentFactory
|
||||
import com.github.terrakok.cicerone.Screen
|
||||
|
||||
sealed class AppScreen : Screen()
|
||||
fun interface Creator<A, R> {
|
||||
fun create(argument: A): R
|
||||
}
|
||||
|
||||
open class FragmentScreen(
|
||||
override val screenKey: String,
|
||||
val createFragment: (FragmentFactory) -> Fragment
|
||||
) : AppScreen()
|
||||
interface FragmentScreen : Screen {
|
||||
val clearContainer: Boolean get() = true
|
||||
fun createFragment(factory: FragmentFactory): Fragment
|
||||
|
||||
open class ActivityScreen(
|
||||
override val screenKey: String,
|
||||
val createIntent: (context: Context) -> Intent
|
||||
) : AppScreen() {
|
||||
open val startActivityOptions: Bundle? = null
|
||||
companion object {
|
||||
operator fun invoke(
|
||||
key: String? = null,
|
||||
clearContainer: Boolean = true,
|
||||
fragmentCreator: Creator<FragmentFactory, Fragment>
|
||||
) = object : FragmentScreen {
|
||||
override val screenKey = key ?: fragmentCreator::class.java.name
|
||||
override val clearContainer = clearContainer
|
||||
override fun createFragment(factory: FragmentFactory) = fragmentCreator.create(factory)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
interface ActivityScreen : Screen {
|
||||
val startActivityOptions: Bundle? get() = null
|
||||
fun createIntent(context: Context): Intent
|
||||
|
||||
companion object {
|
||||
operator fun invoke(
|
||||
key: String? = null,
|
||||
startActivityOptions: Bundle? = null,
|
||||
intentCreator: Creator<Context, Intent>
|
||||
) = object : ActivityScreen {
|
||||
override val screenKey = key ?: intentCreator::class.java.name
|
||||
override val startActivityOptions = startActivityOptions
|
||||
override fun createIntent(context: Context) = intentCreator.create(context)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
package com.github.terrakok.cicerone.androidx
|
||||
|
||||
data class TransactionInfo(
|
||||
val screenKey: String,
|
||||
val type: Type
|
||||
) {
|
||||
enum class Type(val symbol: Char) {
|
||||
ADD('+'),
|
||||
REPLACE('-');
|
||||
}
|
||||
|
||||
override fun toString() = screenKey + type.symbol
|
||||
|
||||
companion object {
|
||||
fun fromString(str: String) = TransactionInfo(
|
||||
str.dropLast(1),
|
||||
if (str.last() == Type.ADD.symbol) Type.ADD else Type.REPLACE
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -10,10 +10,7 @@ interface Command
|
||||
/**
|
||||
* Opens new screen.
|
||||
*/
|
||||
data class Forward(
|
||||
val screen: Screen,
|
||||
val clearContainer: Boolean
|
||||
) : Command
|
||||
data class Forward(val screen: Screen) : Command
|
||||
|
||||
/**
|
||||
* Replaces the current screen.
|
||||
|
||||
@@ -36,6 +36,10 @@ public class FragmentManager {
|
||||
throw new RuntimeException("Stub!");
|
||||
}
|
||||
|
||||
public FragmentFactory getFragmentFactory() {
|
||||
throw new RuntimeException("Stub!");
|
||||
}
|
||||
|
||||
public interface BackStackEntry {
|
||||
int getId();
|
||||
|
||||
|
||||
@@ -6,6 +6,10 @@ package androidx.fragment.app;
|
||||
*/
|
||||
|
||||
public class FragmentTransaction {
|
||||
public FragmentTransaction setReorderingAllowed(boolean reorderingAllowed) {
|
||||
throw new RuntimeException("Stub!");
|
||||
}
|
||||
|
||||
public FragmentTransaction add(int containerViewId, Fragment fragment, String tag) {
|
||||
throw new RuntimeException("Stub!");
|
||||
}
|
||||
|
||||
@@ -24,39 +24,39 @@ object Screens {
|
||||
SampleFragment.getNewInstance(number)
|
||||
}
|
||||
|
||||
fun Start() = ActivityScreen("Start") {
|
||||
fun Start() = ActivityScreen {
|
||||
Intent(it, StartActivity::class.java)
|
||||
}
|
||||
|
||||
fun Main() = ActivityScreen("Main") {
|
||||
fun Main() = ActivityScreen {
|
||||
Intent(it, MainActivity::class.java)
|
||||
}
|
||||
|
||||
fun BottomNavigation() = ActivityScreen("BottomNavigation") {
|
||||
fun BottomNavigation() = ActivityScreen {
|
||||
Intent(it, BottomNavigationActivity::class.java)
|
||||
}
|
||||
|
||||
fun Tab(tabName: String) = FragmentScreen("Tab") {
|
||||
fun Tab(tabName: String) = FragmentScreen {
|
||||
TabContainerFragment.getNewInstance(tabName)
|
||||
}
|
||||
|
||||
fun Forward(containerName: String, number: Int) = FragmentScreen("Forward") {
|
||||
fun Forward(containerName: String, number: Int) = FragmentScreen {
|
||||
ForwardFragment.getNewInstance(containerName, number)
|
||||
}
|
||||
|
||||
fun Github() = ActivityScreen("Github") {
|
||||
fun Github() = ActivityScreen {
|
||||
Intent(Intent.ACTION_VIEW, Uri.parse("https://github.com/terrakok/Cicerone"))
|
||||
}
|
||||
|
||||
fun Profile() = ActivityScreen("Profile") {
|
||||
fun Profile() = ActivityScreen {
|
||||
Intent(it, ProfileActivity::class.java)
|
||||
}
|
||||
|
||||
fun ProfileInfo() = FragmentScreen("ProfileInfo") {
|
||||
fun ProfileInfo() = FragmentScreen {
|
||||
ProfileFragment()
|
||||
}
|
||||
|
||||
fun SelectPhoto(resultKey: String) = FragmentScreen("SelectPhoto") {
|
||||
fun SelectPhoto(resultKey: String) = FragmentScreen {
|
||||
SelectPhotoFragment.getNewInstance(resultKey)
|
||||
}
|
||||
}
|
||||
+8
-1
@@ -1,5 +1,6 @@
|
||||
package com.github.terrakok.cicerone.sample.mvp.animation.profile
|
||||
|
||||
import com.github.terrakok.cicerone.ResultListenerHandler
|
||||
import com.github.terrakok.cicerone.Router
|
||||
import com.github.terrakok.cicerone.sample.R
|
||||
import com.github.terrakok.cicerone.sample.Screens.SelectPhoto
|
||||
@@ -13,6 +14,7 @@ import moxy.MvpPresenter
|
||||
class ProfilePresenter(
|
||||
private val router: Router
|
||||
) : MvpPresenter<ProfileView>() {
|
||||
private var resultListenerHandler: ResultListenerHandler? = null
|
||||
|
||||
companion object {
|
||||
private const val RESULT_KEY = "photo_result"
|
||||
@@ -25,12 +27,17 @@ class ProfilePresenter(
|
||||
}
|
||||
|
||||
fun onPhotoClicked() {
|
||||
router.setResultListener(RESULT_KEY) { data ->
|
||||
resultListenerHandler = router.setResultListener(RESULT_KEY) { data ->
|
||||
viewState!!.showPhoto(data as Int)
|
||||
}
|
||||
router.navigateTo(SelectPhoto(RESULT_KEY))
|
||||
}
|
||||
|
||||
override fun onDestroy() {
|
||||
resultListenerHandler?.dispose()
|
||||
super.onDestroy()
|
||||
}
|
||||
|
||||
fun onBackPressed() {
|
||||
router.exit()
|
||||
}
|
||||
|
||||
+12
-7
@@ -10,6 +10,7 @@ import com.github.terrakok.cicerone.Navigator
|
||||
import com.github.terrakok.cicerone.NavigatorHolder
|
||||
import com.github.terrakok.cicerone.Replace
|
||||
import com.github.terrakok.cicerone.androidx.AppNavigator
|
||||
import com.github.terrakok.cicerone.androidx.FragmentScreen
|
||||
import com.github.terrakok.cicerone.sample.R
|
||||
import com.github.terrakok.cicerone.sample.SampleApplication
|
||||
import com.github.terrakok.cicerone.sample.Screens.ProfileInfo
|
||||
@@ -46,15 +47,19 @@ class ProfileActivity : AppCompatActivity() {
|
||||
super.onPause()
|
||||
}
|
||||
|
||||
private val navigator: Navigator = object : AppNavigator(this, R.id.container, supportFragmentManager, supportFragmentManager.fragmentFactory) {
|
||||
|
||||
override fun setupFragmentTransaction(fragmentTransaction: FragmentTransaction, currentFragment: Fragment?, nextFragment: Fragment?) {
|
||||
private val navigator: Navigator = object : AppNavigator(this, R.id.container) {
|
||||
override fun setupFragmentTransaction(
|
||||
screen: FragmentScreen,
|
||||
fragmentTransaction: FragmentTransaction,
|
||||
currentFragment: Fragment?,
|
||||
nextFragment: Fragment
|
||||
) {
|
||||
if (currentFragment is ProfileFragment
|
||||
&& nextFragment is SelectPhotoFragment) {
|
||||
&& nextFragment is SelectPhotoFragment) {
|
||||
setupSharedElementForProfileToSelectPhoto(
|
||||
currentFragment,
|
||||
nextFragment,
|
||||
fragmentTransaction
|
||||
currentFragment,
|
||||
nextFragment,
|
||||
fragmentTransaction
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
+1
-1
@@ -87,7 +87,7 @@ class BottomNavigationActivity : MvpAppCompatActivity(), BottomNavigationView, R
|
||||
if (newFragment == null) {
|
||||
transaction.add(
|
||||
R.id.ab_container,
|
||||
Tab(tab).createFragment.invoke(fm.fragmentFactory), tab
|
||||
Tab(tab).createFragment(fm.fragmentFactory), tab
|
||||
)
|
||||
}
|
||||
if (currentFragment != null) {
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ import javax.inject.Inject
|
||||
class TabContainerFragment : Fragment(), RouterProvider, BackButtonListener {
|
||||
|
||||
private val navigator: Navigator by lazy {
|
||||
AppNavigator(activity!!, R.id.ftc_container, childFragmentManager, childFragmentManager.fragmentFactory)
|
||||
AppNavigator(activity!!, R.id.ftc_container, childFragmentManager)
|
||||
}
|
||||
|
||||
@Inject
|
||||
|
||||
@@ -31,10 +31,10 @@ class MainActivity : MvpAppCompatActivity(), ChainHolder {
|
||||
@Inject
|
||||
lateinit var navigatorHolder: NavigatorHolder
|
||||
|
||||
private val navigator: Navigator = object : AppNavigator(this, R.id.main_container, supportFragmentManager, supportFragmentManager.fragmentFactory) {
|
||||
private val navigator: Navigator = object : AppNavigator(this, R.id.main_container) {
|
||||
|
||||
override fun applyCommands(commands: Array<out Command>) {
|
||||
super.applyCommands(commands)
|
||||
override fun applyCommandsSync(commands: Array<out Command>) {
|
||||
super.applyCommandsSync(commands)
|
||||
supportFragmentManager.executePendingTransactions()
|
||||
printScreensScheme()
|
||||
}
|
||||
|
||||
@@ -29,7 +29,7 @@ class StartActivity : MvpAppCompatActivity(), StartActivityView {
|
||||
@InjectPresenter
|
||||
lateinit var presenter: StartActivityPresenter
|
||||
|
||||
private val navigator: Navigator = AppNavigator(this, -1, supportFragmentManager, supportFragmentManager.fragmentFactory)
|
||||
private val navigator: Navigator = AppNavigator(this, -1)
|
||||
|
||||
@ProvidePresenter
|
||||
fun createStartActivityPresenter() = StartActivityPresenter(router)
|
||||
|
||||
Reference in New Issue
Block a user