Merge pull request #8 from ozgurg/dev

release: v2.1.1

Author: ozgurg

.gitignore

@@ -73,3 +73,5 @@ lint/generated/
 lint/outputs/
 lint/tmp/
 # lint/reports/
+
+.DS_Store

README.md

@@ -11,7 +11,7 @@ ToggleIconView is a collection library of animated two-stage toggle icons for An
 ### JitPack repository
 
 ```gradle
-// build.gradle Project
+// Project level build.gradle
 allprojects {
     repositories {
         ...
@@ -23,7 +23,7 @@ allprojects {
 If the above doesn't work, try the following:
 
 ```gradle
-// settings.gradle Project
+// settings.gradle
 ...
 dependencyResolutionManagement {
     ...
@@ -37,9 +37,9 @@ dependencyResolutionManagement {
 
 ### Implementation
 ```gradle
-// build.gradle App
+// App level build.gradle
 dependencies {
-    implementation "com.github.ozgurg:ToggleIconView:2.1.0"
+    implementation "com.github.ozgurg:ToggleIconView:2.1.1"
 }
 ```
 
@@ -75,7 +75,7 @@ anything you can with `AppCompatImageView`.
 
 | Event                                                                  | Description                                        |
 |------------------------------------------------------------------------|----------------------------------------------------|
-| `onCheckedChanged(toggleIconView: ToggleIconView, isChecked: Boolean)` | Triggers when the ticked state of the icon changed |
+| `onCheckedChanged(toggleIconView: ToggleIconView, isChecked: Boolean)` | Triggers when the checked state of the icon changed |
 
 ## Built-in icons
 

lib/build.gradle

@@ -39,7 +39,7 @@ afterEvaluate {
 
                 groupId = "com.github.ozgurg"
                 artifactId = "toggle-icon-view"
-                version = "2.1.0"
+                version = "2.1.1"
             }
         }
     }

lib/src/main/java/og/android/lib/toggleiconview/ToggleIconView.kt

@@ -2,83 +2,88 @@ package og.android.lib.toggleiconview
 
 import android.content.Context
 import android.util.AttributeSet
+import androidx.annotation.DrawableRes
 import androidx.appcompat.widget.AppCompatImageView
 import androidx.vectordrawable.graphics.drawable.AnimatedVectorDrawableCompat
 
 abstract class ToggleIconView @JvmOverloads constructor(
     context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0,
-    checkedDrawableRes: Int,
-    uncheckedDrawableRes: Int,
+    @DrawableRes checkedDrawableResId: Int,
+    @DrawableRes uncheckedDrawableResId: Int,
 ) : AppCompatImageView(context, attrs, defStyleAttr) {
-    private var onCheckedChangeListener: ((toggleIconView: ToggleIconView, isChecked: Boolean) -> Unit)? =
-        null
+    private lateinit var checkedDrawable: AnimatedVectorDrawableCompat
+    private lateinit var uncheckedDrawable: AnimatedVectorDrawableCompat
 
-    private var checkedDrawable: AnimatedVectorDrawableCompat? = null
-    private var uncheckedDrawable: AnimatedVectorDrawableCompat? = null
-    private var isChecked = false
+    private var isChecked: Boolean = false
+    private var onCheckedChangeListener: ((toggleIconView: ToggleIconView, isChecked: Boolean) -> Unit)? = null
 
     init {
-        setCheckedDrawable(checkedDrawableRes)
-        setUncheckedDrawable(uncheckedDrawableRes)
+        setCheckedDrawable(checkedDrawableResId)
+        setUncheckedDrawable(uncheckedDrawableResId)
         handleAttributes(attrs, defStyleAttr)
     }
 
-    fun toggle() {
-        setChecked(!isChecked)
+    private fun setCheckedDrawable(@DrawableRes drawableResId: Int) {
+        checkedDrawable = AnimatedVectorDrawableCompat.create(context, drawableResId)!!
     }
 
-    fun isChecked(): Boolean {
-        return isChecked
+    private fun setUncheckedDrawable(@DrawableRes drawableResId: Int) {
+        uncheckedDrawable = AnimatedVectorDrawableCompat.create(context, drawableResId)!!
     }
 
-    fun setChecked(checked: Boolean) {
-        handleCheckState(checked)
-        isChecked = checked
-
-        onCheckedChangeListener?.invoke(this, checked)
-    }
-
-    interface OnCheckedChangeListener {
-        fun onCheckedChanged(toggleIconView: ToggleIconView, isChecked: Boolean)
-    }
-
-    private fun handleCheckedState() {
+    private fun setAndAnimateCheckedDrawable() {
         setImageDrawable(checkedDrawable)
-        checkedDrawable!!.start()
+        checkedDrawable.start()
     }
 
-    private fun handleUncheckedState() {
+    private fun setAndAnimateUncheckedDrawable() {
         setImageDrawable(uncheckedDrawable)
-        uncheckedDrawable!!.start()
+        uncheckedDrawable.start()
     }
 
-    private fun handleCheckState(checked: Boolean) {
+    private fun setAndAnimateDrawableByCheckState(checked: Boolean) {
         if (checked) {
-            handleCheckedState()
+            setAndAnimateCheckedDrawable()
         } else {
-            handleUncheckedState()
+            setAndAnimateUncheckedDrawable()
         }
     }
 
+    private fun handleCheckState(checked: Boolean) {
+        setAndAnimateDrawableByCheckState(checked)
+        isChecked = checked
+    }
+
     private fun handleAttributes(attrs: AttributeSet? = null, defStyleAttr: Int = 0) {
-        val typedArray =
-            context.theme.obtainStyledAttributes(attrs, R.styleable.ToggleIconView, defStyleAttr, 0)
+        val typedArray = context.theme.obtainStyledAttributes(attrs, R.styleable.ToggleIconView, defStyleAttr, 0)
 
         try {
             // app:checked
             val checked = typedArray.getBoolean(R.styleable.ToggleIconView_checked, isChecked)
-            setChecked(checked)
+
+            handleCheckState(checked)
         } finally {
             typedArray.recycle()
         }
     }
 
-    private fun setCheckedDrawable(checkedDrawableRes: Int) {
-        checkedDrawable = AnimatedVectorDrawableCompat.create(context, checkedDrawableRes)
+    fun toggle() {
+        setChecked(!isChecked)
     }
 
-    private fun setUncheckedDrawable(uncheckedDrawableRes: Int) {
-        uncheckedDrawable = AnimatedVectorDrawableCompat.create(context, uncheckedDrawableRes)
+    fun isChecked(): Boolean {
+        return isChecked
+    }
+
+    fun setChecked(checked: Boolean) {
+        // We won't update the status if the status is the same as the current status
+        // This is to prevent the animation from restarting when the state is set again
+        if (checked == isChecked) {
+            return
+        }
+
+        handleCheckState(checked)
+        onCheckedChangeListener?.invoke(this, checked)
     }
 
     open fun setOnCheckedChangeListener(listener: (toggleIconView: ToggleIconView, isChecked: Boolean) -> Unit) {