feat(reminders): launch ScheduleRemindersFragment from DeckPicker and StudyOptionsFragment

Adds logic for opening ScheduleRemindersFragment in the correct fragment container hosts in DeckPicker and StudyOptionsFragment. Mirrors `openStudyOptions` and `tryShowStudyOptionsPanel` by adding `openScheduleReminders` and `tryShowScheduleRemindersPanel`. Reloads the StudyOptionsFragment and removes ScheduleRemindersFragment if an appbar menu button is clicked while the fragment is open on large screens to prevent stale state from showing.

Author: ericli3690

AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt

@@ -64,6 +64,7 @@ import androidx.core.view.doOnLayout
 import androidx.core.view.isVisible
 import androidx.draganddrop.DropHelper
 import androidx.fragment.app.FragmentContainerView
+import androidx.fragment.app.FragmentManager
 import androidx.fragment.app.commit
 import androidx.lifecycle.flowWithLifecycle
 import androidx.lifecycle.lifecycleScope
@@ -72,7 +73,6 @@ import androidx.swiperefreshlayout.widget.SwipeRefreshLayout
 import androidx.work.WorkInfo
 import androidx.work.WorkManager
 import anki.collection.OpChanges
-import anki.decks.deckId
 import anki.sync.SyncStatusResponse
 import com.google.android.material.progressindicator.LinearProgressIndicator
 import com.google.android.material.snackbar.BaseTransientBottomBar
@@ -155,7 +155,9 @@ import com.ichi2.anki.preferences.AdvancedSettingsFragment
 import com.ichi2.anki.preferences.PreferencesActivity
 import com.ichi2.anki.preferences.sharedPrefs
 import com.ichi2.anki.receiver.SdCardReceiver
+import com.ichi2.anki.reviewreminders.ReviewReminderScope
 import com.ichi2.anki.reviewreminders.ReviewRemindersDatabase
+import com.ichi2.anki.reviewreminders.ScheduleRemindersFragment
 import com.ichi2.anki.servicelayer.ScopedStorageService
 import com.ichi2.anki.settings.Prefs
 import com.ichi2.anki.snackbar.BaseSnackbarBuilderProvider
@@ -582,6 +584,12 @@ open class DeckPicker :
             openReviewer()
         }
 
+        setFragmentResultListener(StudyOptionsFragment.REQUEST_STUDY_OPTIONS_REVIEW_REMINDERS) { _, bundle ->
+            Timber.d("Opening review reminders screen from DeckPicker's study options panel")
+            val did = bundle.getLong(StudyOptionsFragment.KEY_REVIEW_REMINDERS_DECK_ID)
+            openScheduleReminders(did)
+        }
+
         pullToSyncWrapper.configureView(
             this,
             IMPORT_MIME_TYPES,
@@ -715,6 +723,7 @@ open class DeckPicker :
                 data = deckList.data,
                 hasSubDecks = deckList.hasSubDecks,
             )
+            tryShowStudyOptionsPanel()
         }
 
         fun onFocusedDeckChanged(deckId: DeckId?) {
@@ -898,8 +907,8 @@ open class DeckPicker :
             }
             DeckPickerContextMenuOption.SCHEDULE_REMINDERS -> {
                 Timber.i("Scheduling review reminders for deck '%d'", deckId)
-                viewModel.scheduleReviewReminders(deckId)
                 dismissAllDialogFragments()
+                openScheduleReminders(deckId)
             }
         }
     }
@@ -1866,12 +1875,28 @@ open class DeckPicker :
      */
     private fun tryShowStudyOptionsPanel(): Boolean {
         val containerId = binding.studyoptionsFragment?.id ?: return false
+        supportFragmentManager.popBackStack(null, FragmentManager.POP_BACK_STACK_INCLUSIVE)
         supportFragmentManager.commit {
             replace(containerId, StudyOptionsFragment())
         }
         return true
     }
 
+    private fun tryShowScheduleRemindersPanel(deckId: DeckId): Boolean {
+        val sidePanel = binding.studyoptionsFragment ?: return false
+        if (!sidePanel.isVisible) return false
+        val newFragment =
+            ScheduleRemindersFragment.newInstance(
+                scope = ReviewReminderScope.DeckSpecific(deckId),
+                host = ScheduleRemindersFragment.FragmentHost.STUDY_OPTIONS_FRAGMENT,
+            )
+        supportFragmentManager.commit {
+            replace(sidePanel.id, newFragment)
+            addToBackStack(null)
+        }
+        return true
+    }
+
     val fragment: StudyOptionsFragment?
         get() = supportFragmentManager.findFragmentById(R.id.studyoptions_fragment) as? StudyOptionsFragment
 
@@ -1905,6 +1930,14 @@ open class DeckPicker :
         reviewLauncher.launch(intent)
     }
 
+    private fun openScheduleReminders(deckId: DeckId) {
+        if (tryShowScheduleRemindersPanel(deckId)) return
+
+        // otherwise, we need to launch the activity
+        Timber.i("Opening Schedule Reminders")
+        viewModel.scheduleReviewReminders(deckId)
+    }
+
     private fun openReviewerOrStudyOptions(selectionType: DeckSelectionType) {
         when (selectionType) {
             DeckSelectionType.DEFAULT -> {

AnkiDroid/src/main/java/com/ichi2/anki/StudyOptionsActivity.kt

@@ -20,6 +20,7 @@ import android.os.Bundle
 import android.view.Menu
 import android.view.MenuItem
 import androidx.core.view.MenuItemCompat
+import androidx.fragment.app.Fragment
 import androidx.fragment.app.commit
 import androidx.lifecycle.lifecycleScope
 import anki.collection.OpChanges
@@ -29,6 +30,8 @@ import com.ichi2.anki.dialogs.customstudy.CustomStudyDialog.CustomStudyAction.Co
 import com.ichi2.anki.libanki.undoAvailable
 import com.ichi2.anki.libanki.undoLabel
 import com.ichi2.anki.observability.ChangeManager
+import com.ichi2.anki.reviewreminders.ReviewReminderScope
+import com.ichi2.anki.reviewreminders.ScheduleRemindersFragment
 import com.ichi2.anki.utils.ext.setFragmentResultListener
 import com.ichi2.ui.RtlCompliantActionProvider
 import kotlinx.coroutines.launch
@@ -58,7 +61,7 @@ class StudyOptionsActivity :
                 CustomStudyAction.CUSTOM_STUDY_SESSION,
                 CustomStudyAction.EXTEND_STUDY_LIMITS,
                 ->
-                    currentFragment!!.refreshInterface()
+                    (currentFragment as? StudyOptionsFragment)?.refreshInterface()
             }
         }
         setFragmentResultListener(StudyOptionsFragment.REQUEST_STUDY_OPTIONS_STUDY) { _, _ ->
@@ -69,6 +72,21 @@ class StudyOptionsActivity :
             startActivity(reviewer)
             finish()
         }
+        setFragmentResultListener(StudyOptionsFragment.REQUEST_STUDY_OPTIONS_REVIEW_REMINDERS) { _, bundle ->
+            Timber.d("Opening review reminders screen from study options screen")
+            val did = bundle.getLong(StudyOptionsFragment.KEY_REVIEW_REMINDERS_DECK_ID)
+            supportFragmentManager.commit {
+                replace(
+                    R.id.studyoptions_frame,
+                    ScheduleRemindersFragment.newInstance(
+                        scope = ReviewReminderScope.DeckSpecific(did),
+                        host = ScheduleRemindersFragment.FragmentHost.STUDY_OPTIONS_FRAME,
+                    ),
+                )
+                addToBackStack(null)
+            }
+            invalidateOptionsMenu()
+        }
     }
 
     private fun loadStudyOptionsFragment() {
@@ -78,16 +96,16 @@ class StudyOptionsActivity :
         }
     }
 
-    private val currentFragment: StudyOptionsFragment?
-        get() = supportFragmentManager.findFragmentById(R.id.studyoptions_frame) as StudyOptionsFragment?
+    private val currentFragment: Fragment?
+        get() = supportFragmentManager.findFragmentById(R.id.studyoptions_frame)
 
     override fun onCreateOptionsMenu(menu: Menu): Boolean {
         menuInflater.inflate(R.menu.activity_study_options, menu)
         val undoMenuItem = menu.findItem(R.id.action_undo)
         val undoActionProvider = MenuItemCompat.getActionProvider(undoMenuItem) as? RtlCompliantActionProvider
         // Set the proper click target for the undo button's ActionProvider
         undoActionProvider?.clickHandler = { _, menuItem -> onOptionsItemSelected(menuItem) }
-        undoMenuItem.isVisible = undoState.hasAction
+        undoMenuItem.isVisible = undoState.hasAction && (currentFragment is StudyOptionsFragment)
         undoMenuItem.title = undoState.label
         return true
     }
@@ -124,7 +142,7 @@ class StudyOptionsActivity :
         handler: Any?,
     ) {
         refreshUndoState()
-        currentFragment?.refreshInterface()
+        (currentFragment as? StudyOptionsFragment)?.refreshInterface()
     }
 
     private fun refreshUndoState() {

AnkiDroid/src/main/java/com/ichi2/anki/StudyOptionsFragment.kt

@@ -49,8 +49,6 @@ import com.ichi2.anki.libanki.Collection
 import com.ichi2.anki.libanki.Decks
 import com.ichi2.anki.observability.ChangeManager
 import com.ichi2.anki.observability.undoableOp
-import com.ichi2.anki.reviewreminders.ReviewReminderScope
-import com.ichi2.anki.reviewreminders.ScheduleRemindersFragment
 import com.ichi2.anki.settings.Prefs
 import com.ichi2.anki.ui.internationalization.sentenceCase
 import com.ichi2.anki.utils.ext.showDialogFragment
@@ -220,12 +218,12 @@ class StudyOptionsFragment :
             }
             R.id.action_schedule_reminders -> {
                 Timber.i("StudyOptionsFragment:: schedule reminders button pressed")
-                val intent =
-                    ScheduleRemindersFragment.getIntent(
-                        requireContext(),
-                        ReviewReminderScope.DeckSpecific(col!!.decks.current().id),
-                    )
-                startActivity(intent)
+                parentFragmentManager.setFragmentResult(
+                    REQUEST_STUDY_OPTIONS_REVIEW_REMINDERS,
+                    bundleOf(
+                        KEY_REVIEW_REMINDERS_DECK_ID to col!!.decks.current().id,
+                    ),
+                )
                 return true
             }
             R.id.action_unbury -> {
@@ -545,6 +543,17 @@ class StudyOptionsFragment :
          */
         const val REQUEST_STUDY_OPTIONS_STUDY = "request_study_option_study"
 
+        /**
+         * Identifier for a fragment result request to open the review reminders screen for the selected deck.
+         * Activities using this fragment need to handle this request and open the review reminders screen as they see fit.
+         */
+        const val REQUEST_STUDY_OPTIONS_REVIEW_REMINDERS = "request_study_option_review_reminders"
+
+        /**
+         * Bundle key for the deck ID whose study options are being displayed, used when the review reminders screen is being opened.
+         */
+        const val KEY_REVIEW_REMINDERS_DECK_ID = "review_reminders_deck_id"
+
         /**
          * Constants for selecting which content view to display
          */

AnkiDroid/src/main/res/layout/activity_study_options.xml

@@ -2,6 +2,7 @@
 <androidx.coordinatorlayout.widget.CoordinatorLayout android:id="@+id/root_layout"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
+    android:fitsSystemWindows="true"
     xmlns:android="http://schemas.android.com/apk/res/android">
             <LinearLayout
                 android:layout_width="match_parent"