From 48bd3c07b87a44fd2b8d49190dc6d3c8e18e9833 Mon Sep 17 00:00:00 2001
From: Evangelos Talos <115378448+vtalos@users.noreply.github.com>
Date: Mon, 10 Jun 2024 07:06:06 -0400
Subject: [PATCH] Add ProgressBar to MediaDetailPagerFragment for Image Loading
 Indicator (#5736)

* Add progress bar to fragment_media_detail_pager.xml

* Add progress bar to MediaDetailPagerFragment.java

* Add javadoc & comments

* Fix tests

---------

Co-authored-by: Giannis Karyotakis <110292528+karyotakisg@users.noreply.github.com>
---
 .../media/MediaDetailPagerFragment.java       | 41 +++++++++++++------
 .../layout/fragment_media_detail_pager.xml    | 28 ++++++++-----
 2 files changed, 46 insertions(+), 23 deletions(-)

diff --git a/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java b/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java
index 451423e9e..f6ef824e7 100644
--- a/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java
+++ b/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java
@@ -2,6 +2,9 @@ package fr.free.nrw.commons.media;
 
 import static fr.free.nrw.commons.Utils.handleWebUrl;
 
+import android.os.Handler;
+import android.os.Looper;
+import android.widget.ProgressBar;
 import android.content.ActivityNotFoundException;
 import android.content.Intent;
 import android.graphics.Bitmap;
@@ -76,6 +79,11 @@ public class MediaDetailPagerFragment extends CommonsDaggerSupportFragment imple
     private boolean isFromFeaturedRootFragment;
     private int position;
 
+    /**
+     * ProgressBar used to indicate the loading status of media items.
+     */
+    private ProgressBar imageProgressBar;
+
     private ArrayList<Integer> removedItems=new ArrayList<Integer>();
 
     public void clearRemoved(){
@@ -89,7 +97,7 @@ public class MediaDetailPagerFragment extends CommonsDaggerSupportFragment imple
     /**
      * Use this factory method to create a new instance of this fragment using the provided
      * parameters.
-     * 
+     *
      * This method will create a new instance of MediaDetailPagerFragment and the arguments will be
      * saved to a bundle which will be later available in the {@link #onCreate(Bundle)}
      * @param editable
@@ -108,7 +116,7 @@ public class MediaDetailPagerFragment extends CommonsDaggerSupportFragment imple
     public MediaDetailPagerFragment() {
         // Required empty public constructor
     };
-   
+
 
     @Override
     public View onCreateView(LayoutInflater inflater,
@@ -116,7 +124,8 @@ public class MediaDetailPagerFragment extends CommonsDaggerSupportFragment imple
                              Bundle savedInstanceState) {
         binding = FragmentMediaDetailPagerBinding.inflate(inflater, container, false);
         binding.mediaDetailsPager.addOnPageChangeListener(this);
-
+        // Initialize the ProgressBar by finding it in the layout
+        imageProgressBar = binding.getRoot().findViewById(R.id.itemProgressBar);
         adapter = new MediaDetailAdapter(getChildFragmentManager());
 
         // ActionBar is now supported in both activities - if this crashes something is quite wrong
@@ -397,7 +406,7 @@ public class MediaDetailPagerFragment extends CommonsDaggerSupportFragment imple
                     } catch (Exception e) {
                         Timber.e("Cant detect media transparency");
                     }
-                    
+
                     // Initialize bookmark object
                     bookmark = new Bookmark(
                             m.getFilename(),
@@ -497,19 +506,27 @@ public class MediaDetailPagerFragment extends CommonsDaggerSupportFragment imple
      * @param position current item that to be shown
      */
     private void setViewPagerCurrentItem(int position) {
-        final Boolean[] currentItemNotShown = {true};
-        Runnable runnable = new Runnable() {
+
+        final Handler handler = new Handler(Looper.getMainLooper());
+        final Runnable runnable = new Runnable() {
             @Override
             public void run() {
-                while(currentItemNotShown[0]){
-                    if(adapter.getCount() > position){
-                        binding.mediaDetailsPager.setCurrentItem(position, false);
-                        currentItemNotShown[0] = false;
-                    }
+                // Show the ProgressBar while waiting for the item to load
+                imageProgressBar.setVisibility(View.VISIBLE);
+                // Check if the adapter has enough items loaded
+                if(adapter.getCount() > position){
+                    // Set the current item in the ViewPager
+                    binding.mediaDetailsPager.setCurrentItem(position, false);
+                    // Hide the ProgressBar once the item is loaded
+                    imageProgressBar.setVisibility(View.GONE);
+                } else {
+                    // If the item is not ready yet, post the Runnable again
+                    handler.post(this);
                 }
             }
         };
-        new Thread(runnable).start();
+        // Start the Runnable
+        handler.post(runnable);
     }
 
     /**
diff --git a/app/src/main/res/layout/fragment_media_detail_pager.xml b/app/src/main/res/layout/fragment_media_detail_pager.xml
index 19d5d002d..e92c739de 100644
--- a/app/src/main/res/layout/fragment_media_detail_pager.xml
+++ b/app/src/main/res/layout/fragment_media_detail_pager.xml
@@ -1,14 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
 <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
-    android:orientation="vertical"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"
-    >
-    <androidx.viewpager.widget.ViewPager
-        android:id="@+id/mediaDetailsPager"
-        android:layout_width="match_parent"
-        android:layout_height="match_parent"
-        android:fadingEdge="none"
-        />
+              android:orientation="vertical"
+              android:layout_width="match_parent"
+              android:layout_height="match_parent"
+              xmlns:app="http://schemas.android.com/apk/res-auto">
+    <ProgressBar
+        android:id="@+id/itemProgressBar"
+        style="?android:attr/progressBarStyle"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_gravity="center"
+        android:progressBackgroundTint="@android:color/white"/>
 
-</LinearLayout>
\ No newline at end of file
+    <androidx.viewpager.widget.ViewPager
+      android:id="@+id/mediaDetailsPager"
+      android:layout_width="match_parent"
+      android:layout_height="match_parent"
+      android:fadingEdge="none" />
+  </LinearLayout>