Add auto sort checked items by checked timestamp

Crustack · Crustack · commit ea0f2c93b669 · 2026-03-15T14:39:39.000+01:00
diff --git a/app/src/main/java/com/philkes/notallyx/data/model/Converters.kt b/app/src/main/java/com/philkes/notallyx/data/model/Converters.kt
@@ -120,7 +120,15 @@ object Converters {
             val checked = jsonObject.getSafeBoolean("checked")
             val isChild = jsonObject.getSafeBoolean("isChild")
             val order = jsonObject.getSafeInt("order")
-            ListItem(body, checked, isChild, order, mutableListOf())
+            val checkedTimestamp = jsonObject.getSafeLong("checkedTimestamp")
+            ListItem(
+                body,
+                checked,
+                isChild,
+                order,
+                mutableListOf(),
+                checkedTimestamp = checkedTimestamp,
+            )
         }
     }
 
@@ -134,6 +142,7 @@ object Converters {
                 jsonObject.put("checked", item.checked)
                 jsonObject.put("isChild", item.isChild)
                 jsonObject.put("order", item.order)
+                jsonObject.put("checkedTimestamp", item.checkedTimestamp)
             }
         return JSONArray(objects)
     }
diff --git a/app/src/main/java/com/philkes/notallyx/data/model/ListItem.kt b/app/src/main/java/com/philkes/notallyx/data/model/ListItem.kt
@@ -7,6 +7,7 @@ data class ListItem(
     var order: Int?,
     var children: MutableList<ListItem>,
     var id: Int = -1,
+    var checkedTimestamp: Long? = null,
 ) : Cloneable {
 
     public override fun clone(): Any {
@@ -18,26 +19,33 @@ data class ListItem(
             order,
             children.map { it.clone() as ListItem }.toMutableList(),
             id,
+            checkedTimestamp,
         )
     }
 
     override fun equals(other: Any?): Boolean {
-        if (this == null && other == null) {
+        if (this === other) {
             return true
         }
-        if (this != null && other == null) {
-            return false
-        }
-        if (this == null && other != null) {
-            return false
-        }
         if (other !is ListItem) {
             return false
         }
         return (this.body == other.body &&
             this.order == other.order &&
             this.checked == other.checked &&
-            this.isChild == other.isChild)
+            this.isChild == other.isChild &&
+            this.checkedTimestamp == other.checkedTimestamp)
+    }
+
+    override fun hashCode(): Int {
+        var result = body.hashCode()
+        result = 31 * result + checked.hashCode()
+        result = 31 * result + isChild.hashCode()
+        result = 31 * result + (order ?: 0)
+        result = 31 * result + children.hashCode()
+        result = 31 * result + id
+        result = 31 * result + (checkedTimestamp?.hashCode() ?: 0)
+        return result
     }
 
     val itemCount: Int
diff --git a/app/src/main/java/com/philkes/notallyx/data/model/ListItemExtensions.kt b/app/src/main/java/com/philkes/notallyx/data/model/ListItemExtensions.kt
@@ -12,8 +12,13 @@ fun ListItem.findChild(childId: Int): ListItem? {
 
 fun ListItem.check(checked: Boolean, checkChildren: Boolean = true) {
     this.checked = checked
+    val checkedTimestamp = if (checked) System.currentTimeMillis() else null
+    this.checkedTimestamp = checkedTimestamp
     if (checkChildren) {
-        this.children.forEach { child -> child.checked = checked }
+        this.children.forEach { child ->
+            child.checked = checked
+            child.checkedTimestamp = checkedTimestamp
+        }
     }
 }
 
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/note/EditActivity.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/note/EditActivity.kt
@@ -71,12 +71,12 @@ import com.philkes.notallyx.presentation.view.note.preview.PreviewImageAdapter
 import com.philkes.notallyx.presentation.viewmodel.NotallyModel
 import com.philkes.notallyx.presentation.viewmodel.preference.DateFormat
 import com.philkes.notallyx.presentation.viewmodel.preference.EditAction
-import com.philkes.notallyx.presentation.viewmodel.preference.ListItemSort
 import com.philkes.notallyx.presentation.viewmodel.preference.NotallyXPreferences
 import com.philkes.notallyx.presentation.viewmodel.preference.NotesSortBy
 import com.philkes.notallyx.presentation.viewmodel.preference.displaySmallerSize
 import com.philkes.notallyx.presentation.viewmodel.preference.editBodySize
 import com.philkes.notallyx.presentation.viewmodel.preference.editTitleSize
+import com.philkes.notallyx.presentation.viewmodel.preference.isAutoSortChecked
 import com.philkes.notallyx.presentation.widget.WidgetProvider
 import com.philkes.notallyx.utils.FileError
 import com.philkes.notallyx.utils.changeStatusAndNavigationBarColor
@@ -925,9 +925,7 @@ abstract class EditActivity(private val type: Type) : LockedActivity<ActivityEdi
             Type.LIST -> {
                 binding.EnterBody.visibility = GONE
                 binding.CheckedListView.visibility =
-                    if (preferences.listItemSorting.value == ListItemSort.AUTO_SORT_BY_CHECKED)
-                        VISIBLE
-                    else GONE
+                    if (preferences.listItemSorting.value.isAutoSortChecked) VISIBLE else GONE
             }
         }
 
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/note/EditListActivity.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/note/EditListActivity.kt
@@ -19,12 +19,12 @@ import com.philkes.notallyx.presentation.view.note.listitem.adapter.ListItemHigh
 import com.philkes.notallyx.presentation.view.note.listitem.adapter.ListItemVH
 import com.philkes.notallyx.presentation.view.note.listitem.init
 import com.philkes.notallyx.presentation.view.note.listitem.setItems
-import com.philkes.notallyx.presentation.view.note.listitem.sorting.ListItemParentSortCallback
 import com.philkes.notallyx.presentation.view.note.listitem.sorting.SortedItemsList
 import com.philkes.notallyx.presentation.view.note.listitem.splitByChecked
 import com.philkes.notallyx.presentation.view.note.listitem.toMutableList
 import com.philkes.notallyx.presentation.viewmodel.preference.NotallyXPreferences
 import com.philkes.notallyx.presentation.viewmodel.preference.autoSortByCheckedEnabled
+import com.philkes.notallyx.presentation.viewmodel.preference.callback
 import com.philkes.notallyx.utils.findAllOccurrences
 import com.philkes.notallyx.utils.indices
 import com.philkes.notallyx.utils.mapIndexed
@@ -260,9 +260,8 @@ class EditListActivity : EditActivity(Type.LIST) {
                     binding.ScrollView,
                 )
             itemsChecked =
-                SortedItemsList(ListItemParentSortCallback(adapterChecked!!)).apply {
-                    setItems(checkedItems.toMutableList())
-                }
+                SortedItemsList(preferences.listItemSorting.value.callback(adapterChecked!!))
+                    .apply { setItems(checkedItems.toMutableList()) }
             adapterChecked?.setList(itemsChecked!!)
             binding.CheckedListView.adapter = adapterChecked
         } else {
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/ListManager.kt b/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/ListManager.kt
@@ -68,7 +68,7 @@ class ListManager(
         this.checkedAdapter = adapterChecked
         nextItemId = this.items.size + (this.itemsChecked?.size() ?: 0)
         Log.d(TAG, "initList:\n${this.items.toReadableString()}")
-        this.itemsChecked?.let { Log.d(TAG, "itemsChecked:\n${it}") }
+        this.itemsChecked?.let { Log.d(TAG, "itemsChecked:\n${it.toReadableString()}") }
     }
 
     internal fun getState(selectedPos: Int? = null): ListState {
@@ -458,6 +458,7 @@ class ListManager(
     ) {
         if (checked) {
             child.checked = true
+            child.checkedTimestamp = System.currentTimeMillis()
             adapter.notifyItemChanged(position)
             val (_, parent) = items.findParent(child)!!
             parent.updateParentChecked()
@@ -466,6 +467,7 @@ class ListManager(
                 uncheckWithAutoSort(child)
             } else {
                 child.checked = false
+                child.checkedTimestamp = null
                 adapter.notifyItemChanged(position)
                 checkParent(child, false)
             }
@@ -529,6 +531,7 @@ class ListManager(
         val (parentPos, parent) = items.findParent(item)!!
         if (parent.checked != checked) {
             parent.checked = checked
+            parent.checkedTimestamp = if (checked) System.currentTimeMillis() else null
             adapter.notifyItemChanged(parentPos)
         }
     }
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/adapter/ListItemVH.kt b/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/adapter/ListItemVH.kt
@@ -32,6 +32,7 @@ import com.philkes.notallyx.presentation.view.note.listitem.ListManager
 import com.philkes.notallyx.presentation.view.note.listitem.firstBodyOrEmptyString
 import com.philkes.notallyx.presentation.viewmodel.preference.ListItemSort
 import com.philkes.notallyx.presentation.viewmodel.preference.editBodySize
+import com.philkes.notallyx.presentation.viewmodel.preference.isAutoSortChecked
 import com.philkes.notallyx.utils.changehistory.EditTextState
 import com.philkes.notallyx.utils.copyToClipBoard
 import com.philkes.notallyx.utils.textMaxLengthFilter
@@ -105,7 +106,7 @@ class ListItemVH(
             visibility =
                 when {
                     viewMode != NoteViewMode.EDIT -> GONE
-                    item.checked && autoSort == ListItemSort.AUTO_SORT_BY_CHECKED -> INVISIBLE
+                    item.checked && autoSort.isAutoSortChecked -> INVISIBLE
                     else -> VISIBLE
                 }
             contentDescription = "Drag$position"
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/sorting/ListItemCheckedTimestampSortCallback.kt b/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/sorting/ListItemCheckedTimestampSortCallback.kt
@@ -0,0 +1,24 @@
+package com.philkes.notallyx.presentation.view.note.listitem.sorting
+
+import androidx.recyclerview.widget.RecyclerView
+import com.philkes.notallyx.data.model.ListItem
+
+/**
+ * Sort algorithm that only sorts by [ListItem.checkedTimestamp]. A children is always below it's
+ * parent and above parents with a lower order.
+ */
+class ListItemCheckedTimestampSortCallback(adapter: RecyclerView.Adapter<*>?) :
+    ListItemParentSortCallback(adapter) {
+
+    override fun compareItems(item1: ListItem, item2: ListItem): Int {
+        return (item2.checkedTimestamp ?: 0L).compareTo(item1.checkedTimestamp ?: 0L)
+    }
+
+    override fun areContentsTheSame(oldItem: ListItem?, newItem: ListItem?): Boolean {
+        return oldItem == newItem
+    }
+
+    override fun areItemsTheSame(item1: ListItem?, item2: ListItem?): Boolean {
+        return item1?.id == item2?.id
+    }
+}
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/sorting/ListItemParentSortCallback.kt b/app/src/main/java/com/philkes/notallyx/presentation/view/note/listitem/sorting/ListItemParentSortCallback.kt
@@ -11,10 +11,10 @@ import com.philkes.notallyx.presentation.view.note.listitem.findParent
  * Sort algorithm that only sorts by [ListItem.order]. A children is always below it's parent and
  * above parents with a lower order.
  */
-class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :
+open class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :
     SortedListAdapterCallback<ListItem>(adapter) {
 
-    private var items: SortedList<ListItem>? = null
+    protected var items: SortedList<ListItem>? = null
 
     internal fun setItems(items: SortedList<ListItem>) {
         this.items = items
@@ -34,7 +34,7 @@ class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :
                         items!!.findParent(item2)!!.second
                     }
                 return when {
-                    item1.id == parent2.id -> compareOrder(item1, item2)
+                    item1.id == parent2.id -> compareItems(item1, item2)
                     else -> compare(item1, parent2)
                 }
             }
@@ -47,17 +47,17 @@ class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :
                         items!!.findParent(item1)!!.second
                     }
                 when {
-                    item2.id == parent1.id -> compareOrder(item1, item2)
+                    item2.id == parent1.id -> compareItems(item1, item2)
                     else -> compare(parent1, item2)
                 }
             }
             else -> {
-                return compareOrder(item1, item2)
+                return compareItems(item1, item2)
             }
         }
     }
 
-    private fun compareOrder(item1: ListItem, item2: ListItem): Int {
+    protected open fun compareItems(item1: ListItem, item2: ListItem): Int {
         val orderCmp = item1.order!!.compareTo(item2.order!!)
         if (orderCmp == 0 && item1.isChildOf(item2)) {
             return -1 // happens when a parent with children is moved up, the children is
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/viewmodel/preference/NotallyXPreferences.kt b/app/src/main/java/com/philkes/notallyx/presentation/viewmodel/preference/NotallyXPreferences.kt
@@ -341,4 +341,4 @@ class NotallyXPreferences private constructor(private val context: Context) {
 }
 
 val NotallyXPreferences.autoSortByCheckedEnabled
-    get() = listItemSorting.value == ListItemSort.AUTO_SORT_BY_CHECKED
+    get() = listItemSorting.value.isAutoSortChecked
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/viewmodel/preference/Preference.kt b/app/src/main/java/com/philkes/notallyx/presentation/viewmodel/preference/Preference.kt
@@ -15,6 +15,9 @@ import com.philkes.notallyx.data.model.Type
 import com.philkes.notallyx.presentation.format
 import com.philkes.notallyx.presentation.merge
 import com.philkes.notallyx.presentation.view.misc.NotNullLiveData
+import com.philkes.notallyx.presentation.view.note.listitem.adapter.CheckedListItemAdapter
+import com.philkes.notallyx.presentation.view.note.listitem.sorting.ListItemCheckedTimestampSortCallback
+import com.philkes.notallyx.presentation.view.note.listitem.sorting.ListItemParentSortCallback
 import com.philkes.notallyx.utils.createObserverSkipFirst
 import com.philkes.notallyx.utils.deserializeEnums
 import com.philkes.notallyx.utils.fromCamelCaseToEnumName
@@ -386,8 +389,21 @@ val TextSizeSp.displayTitleSize: Float
 enum class ListItemSort(override val textResId: Int) : StaticTextProvider {
     NO_AUTO_SORT(R.string.no_auto_sort),
     AUTO_SORT_BY_CHECKED(R.string.auto_sort_by_checked),
+    AUTO_SORT_BY_CHECKED_TIMESTAMP(R.string.auto_sort_by_checked_timestamp),
 }
 
+val ListItemSort.isAutoSortChecked
+    get() =
+        this in
+            setOf(ListItemSort.AUTO_SORT_BY_CHECKED, ListItemSort.AUTO_SORT_BY_CHECKED_TIMESTAMP)
+
+fun ListItemSort.callback(adapterChecked: CheckedListItemAdapter) =
+    when (this) {
+        ListItemSort.AUTO_SORT_BY_CHECKED_TIMESTAMP ->
+            ListItemCheckedTimestampSortCallback(adapterChecked)
+        else -> ListItemParentSortCallback(adapterChecked)
+    }
+
 enum class BiometricLock(override val textResId: Int) : StaticTextProvider {
     ENABLED(R.string.enabled),
     DISABLED(R.string.disabled);
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -36,6 +36,7 @@
     <string name="auto_remove_deleted_notes_hint">By enabling this, Notes that were deleted will be permanently removed after X days</string>
     <string name="auto_save_after_idle_time">Auto save note after specified idle time</string>
     <string name="auto_sort_by_checked">Sort checked items to the end</string>
+    <string name="auto_sort_by_checked_timestamp">Sort checked items by checked time</string>
     <string name="back">Back</string>
     <string name="backup">Backup</string>
     <string name="backup_password">Backup Password</string>
diff --git a/app/src/test/kotlin/com/philkes/notallyx/recyclerview/listmanager/ListManagerCheckedTest.kt b/app/src/test/kotlin/com/philkes/notallyx/recyclerview/listmanager/ListManagerCheckedTest.kt
diff --git a/app/src/test/kotlin/com/philkes/notallyx/recyclerview/listmanager/ListManagerTestBase.kt b/app/src/test/kotlin/com/philkes/notallyx/recyclerview/listmanager/ListManagerTestBase.kt
diff --git a/app/translations.xlsx b/app/translations.xlsx

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,15 @@ object Converters {`
`120`	`120`	`val checked = jsonObject.getSafeBoolean("checked")`
`121`	`121`	`val isChild = jsonObject.getSafeBoolean("isChild")`
`122`	`122`	`val order = jsonObject.getSafeInt("order")`
`123`		`- ListItem(body, checked, isChild, order, mutableListOf())`
	`123`	`+ val checkedTimestamp = jsonObject.getSafeLong("checkedTimestamp")`
	`124`	`+ ListItem(`
	`125`	`+ body,`
	`126`	`+ checked,`
	`127`	`+ isChild,`
	`128`	`+ order,`
	`129`	`+ mutableListOf(),`
	`130`	`+ checkedTimestamp = checkedTimestamp,`
	`131`	`+ )`
`124`	`132`	`}`
`125`	`133`	`}`
`126`	`134`
`@@ -134,6 +142,7 @@ object Converters {`
`134`	`142`	`jsonObject.put("checked", item.checked)`
`135`	`143`	`jsonObject.put("isChild", item.isChild)`
`136`	`144`	`jsonObject.put("order", item.order)`
	`145`	`+ jsonObject.put("checkedTimestamp", item.checkedTimestamp)`
`137`	`146`	`}`
`138`	`147`	`return JSONArray(objects)`
`139`	`148`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,13 @@ fun ListItem.findChild(childId: Int): ListItem? {`
`12`	`12`
`13`	`13`	`fun ListItem.check(checked: Boolean, checkChildren: Boolean = true) {`
`14`	`14`	`this.checked = checked`
	`15`	`+ val checkedTimestamp = if (checked) System.currentTimeMillis() else null`
	`16`	`+ this.checkedTimestamp = checkedTimestamp`
`15`	`17`	`if (checkChildren) {`
`16`		`- this.children.forEach { child -> child.checked = checked }`
	`18`	`+ this.children.forEach { child ->`
	`19`	`+ child.checked = checked`
	`20`	`+ child.checkedTimestamp = checkedTimestamp`
	`21`	`+ }`
`17`	`22`	`}`
`18`	`23`	`}`
`19`	`24`
Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,10 @@ import com.philkes.notallyx.presentation.view.note.listitem.findParent`
`11`	`11`	`* Sort algorithm that only sorts by [ListItem.order]. A children is always below it's parent and`
`12`	`12`	`* above parents with a lower order.`
`13`	`13`	`*/`
`14`		`-class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :`
	`14`	`+open class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :`
`15`	`15`	`SortedListAdapterCallback<ListItem>(adapter) {`
`16`	`16`
`17`		`- private var items: SortedList<ListItem>? = null`
	`17`	`+ protected var items: SortedList<ListItem>? = null`
`18`	`18`
`19`	`19`	`internal fun setItems(items: SortedList<ListItem>) {`
`20`	`20`	`this.items = items`
`@@ -34,7 +34,7 @@ class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :`
`34`	`34`	`items!!.findParent(item2)!!.second`
`35`	`35`	`}`
`36`	`36`	`return when {`
`37`		`- item1.id == parent2.id -> compareOrder(item1, item2)`
	`37`	`+ item1.id == parent2.id -> compareItems(item1, item2)`
`38`	`38`	`else -> compare(item1, parent2)`
`39`	`39`	`}`
`40`	`40`	`}`
`@@ -47,17 +47,17 @@ class ListItemParentSortCallback(adapter: RecyclerView.Adapter<*>?) :`
`47`	`47`	`items!!.findParent(item1)!!.second`
`48`	`48`	`}`
`49`	`49`	`when {`
`50`		`- item2.id == parent1.id -> compareOrder(item1, item2)`
	`50`	`+ item2.id == parent1.id -> compareItems(item1, item2)`
`51`	`51`	`else -> compare(parent1, item2)`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`	`else -> {`
`55`		`- return compareOrder(item1, item2)`
	`55`	`+ return compareItems(item1, item2)`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`	`}`
`59`	`59`
`60`		`- private fun compareOrder(item1: ListItem, item2: ListItem): Int {`
	`60`	`+ protected open fun compareItems(item1: ListItem, item2: ListItem): Int {`
`61`	`61`	`val orderCmp = item1.order!!.compareTo(item2.order!!)`
`62`	`62`	`if (orderCmp == 0 && item1.isChildOf(item2)) {`
`63`	`63`	`return -1 // happens when a parent with children is moved up, the children is`
Original file line number	Diff line number	Diff line change
`@@ -341,4 +341,4 @@ class NotallyXPreferences private constructor(private val context: Context) {`
`341`	`341`	`}`
`342`	`342`
`343`	`343`	`val NotallyXPreferences.autoSortByCheckedEnabled`
`344`		`- get() = listItemSorting.value == ListItemSort.AUTO_SORT_BY_CHECKED`
	`344`	`+ get() = listItemSorting.value.isAutoSortChecked`