Reimplement the EPUB selection menu with selectionActionModeCallback (#455)

Author: mickael-menu

test-app/r2-testapp/src/main/java/org/readium/r2/testapp/reader/BaseReaderFragment.kt

@@ -23,7 +23,9 @@ import kotlinx.coroutines.flow.onEach
 import kotlinx.parcelize.Parcelize
 import org.readium.r2.lcp.lcpLicense
 import org.readium.r2.navigator.*
+import org.readium.r2.navigator.util.BaseActionModeCallback
 import org.readium.r2.shared.publication.Locator
+import org.readium.r2.shared.publication.services.isProtected
 import org.readium.r2.testapp.R
 import org.readium.r2.testapp.databinding.FragmentReaderBinding
 import org.readium.r2.testapp.domain.model.Highlight
@@ -173,35 +175,37 @@ abstract class BaseReaderFragment : Fragment() {
         R.id.purple to Color.rgb(182, 153, 255),
     )
 
-    fun onActionModeStarted(mode: ActionMode?, menuInflater: MenuInflater) {
-        val viewScope = viewLifecycleOwner.lifecycleScope
-        val navigator = (navigator as? SelectableNavigator) ?: return
-
-        this.mode = mode?.apply {
-            // Remove the default text selection menu items and set our own menu.
-            menu.clear()
-            menuInflater.inflate(R.menu.menu_action_mode, menu)
-
-            fun showHighlightPopupWithStyle(style: Highlight.Style) = viewScope.launchWhenResumed {
-                // Get the rect of the current selection to know where to position the highlight
-                // popup.
-                navigator.currentSelection()?.rect?.let { selectionRect ->
-                    showHighlightPopup(selectionRect, style)
-                }
-            }
+    val customSelectionActionModeCallback: ActionMode.Callback by lazy { SelectionActionModeCallback() }
 
-            menu.findItem(R.id.highlight).setOnMenuItemClickListener {
-                showHighlightPopupWithStyle(Highlight.Style.HIGHLIGHT)
-                true
+    private inner class SelectionActionModeCallback : BaseActionModeCallback() {
+        override fun onCreateActionMode(mode: ActionMode, menu: Menu): Boolean {
+            mode.menuInflater.inflate(R.menu.menu_action_mode, menu)
+            if (navigator is DecorableNavigator) {
+                menu.findItem(R.id.highlight).isVisible = true
+                menu.findItem(R.id.underline).isVisible = true
+                menu.findItem(R.id.note).isVisible = true
             }
-            menu.findItem(R.id.underline).setOnMenuItemClickListener {
-                showHighlightPopupWithStyle(Highlight.Style.UNDERLINE)
-                true
-            }
-            menu.findItem(R.id.note).setOnMenuItemClickListener {
-                showAnnotationPopup()
-                true
+            return true
+        }
+
+        override fun onActionItemClicked(mode: ActionMode, item: MenuItem): Boolean {
+            when (item.itemId) {
+                R.id.highlight -> showHighlightPopupWithStyle(Highlight.Style.HIGHLIGHT)
+                R.id.underline -> showHighlightPopupWithStyle(Highlight.Style.UNDERLINE)
+                R.id.note -> showAnnotationPopup()
+                else -> return false
             }
+
+            mode.finish()
+            return true
+        }
+    }
+
+    private fun showHighlightPopupWithStyle(style: Highlight.Style) = viewLifecycleOwner.lifecycleScope.launchWhenResumed {
+        // Get the rect of the current selection to know where to position the highlight
+        // popup.
+        (navigator as? SelectableNavigator)?.currentSelection()?.rect?.let { selectionRect ->
+            showHighlightPopup(selectionRect, style)
         }
     }
 
@@ -319,7 +323,9 @@ abstract class BaseReaderFragment : Fragment() {
             } else {
                 val tint = highlightTints.values.random()
                 findViewById<View>(R.id.sidemark).setBackgroundColor(tint)
-                val selection = (navigator as? SelectableNavigator)?.currentSelection() ?: return@launchWhenResumed
+                val navigator = navigator as? SelectableNavigator ?: return@launchWhenResumed
+                val selection = navigator.currentSelection() ?: return@launchWhenResumed
+                navigator.clearSelection()
                 findViewById<TextView>(R.id.select_text).text = selection.locator.text.highlight
 
                 findViewById<TextView>(R.id.positive).setOnClickListener {

test-app/r2-testapp/src/main/java/org/readium/r2/testapp/reader/EpubReaderFragment.kt

@@ -91,6 +91,7 @@ class EpubReaderFragment : VisualReaderFragment(), EpubNavigatorFragment.Listene
                 config = EpubNavigatorFragment.Configuration().apply {
                     // Register the HTML template for our custom [DecorationStyleAnnotationMark].
                     decorationTemplates[DecorationStyleAnnotationMark::class] = annotationMarkTemplate(activity)
+                    selectionActionModeCallback = customSelectionActionModeCallback
                 }
             )
 

test-app/r2-testapp/src/main/java/org/readium/r2/testapp/reader/ReaderActivity.kt

@@ -121,11 +121,6 @@ open class ReaderActivity : AppCompatActivity() {
         }
     }
 
-    override fun onActionModeStarted(mode: ActionMode?) {
-        super.onActionModeStarted(mode)
-        readerFragment.onActionModeStarted(mode, menuInflater)
-    }
-
     override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory {
         return modelFactory
     }

test-app/r2-testapp/src/main/res/menu/menu_action_mode.xml

@@ -5,18 +5,21 @@
     <item
         android:id="@+id/highlight"
         android:title="@string/action_mode_menu_highlight"
+        android:visible="false"
         app:showAsAction="ifRoom">
     </item>
 
     <item
         android:id="@+id/underline"
         android:title="@string/action_mode_menu_underline"
+        android:visible="false"
         app:showAsAction="ifRoom">
     </item>
 
     <item
         android:id="@+id/note"
         android:title="@string/action_mode_menu_note"
+        android:visible="false"
         app:showAsAction="ifRoom">
     </item>