SDC: Add Progress Bar for Questionnaire

datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireFragment.kt

@@ -29,7 +29,9 @@ import androidx.fragment.app.viewModels
 import androidx.lifecycle.lifecycleScope
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
+import com.google.android.fhir.datacapture.utilities.calculatePercent
 import com.google.android.fhir.datacapture.views.QuestionnaireItemViewHolderFactory
+import com.google.android.material.progressindicator.LinearProgressIndicator
 import org.hl7.fhir.r4.model.Questionnaire
 
 /**
@@ -76,6 +78,8 @@ open class QuestionnaireFragment : Fragment() {
     requireView().findViewById<Button>(R.id.submit_questionnaire).setOnClickListener {
       setFragmentResult(SUBMIT_REQUEST_KEY, Bundle.EMPTY)
     }
+    val questionnaireProgressIndicator: LinearProgressIndicator =
+      view.findViewById(R.id.questionnaire_progress_indicator)
     val questionnaireItemEditAdapter =
       QuestionnaireItemEditAdapter(getCustomQuestionnaireItemViewHolderFactoryMatchers())
     val questionnaireItemReviewAdapter = QuestionnaireItemReviewAdapter()
@@ -93,7 +97,8 @@ open class QuestionnaireFragment : Fragment() {
     reviewModeButton.setOnClickListener { viewModel.setReviewMode(true) }
 
     questionnaireEditRecyclerView.adapter = questionnaireItemEditAdapter
-    questionnaireEditRecyclerView.layoutManager = LinearLayoutManager(view.context)
+    val linearLayoutManager = LinearLayoutManager(view.context)
+    questionnaireEditRecyclerView.layoutManager = linearLayoutManager
     // Animation does work well with views that could gain focus
     questionnaireEditRecyclerView.itemAnimator = null
 
@@ -108,21 +113,47 @@ open class QuestionnaireFragment : Fragment() {
           questionnaireReviewRecyclerView.visibility = View.VISIBLE
           questionnaireEditRecyclerView.visibility = View.GONE
           reviewModeEditButton.visibility = View.VISIBLE
+          questionnaireProgressIndicator.visibility = View.GONE
         } else {
           questionnaireItemEditAdapter.submitList(state.items)
           questionnaireEditRecyclerView.visibility = View.VISIBLE
           questionnaireReviewRecyclerView.visibility = View.GONE
           reviewModeEditButton.visibility = View.GONE
+          questionnaireProgressIndicator.visibility = View.VISIBLE
         }
 
         if (state.pagination.isPaginated && !state.reviewMode) {
           paginationPreviousButton.visibility = View.VISIBLE
           paginationPreviousButton.isEnabled = state.pagination.hasPreviousPage
           paginationNextButton.visibility = View.VISIBLE
           paginationNextButton.isEnabled = state.pagination.hasNextPage
+          questionnaireProgressIndicator.updateProgressIndicator(
+            calculatePercent(
+              count =
+                (state.pagination.currentPageIndex +
+                  1), // incremented by 1 due to initialPageIndex starts with 0.
+              totalCount = state.pagination.pages.size
+            )
+          )
         } else {
           paginationPreviousButton.visibility = View.GONE
           paginationNextButton.visibility = View.GONE
+
+          questionnaireEditRecyclerView.addOnScrollListener(
+            object : RecyclerView.OnScrollListener() {
+              override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) {
+                super.onScrolled(recyclerView, dx, dy)
+                questionnaireProgressIndicator.updateProgressIndicator(
+                  calculatePercent(
+                    count =
+                      (linearLayoutManager.findLastVisibleItemPosition() +
+                        1), // incremented by 1 due to findLastVisiblePosition() starts with 0.
+                    totalCount = linearLayoutManager.itemCount
+                  )
+                )
+              }
+            }
+          )
         }
 
         reviewModeButton.visibility =
@@ -233,3 +264,14 @@ open class QuestionnaireFragment : Fragment() {
     val matches: (Questionnaire.QuestionnaireItemComponent) -> Boolean,
   )
 }
+/**
+ * Updates the [LinearProgressIndicator] progress with given value.
+ *
+ * This method will also set max value of [LinearProgressIndicator] to 100.
+ *
+ * @param progress The new progress [Integer] value between 0 to 100.
+ */
+internal fun LinearProgressIndicator.updateProgressIndicator(progress: Int) {
+  setProgress(progress)
+  max = 100
+}

datacapture/src/main/java/com/google/android/fhir/datacapture/utilities/MoreNumberUtil.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.fhir.datacapture.utilities
+
+/** Calculates the percentage from given [count] and [totalCount] values. */
+internal fun calculatePercent(count: Int, totalCount: Int): Int {
+  return if (totalCount == 0) 0 else (count * 100 / totalCount)
+}

datacapture/src/main/res/layout/questionnaire_fragment.xml

@@ -35,13 +35,24 @@
         app:layout_constraintTop_toTopOf="parent"
     />
 
+    <com.google.android.material.progressindicator.LinearProgressIndicator
+        android:id="@+id/questionnaire_progress_indicator"
+        style="?attr/questionnaireLinearProgressIndicatorStyle"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintTop_toBottomOf="@+id/review_mode_edit_button"
+        app:layout_constraintBottom_toTopOf="@id/questionnaire_edit_recycler_view"
+    />
+
     <androidx.recyclerview.widget.RecyclerView
         android:id="@+id/questionnaire_edit_recycler_view"
         android:layout_width="match_parent"
         android:layout_height="0dp"
         android:scrollbars="vertical"
         app:layout_constraintBottom_toTopOf="@+id/bottom_buttons"
-        app:layout_constraintTop_toBottomOf="@+id/review_mode_edit_button"
+        app:layout_constraintTop_toBottomOf="@+id/questionnaire_progress_indicator"
     />
 
     <androidx.recyclerview.widget.RecyclerView

datacapture/src/main/res/values/attrs.xml

@@ -73,6 +73,9 @@
     <!--   Style for edit button. -->
     <attr name="questionnaireEditButtonStyle" format="reference" />
 
+    <!--   Style for Linear Progress Indicator. -->
+    <attr name="questionnaireLinearProgressIndicatorStyle" format="reference" />
+
     <declare-styleable name="QuestionnaireTheme">
         <!-- The ID of the theme to be applied to the questionnaire. The referenced theme must
              extend Theme.Questionnaire. If unspecified, Theme.Questionnaire will be used. -->

datacapture/src/main/res/values/styles.xml

@@ -109,6 +109,10 @@
             name="questionnaireAddAnotherAnswerButtonStyle"
         >@style/Widget.Material3.Button
         </item>
+        <item
+            name="questionnaireLinearProgressIndicatorStyle"
+        >@style/Widget.Material3.LinearProgressIndicator
+        </item>
     </style>
 
     <style

datacapture/src/test/java/com/google/android/fhir/datacapture/utilities/MoreNumberUtilTest.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.fhir.datacapture.utilities
+
+import com.google.common.truth.Truth.assertThat
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+
+@RunWith(RobolectricTestRunner::class)
+class MoreNumberUtilTest {
+
+  @Test
+  fun `calculatePercent should return zero for totalCount as zero`() {
+    assertThat(calculatePercent(count = 10, totalCount = 0)).isEqualTo(0)
+  }
+
+  @Test
+  fun `calculatePercent should return valid result`() {
+    assertThat(calculatePercent(count = 10, totalCount = 50)).isEqualTo(20)
+  }
+}