Fix #3708: Content Description Generation For ImageRegionSelectionInteraction

app/src/main/java/org/oppia/android/app/player/state/ImageRegionSelectionInteractionView.kt

@@ -11,6 +11,7 @@ import androidx.fragment.app.FragmentManager
 import org.oppia.android.app.model.ImageWithRegions
 import org.oppia.android.app.model.UserAnswerState
 import org.oppia.android.app.shim.ViewBindingShim
+import org.oppia.android.app.translation.AppLanguageResourceHandler
 import org.oppia.android.app.utility.ClickableAreasImage
 import org.oppia.android.app.utility.OnClickableAreaClickedListener
 import org.oppia.android.app.view.ViewComponentFactory
@@ -46,6 +47,7 @@ class ImageRegionSelectionInteractionView @JvmOverloads constructor(
   @Inject lateinit var machineLocale: OppiaLocale.MachineLocale
   @Inject lateinit var accessibilityService: AccessibilityService
   @Inject lateinit var imageLoader: ImageLoader
+  @Inject lateinit var resourceHandler: AppLanguageResourceHandler
 
   private lateinit var entityId: String
   private lateinit var overlayView: FrameLayout
@@ -64,8 +66,8 @@ class ImageRegionSelectionInteractionView @JvmOverloads constructor(
     maybeInitializeClickableAreas()
   }
 
-  fun setUserAnswerState(userAnswerrState: UserAnswerState) {
-    this.userAnswerState = userAnswerrState
+  fun setUserAnswerState(userAnswerState: UserAnswerState) {
+    this.userAnswerState = userAnswerState
   }
 
   fun setEntityId(entityId: String) {
@@ -118,7 +120,8 @@ class ImageRegionSelectionInteractionView @JvmOverloads constructor(
       ::entityId.isInitialized &&
       ::imageUrl.isInitialized &&
       ::onRegionClicked.isInitialized &&
-      ::overlayView.isInitialized
+      ::overlayView.isInitialized &&
+      ::resourceHandler.isInitialized
     ) {
       loadImage()
 
@@ -129,7 +132,8 @@ class ImageRegionSelectionInteractionView @JvmOverloads constructor(
         bindingInterface,
         isAccessibilityEnabled = accessibilityService.isScreenReaderEnabled(),
         clickableAreas,
-        userAnswerState
+        userAnswerState,
+        resourceHandler
       )
       areasImage.addRegionViews()
       performAttachment(areasImage)

app/src/main/java/org/oppia/android/app/utility/ClickableAreasImage.kt

@@ -13,6 +13,7 @@ import org.oppia.android.app.model.ImageWithRegions.LabeledRegion
 import org.oppia.android.app.model.UserAnswerState
 import org.oppia.android.app.player.state.ImageRegionSelectionInteractionView
 import org.oppia.android.app.shim.ViewBindingShim
+import org.oppia.android.app.translation.AppLanguageResourceHandler
 import kotlin.math.roundToInt
 
 /** Helper class to handle clicks on an image along with highlighting the selected region. */
@@ -23,7 +24,8 @@ class ClickableAreasImage(
   bindingInterface: ViewBindingShim,
   private val isAccessibilityEnabled: Boolean,
   private val clickableAreas: List<LabeledRegion>,
-  userAnswerState: UserAnswerState
+  userAnswerState: UserAnswerState,
+  private val resourceHandler: AppLanguageResourceHandler
 ) {
   private var imageLabel: String? = null
   private val defaultRegionView by lazy { bindingInterface.getDefaultRegion(parentView) }
@@ -60,6 +62,16 @@ class ClickableAreasImage(
       // Remove any previously selected region excluding 0th index(image view)
       if (index > 0) {
         childView.setBackgroundResource(0)
+        if (childView.tag != null) {
+          val regionLabel = childView.tag as String
+          clickableAreas.find { it.label == regionLabel }?.let { clickableArea ->
+            updateRegionContentDescription(
+              childView,
+              clickableArea,
+              regionLabel == imageLabel
+            )
+          }
+        }
       }
     }
   }
@@ -112,8 +124,13 @@ class ClickableAreasImage(
       newView.isFocusable = true
       newView.isFocusableInTouchMode = true
       newView.tag = clickableArea.label
+
+      val isInitiallySelected = clickableArea.label.equals(imageLabel)
+      updateRegionContentDescription(newView, clickableArea, isInitiallySelected)
+
       newView.initializeToggleRegionTouchListener(clickableArea)
-      if (clickableArea.label.equals(imageLabel)) {
+
+      if (isInitiallySelected) {
         showOrHideRegion(newView = newView, clickableArea = clickableArea)
       }
       if (isAccessibilityEnabled) {
@@ -123,7 +140,7 @@ class ClickableAreasImage(
           showOrHideRegion(newView, clickableArea)
         }
       }
-      newView.contentDescription = clickableArea.contentDescription
+
       parentView.addView(newView)
     }
 
@@ -143,14 +160,18 @@ class ClickableAreasImage(
   }
 
   private fun showOrHideRegion(newView: View, clickableArea: LabeledRegion) {
-    resetRegionSelectionViews()
-    listener.onClickableAreaTouched(
-      NamedRegionClickedEvent(
-        clickableArea.label,
-        clickableArea.contentDescription
+    if (clickableArea.label != imageLabel) {
+      imageLabel = clickableArea.label
+      resetRegionSelectionViews()
+      newView.setBackgroundResource(R.drawable.selected_region_background)
+
+      listener.onClickableAreaTouched(
+        NamedRegionClickedEvent(
+          clickableArea.label,
+          generateContentDescription(clickableArea, true)
+        )
       )
-    )
-    newView.setBackgroundResource(R.drawable.selected_region_background)
+    }
   }
 
   private fun View.initializeShowRegionTouchListener() {
@@ -172,4 +193,27 @@ class ClickableAreasImage(
       return@setOnTouchListener true
     }
   }
+
+  private fun generateContentDescription(
+    clickableArea: LabeledRegion,
+    isSelected: Boolean
+  ): String = if (isSelected) {
+    resourceHandler.getStringInLocaleWithWrapping(
+      R.string.selected_image_region_selection_content_description,
+      clickableArea.label
+    )
+  } else {
+    resourceHandler.getStringInLocaleWithWrapping(
+      R.string.unselected_image_region_selection_content_description,
+      clickableArea.label
+    )
+  }
+
+  private fun updateRegionContentDescription(
+    view: View,
+    clickableArea: LabeledRegion,
+    isSelected: Boolean
+  ) {
+    view.contentDescription = generateContentDescription(clickableArea, isSelected)
+  }
 }

app/src/main/res/values/strings.xml

@@ -191,6 +191,8 @@
   <string name="correct">Correct!</string>
   <string name="topic_prefix">Topic: %s</string>
   <string name="welcome_profile_name">%1$s %2$s!</string>
+  <string name="selected_image_region_selection_content_description">Image showing %1$s.</string>
+  <string name="unselected_image_region_selection_content_description">Select %1$s image.</string>
   <plurals name="chapter_count">
     <item quantity="one">1 Chapter</item>
     <item quantity="other">%s Chapters</item>

app/src/sharedTest/java/org/oppia/android/app/testing/ImageRegionSelectionInteractionViewTest.kt

@@ -11,6 +11,7 @@ import androidx.test.espresso.action.ViewActions.click
 import androidx.test.espresso.assertion.ViewAssertions.matches
 import androidx.test.espresso.matcher.ViewMatchers.isDisplayed
 import androidx.test.espresso.matcher.ViewMatchers.isEnabled
+import androidx.test.espresso.matcher.ViewMatchers.withContentDescription
 import androidx.test.espresso.matcher.ViewMatchers.withId
 import androidx.test.espresso.matcher.ViewMatchers.withTagValue
 import androidx.test.espresso.matcher.ViewMatchers.withText
@@ -177,7 +178,7 @@ class ImageRegionSelectionInteractionViewTest {
       assertThat(regionClickedEvent.value)
         .isEqualTo(
           NamedRegionClickedEvent(
-            regionLabel = "Region 3", contentDescription = "You have selected Region 3"
+            regionLabel = "Region 3", contentDescription = "Image showing Region 3."
           )
         )
     }
@@ -218,12 +219,26 @@ class ImageRegionSelectionInteractionViewTest {
       assertThat(regionClickedEvent.value)
         .isEqualTo(
           NamedRegionClickedEvent(
-            regionLabel = "Region 2", contentDescription = "You have selected Region 2"
+            regionLabel = "Region 2", contentDescription = "Image showing Region 2."
           )
         )
     }
   }
 
+  @Test
+  // TODO(#1611): Fix ImageRegionSelectionInteractionViewTest
+  @RunOn(TestPlatform.ESPRESSO)
+  fun testImageRegionSelectionInteractionView_initialContentDescriptionRegion3_isCorrect() {
+    launch(ImageRegionSelectionTestActivity::class.java).use {
+      onView(
+        allOf(
+          withTagValue(`is`("Region 3")),
+          withContentDescription("Select Region 3 image.")
+        )
+      ).check(matches(isDisplayed()))
+    }
+  }
+
   @Test
   // TODO(#1611): Fix ImageRegionSelectionInteractionViewTest
   @RunOn(TestPlatform.ESPRESSO)
@@ -280,7 +295,7 @@ class ImageRegionSelectionInteractionViewTest {
       assertThat(regionClickedEvent.value)
         .isEqualTo(
           NamedRegionClickedEvent(
-            regionLabel = "Region 2", contentDescription = "You have selected Region 2"
+            regionLabel = "Region 2", contentDescription = "Image showing Region 2."
           )
         )
     }
@@ -308,7 +323,7 @@ class ImageRegionSelectionInteractionViewTest {
       assertThat(regionClickedEvent.value)
         .isEqualTo(
           NamedRegionClickedEvent(
-            regionLabel = "Region 3", contentDescription = "You have selected Region 3"
+            regionLabel = "Region 3", contentDescription = "Image showing Region 3."
           )
         )
     }
@@ -352,7 +367,7 @@ class ImageRegionSelectionInteractionViewTest {
       assertThat(regionClickedEvent.value)
         .isEqualTo(
           NamedRegionClickedEvent(
-            regionLabel = "Region 3", contentDescription = "You have selected Region 3"
+            regionLabel = "Region 3", contentDescription = "Image showing Region 3."
           )
         )
     }
@@ -394,7 +409,7 @@ class ImageRegionSelectionInteractionViewTest {
       assertThat(regionClickedEvent.value)
         .isEqualTo(
           NamedRegionClickedEvent(
-            regionLabel = "Region 2", contentDescription = "You have selected Region 2"
+            regionLabel = "Region 2", contentDescription = "Image showing Region 2."
           )
         )
     }