Add ability to set tooltipText (Closes #12)

ozgurg · Aug 6, 2022 · 31c9ab4 · 31c9ab4
1 parent c8edc3d
commit 31c9ab4
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -64,6 +64,8 @@ anything you can with `AppCompatImageView`.
 | `app:checked`                     | Sets the initial state of the icon                         | `Boolean` | `false` |
 | `app:checkedContentDescription`   | Sets the initial checked content description of the icon   | `String`  | `null`  |
 | `app:uncheckedContentDescription` | Sets the initial unchecked content description of the icon | `String`  | `null`  |
+| `app:checkedTooltipText`          | Sets the initial checked tooltip text of the icon          | `String`  | `null`  |
+| `app:uncheckedTooltipText`        | Sets the initial unchecked tooltip text of the icon        | `String`  | `null`  |
 
 ### Methods
 
@@ -76,6 +78,10 @@ anything you can with `AppCompatImageView`.
 | `.checkedContentDescription = String?` <br /> `setCheckedContentDescription(value: String?)`     | Sets the checked content description of the icon            | -         |
 | `.uncheckedContentDescription` <br /> `getUncheckedContentDescription()`                         | Returns the unchecked content description of the icon       | `String?` |
 | `.uncheckedContentDescription = String?` <br /> `setUncheckedContentDescription(value: String?)` | Sets the unchecked content description of the icon          | -         |
+| `.checkedTooltipText` <br /> `getCheckedTooltipText()`                                           | Returns the checked tooltip text of the icon                | `String?` |
+| `.checkedTooltipText = String?` <br /> `setCheckedTooltipText(value: String?)`                   | Sets the checked tooltip text of the icon                   | -         |
+| `.uncheckedTooltipText` <br /> `getUncheckedTooltipText()`                                       | Returns the unchecked tooltip text of the icon              | `String?` |
+| `.uncheckedTooltipText = String?` <br /> `setUncheckedTooltipText(value: String?)`               | Sets the unchecked tooltip text of the icon                 | -         |
 
 ### Events
 

diff --git a/lib/src/main/java/og/android/lib/toggleiconview/ToggleIconView.kt b/lib/src/main/java/og/android/lib/toggleiconview/ToggleIconView.kt
@@ -17,6 +17,9 @@ abstract class ToggleIconView @JvmOverloads constructor(
     private var mCheckedContentDescription: String? = null
     private var mUncheckedContentDescription: String? = null
 
+    private var mCheckedTooltipText: String? = null
+    private var mUncheckedTooltipText: String? = null
+
     private var mIsChecked: Boolean = false
 
     private var mOnCheckedChangeListener: ((view: ToggleIconView, isChecked: Boolean) -> Unit)? = null
@@ -70,6 +73,14 @@ abstract class ToggleIconView @JvmOverloads constructor(
         }
     }
 
+    private fun setTooltipTextByCheckState(isChecked: Boolean) {
+        tooltipText = if (isChecked) {
+            mCheckedTooltipText
+        } else {
+            mUncheckedTooltipText
+        }
+    }
+
     private fun handleAttributes(attrs: AttributeSet? = null, defStyleAttr: Int = 0) {
         val typedArray = context.theme.obtainStyledAttributes(attrs, R.styleable.ToggleIconView, defStyleAttr, 0)
 
@@ -85,7 +96,16 @@ abstract class ToggleIconView @JvmOverloads constructor(
             val uncheckedContentDescription = typedArray.getString(R.styleable.ToggleIconView_uncheckedContentDescription)
             mUncheckedContentDescription = uncheckedContentDescription
 
+            // app:checkedTooltipText
+            val checkedTooltipText = typedArray.getString(R.styleable.ToggleIconView_checkedTooltipText)
+            mCheckedTooltipText = checkedTooltipText
+
+            // app:uncheckedTooltipText
+            val uncheckedTooltipText = typedArray.getString(R.styleable.ToggleIconView_uncheckedTooltipText)
+            mUncheckedTooltipText = uncheckedTooltipText
+
             setContentDescriptionByCheckState(checked)
+            setTooltipTextByCheckState(checked)
             handleCheckState(checked)
         } finally {
             typedArray.recycle()
@@ -116,6 +136,18 @@ abstract class ToggleIconView @JvmOverloads constructor(
             mUncheckedContentDescription = value
         }
 
+    var checkedTooltipText: String?
+        get() = mCheckedTooltipText
+        set(value) {
+            mCheckedTooltipText = value
+        }
+
+    var uncheckedTooltipText: String?
+        get() = mUncheckedTooltipText
+        set(value) {
+            mUncheckedTooltipText = value
+        }
+
     var isChecked: Boolean
         get() = mIsChecked
         set(isChecked) {
@@ -126,6 +158,7 @@ abstract class ToggleIconView @JvmOverloads constructor(
             }
 
             setContentDescriptionByCheckState(isChecked)
+            setTooltipTextByCheckState(isChecked)
             handleCheckState(isChecked)
             invokeOnCheckedChangeListener(isChecked)
         }

diff --git a/lib/src/main/res/values/attrs.xml b/lib/src/main/res/values/attrs.xml
@@ -4,5 +4,7 @@
         <attr name="checked" format="boolean" />
         <attr name="checkedContentDescription" format="string" />
         <attr name="uncheckedContentDescription" format="string" />
+        <attr name="checkedTooltipText" format="string" />
+        <attr name="uncheckedTooltipText" format="string" />
     </declare-styleable>
 </resources>
diff --git a/sample/src/main/res/layout/activity_main.xml b/sample/src/main/res/layout/activity_main.xml
@@ -52,7 +52,9 @@
                     <og.android.lib.toggleiconview.sharp.PlayPause
                         style="@style/DemoIcon"
                         app:checkedContentDescription="Playing..."
-                        app:uncheckedContentDescription="Paused" />
+                        app:checkedTooltipText="Playing..."
+                        app:uncheckedContentDescription="Paused"
+                        app:uncheckedTooltipText="Paused" />
                 </LinearLayout>
 
                 <LinearLayout
@@ -69,7 +71,9 @@
                     <og.android.lib.toggleiconview.rounded.PlayPause
                         style="@style/DemoIcon"
                         app:checkedContentDescription="Playing..."
-                        app:uncheckedContentDescription="Paused" />
+                        app:checkedTooltipText="Playing..."
+                        app:uncheckedContentDescription="Paused"
+                        app:uncheckedTooltipText="Paused" />
                 </LinearLayout>
             </LinearLayout>
         </LinearLayout>