Merge pull request getodk#5971 from seadowg/saved-form-select

Retain selection when rotating delete saved forms

Author: seadowg

androidshared/build.gradle.kts

@@ -59,6 +59,7 @@ dependencies {
     implementation(Dependencies.play_services_location)
 
     testImplementation(project(":test-shared"))
+    testImplementation(project(":androidtest"))
     testImplementation(Dependencies.junit)
     testImplementation(Dependencies.androidx_test_ext_junit)
     testImplementation(Dependencies.androidx_test_espresso_core)

androidshared/src/main/java/org/odk/collect/androidshared/data/AppState.kt

@@ -8,6 +8,8 @@ import androidx.fragment.app.Fragment
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.MutableStateFlow
 
 /**
  * [AppState] can be used as a shared store of state that lives at an "app"/"in-memory" level
@@ -50,6 +52,10 @@ class AppState {
         return get(key, MutableLiveData(default))
     }
 
+    fun <T> getFlow(key: String, default: T): Flow<T> {
+        return get(key, MutableStateFlow(default))
+    }
+
     fun set(key: String, value: Any?) {
         map[key] = value
     }
@@ -58,6 +64,16 @@ class AppState {
         get(key, MutableLiveData<T>()).postValue(value)
     }
 
+    fun <T> setFlow(key: String, value: T) {
+        get<MutableStateFlow<T>>(key).let {
+            if (it != null) {
+                it.value = value
+            } else {
+                map[key] = MutableStateFlow(value)
+            }
+        }
+    }
+
     fun clear() {
         map.clear()
     }

androidshared/src/main/java/org/odk/collect/androidshared/livedata/LiveDataUtils.java

@@ -14,6 +14,7 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
+import kotlin.Pair;
 import kotlin.Triple;
 
 public class LiveDataUtils {
@@ -54,6 +55,13 @@ public static <T> LiveData<T> liveDataOf(T value) {
         return new MutableLiveData<>(value);
     }
 
+    public static <T, U> LiveData<Pair<T, U>> zip(LiveData<T> one, LiveData<U> two) {
+        return new ZippedLiveData<>(
+                new LiveData[]{one, two},
+                values -> new Pair<>((T) values[0], (U) values[1])
+        );
+    }
+
     public static <T, U, V> LiveData<Triple<T, U, V>> zip3(LiveData<T> one, LiveData<U> two, LiveData<V> three) {
         return new ZippedLiveData<>(
                 new LiveData[]{one, two, three},

…k/collect/android/views/EmptyListView.kt …ollect/androidshared/ui/EmptyListView.ktcollect_app/src/main/java/org/odk/collect/android/views/EmptyListView.kt renamed to androidshared/src/main/java/org/odk/collect/androidshared/ui/EmptyListView.kt collect_app/src/main/java/org/odk/collect/android/views/EmptyListView.kt renamed to androidshared/src/main/java/org/odk/collect/androidshared/ui/EmptyListView.kt

@@ -1,12 +1,12 @@
-package org.odk.collect.android.views
+package org.odk.collect.androidshared.ui
 
 import android.content.Context
 import android.util.AttributeSet
 import android.view.LayoutInflater
 import android.widget.FrameLayout
 import androidx.annotation.DrawableRes
-import org.odk.collect.android.R
-import org.odk.collect.android.databinding.EmptyListViewBinding
+import org.odk.collect.androidshared.R
+import org.odk.collect.androidshared.databinding.EmptyListViewBinding
 
 class EmptyListView(context: Context, attrs: AttributeSet?) : FrameLayout(context, attrs) {
     constructor(context: Context) : this(context, null)

androidshared/src/main/java/org/odk/collect/androidshared/ui/ListFragmentStateAdapter.kt

@@ -0,0 +1,24 @@
+package org.odk.collect.androidshared.ui
+
+import androidx.fragment.app.Fragment
+import androidx.fragment.app.FragmentActivity
+import androidx.viewpager2.adapter.FragmentStateAdapter
+
+class ListFragmentStateAdapter(
+    activity: FragmentActivity,
+    private val fragments: List<Class<out Fragment>>
+) : FragmentStateAdapter(activity) {
+
+    private val fragmentFactory = activity.supportFragmentManager.fragmentFactory
+
+    override fun createFragment(position: Int): Fragment {
+        return fragmentFactory.instantiate(
+            Thread.currentThread().contextClassLoader,
+            fragments[position].name
+        )
+    }
+
+    override fun getItemCount(): Int {
+        return fragments.size
+    }
+}

androidshared/src/main/java/org/odk/collect/androidshared/ui/MultiSelectViewModel.kt

@@ -0,0 +1,17 @@
+package org.odk.collect.androidshared.ui
+
+import android.content.Context
+import androidx.core.content.ContextCompat
+import androidx.recyclerview.widget.DividerItemDecoration
+import org.odk.collect.androidshared.R
+
+object RecyclerViewUtils {
+
+    fun verticalLineDivider(context: Context): DividerItemDecoration {
+        val itemDecoration = DividerItemDecoration(context, DividerItemDecoration.VERTICAL)
+        val drawable = ContextCompat.getDrawable(context, R.drawable.list_item_divider)!!
+        itemDecoration.setDrawable(drawable)
+
+        return itemDecoration
+    }
+}

androidshared/src/main/java/org/odk/collect/androidshared/ui/RecyclerViewUtils.kt

@@ -133,12 +133,12 @@ object SnackbarUtils {
     data class Action(val text: String, val listener: () -> Unit)
 
     abstract class SnackbarPresenterObserver<T : Any?>(private val parentView: View) :
-        Observer<Consumable<T>> {
+        Observer<Consumable<T>?> {
 
         abstract fun getSnackbarDetails(value: T): SnackbarDetails
 
-        override fun onChanged(consumable: Consumable<T>) {
-            if (!consumable.isConsumed()) {
+        override fun onChanged(consumable: Consumable<T>?) {
+            if (consumable != null && !consumable.isConsumed()) {
                 showLongSnackbar(parentView, getSnackbarDetails(consumable.value))
                 consumable.consume()
             }

androidshared/src/main/java/org/odk/collect/androidshared/ui/SnackbarUtils.kt

@@ -0,0 +1,59 @@
+package org.odk.collect.androidshared.ui.multiselect
+
+import android.view.View
+import android.view.ViewGroup
+import android.widget.CheckBox
+import androidx.recyclerview.widget.RecyclerView
+
+/**
+ * An adapter for creating multi select lists with `MultiSelectViewModel` and `RecyclerView`.
+ */
+class MultiSelectAdapter<T, VH : MultiSelectAdapter.ViewHolder<T>>(
+    private val multiSelectViewModel: MultiSelectViewModel<*>,
+    private val viewHolderFactory: (ViewGroup) -> VH
+) : RecyclerView.Adapter<VH>() {
+
+    var selected: Set<Long> = emptySet()
+        set(value) {
+            field = value
+            notifyDataSetChanged()
+        }
+
+    var data = emptyList<MultiSelectItem<T>>()
+        set(value) {
+            field = value.toList()
+            notifyDataSetChanged()
+        }
+
+    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): VH {
+        return viewHolderFactory(parent)
+    }
+
+    override fun onBindViewHolder(holder: VH, position: Int) {
+        val item = data[position]
+        holder.setItem(item.item)
+
+        val checkbox = holder.getCheckbox().also {
+            it.isChecked = selected.contains(item.id)
+            it.setOnClickListener {
+                multiSelectViewModel.toggle(item.id)
+            }
+        }
+
+        holder.getSelectArea().setOnClickListener {
+            checkbox.performClick()
+        }
+    }
+
+    override fun getItemCount(): Int {
+        return data.size
+    }
+
+    abstract class ViewHolder<T>(view: View) : RecyclerView.ViewHolder(view) {
+        abstract fun setItem(item: T)
+        abstract fun getCheckbox(): CheckBox
+        open fun getSelectArea(): View {
+            return itemView
+        }
+    }
+}

androidshared/src/main/java/org/odk/collect/androidshared/ui/multiselect/MultiSelectAdapter.kt

@@ -0,0 +1,126 @@
+package org.odk.collect.androidshared.ui.multiselect
+
+import android.content.Context
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import android.widget.FrameLayout
+import androidx.fragment.app.Fragment
+import org.odk.collect.androidshared.databinding.MultiSelectControlsLayoutBinding
+
+/**
+ * A control UI for performing "select all" and "clear all" on multi select lists using
+ * `MultiSelectViewModel`. Also supports an action that's text can be defined (via the
+ * constructor) and can be reacted to by responding to the `"action"` Fragment result.
+ */
+class MultiSelectControlsFragment(
+    private val actionText: String,
+    private val multiSelectViewModel: MultiSelectViewModel<*>
+) : Fragment() {
+
+    override fun onCreateView(
+        inflater: LayoutInflater,
+        container: ViewGroup?,
+        savedInstanceState: Bundle?
+    ): View {
+        return MultiSelectControlsView(requireContext())
+    }
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        val controls = view as MultiSelectControlsView
+
+        controls.actionText = actionText
+
+        multiSelectViewModel.getSelected().observe(viewLifecycleOwner) {
+            controls.selected = it
+        }
+
+        multiSelectViewModel.isAllSelected().observe(viewLifecycleOwner) {
+            controls.isAllSelected = it
+        }
+
+        controls.listener = object : MultiSelectControlsView.Listener {
+            override fun onSelectAll() {
+                multiSelectViewModel.selectAll()
+            }
+
+            override fun onClearAll() {
+                multiSelectViewModel.unselectAll()
+            }
+
+            override fun onAction(selected: Set<Long>) {
+                parentFragmentManager.setFragmentResult(
+                    REQUEST_ACTION,
+                    Bundle().apply {
+                        putLongArray(
+                            RESULT_SELECTED,
+                            selected.toLongArray()
+                        )
+                    }
+                )
+            }
+        }
+    }
+
+    companion object {
+        const val REQUEST_ACTION = "action"
+        const val RESULT_SELECTED = "selected"
+    }
+}
+
+private class MultiSelectControlsView(context: Context) :
+    FrameLayout(context) {
+
+    var selected = emptySet<Long>()
+        set(value) {
+            field = value
+            render()
+        }
+
+    var isAllSelected = false
+        set(value) {
+            field = value
+            render()
+        }
+
+    var listener: Listener? = null
+    var actionText: String = ""
+        set(value) {
+            field = value
+            render()
+        }
+
+    private val binding =
+        MultiSelectControlsLayoutBinding.inflate(LayoutInflater.from(context), this, true)
+
+    init {
+        render()
+    }
+
+    private fun render() {
+        if (isAllSelected) {
+            binding.selectAll.setText(org.odk.collect.strings.R.string.clear_all)
+            binding.selectAll.setOnClickListener {
+                listener?.onClearAll()
+            }
+        } else {
+            binding.selectAll.setText(org.odk.collect.strings.R.string.select_all)
+            binding.selectAll.setOnClickListener {
+                listener?.onSelectAll()
+            }
+        }
+
+        binding.action.text = actionText
+        binding.action.isEnabled = selected.isNotEmpty()
+        binding.action.setOnClickListener {
+            listener?.onAction(selected)
+        }
+    }
+
+    interface Listener {
+        fun onSelectAll()
+        fun onClearAll()
+        fun onAction(selected: Set<Long>)
+    }
+}