Add click listeners to multicolumnrow texts (#41)

* Add click listeners to multicolumnrow texts

* Improve kotlin-ness of parameter ordering

* Remove setTextIsSelectable from MultiColumnRowView

Author: jemmaSlater

CHANGELOG.md

@@ -16,6 +16,22 @@ Allowed headings:
 
 ## [Unreleased]
 
+### Added
+
+* Added new methods to set click listeners and custom click content descriptions to each text view inside `MultiColumnRowView`:
+	`setText1ClickAction(clickDescription: CharSequence? = null, listener: OnClickListener)`,
+	`setText2ClickAction(clickDescription: CharSequence? = null, listener: OnClickListener)`,
+	`setText3ClickAction(clickDescription: CharSequence? = null, listener: OnClickListener)`
+
+### Changed
+
+* Fixed typo in method name inside `MultiColumnRowView`:
+	`setTextContentDescription(desc1: CharSequence?, desc2: CharSequence?, desc3: CharSequence?)`
+
+### Removed
+
+* Removed `setTextIsSelectable` method and xml attributes `text1IsSelectable`, `text2IsSelectable` and `text3IsSelectable` from `MultiColumnRowView`
+
 ## [3.13.0] - 2021-05-10
 
 ### Added

README.md

@@ -260,9 +260,6 @@ the xml text attribute
     app:text1ContentDescription="@string/text1_desc"
     app:text2ContentDescription="@string/text2_desc"
     app:text3ContentDescription="@string/text3_desc"
-    app:text1IsSelectable="false"
-    app:text2IsSelectable="true"
-    app:text3IsSelectable="true"
     app:textStyle="@style/Text.Body"
     app:textStyle2="@style/Text.Body"
     app:textStyle3="@style/Text.Bold"
@@ -278,6 +275,17 @@ multi_column_row.setTextStyle(R.style.Text_Bold)
 multi_column_row.setText1AsHeading(true)
 ```
 
+If you need to, you can add a click listener to each column and provide a custom click content description:
+```kotlin
+multi_column_row.setText1ClickAction("custom click content description") {
+    // click listener
+}
+multi_column_row.setText2ClickAction { Toast.makeText(context, "text 2 clicked", LENGTH_LONG).show() }
+multi_column_row.setText3ClickAction("do custom action") {
+    Toast.makeText(context, "text 3 custom action invoked", LENGTH_LONG).show()
+}
+```
+
 ### Text Input View
 
 ```xml

components/src/main/java/uk/gov/hmrc/components/molecule/item/MultiColumnRowView.kt

@@ -23,6 +23,7 @@ import android.widget.LinearLayout
 import androidx.annotation.StyleRes
 import uk.gov.hmrc.components.R
 import uk.gov.hmrc.components.databinding.ComponentMultiColumnRowBinding
+import uk.gov.hmrc.components.extensions.setAccessibilityMessage
 import uk.gov.hmrc.components.extensions.setAsAccessibilityHeading
 import uk.gov.hmrc.components.extensions.setStyle
 
@@ -50,17 +51,13 @@ class MultiColumnRowView @JvmOverloads constructor(
             val text1ContentDescription = typedArray.getString(R.styleable.MultiColumnRowView_text1ContentDescription)
             val text2ContentDescription = typedArray.getString(R.styleable.MultiColumnRowView_text2ContentDescription)
             val text3ContentDescription = typedArray.getString(R.styleable.MultiColumnRowView_text3ContentDescription)
-            val text1IsSelectable = typedArray.getBoolean(R.styleable.MultiColumnRowView_text1IsSelectable, false)
-            val text2IsSelectable = typedArray.getBoolean(R.styleable.MultiColumnRowView_text2IsSelectable, false)
-            val text3IsSelectable = typedArray.getBoolean(R.styleable.MultiColumnRowView_text3IsSelectable, false)
             val textStyle = typedArray.getResourceId(R.styleable.MultiColumnRowView_textStyle, R.style.Text_Body)
             val textStyle2 = typedArray.getResourceId(R.styleable.MultiColumnRowView_textStyle2, textStyle)
             val textStyle3 = typedArray.getResourceId(R.styleable.MultiColumnRowView_textStyle3, textStyle)
             val text1Heading = typedArray.getBoolean(R.styleable.MultiColumnRowView_text1Heading, false)
 
             setText(text1, text2, text3)
-            setTextContentDesription(text1ContentDescription, text2ContentDescription, text3ContentDescription)
-            setTextIsSelectable(text1IsSelectable, text2IsSelectable, text3IsSelectable)
+            setTextContentDescription(text1ContentDescription, text2ContentDescription, text3ContentDescription)
             setTextStyle(textStyle, textStyle2, textStyle3)
             setText1AsHeading(text1Heading)
 
@@ -143,33 +140,42 @@ class MultiColumnRowView @JvmOverloads constructor(
         setText(binding.rowText1.text, binding.rowText2.text, text3)
     }
 
-    fun setTextContentDesription(desc1: CharSequence?, desc2: CharSequence?, desc3: CharSequence?) {
+    fun setTextContentDescription(desc1: CharSequence?, desc2: CharSequence?, desc3: CharSequence?) {
         desc1?.let { binding.rowText1.contentDescription = it }
         desc2?.let { binding.rowText2.contentDescription = it }
         desc3?.let { binding.rowText3.contentDescription = it }
     }
 
     fun setText1ContentDescription(desc1: CharSequence?) {
-        setTextContentDesription(desc1, binding.rowText2.contentDescription, binding.rowText3.contentDescription)
+        setTextContentDescription(desc1, binding.rowText2.contentDescription, binding.rowText3.contentDescription)
     }
 
     fun setText2ContentDescription(desc2: CharSequence?) {
-        setTextContentDesription(binding.rowText1.contentDescription, desc2, binding.rowText3.contentDescription)
+        setTextContentDescription(binding.rowText1.contentDescription, desc2, binding.rowText3.contentDescription)
     }
 
     fun setText3ContentDescription(desc3: CharSequence?) {
-        setTextContentDesription(binding.rowText1.contentDescription, binding.rowText2.contentDescription, desc3)
+        setTextContentDescription(binding.rowText1.contentDescription, binding.rowText2.contentDescription, desc3)
     }
 
-    fun setTextIsSelectable(
-        text1IsSelectable: Boolean = binding.rowText1.isTextSelectable,
-        text2IsSelectable: Boolean = binding.rowText2.isTextSelectable,
-        text3IsSelectable: Boolean = binding.rowText3.isTextSelectable
-    ) {
-        binding.apply {
-            rowText1.setTextIsSelectable(text1IsSelectable)
-            rowText2.setTextIsSelectable(text2IsSelectable)
-            rowText3.setTextIsSelectable(text3IsSelectable)
+    fun setText1ClickAction(clickDescription: CharSequence? = null, listener: OnClickListener) {
+        binding.rowText1.apply {
+            setOnClickListener(listener)
+            clickDescription?.let { setAccessibilityMessage(it) }
+        }
+    }
+
+    fun setText2ClickAction(clickDescription: CharSequence? = null, listener: OnClickListener) {
+        binding.rowText2.apply {
+            setOnClickListener(listener)
+            clickDescription?.let { setAccessibilityMessage(it) }
+        }
+    }
+
+    fun setText3ClickAction(clickDescription: CharSequence? = null, listener: OnClickListener) {
+        binding.rowText3.apply {
+            setOnClickListener(listener)
+            clickDescription?.let { setAccessibilityMessage(it) }
         }
     }
 

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

@@ -106,12 +106,6 @@
         <attr name="text2ContentDescription" format="string" />
         <!-- Third piece of text content description. -->
         <attr name="text3ContentDescription" format="string" />
-        <!-- Whether or not the first piece of text is selectable. -->
-        <attr name="text1IsSelectable" format="boolean" />
-        <!-- Whether or not the second piece of text is selectable. -->
-        <attr name="text2IsSelectable" format="boolean" />
-        <!-- Whether or not the third piece of text is selectable. -->
-        <attr name="text3IsSelectable" format="boolean" />
         <!-- Text style for the first piece of text. -->
         <attr name="textStyle" format="reference" />
         <!-- Text style for the second piece of text. -->

sample/src/main/java/uk/gov/hmrc/components/sample/molecules/MultiColumnRowFragment.kt

@@ -19,6 +19,8 @@ import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
+import android.widget.Toast
+import android.widget.Toast.LENGTH_LONG
 import uk.gov.hmrc.components.sample.R
 import uk.gov.hmrc.components.sample.autoCleared
 import uk.gov.hmrc.components.sample.base.BaseComponentsFragment
@@ -31,8 +33,18 @@ class MultiColumnRowFragment : BaseComponentsFragment() {
 
     override fun provideToolbar() = ToolbarState(true, R.string.molecules_multi_column_row, true)
 
-    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
+    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
         binding = FragmentMultiColumnRowBinding.inflate(inflater, container, false)
         return binding.root
     }
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+        binding.multiColumnRowPlaceholder.apply {
+            setText2ClickAction { Toast.makeText(context, "text 2 clicked", LENGTH_LONG).show() }
+            setText3ClickAction("do custom action") {
+                Toast.makeText(context, "text 3 custom action invoked", LENGTH_LONG).show()
+            }
+        }
+    }
 }