AddIndicator: add content description and tooltip for all states

UweTrottmann · Oct 10, 2024 · 3e1158c · 3e1158c
1 parent 8792317
commit 3e1158c
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 25 deletions.
diff --git a/app/src/main/java/com/battlelancer/seriesguide/shows/search/discover/AddFragment.kt b/app/src/main/java/com/battlelancer/seriesguide/shows/search/discover/AddFragment.kt
@@ -14,8 +14,9 @@ import android.widget.ArrayAdapter
 import android.widget.GridView
 import androidx.appcompat.widget.TooltipCompat
 import androidx.core.view.ViewCompat
+import androidx.core.view.isGone
+import androidx.core.view.isVisible
 import androidx.fragment.app.Fragment
-import com.battlelancer.seriesguide.R
 import com.battlelancer.seriesguide.databinding.ItemAddshowBinding
 import com.battlelancer.seriesguide.enums.NetworkResult
 import com.battlelancer.seriesguide.shows.tools.AddShowTask.OnShowAddedEvent
@@ -258,18 +259,18 @@ abstract class AddFragment : Fragment() {
                     if (enableMoreOptions) View.VISIBLE else View.GONE
 
                 if (item == null) {
-                    binding.addIndicatorAddShow.setState(SearchResult.STATE_ADD)
-                    binding.addIndicatorAddShow.setContentDescriptionAdded(null)
+                    binding.addIndicatorAddShow.isGone = true
                     binding.textViewAddTitle.text = null
                     binding.textViewAddDescription.text = null
                     binding.imageViewAddPoster.setImageDrawable(null)
                 } else {
-                    // display added indicator instead of add button if already added that show
-                    binding.addIndicatorAddShow.setState(item.state)
+                    // add indicator
                     val showTitle = item.title
-                    binding.addIndicatorAddShow.setContentDescriptionAdded(
-                        context.getString(R.string.add_already_exists, showTitle)
-                    )
+                    binding.addIndicatorAddShow.apply {
+                        setState(item.state)
+                        setNameOfAssociatedItem(showTitle)
+                        isVisible = true
+                    }
 
                     // set text properties immediately
                     binding.textViewAddTitle.text = showTitle

diff --git a/app/src/main/java/com/battlelancer/seriesguide/shows/search/discover/AddIndicator.kt b/app/src/main/java/com/battlelancer/seriesguide/shows/search/discover/AddIndicator.kt
@@ -7,27 +7,43 @@ import android.content.Context
 import android.util.AttributeSet
 import android.view.LayoutInflater
 import android.widget.FrameLayout
+import androidx.appcompat.widget.TooltipCompat
+import com.battlelancer.seriesguide.R
 import com.battlelancer.seriesguide.databinding.LayoutAddIndicatorBinding
 
 /**
  * A three state visual indicator with states add, adding and added from [SearchResult].
+ *
+ * Make sure to call [setNameOfAssociatedItem] to provide content description and tooltips for all
+ * states.
  */
 class AddIndicator(context: Context, attrs: AttributeSet?) : FrameLayout(context, attrs) {
 
-    private val binding: LayoutAddIndicatorBinding
-
-    init {
-        binding = LayoutAddIndicatorBinding.inflate(LayoutInflater.from(context), this)
-    }
+    private val binding = LayoutAddIndicatorBinding.inflate(LayoutInflater.from(context), this)
 
     override fun onFinishInflate() {
         super.onFinishInflate()
+        binding.imageViewAddIndicator.also {
+            TooltipCompat.setTooltipText(it, it.contentDescription)
+        }
         binding.imageViewAddIndicatorAdded.visibility = GONE
         binding.progressBarAddIndicator.visibility = GONE
     }
 
-    fun setContentDescriptionAdded(contentDescription: CharSequence?) {
-        binding.imageViewAddIndicatorAdded.contentDescription = contentDescription
+    /**
+     * Sets content descriptions and tooltips of added and adding states.
+     */
+    fun setNameOfAssociatedItem(name: String) {
+        binding.apply {
+            imageViewAddIndicatorAdded.also {
+                it.contentDescription = context.getString(R.string.add_already_exists, name)
+                TooltipCompat.setTooltipText(it, it.contentDescription)
+            }
+            progressBarAddIndicator.also {
+                it.contentDescription = context.getString(R.string.add_started, name)
+                TooltipCompat.setTooltipText(it, it.contentDescription)
+            }
+        }
     }
 
     fun setOnAddClickListener(onClickListener: OnClickListener?) {
@@ -41,11 +57,13 @@ class AddIndicator(context: Context, attrs: AttributeSet?) : FrameLayout(context
                 binding.progressBarAddIndicator.visibility = GONE
                 binding.imageViewAddIndicatorAdded.visibility = GONE
             }
+
             SearchResult.STATE_ADDING -> {
                 binding.imageViewAddIndicator.visibility = GONE
                 binding.progressBarAddIndicator.visibility = VISIBLE
                 binding.imageViewAddIndicatorAdded.visibility = GONE
             }
+
             SearchResult.STATE_ADDED -> {
                 binding.imageViewAddIndicator.visibility = GONE
                 binding.progressBarAddIndicator.visibility = GONE

diff --git a/...rc/main/java/com/battlelancer/seriesguide/shows/search/discover/SearchResultViewHolder.kt b/...rc/main/java/com/battlelancer/seriesguide/shows/search/discover/SearchResultViewHolder.kt
@@ -43,19 +43,16 @@ class SearchResultViewHolder(
         // hide more options button
         moreOptionsButton.visibility = View.GONE
 
-        // display added indicator instead of add button if already added that show
-        val showTitle = searchResult?.title
+        // add indicator
         if (searchResult != null) {
             addIndicator.setState(searchResult.state)
-            addIndicator.setContentDescriptionAdded(
-                itemView.context.getString(R.string.add_already_exists, showTitle)
-            )
+            addIndicator.setNameOfAssociatedItem(searchResult.title)
             addIndicator.visibility = View.VISIBLE
         } else {
             addIndicator.visibility = View.GONE
         }
 
-        title.text = showTitle
+        title.text = searchResult?.title
         description.text = searchResult?.overview
 
         // only local shows will have a poster path set

diff --git a/app/src/main/java/com/battlelancer/seriesguide/shows/search/discover/ShowsDiscoverAdapter.kt b/app/src/main/java/com/battlelancer/seriesguide/shows/search/discover/ShowsDiscoverAdapter.kt
@@ -299,9 +299,7 @@ class ShowsDiscoverAdapter(
             // display added indicator instead of add button if already added that show
             binding.addIndicatorAddShow.setState(item.state)
             val showTitle = item.title
-            binding.addIndicatorAddShow.setContentDescriptionAdded(
-                context.getString(R.string.add_already_exists, showTitle)
-            )
+            binding.addIndicatorAddShow.setNameOfAssociatedItem(showTitle)
 
             // set text properties immediately
             binding.textViewAddTitle.text = showTitle

diff --git a/app/src/main/res/layout/layout_add_indicator.xml b/app/src/main/res/layout/layout_add_indicator.xml
@@ -12,7 +12,7 @@
         android:scaleType="centerInside"
         app:srcCompat="@drawable/ic_add_white_24dp" />
 
-    <!-- Content description is set in code. -->
+    <!-- Content description is set in code -->
     <ImageView
         android:id="@+id/imageViewAddIndicatorAdded"
         android:layout_width="match_parent"
@@ -21,6 +21,7 @@
         android:scaleType="centerInside"
         app:srcCompat="@drawable/ic_watched_24dp" />
 
+    <!-- Content description is set in code -->
     <ProgressBar
         android:id="@+id/progressBarAddIndicator"
         android:layout_width="match_parent"