UI with Conductor (#784)

2017-05-06 15:49:39 +02:00
parent 89b293fecd
commit 2eeac0bf8b
110 changed files with 7463 additions and 5807 deletions
@@ -1,7 +1,5 @@
 package eu.kanade.tachiyomi.ui.base.activity

-import android.os.Bundle
-import eu.kanade.tachiyomi.App
 import eu.kanade.tachiyomi.ui.base.presenter.BasePresenter
 import eu.kanade.tachiyomi.util.LocaleHelper
 import nucleus.view.NucleusAppCompatActivity
@@ -14,17 +12,6 @@ abstract class BaseRxActivity<P : BasePresenter<*>> : NucleusAppCompatActivity<P
        LocaleHelper.updateConfiguration(this)
    }

-    override fun onCreate(savedState: Bundle?) {
-        val superFactory = presenterFactory
-        setPresenterFactory {
-            superFactory.createPresenter().apply {
-                val app = application as App
-                context = app.applicationContext
-            }
-        }
-        super.onCreate(savedState)
-    }
-
    override fun getActivity() = this

    override fun onResume() {
@@ -0,0 +1,57 @@
+package eu.kanade.tachiyomi.ui.base.controller
+
+import android.os.Bundle
+import android.support.v7.app.AppCompatActivity
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import com.bluelinelabs.conductor.ControllerChangeHandler
+import com.bluelinelabs.conductor.ControllerChangeType
+import com.bluelinelabs.conductor.RestoreViewOnCreateController
+import com.bluelinelabs.conductor.Router
+
+abstract class BaseController(bundle: Bundle? = null) : RestoreViewOnCreateController(bundle) {
+
+    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup, savedViewState: Bundle?): View {
+        val view = inflateView(inflater, container)
+        onViewCreated(view, savedViewState)
+        return view
+    }
+
+    abstract fun inflateView(inflater: LayoutInflater, container: ViewGroup): View
+
+    open fun onViewCreated(view: View, savedViewState: Bundle?) { }
+
+    override fun onChangeStarted(handler: ControllerChangeHandler, type: ControllerChangeType) {
+        if (type.isEnter) {
+            setTitle()
+        }
+        super.onChangeStarted(handler, type)
+    }
+
+    open fun getTitle(): String? {
+        return null
+    }
+
+    private fun setTitle() {
+        var parentController = parentController
+        while (parentController != null) {
+            if (parentController is BaseController && parentController.getTitle() != null) {
+                return
+            }
+            parentController = parentController.parentController
+        }
+
+        (activity as? AppCompatActivity)?.supportActionBar?.title = getTitle()
+    }
+
+    fun Router.popControllerWithTag(tag: String): Boolean {
+        val controller = getControllerWithTag(tag)
+        if (controller != null) {
+            popController(controller)
+            return true
+        }
+        return false
+    }
+
+}
@@ -0,0 +1,139 @@
+package eu.kanade.tachiyomi.ui.base.controller;
+
+import android.app.Dialog;
+import android.content.DialogInterface;
+import android.os.Bundle;
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+
+import com.bluelinelabs.conductor.RestoreViewOnCreateController;
+import com.bluelinelabs.conductor.Router;
+import com.bluelinelabs.conductor.RouterTransaction;
+import com.bluelinelabs.conductor.changehandler.SimpleSwapChangeHandler;
+
+/**
+ * A controller that displays a dialog window, floating on top of its activity's window.
+ * This is a wrapper over {@link Dialog} object like {@link android.app.DialogFragment}.
+ *
+ * <p>Implementations should override this class and implement {@link #onCreateDialog(Bundle)} to create a custom dialog, such as an {@link android.app.AlertDialog}
+ */
+public abstract class DialogController extends RestoreViewOnCreateController {
+
+    private static final String SAVED_DIALOG_STATE_TAG = "android:savedDialogState";
+
+    private Dialog dialog;
+    private boolean dismissed;
+
+    /**
+     * Convenience constructor for use when no arguments are needed.
+     */
+    protected DialogController() {
+        super(null);
+    }
+
+    /**
+     * Constructor that takes arguments that need to be retained across restarts.
+     *
+     * @param args Any arguments that need to be retained.
+     */
+    protected DialogController(@Nullable Bundle args) {
+        super(args);
+    }
+
+    @NonNull
+    @Override
+    final protected View onCreateView(@NonNull LayoutInflater inflater, @NonNull ViewGroup container, @Nullable Bundle savedViewState) {
+        dialog = onCreateDialog(savedViewState);
+        //noinspection ConstantConditions
+        dialog.setOwnerActivity(getActivity());
+        dialog.setOnDismissListener(new DialogInterface.OnDismissListener() {
+            @Override
+            public void onDismiss(DialogInterface dialog) {
+                dismissDialog();
+            }
+        });
+        if (savedViewState != null) {
+            Bundle dialogState = savedViewState.getBundle(SAVED_DIALOG_STATE_TAG);
+            if (dialogState != null) {
+                dialog.onRestoreInstanceState(dialogState);
+            }
+        }
+        return new View(getActivity());//stub view
+    }
+
+    @Override
+    protected void onSaveViewState(@NonNull View view, @NonNull Bundle outState) {
+        super.onSaveViewState(view, outState);
+        Bundle dialogState = dialog.onSaveInstanceState();
+        outState.putBundle(SAVED_DIALOG_STATE_TAG, dialogState);
+    }
+
+    @Override
+    protected void onAttach(@NonNull View view) {
+        super.onAttach(view);
+        dialog.show();
+    }
+
+    @Override
+    protected void onDetach(@NonNull View view) {
+        super.onDetach(view);
+        dialog.hide();
+    }
+
+    @Override
+    protected void onDestroyView(@NonNull View view) {
+        super.onDestroyView(view);
+        dialog.setOnDismissListener(null);
+        dialog.dismiss();
+        dialog = null;
+    }
+
+    /**
+     * Display the dialog, create a transaction and pushing the controller.
+     * @param router The router on which the transaction will be applied
+     */
+    public void showDialog(@NonNull Router router) {
+        showDialog(router, null);
+    }
+
+    /**
+     * Display the dialog, create a transaction and pushing the controller.
+     * @param router The router on which the transaction will be applied
+     * @param tag The tag for this controller
+     */
+    public void showDialog(@NonNull Router router, @Nullable String tag) {
+        dismissed = false;
+        router.pushController(RouterTransaction.with(this)
+                .pushChangeHandler(new SimpleSwapChangeHandler(false))
+                .popChangeHandler(new SimpleSwapChangeHandler(false))
+                .tag(tag));
+    }
+
+    /**
+     * Dismiss the dialog and pop this controller
+     */
+    public void dismissDialog() {
+        if (dismissed) {
+            return;
+        }
+        getRouter().popController(this);
+        dismissed = true;
+    }
+
+    @Nullable
+    protected Dialog getDialog() {
+        return dialog;
+    }
+
+    /**
+     * Build your own custom Dialog container such as an {@link android.app.AlertDialog}
+     *
+     * @param savedViewState A bundle for the view's state, which would have been created in {@link #onSaveViewState(View, Bundle)} or {@code null} if no saved state exists.
+     * @return Return a new Dialog instance to be displayed by the Controller
+     */
+    @NonNull
+    protected abstract Dialog onCreateDialog(@Nullable Bundle savedViewState);
+}
@@ -0,0 +1,3 @@
+package eu.kanade.tachiyomi.ui.base.controller
+
+interface NoToolbarElevationController
@@ -0,0 +1,21 @@
+package eu.kanade.tachiyomi.ui.base.controller
+
+import android.os.Bundle
+import eu.kanade.tachiyomi.ui.base.presenter.NucleusConductorDelegate
+import eu.kanade.tachiyomi.ui.base.presenter.NucleusConductorLifecycleListener
+import nucleus.factory.PresenterFactory
+import nucleus.presenter.Presenter
+
+@Suppress("LeakingThis")
+abstract class NucleusController<P : Presenter<*>>(val bundle: Bundle? = null) : RxController(),
+        PresenterFactory<P> {
+
+    private val delegate = NucleusConductorDelegate(this)
+
+    val presenter: P
+        get() = delegate.presenter
+
+    init {
+        addLifecycleListener(NucleusConductorLifecycleListener(delegate))
+    }
+}
@@ -0,0 +1,186 @@
+package eu.kanade.tachiyomi.ui.base.controller;
+
+import android.os.Bundle;
+import android.os.Parcelable;
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+import android.support.v4.view.PagerAdapter;
+import android.util.SparseArray;
+import android.view.View;
+import android.view.ViewGroup;
+
+import com.bluelinelabs.conductor.Controller;
+import com.bluelinelabs.conductor.Router;
+import com.bluelinelabs.conductor.RouterTransaction;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * An adapter for ViewPagers 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_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 SparseArray<Bundle> savedPages = new SparseArray<>();
+    private SparseArray<Router> visibleRouters = new SparseArray<>();
+    private ArrayList<Integer> savedPageHistory = new ArrayList<>();
+    private Router primaryRouter;
+
+    /**
+     * 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));
+
+        Router router = host.getChildRouter(container, name);
+        if (!router.hasRootController()) {
+            Bundle routerSavedState = savedPages.get(position);
+
+            if (routerSavedState != null) {
+                router.restoreInstanceState(routerSavedState);
+                savedPages.remove(position);
+            }
+        }
+
+        router.rebindIfNeeded();
+        configureRouter(router, position);
+
+        if (router != primaryRouter) {
+            for (RouterTransaction transaction : router.getBackstack()) {
+                transaction.controller().setOptionsMenuHidden(true);
+            }
+        }
+
+        visibleRouters.put(position, router);
+        return router;
+    }
+
+    @Override
+    public void destroyItem(ViewGroup container, int position, 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(ViewGroup container, int position, Object object) {
+        Router router = (Router)object;
+        if (router != primaryRouter) {
+            if (primaryRouter != null) {
+                for (RouterTransaction transaction : primaryRouter.getBackstack()) {
+                    transaction.controller().setOptionsMenuHidden(true);
+                }
+            }
+            if (router != null) {
+                for (RouterTransaction transaction : router.getBackstack()) {
+                    transaction.controller().setOptionsMenuHidden(false);
+                }
+            }
+            primaryRouter = router;
+        }
+    }
+
+    @Override
+    public boolean isViewFromObject(View view, 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.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);
+        }
+    }
+
+    /**
+     * 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,92 @@
+package eu.kanade.tachiyomi.ui.base.controller
+
+import android.os.Bundle
+import android.support.annotation.CallSuper
+import android.view.View
+import rx.Observable
+import rx.Subscription
+import rx.subscriptions.CompositeSubscription
+
+abstract class RxController(bundle: Bundle? = null) : BaseController(bundle) {
+
+    var untilDetachSubscriptions = CompositeSubscription()
+        private set
+
+    var untilDestroySubscriptions = CompositeSubscription()
+        private set
+
+    @CallSuper
+    override fun onAttach(view: View) {
+        super.onAttach(view)
+        if (untilDetachSubscriptions.isUnsubscribed) {
+            untilDetachSubscriptions = CompositeSubscription()
+        }
+    }
+
+    @CallSuper
+    override fun onDetach(view: View) {
+        super.onDetach(view)
+        untilDetachSubscriptions.unsubscribe()
+    }
+
+    @CallSuper
+    override fun onViewCreated(view: View, savedViewState: Bundle?) {
+        if (untilDestroySubscriptions.isUnsubscribed) {
+            untilDestroySubscriptions = CompositeSubscription()
+        }
+    }
+
+    @CallSuper
+    override fun onDestroyView(view: View) {
+        super.onDestroyView(view)
+        untilDestroySubscriptions.unsubscribe()
+    }
+
+
+    fun <T> Observable<T>.subscribeUntilDetach(): Subscription {
+
+        return subscribe().also { untilDetachSubscriptions.add(it) }
+    }
+
+    fun <T> Observable<T>.subscribeUntilDetach(onNext: (T) -> Unit): Subscription {
+
+        return subscribe(onNext).also { untilDetachSubscriptions.add(it) }
+    }
+
+    fun <T> Observable<T>.subscribeUntilDetach(onNext: (T) -> Unit,
+                                               onError: (Throwable) -> Unit): Subscription {
+
+        return subscribe(onNext, onError).also { untilDetachSubscriptions.add(it) }
+    }
+
+    fun <T> Observable<T>.subscribeUntilDetach(onNext: (T) -> Unit,
+                                               onError: (Throwable) -> Unit,
+                                               onCompleted: () -> Unit): Subscription {
+
+        return subscribe(onNext, onError, onCompleted).also { untilDetachSubscriptions.add(it) }
+    }
+
+    fun <T> Observable<T>.subscribeUntilDestroy(): Subscription {
+
+        return subscribe().also { untilDestroySubscriptions.add(it) }
+    }
+
+    fun <T> Observable<T>.subscribeUntilDestroy(onNext: (T) -> Unit): Subscription {
+
+        return subscribe(onNext).also { untilDestroySubscriptions.add(it) }
+    }
+
+    fun <T> Observable<T>.subscribeUntilDestroy(onNext: (T) -> Unit,
+                                                onError: (Throwable) -> Unit): Subscription {
+
+        return subscribe(onNext, onError).also { untilDestroySubscriptions.add(it) }
+    }
+
+    fun <T> Observable<T>.subscribeUntilDestroy(onNext: (T) -> Unit,
+                                                onError: (Throwable) -> Unit,
+                                                onCompleted: () -> Unit): Subscription {
+
+        return subscribe(onNext, onError, onCompleted).also { untilDestroySubscriptions.add(it) }
+    }
+
+}
@@ -0,0 +1,11 @@
+package eu.kanade.tachiyomi.ui.base.controller
+
+import android.support.v4.widget.DrawerLayout
+import android.view.ViewGroup
+
+interface SecondaryDrawerController {
+
+    fun createSecondaryDrawer(drawer: DrawerLayout): ViewGroup?
+
+    fun cleanupSecondaryDrawer(drawer: DrawerLayout)
+}
@@ -0,0 +1,10 @@
+package eu.kanade.tachiyomi.ui.base.controller
+
+import android.support.design.widget.TabLayout
+
+interface TabbedController {
+
+    fun configureTabs(tabs: TabLayout) {}
+
+    fun cleanupTabs(tabs: TabLayout) {}
+}
@@ -1,7 +0,0 @@
-package eu.kanade.tachiyomi.ui.base.fragment
-
-import android.support.v4.app.Fragment
-
-abstract class BaseFragment : Fragment(), FragmentMixin {
-
-}
@@ -1,20 +0,0 @@
-package eu.kanade.tachiyomi.ui.base.fragment
-
-import android.os.Bundle
-import eu.kanade.tachiyomi.App
-import eu.kanade.tachiyomi.ui.base.presenter.BasePresenter
-import nucleus.view.NucleusSupportFragment
-
-abstract class BaseRxFragment<P : BasePresenter<*>> : NucleusSupportFragment<P>(), FragmentMixin {
-
-    override fun onCreate(savedState: Bundle?) {
-        val superFactory = presenterFactory
-        setPresenterFactory {
-            superFactory.createPresenter().apply {
-                val app = activity.application as App
-                context = app.applicationContext
-            }
-        }
-        super.onCreate(savedState)
-    }
-}
@@ -1,19 +0,0 @@
-package eu.kanade.tachiyomi.ui.base.fragment
-
-import android.support.v4.app.FragmentActivity
-import eu.kanade.tachiyomi.ui.base.activity.ActivityMixin
-
-interface FragmentMixin {
-
-    fun setToolbarTitle(title: String) {
-        (getActivity() as ActivityMixin).setToolbarTitle(title)
-    }
-
-    fun setToolbarTitle(resourceId: Int) {
-        (getActivity() as ActivityMixin).setToolbarTitle(getString(resourceId))
-    }
-
-    fun getActivity(): FragmentActivity
-    
-    fun getString(resource: Int): String
-}
@@ -1,13 +1,9 @@
 package eu.kanade.tachiyomi.ui.base.presenter

-import android.content.Context
 import nucleus.presenter.RxPresenter
-import nucleus.view.ViewWithPresenter
 import rx.Observable

-open class BasePresenter<V : ViewWithPresenter<*>> : RxPresenter<V>() {
-
-    lateinit var context: Context
+open class BasePresenter<V> : RxPresenter<V>() {

    /**
     * Subscribes an observable with [deliverFirst] and adds it to the presenter's lifecycle
@@ -0,0 +1,67 @@
+package eu.kanade.tachiyomi.ui.base.presenter;
+
+import android.os.Bundle;
+import android.support.annotation.Nullable;
+
+import nucleus.factory.PresenterFactory;
+import nucleus.presenter.Presenter;
+
+public class NucleusConductorDelegate<P extends Presenter> {
+
+    @Nullable private P presenter;
+    @Nullable private Bundle bundle;
+    private boolean presenterHasView = false;
+
+    private PresenterFactory<P> factory;
+
+    public NucleusConductorDelegate(PresenterFactory<P> creator) {
+        this.factory = creator;
+    }
+
+    public P getPresenter() {
+        if (presenter == null) {
+            presenter = factory.createPresenter();
+            presenter.create(bundle);
+        }
+        bundle = null;
+        return presenter;
+    }
+
+    Bundle onSaveInstanceState() {
+        Bundle bundle = new Bundle();
+        getPresenter();
+        if (presenter != null) {
+            presenter.save(bundle);
+        }
+        return bundle;
+    }
+
+    void onRestoreInstanceState(Bundle presenterState) {
+        if (presenter != null)
+            throw new IllegalArgumentException("onRestoreInstanceState() should be called before onResume()");
+        bundle = presenterState;
+    }
+
+    void onTakeView(Object view) {
+        getPresenter();
+        if (presenter != null && !presenterHasView) {
+            //noinspection unchecked
+            presenter.takeView(view);
+            presenterHasView = true;
+        }
+    }
+
+    void onDropView() {
+        if (presenter != null && presenterHasView) {
+            presenter.dropView();
+            presenterHasView = false;
+        }
+    }
+
+    void onDestroy() {
+        if (presenter != null) {
+            presenter.destroy();
+            presenter = null;
+        }
+    }
+}
@@ -0,0 +1,44 @@
+package eu.kanade.tachiyomi.ui.base.presenter;
+
+import android.os.Bundle;
+import android.support.annotation.NonNull;
+import android.view.View;
+
+import com.bluelinelabs.conductor.Controller;
+
+public class NucleusConductorLifecycleListener extends Controller.LifecycleListener {
+
+    private static final String PRESENTER_STATE_KEY = "presenter_state";
+
+    private NucleusConductorDelegate delegate;
+
+    public NucleusConductorLifecycleListener(NucleusConductorDelegate delegate) {
+        this.delegate = delegate;
+    }
+
+    @Override
+    public void postCreateView(@NonNull Controller controller, @NonNull View view) {
+        delegate.onTakeView(controller);
+    }
+
+    @Override
+    public void preDestroyView(@NonNull Controller controller, @NonNull View view) {
+        delegate.onDropView();
+    }
+
+    @Override
+    public void preDestroy(@NonNull Controller controller) {
+        delegate.onDestroy();
+    }
+
+    @Override
+    public void onSaveInstanceState(@NonNull Controller controller, @NonNull Bundle outState) {
+        outState.putBundle(PRESENTER_STATE_KEY, delegate.onSaveInstanceState());
+    }
+
+    @Override
+    public void onRestoreInstanceState(@NonNull Controller controller, @NonNull Bundle savedInstanceState) {
+        delegate.onRestoreInstanceState(savedInstanceState.getBundle(PRESENTER_STATE_KEY));
+    }
+
+}