Factored out custom answer view

grzesiek2010 · grzesiek2010 · commit 60e400554ec5 · 2025-01-16T14:40:25.000+01:00
diff --git a/collect_app/src/main/java/org/odk/collect/android/widgets/BarcodeWidget.kt b/collect_app/src/main/java/org/odk/collect/android/widgets/BarcodeWidget.kt
@@ -3,7 +3,6 @@ package org.odk.collect.android.widgets
 import android.annotation.SuppressLint
 import android.app.Activity
 import android.content.Context
-import android.util.TypedValue
 import android.view.View
 import com.google.zxing.integration.android.IntentIntegrator
 import org.javarosa.core.model.data.IAnswerData
@@ -43,59 +42,44 @@ class BarcodeWidget(
         } else {
             binding.barcodeButton.setOnClickListener { onButtonClick() }
         }
-        binding.barcodeAnswerText.setTextSize(
-            TypedValue.COMPLEX_UNIT_DIP,
-            answerFontSize.toFloat()
-        )
+        binding.answerView.setHidden(hasAppearance(prompt, Appearances.HIDDEN_ANSWER))
+        binding.answerView.setTextSize(answerFontSize.toFloat())
 
         val answer = prompt.answerText
         if (!answer.isNullOrEmpty()) {
             binding.barcodeButton.text = getContext().getString(R.string.replace_barcode)
-            binding.barcodeAnswerText.text = answer
         }
+        binding.answerView.setAnswer(prompt.answerText)
 
-        updateVisibility()
         return binding.root
     }
 
     override fun clearAnswer() {
-        binding.barcodeAnswerText.text = null
+        binding.answerView.setAnswer(null)
         binding.barcodeButton.text = context.getString(R.string.get_barcode)
         widgetValueChanged()
-        updateVisibility()
     }
 
     override fun getAnswer(): IAnswerData? {
-        val answer = binding.barcodeAnswerText.text.toString()
+        val answer = binding.answerView.getAnswer()
         return if (answer.isEmpty()) null else StringData(answer)
     }
 
     override fun setData(answer: Any) {
-        val response = answer as String
-        binding.barcodeAnswerText.text = stripInvalidCharacters(response)
+        binding.answerView.setAnswer(answer as String)
         binding.barcodeButton.text = context.getString(R.string.replace_barcode)
-        updateVisibility()
         widgetValueChanged()
     }
 
-    private fun updateVisibility() {
-        if (hasAppearance(formEntryPrompt, Appearances.HIDDEN_ANSWER)) {
-            binding.barcodeAnswerText.visibility = GONE
-        } else {
-            binding.barcodeAnswerText.visibility =
-                if (binding.barcodeAnswerText.text.toString().isBlank()) GONE else VISIBLE
-        }
-    }
-
     override fun setOnLongClickListener(l: OnLongClickListener?) {
-        binding.barcodeAnswerText.setOnLongClickListener(l)
         binding.barcodeButton.setOnLongClickListener(l)
+        binding.answerView.setOnLongClickListener(l)
     }
 
     override fun cancelLongPress() {
         super.cancelLongPress()
         binding.barcodeButton.cancelLongPress()
-        binding.barcodeAnswerText.cancelLongPress()
+        binding.answerView.cancelLongPress()
     }
 
     private fun onButtonClick() {
@@ -122,9 +106,4 @@ class BarcodeWidget(
             }
         }
     }
-
-    // Remove control characters, invisible characters and unused code points.
-    private fun stripInvalidCharacters(data: String?): String? {
-        return data?.replace("\\p{C}".toRegex(), "")
-    }
 }
diff --git a/collect_app/src/main/java/org/odk/collect/android/widgets/BarcodeWidgetAnswer.kt b/collect_app/src/main/java/org/odk/collect/android/widgets/BarcodeWidgetAnswer.kt
@@ -0,0 +1,39 @@
+package org.odk.collect.android.widgets
+
+import android.content.Context
+import android.util.AttributeSet
+import android.util.TypedValue
+import android.view.LayoutInflater
+import android.widget.FrameLayout
+import org.odk.collect.android.databinding.BarcodeWidgetAnswerBinding
+
+class BarcodeWidgetAnswer @JvmOverloads constructor(
+    context: Context,
+    attrs: AttributeSet? = null,
+    defStyle: Int = 0
+) : FrameLayout(context, attrs, defStyle) {
+    private val binding = BarcodeWidgetAnswerBinding.inflate(LayoutInflater.from(context), this, true)
+    private var hidden = false
+
+    fun setAnswer(answer: String?) {
+        binding.answer.text = stripInvalidCharacters(answer)
+        binding.root.visibility = if (hidden || binding.answer.text.isNullOrBlank()) GONE else VISIBLE
+    }
+
+    fun setTextSize(textSize: Float) {
+        binding.answer.setTextSize(TypedValue.COMPLEX_UNIT_DIP, textSize)
+    }
+
+    fun setHidden(hidden: Boolean) {
+        this.hidden = hidden
+    }
+
+    fun getAnswer(): String {
+        return binding.answer.text.toString()
+    }
+
+    // Remove control characters, invisible characters and unused code points.
+    private fun stripInvalidCharacters(data: String?): String? {
+        return data?.replace("\\p{C}".toRegex(), "")
+    }
+}
diff --git a/collect_app/src/main/res/layout/barcode_widget.xml b/collect_app/src/main/res/layout/barcode_widget.xml
@@ -1,20 +1,25 @@
 <?xml version="1.0" encoding="utf-8"?>
-<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto"
-    android:orientation="vertical"
     android:layout_width="match_parent"
-    android:layout_height="wrap_content">
+    android:layout_height="match_parent">
 
     <org.odk.collect.androidshared.ui.multiclicksafe.MultiClickSafeMaterialButton
         android:id="@+id/barcode_button"
         style="?widgetButtonIconQuestionWidgetStyle"
         android:text="@string/get_barcode"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
+        app:layout_constraintTop_toTopOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
         app:icon="@drawable/ic_baseline_barcode_scanner_white_24" />
 
-    <com.google.android.material.textview.MaterialTextView
-        android:id="@+id/barcode_answer_text"
-        style="@style/Widget.Collect.TextView.WidgetAnswer" />
+    <org.odk.collect.android.widgets.BarcodeWidgetAnswer
+        android:id="@+id/answer_view"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        app:layout_constraintTop_toBottomOf="@id/barcode_button"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintEnd_toEndOf="parent"/>
 
-</LinearLayout>
+</androidx.constraintlayout.widget.ConstraintLayout>
diff --git a/collect_app/src/main/res/layout/barcode_widget_answer.xml b/collect_app/src/main/res/layout/barcode_widget_answer.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/barcode_widget_answer"
+    android:layout_width="wrap_content"
+    android:layout_height="wrap_content">
+
+    <ImageView
+        android:id="@+id/icon"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        app:tint="?colorOnSurface"
+        app:srcCompat="@drawable/ic_baseline_barcode_scanner_white_24"
+        app:layout_constraintTop_toTopOf="@id/answer"
+        app:layout_constraintBottom_toBottomOf="@id/answer"
+        app:layout_constraintStart_toStartOf="parent" />
+
+    <com.google.android.material.textview.MaterialTextView
+        android:id="@+id/answer"
+        style="@style/Widget.Collect.TextView.WidgetAnswer"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        app:layout_constraintTop_toTopOf="parent"
+        app:layout_constraintStart_toEndOf="@id/icon"
+        tools:text="123456789" />
+
+</androidx.constraintlayout.widget.ConstraintLayout>
diff --git a/collect_app/src/test/java/org/odk/collect/android/widgets/BarcodeWidgetTest.kt b/collect_app/src/test/java/org/odk/collect/android/widgets/BarcodeWidgetTest.kt
@@ -5,7 +5,6 @@ import android.view.View.OnLongClickListener
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import org.hamcrest.CoreMatchers.equalTo
 import org.hamcrest.MatcherAssert.assertThat
-import org.hamcrest.Matchers
 import org.javarosa.core.model.FormIndex
 import org.javarosa.core.model.data.StringData
 import org.javarosa.form.api.FormEntryPrompt
@@ -15,14 +14,15 @@ import org.mockito.ArgumentMatchers
 import org.mockito.Mockito.verify
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.whenever
+import org.odk.collect.android.R
 import org.odk.collect.android.fakes.FakePermissionsProvider
 import org.odk.collect.android.formentry.questions.QuestionDetails
 import org.odk.collect.android.support.MockFormEntryPromptBuilder
 import org.odk.collect.android.utilities.Appearances
 import org.odk.collect.android.widgets.support.FakeWaitingForDataRegistry
 import org.odk.collect.android.widgets.support.QuestionWidgetHelpers
 import org.odk.collect.androidshared.system.CameraUtils
-import org.odk.collect.strings.R
+import org.odk.collect.strings.R.string
 import org.robolectric.Shadows
 import org.robolectric.shadows.ShadowToast
 
@@ -51,15 +51,15 @@ class BarcodeWidgetTest {
         val widget = createWidget(QuestionWidgetHelpers.promptWithAnswer(StringData("blah")))
         assertThat(
             widget.binding.barcodeButton.text.toString(),
-            equalTo(widgetTestActivity.getString(R.string.replace_barcode))
+            equalTo(widgetTestActivity.getString(string.replace_barcode))
         )
     }
 
     @Test
     fun `Display the answer if answer is present`() {
         val widget = createWidget(QuestionWidgetHelpers.promptWithAnswer(StringData("blah")))
         assertThat(
-            widget.binding.barcodeAnswerText.text.toString(),
+            widget.binding.answerView.getAnswer(),
             equalTo("blah")
         )
     }
@@ -86,12 +86,12 @@ class BarcodeWidgetTest {
         widget.clearAnswer()
 
         assertThat(
-            widget.binding.barcodeAnswerText.text.toString(),
+            widget.binding.answerView.getAnswer(),
             equalTo("")
         )
         assertThat(
             widget.binding.barcodeButton.text.toString(),
-            equalTo(widgetTestActivity.getString(R.string.get_barcode))
+            equalTo(widgetTestActivity.getString(string.get_barcode))
         )
     }
 
@@ -109,7 +109,7 @@ class BarcodeWidgetTest {
         val widget = createWidget(QuestionWidgetHelpers.promptWithAnswer(null))
         widget.setData("\ud800blah\b")
         assertThat(
-            widget.binding.barcodeAnswerText.text.toString(),
+            widget.binding.answerView.getAnswer(),
             equalTo("blah")
         )
     }
@@ -120,7 +120,7 @@ class BarcodeWidgetTest {
         widget.setData("\ud800blah\b")
         assertThat(
             widget.binding.barcodeButton.text,
-            equalTo(widgetTestActivity.getString(R.string.replace_barcode))
+            equalTo(widgetTestActivity.getString(string.replace_barcode))
         )
     }
 
@@ -138,10 +138,10 @@ class BarcodeWidgetTest {
         val widget = createWidget(QuestionWidgetHelpers.promptWithAnswer(null))
         widget.setOnLongClickListener(listener)
         widget.binding.barcodeButton.performLongClick()
-        widget.binding.barcodeAnswerText.performLongClick()
+        widget.binding.answerView.performLongClick()
 
         verify(listener).onLongClick(widget.binding.barcodeButton)
-        verify(listener).onLongClick(widget.binding.barcodeAnswerText)
+        verify(listener).onLongClick(widget.binding.answerView)
     }
 
     @Test
@@ -179,7 +179,7 @@ class BarcodeWidgetTest {
 
         assertThat(
             ShadowToast.getTextOfLatestToast(),
-            equalTo(widgetTestActivity.getString(R.string.error_front_camera_unavailable))
+            equalTo(widgetTestActivity.getString(string.error_front_camera_unavailable))
         )
     }
 
@@ -207,24 +207,24 @@ class BarcodeWidgetTest {
 
         // Check initial value is not shown
         assertThat(
-            widget.binding.barcodeAnswerText.visibility,
+            widget.binding.answerView.findViewById<View>(R.id.barcode_widget_answer).visibility,
             equalTo(View.GONE)
         )
         assertThat(
             widget.binding.barcodeButton.text,
-            equalTo(widgetTestActivity.getString(R.string.replace_barcode))
+            equalTo(widgetTestActivity.getString(string.replace_barcode))
         )
-        assertThat(widget.answer, Matchers.equalTo(StringData("original contents")))
+        assertThat(widget.answer, equalTo(StringData("original contents")))
 
         // Check updates aren't shown
         widget.setData("updated contents")
         assertThat(
-            widget.binding.barcodeAnswerText.visibility,
+            widget.binding.answerView.findViewById<View>(R.id.barcode_widget_answer).visibility,
             equalTo(View.GONE)
         )
         assertThat(
             widget.binding.barcodeButton.text,
-            equalTo(widgetTestActivity.getString(R.string.replace_barcode))
+            equalTo(widgetTestActivity.getString(string.replace_barcode))
         )
         assertThat(
             widget.answer,
