chore: convert SharedDecksDownloadFragment to ViewBinding

Issue 11116

Author: david-allison

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

@@ -27,11 +27,10 @@ import android.database.Cursor
 import android.os.Bundle
 import android.os.Handler
 import android.os.Looper
+import android.view.LayoutInflater
 import android.view.View
+import android.view.ViewGroup
 import android.webkit.CookieManager
-import android.widget.Button
-import android.widget.ProgressBar
-import android.widget.TextView
 import androidx.activity.OnBackPressedCallback
 import androidx.annotation.VisibleForTesting
 import androidx.appcompat.app.AlertDialog
@@ -40,6 +39,7 @@ import androidx.core.content.FileProvider
 import androidx.core.net.toUri
 import androidx.fragment.app.Fragment
 import com.ichi2.anki.SharedDecksActivity.Companion.DOWNLOAD_FILE
+import com.ichi2.anki.databinding.FragmentSharedDecksDownloadBinding
 import com.ichi2.anki.snackbar.showSnackbar
 import com.ichi2.anki.utils.openUrl
 import com.ichi2.compat.CompatHelper.Companion.getSerializableCompat
@@ -58,22 +58,18 @@ import kotlin.math.abs
  * Only one download is supported at a time, since importing multiple decks
  * simultaneously is not supported.
  */
-class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_download) {
+class SharedDecksDownloadFragment : Fragment() {
+    // binding pattern to handle onCreateView/onDestroyView
+    private var fragmentBinding: FragmentSharedDecksDownloadBinding? = null
+    private val binding get() = fragmentBinding!!
+
     private var downloadId: Long = 0
 
     private var fileName: String? = null
 
     private var handler: Handler = Handler(Looper.getMainLooper())
     private var isProgressCheckerRunning = false
 
-    private lateinit var cancelButton: Button
-    private lateinit var tryAgainButton: Button
-    private lateinit var importDeckButton: Button
-    private lateinit var downloadPercentageText: TextView
-    private lateinit var downloadProgressBar: ProgressBar
-    private lateinit var checkNetworkInfoText: TextView
-    private lateinit var openInBrowserButton: Button
-
     /**
      * Android's DownloadManager - Used here to manage the functionality of downloading decks, one
      * at a time. Responsible for enqueuing a download and generating the corresponding download ID,
@@ -142,52 +138,59 @@ class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_down
         }
     }
 
+    override fun onCreateView(
+        inflater: LayoutInflater,
+        container: ViewGroup?,
+        savedInstanceState: Bundle?,
+    ) = FragmentSharedDecksDownloadBinding
+        .inflate(inflater, container, false)
+        .apply {
+            fragmentBinding = this
+        }.root
+
     override fun onViewCreated(
         view: View,
         savedInstanceState: Bundle?,
     ) {
         super.onViewCreated(view, savedInstanceState)
 
-        downloadPercentageText = view.findViewById(R.id.download_percentage)
-        downloadProgressBar = view.findViewById(R.id.download_progress)
-        cancelButton = view.findViewById(R.id.cancel_shared_decks_download)
-        importDeckButton = view.findViewById(R.id.import_shared_deck_button)
-        tryAgainButton = view.findViewById(R.id.try_again_deck_download)
-        checkNetworkInfoText = view.findViewById(R.id.check_network_info_text)
-        openInBrowserButton = view.findViewById(R.id.download_shared_deck_from_browser)
-
         val fileToBeDownloaded = arguments?.getSerializableCompat<DownloadFile>(DOWNLOAD_FILE)!!
         downloadManager = (activity as SharedDecksActivity).downloadManager
 
         downloadFile(fileToBeDownloaded)
 
-        cancelButton.setOnClickListener {
+        binding.cancelDownloadButton.setOnClickListener {
             Timber.i("Cancel download button clicked which would lead to showing of confirmation dialog")
             showCancelConfirmationDialog()
         }
 
-        importDeckButton.setOnClickListener {
+        binding.importSharedDeckButton.setOnClickListener {
             Timber.i("Import deck button clicked")
             openDownloadedDeck(context)
         }
 
-        openInBrowserButton.setOnClickListener {
+        binding.openInWebBrowserButton.setOnClickListener {
             Timber.i("'Open in Browser' clicked")
             downloadManager.remove(downloadId)
             openUrl(requireContext().getDeckPageUri(fileToBeDownloaded.url).toUri())
             parentFragmentManager.popBackStack()
         }
 
-        tryAgainButton.setOnClickListener {
+        binding.tryDownloadAgainButton.setOnClickListener {
             Timber.i("Try again button clicked, retry downloading of deck")
             downloadManager.remove(downloadId)
             downloadFile(fileToBeDownloaded)
-            cancelButton.visibility = View.VISIBLE
-            tryAgainButton.visibility = View.GONE
-            openInBrowserButton.visibility = View.GONE
+            binding.cancelDownloadButton.visibility = View.VISIBLE
+            binding.tryDownloadAgainButton.visibility = View.GONE
+            binding.openInWebBrowserButton.visibility = View.GONE
         }
     }
 
+    override fun onDestroyView() {
+        super.onDestroyView()
+        fragmentBinding = null
+    }
+
     /**
      * Register broadcast receiver for listening to download completion.
      * Set the request for downloading a deck, enqueue it in DownloadManager, store download ID and
@@ -225,7 +228,7 @@ class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_down
         onBackPressedCallback.isEnabled = isDownloadInProgress
         Timber.d("Download ID -> $downloadId")
         Timber.d("File name -> $fileName")
-        view?.findViewById<TextView>(R.id.downloading_title)?.text = getString(R.string.downloading_file, fileName)
+        fragmentBinding?.downloadingTitle?.text = getString(R.string.downloading_file, fileName)
         startDownloadProgressChecker()
     }
 
@@ -337,12 +340,12 @@ class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_down
 
                 if (isVisible) {
                     // Setting these since progress checker can stop before progress is updated to represent 100%
-                    downloadPercentageText.text = getString(R.string.percentage, DOWNLOAD_COMPLETED_PROGRESS_PERCENTAGE)
-                    downloadProgressBar.progress = DOWNLOAD_COMPLETED_PROGRESS_PERCENTAGE.toInt()
+                    binding.downloadPercentageText.text = getString(R.string.percentage, DOWNLOAD_COMPLETED_PROGRESS_PERCENTAGE)
+                    binding.downloadProgressBar.progress = DOWNLOAD_COMPLETED_PROGRESS_PERCENTAGE.toInt()
 
                     // Remove cancel button and show import deck button
-                    cancelButton.visibility = View.GONE
-                    importDeckButton.visibility = View.VISIBLE
+                    binding.cancelDownloadButton.visibility = View.GONE
+                    binding.importSharedDeckButton.visibility = View.VISIBLE
                 }
 
                 Timber.i("Opening downloaded deck for import")
@@ -410,8 +413,8 @@ class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_down
         Timber.d("Starting download progress checker")
         downloadProgressChecker.run()
         isProgressCheckerRunning = true
-        downloadPercentageText.text = getString(R.string.percentage, DOWNLOAD_STARTED_PROGRESS_PERCENTAGE)
-        downloadProgressBar.progress = DOWNLOAD_STARTED_PROGRESS_PERCENTAGE.toInt()
+        binding.downloadPercentageText.text = getString(R.string.percentage, DOWNLOAD_STARTED_PROGRESS_PERCENTAGE)
+        binding.downloadProgressBar.progress = DOWNLOAD_STARTED_PROGRESS_PERCENTAGE.toInt()
     }
 
     /**
@@ -452,8 +455,8 @@ class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_down
                     // Show download progress percentage up to 1 decimal place.
                     "%.1f".format(downloadProgress)
                 }
-            downloadPercentageText.text = getString(R.string.percentage, percentageValue)
-            downloadProgressBar.progress = downloadProgress.toInt()
+            binding.downloadPercentageText.text = getString(R.string.percentage, percentageValue)
+            binding.downloadProgressBar.progress = downloadProgress.toInt()
 
             val columnIndexForStatus = it.getColumnIndex(DownloadManager.COLUMN_STATUS)
             val columnIndexForReason = it.getColumnIndex(DownloadManager.COLUMN_REASON)
@@ -472,9 +475,9 @@ class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_down
             if (it.getInt(columnIndexForStatus) == DownloadManager.STATUS_PAUSED &&
                 it.getInt(columnIndexForReason) == DownloadManager.PAUSED_WAITING_FOR_NETWORK
             ) {
-                checkNetworkInfoText.visibility = View.VISIBLE
+                binding.checkNetworkInfoText.visibility = View.VISIBLE
             } else {
-                checkNetworkInfoText.visibility = View.GONE
+                binding.checkNetworkInfoText.visibility = View.GONE
             }
         }
     }
@@ -528,11 +531,11 @@ class SharedDecksDownloadFragment : Fragment(R.layout.fragment_shared_decks_down
                 Timber.i("Download failed, update UI and provide option to retry")
                 context?.let { showThemedToast(it, R.string.something_wrong, false) }
                 // Update UI if download could not be successful
-                tryAgainButton.visibility = View.VISIBLE
-                openInBrowserButton.visibility = View.VISIBLE
-                cancelButton.visibility = View.GONE
-                downloadPercentageText.text = getString(R.string.download_failed)
-                downloadProgressBar.progress = DOWNLOAD_STARTED_PROGRESS_PERCENTAGE.toInt()
+                binding.tryDownloadAgainButton.visibility = View.VISIBLE
+                binding.openInWebBrowserButton.visibility = View.VISIBLE
+                binding.cancelDownloadButton.visibility = View.GONE
+                binding.downloadPercentageText.text = getString(R.string.download_failed)
+                binding.downloadProgressBar.progress = DOWNLOAD_STARTED_PROGRESS_PERCENTAGE.toInt()
             }
         }
 

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

@@ -37,7 +37,7 @@
         app:layout_constraintTop_toBottomOf="@id/downloading_title" />
 
     <com.ichi2.ui.FixedTextView
-        android:id="@+id/download_percentage"
+        android:id="@+id/download_percentage_text"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:textSize="20sp"
@@ -48,7 +48,7 @@
         tools:text="100 %" />
 
     <ProgressBar
-        android:id="@+id/download_progress"
+        android:id="@+id/download_progress_bar"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         android:layout_marginTop="16dp"
@@ -57,7 +57,7 @@
         android:scaleY="4"
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintEnd_toEndOf="parent"
-        app:layout_constraintTop_toBottomOf="@id/download_percentage"
+        app:layout_constraintTop_toBottomOf="@id/download_percentage_text"
         style="@style/Widget.AppCompat.ProgressBar.Horizontal" />
 
     <com.ichi2.ui.FixedTextView
@@ -73,11 +73,11 @@
         android:gravity="center"
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintEnd_toEndOf="parent"
-        app:layout_constraintTop_toBottomOf="@id/download_progress"
+        app:layout_constraintTop_toBottomOf="@id/download_progress_bar"
         android:visibility="gone" />
 
     <android.widget.Button
-        android:id="@+id/download_shared_deck_from_browser"
+        android:id="@+id/open_in_web_browser_button"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         android:text="@string/open_in_browser"
@@ -89,11 +89,11 @@
         android:layout_marginEnd="24dp"
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintEnd_toEndOf="parent"
-        app:layout_constraintBottom_toTopOf="@id/try_again_deck_download"
+        app:layout_constraintBottom_toTopOf="@id/try_download_again_button"
         android:visibility="gone" />
 
     <android.widget.Button
-        android:id="@+id/cancel_shared_decks_download"
+        android:id="@+id/cancel_download_button"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         android:text="@string/cancel_download"
@@ -108,7 +108,7 @@
         app:layout_constraintEnd_toEndOf="parent" />
 
     <android.widget.Button
-        android:id="@+id/try_again_deck_download"
+        android:id="@+id/try_download_again_button"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         android:text="@string/try_again"