simplify deckpicker with unified menu

ankidroid · May 29, 2024 · aaf4a5e · aaf4a5e
1 parent 584dc43
commit aaf4a5e
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 30 deletions.
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt b/AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt
@@ -800,31 +800,40 @@ open class DeckPicker :
         Timber.d("onCreateOptionsMenu()")
         floatingActionMenu.closeFloatingActionMenu(applyRiseAndShrinkAnimation = false)
         menuInflater.inflate(R.menu.deck_picker, menu)
-        menu.findItem(R.id.action_export)?.title = TR.exportingExport()
-        setupMediaSyncMenuItem(menu)
         menu.findItem(R.id.deck_picker_action_filter)?.let {
             toolbarSearchItem = it
             setupSearchIcon(it)
             toolbarSearchView = it.actionView as SearchView
         }
         toolbarSearchView?.maxWidth = Integer.MAX_VALUE
-        // redraw menu synchronously to avoid flicker
-        updateMenuFromState(menu)
+
+        if (fragmented && studyoptionsFrame!!.visibility == View.VISIBLE) {
+            menu.setGroupVisible(R.id.allItems, false)
+        } else {
+            menu.findItem(R.id.action_export_collection)?.title = TR.exportingExport()
+            setupMediaSyncMenuItem(menu)
+            // redraw menu synchronously to avoid flicker
+            updateMenuFromState(menu)
+            updateSearchFromState(menu)
+        }
         // ...then launch a task to possibly update the visible icons.
         // Store the job so that tests can easily await it. In the future
         // this may be better done by injecting a custom test scheduler
         // into CollectionManager, and awaiting that.
         createMenuJob = launchCatchingTask {
             updateMenuState()
-            updateMenuFromState(menu)
+            updateSearchFromState(menu)
+            if (!fragmented) {
+                updateMenuFromState(menu)
+            }
         }
         return super.onCreateOptionsMenu(menu)
     }
 
     private var migrationProgressPublishingJob: Job? = null
     private var cachedMigrationProgressMenuItemActionView: View? = null
 
-    private fun setupMediaSyncMenuItem(menu: Menu) {
+    fun setupMediaSyncMenuItem(menu: Menu) {
         // shouldn't be necessary, but `invalidateOptionsMenu()` is called way more than necessary
         syncMediaProgressJob?.cancel()
 
@@ -918,6 +927,7 @@ open class DeckPicker :
                                 is MigrationService.Progress.Done -> {
                                     updateMenuState()
                                     updateMenuFromState(menu)
+                                    updateSearchFromState(menu)
                                 }
                             }
                         }
@@ -970,17 +980,21 @@ open class DeckPicker :
         searchDecksIcon = menuItem
     }
 
-    private fun updateMenuFromState(menu: Menu) {
-        menu.setGroupVisible(R.id.allItems, optionsMenuState != null)
+    fun updateMenuFromState(menu: Menu) {
         optionsMenuState?.run {
-            menu.findItem(R.id.deck_picker_action_filter).isVisible = searchIcon
             updateUndoLabelFromState(menu.findItem(R.id.action_undo), undoLabel)
             updateSyncIconFromState(menu.findItem(R.id.action_sync), this)
             menu.findItem(R.id.action_scoped_storage_migrate).isVisible = shouldShowStartMigrationButton
             setupMigrationProgressMenuItem(menu, mediaMigrationState)
         }
     }
 
+    private fun updateSearchFromState(menu: Menu) {
+        optionsMenuState?.run {
+            menu.findItem(R.id.deck_picker_action_filter).isVisible = searchIcon
+        }
+    }
+
     private fun updateUndoLabelFromState(menuItem: MenuItem, undoLabel: String?) {
         menuItem.run {
             if (undoLabel != null) {
@@ -1134,7 +1148,7 @@ open class DeckPicker :
                 showDatabaseErrorDialog(DatabaseErrorDialogType.DIALOG_CONFIRM_RESTORE_BACKUP)
                 return true
             }
-            R.id.action_export -> {
+            R.id.action_export_collection -> {
                 Timber.i("DeckPicker:: Export menu item selected")
                 if (mediaMigrationIsInProgress(this)) {
                     showSnackbar(R.string.functionality_disabled_during_storage_migration, Snackbar.LENGTH_SHORT)

diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/StudyOptionsFragment.kt b/AnkiDroid/src/main/java/com/ichi2/anki/StudyOptionsFragment.kt
@@ -81,6 +81,10 @@ class StudyOptionsFragment : Fragment(), ChangeManager.Subscriber, Toolbar.OnMen
     private lateinit var textTotal: TextView
     private var toolbar: Toolbar? = null
 
+    @VisibleForTesting
+    var createMenuJob: Job? = null
+    private lateinit var deckPicker: DeckPicker
+
     // Flag to indicate if the fragment should load the deck options immediately after it loads
     private var loadWithDeckOptions = false
     private var fragmented = false
@@ -138,13 +142,15 @@ class StudyOptionsFragment : Fragment(), ChangeManager.Subscriber, Toolbar.OnMen
 
     override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
         Timber.i("onCreateView()")
+        deckPicker = activity as DeckPicker
         val studyOptionsView = inflater.inflate(R.layout.studyoptions_fragment, container, false)
         this.studyOptionsView = studyOptionsView
         fragmented = requireActivity().javaClass != StudyOptionsActivity::class.java
         initAllContentViews(studyOptionsView)
         toolbar = studyOptionsView.findViewById(R.id.studyOptionsToolbar)
         if (toolbar != null) {
             toolbar!!.inflateMenu(R.menu.study_options_fragment)
+            toolbar!!.inflateMenu(R.menu.deck_picker)
             configureToolbar()
         }
         refreshInterface()
@@ -222,8 +228,11 @@ class StudyOptionsFragment : Fragment(), ChangeManager.Subscriber, Toolbar.OnMen
     }
 
     override fun onMenuItemClick(item: MenuItem): Boolean {
+        if (deckPicker.onOptionsItemSelected(item)) {
+            return true
+        }
         when (item.itemId) {
-            R.id.action_undo -> {
+            R.id.action_undo_study_options -> {
                 Timber.i("StudyOptionsFragment:: Undo button pressed")
                 launchCatchingTask {
                     requireActivity().undoAndShowSnackbar()
@@ -267,15 +276,15 @@ class StudyOptionsFragment : Fragment(), ChangeManager.Subscriber, Toolbar.OnMen
                 return true
             }
             R.id.action_rename -> {
-                (activity as DeckPicker).renameDeckDialog(col!!.decks.selected())
+                deckPicker.renameDeckDialog(col!!.decks.selected())
                 return true
             }
             R.id.action_delete -> {
-                (activity as DeckPicker).confirmDeckDeletion(col!!.decks.selected())
+                deckPicker.confirmDeckDeletion(col!!.decks.selected())
                 return true
             }
-            R.id.action_export -> {
-                (activity as DeckPicker).exportDeck(col!!.decks.selected())
+            R.id.action_export_deck -> {
+                deckPicker.exportDeck(col!!.decks.selected())
                 return true
             }
             else -> return false
@@ -335,9 +344,24 @@ class StudyOptionsFragment : Fragment(), ChangeManager.Subscriber, Toolbar.OnMen
             }
             // Switch on rename / delete / export if tablet layout
             if (fragmented) {
+                menu.setGroupVisible(R.id.allItems, true)
                 menu.findItem(R.id.action_rename).isVisible = true
                 menu.findItem(R.id.action_delete).isVisible = true
                 menu.findItem(R.id.action_export).isVisible = true
+
+                // Add export collection item in export menu and remove it from menu
+                val exportMenu = menu.findItem(R.id.action_export).subMenu
+                if (exportMenu?.findItem(R.id.action_export_collection) == null) {
+                    exportMenu?.add(0, R.id.action_export_collection, 0, R.string.export_collection)
+                }
+                menu.removeItem(R.id.action_export_collection)
+
+                deckPicker.setupMediaSyncMenuItem(menu)
+                deckPicker.updateMenuFromState(menu)
+                createMenuJob = launchCatchingTask {
+                    deckPicker.updateMenuState()
+                    deckPicker.updateMenuFromState(menu)
+                }
             } else {
                 menu.findItem(R.id.action_rename).isVisible = false
                 menu.findItem(R.id.action_delete).isVisible = false
@@ -347,15 +371,15 @@ class StudyOptionsFragment : Fragment(), ChangeManager.Subscriber, Toolbar.OnMen
             menu.findItem(R.id.action_unbury).isVisible = col != null && col!!.sched.haveBuried()
             // Set the proper click target for the undo button's ActionProvider
             val undoActionProvider: RtlCompliantActionProvider? = MenuItemCompat.getActionProvider(
-                menu.findItem(R.id.action_undo)
+                menu.findItem(R.id.action_undo_study_options)
             ) as? RtlCompliantActionProvider
             undoActionProvider?.clickHandler = { _, menuItem -> onMenuItemClick(menuItem) }
             // Switch on or off undo depending on whether undo is available
             if (col == null || !col!!.undoAvailable()) {
-                menu.findItem(R.id.action_undo).isVisible = false
+                menu.findItem(R.id.action_undo_study_options).isVisible = false
             } else {
-                menu.findItem(R.id.action_undo).isVisible = true
-                menu.findItem(R.id.action_undo).title = col?.undoLabel()
+                menu.findItem(R.id.action_undo_study_options).isVisible = true
+                menu.findItem(R.id.action_undo_study_options).title = col?.undoLabel()
             }
             // Set the back button listener
             if (!fragmented) {

diff --git a/AnkiDroid/src/main/res/menu/deck_picker.xml b/AnkiDroid/src/main/res/menu/deck_picker.xml
@@ -1,14 +1,15 @@
 <menu xmlns:tools="http://schemas.android.com/tools"
     xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:ankidroid="http://schemas.android.com/apk/res-auto"
-    tools:context=".DeckPicker">
+    >
+    <item
+        android:id="@+id/deck_picker_action_filter"
+        android:icon="@drawable/ic_search_white"
+        android:title="@string/search_decks"
+        android:visible="false"
+        ankidroid:actionViewClass="androidx.appcompat.widget.SearchView"
+        ankidroid:showAsAction="always|collapseActionView"/>
     <group android:id="@+id/allItems">
-        <item
-            android:id="@+id/deck_picker_action_filter"
-            android:icon="@drawable/ic_search_white"
-            android:title="@string/search_decks"
-            ankidroid:actionViewClass="androidx.appcompat.widget.SearchView"
-            ankidroid:showAsAction="always|collapseActionView"/>
         <item
             android:id="@+id/action_migration_progress"
             android:visible="false"
@@ -67,7 +68,7 @@
             android:menuCategory="secondary"
             android:title="@string/menu_import"/>
         <item
-            android:id="@+id/action_export"
+            android:id="@+id/action_export_collection"
             android:menuCategory="secondary" />
     </group>
 </menu>
diff --git a/AnkiDroid/src/main/res/menu/study_options_fragment.xml b/AnkiDroid/src/main/res/menu/study_options_fragment.xml
@@ -1,7 +1,7 @@
 <menu xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:ankidroid="http://schemas.android.com/apk/res-auto" >
     <item
-        android:id="@+id/action_undo"
+        android:id="@+id/action_undo_study_options"
         android:enabled="true"
         android:icon="@drawable/ic_undo_white"
         android:title="@string/undo"
@@ -40,8 +40,15 @@
         android:visibility = "gone"/>
     <item
         android:id="@+id/action_export"
-        android:title="@string/export_deck"
-        android:visibility = "gone"/>
+        android:title="@string/export"
+        android:visibility="gone">
+        <menu>
+            <item
+                android:id="@+id/action_export_deck"
+                android:menuCategory="secondary"
+                android:title="@string/export_deck" />
+        </menu>
+    </item>
     <item
         android:id="@+id/action_unbury"
         android:title="@string/unbury"

diff --git a/AnkiDroid/src/main/res/values/01-core.xml b/AnkiDroid/src/main/res/values/01-core.xml
@@ -129,7 +129,9 @@
     <string name="sync_cancelled" tools:ignore="UnusedResources">Sync cancelled</string>
     <string name="sync_cancel_message" tools:ignore="UnusedResources">Cancelling…\nThis may take some time.</string>
     <string name="syncing_media">Syncing media</string>
+    <string name="export">Export</string>
     <string name="export_deck">Export deck</string>
+    <string name="export_collection">Export collection</string>
     <string name="nothing">Nothing</string>
 
     <!-- Card template editor -->