Forms: merge latest FeatureForms to v.next (#380)

* provide public webmap which has forms

* `Forms`: Updated radio button tests (#366)

* updated radio button tests

* added test doc link

* FeatureForm composable KDoc edit (#368)

* slight edits to FeatureForm composable function KDoc.

* Update toolkit/featureforms/src/main/java/com/arcgismaps/toolkit/featureforms/FeatureForm.kt

Co-authored-by: Gunther Heppner <[email protected]>

---------

Co-authored-by: Soren Roth <[email protected]>
Co-authored-by: Gunther Heppner <[email protected]>

* add groups to final error validation reporting in the app (#367)

Co-authored-by: Soren Roth <[email protected]>

* `Forms` : Optimize FeatureForm (#369)

* agree with exception name change (#377)

* update exception name for API change

* update exception name for API change

* pull in the build of the SDK with the name change of IncorrectValueTypeException

---------

Co-authored-by: Soren Roth <[email protected]>

* use geo-compose in FeatureFormsApp (#378)

* use geo-compose in FeatureFormsApp.

* remove DI providing MapViewProxy.
add AndroidViewModel usage

---------

Co-authored-by: Soren Roth <[email protected]>

* `Forms`: do not pass a selected date into date picker if it is out of range. (#376)

* do not pass a selected date into date picker if it is out of range.

* just expand the year range to incloude out of range field value's date

* add an initialError property to the DateTimePickerState, weave it through to the PickerHeader.

* use includeTime and adjust spacing.

---------

Co-authored-by: Soren Roth <[email protected]>

* remove gif. add screenshots (#381)

Co-authored-by: Soren Roth <[email protected]>

* `Forms`: fix title padding (#382)

* swap out public webmap for a managed public webmap (#384)

Co-authored-by: Soren Roth <[email protected]>

* `Forms` : Update validation behavior for text fields (#385)

* fix for breaking API change in dependency (#386)

Co-authored-by: Soren Roth <[email protected]>

---------

Co-authored-by: Soren Roth <[email protected]>
Co-authored-by: Kaushik Meesala <[email protected]>
Co-authored-by: Gunther Heppner <[email protected]>

Author: 4 people

gradle.properties

@@ -54,4 +54,4 @@ ignoreBuildNumber=false
 # these versions define the dependency of the ArcGIS Maps SDK for Kotlin dependency
 # and are generally not overridden at the command line unless a special build is requested.
 sdkVersionNumber=200.4.0
-sdkBuildNumber=4180
+sdkBuildNumber=4196

microapps/FeatureFormsApp/README.md

@@ -3,7 +3,7 @@
 This micro-app demonstrates the use of the [FeatureForm](../../toolkit/featureforms/README.md) toolkit component which provides a rich, dynamic, and responsive form
 for editing Feature attributes.
 
-![Screenshot](screenshot.gif)
+![Screenshot](screenshot2.png) ![Screenshot](screenshot3.png)
 
 ## Usage
 

microapps/FeatureFormsApp/app/build.gradle.kts

@@ -81,7 +81,7 @@ tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile::class).all {
 dependencies {
     implementation(project(":authentication"))
     implementation(project(":featureforms"))
-    implementation(project(":composable-map"))
+    implementation(project(":geoview-compose"))
     // sdk
     implementation(arcgis.mapsSdk)
     // hilt

microapps/FeatureFormsApp/app/src/main/java/com/arcgismaps/toolkit/featureformsapp/data/PortalItemRepository.kt

@@ -166,5 +166,5 @@ class PortalItemRepository(
  */
 fun getListOfMaps(): List<String> =
     listOf(
-        "https://www.arcgis.com/home/item.html?id=fe8b712a5bf7480e9781a4ad3dd5e0ff"
+        "https://www.arcgis.com/home/item.html?id=f72207ac170a40d8992b7a3507b44fad"
     )

microapps/FeatureFormsApp/app/src/main/java/com/arcgismaps/toolkit/featureformsapp/screens/map/MapScreen.kt

@@ -71,7 +71,6 @@ import androidx.hilt.navigation.compose.hiltViewModel
 import androidx.window.core.layout.WindowSizeClass
 import androidx.window.layout.WindowMetricsCalculator
 import com.arcgismaps.exceptions.FeatureFormValidationException
-import com.arcgismaps.toolkit.composablemap.ComposableMap
 import com.arcgismaps.toolkit.featureforms.FeatureForm
 import com.arcgismaps.toolkit.featureforms.ValidationErrorVisibility
 import com.arcgismaps.toolkit.featureformsapp.R
@@ -81,6 +80,7 @@ import com.arcgismaps.toolkit.featureformsapp.screens.bottomsheet.SheetLayout
 import com.arcgismaps.toolkit.featureformsapp.screens.bottomsheet.SheetValue
 import com.arcgismaps.toolkit.featureformsapp.screens.bottomsheet.StandardBottomSheet
 import com.arcgismaps.toolkit.featureformsapp.screens.bottomsheet.rememberStandardBottomSheetState
+import com.arcgismaps.toolkit.geoviewcompose.MapView
 import kotlinx.coroutines.launch
 
 @OptIn(ExperimentalMaterial3Api::class)
@@ -102,7 +102,7 @@ fun MapScreen(mapViewModel: MapViewModel = hiltViewModel(), onBackPressed: () ->
                     ValidationErrorVisibility.Automatic
                 )
             }
-            
+
             is UIState.Switching -> {
                 val state = uiState as UIState.Switching
                 Pair(
@@ -130,7 +130,6 @@ fun MapScreen(mapViewModel: MapViewModel = hiltViewModel(), onBackPressed: () ->
                     showDiscardEditsDialog = true
                 },
                 onSave = {
-                    //SubmitForm(mapViewModel = mapViewModel, featureForm = (uiState as UIState.Editing).featureForm)
                     scope.launch {
                         mapViewModel.commitEdits().onFailure {
                             Log.w("Forms", "Applying edits failed : ${it.message}")
@@ -147,18 +146,25 @@ fun MapScreen(mapViewModel: MapViewModel = hiltViewModel(), onBackPressed: () ->
         }
     ) { padding ->
         // show the composable map using the mapViewModel
-        ComposableMap(
+        MapView(
+            arcGISMap = mapViewModel.map,
+            mapViewProxy = mapViewModel.proxy,
             modifier = Modifier
                 .padding(padding)
                 .fillMaxSize(),
-            mapInterface = mapViewModel
+            onSingleTapConfirmed = { mapViewModel.onSingleTapConfirmed(it) }
         )
         AnimatedVisibility(
             visible = featureForm != null,
             enter = slideInVertically { h -> h },
             exit = slideOutVertically { h -> h },
             label = "feature form"
         ) {
+            val isSwitching = uiState is UIState.Switching
+            // remember the form and update it when a new form is opened
+            val rememberedForm = remember(this, isSwitching) {
+                featureForm!!
+            }
             val bottomSheetState = rememberStandardBottomSheetState(
                 initialValue = SheetValue.PartiallyExpanded,
                 confirmValueChange = { it != SheetValue.Hidden },
@@ -180,13 +186,11 @@ fun MapScreen(mapViewModel: MapViewModel = hiltViewModel(), onBackPressed: () ->
                     sheetWidth = with(LocalDensity.current) { layoutWidth.toDp() }
                 ) {
                     // set bottom sheet content to the FeatureForm
-                    if (featureForm != null) {
-                        FeatureForm(
-                            featureForm = featureForm,
-                            modifier = Modifier.fillMaxSize(),
-                            validationErrorVisibility = errorVisibility
-                        )
-                    }
+                    FeatureForm(
+                        featureForm = rememberedForm,
+                        modifier = Modifier.fillMaxSize(),
+                        validationErrorVisibility = errorVisibility
+                    )
                 }
             }
         }
@@ -282,7 +286,7 @@ fun TopFormBar(
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
-private fun SubmitForm(errors : List<ErrorInfo>, onDismissRequest: () -> Unit) {
+private fun SubmitForm(errors: List<ErrorInfo>, onDismissRequest: () -> Unit) {
     if (errors.isEmpty()) {
         // show a progress dialog if no errors are present
         AlertDialog(
@@ -358,7 +362,7 @@ private fun SubmitForm(errors : List<ErrorInfo>, onDismissRequest: () -> Unit) {
 @Composable
 fun FeatureFormValidationException.getString(): String {
     return when (this) {
-        is FeatureFormValidationException.IncorrectValueTypeError -> {
+        is FeatureFormValidationException.IncorrectValueTypeException -> {
             stringResource(id = R.string.value_must_be_of_correct_type)
         }
 

microapps/FeatureFormsApp/app/src/main/java/com/arcgismaps/toolkit/featureformsapp/screens/map/MapViewModel.kt

@@ -18,30 +18,34 @@
 
 package com.arcgismaps.toolkit.featureformsapp.screens.map
 
+import android.app.Application
 import android.widget.Toast
 import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.State
 import androidx.compose.runtime.mutableStateOf
+import androidx.compose.ui.unit.dp
+import androidx.lifecycle.AndroidViewModel
 import androidx.lifecycle.SavedStateHandle
-import androidx.lifecycle.ViewModel
-import androidx.lifecycle.viewModelScope
 import com.arcgismaps.data.ArcGISFeature
 import com.arcgismaps.data.ServiceFeatureTable
 import com.arcgismaps.exceptions.FeatureFormValidationException
 import com.arcgismaps.mapping.ArcGISMap
 import com.arcgismaps.mapping.PortalItem
 import com.arcgismaps.mapping.featureforms.FeatureForm
 import com.arcgismaps.mapping.featureforms.FieldFormElement
+import com.arcgismaps.mapping.featureforms.FormElement
+import com.arcgismaps.mapping.featureforms.GroupFormElement
 import com.arcgismaps.mapping.layers.FeatureLayer
-import com.arcgismaps.mapping.view.MapView
 import com.arcgismaps.mapping.view.SingleTapConfirmedEvent
-import com.arcgismaps.toolkit.composablemap.MapInterface
-import com.arcgismaps.toolkit.composablemap.MapInterfaceImpl
 import com.arcgismaps.toolkit.featureforms.ValidationErrorVisibility
 import com.arcgismaps.toolkit.featureformsapp.data.PortalItemRepository
+import com.arcgismaps.toolkit.featureformsapp.di.ApplicationScope
+import com.arcgismaps.toolkit.geoviewcompose.MapViewProxy
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 import javax.inject.Inject
 
 /**
@@ -52,7 +56,7 @@ sealed class UIState {
      * Currently not editing.
      */
     object NotEditing : UIState()
-    
+
     /**
      * Currently selecting a new Feature
      */
@@ -85,30 +89,36 @@ sealed class UIState {
  */
 data class ErrorInfo(val fieldName: String, val error: FeatureFormValidationException)
 
+/**
+ * Base class for context aware AndroidViewModel. This class must have only a single application
+ * parameter.
+ */
+open class BaseMapViewModel(application: Application): AndroidViewModel(application)
+
 /**
  * A view model for the FeatureForms MapView UI
  * @constructor to be invoked by injection
  */
 @HiltViewModel
 class MapViewModel @Inject constructor(
     savedStateHandle: SavedStateHandle,
-    private val portalItemRepository: PortalItemRepository
-) : ViewModel(),
-    MapInterface by MapInterfaceImpl(ArcGISMap()) {
+    portalItemRepository: PortalItemRepository,
+    application: Application,
+    @ApplicationScope private val scope: CoroutineScope
+) : BaseMapViewModel(application) {
     private val itemId: String = savedStateHandle["uri"]!!
-    lateinit var portalItem: PortalItem
+
+    val proxy: MapViewProxy = MapViewProxy()
+
+    var portalItem: PortalItem = portalItemRepository(itemId)
+        ?: throw IllegalStateException("portal item not found with id $itemId")
+
+    val map: ArcGISMap = ArcGISMap(portalItem)
 
     private val _uiState: MutableState<UIState> = mutableStateOf(UIState.NotEditing)
     val uiState: State<UIState>
         get() = _uiState
 
-    init {
-        viewModelScope.launch {
-            portalItem = portalItemRepository(itemId) ?: return@launch
-            setMap(ArcGISMap(portalItem))
-        }
-    }
-
     /**
      * Apply attribute edits to the Geodatabase backing
      * the ServiceFeatureTable and refresh the local feature.
@@ -125,7 +135,7 @@ class MapViewModel @Inject constructor(
         val featureForm = state.featureForm
         featureForm.validationErrors.value.forEach { entry ->
             entry.value.forEach { error ->
-                featureForm.getFormElement(entry.key)?.let { formElement ->
+                featureForm.elements.getFormElement(entry.key)?.let { formElement ->
                     if (formElement.isEditable.value) {
                         errors.add(
                             ErrorInfo(
@@ -182,17 +192,22 @@ class MapViewModel @Inject constructor(
         )
         return Result.success(Unit)
     }
-    
+
     fun selectNewFeature() =
         (_uiState.value as? UIState.Switching)?.let { prevState ->
             prevState.oldState.featureForm.discardEdits()
             val layer = prevState.oldState.featureForm.feature.featureTable?.layer as FeatureLayer
             layer.clearSelection()
             layer.selectFeature(prevState.newFeature)
             _uiState.value =
-                UIState.Editing(featureForm = FeatureForm(prevState.newFeature, layer.featureFormDefinition!!))
+                UIState.Editing(
+                    featureForm = FeatureForm(
+                        prevState.newFeature,
+                        layer.featureFormDefinition!!
+                    )
+                )
         }
-    
+
     fun continueEditing() =
         (_uiState.value as? UIState.Switching)?.let { prevState ->
             _uiState.value = prevState.oldState
@@ -208,58 +223,73 @@ class MapViewModel @Inject constructor(
         } ?: return Result.failure(IllegalStateException("Not in editing state"))
     }
 
-    context(MapView, CoroutineScope) override fun onSingleTapConfirmed(singleTapEvent: SingleTapConfirmedEvent) {
-            launch {
-                this@MapView.identifyLayers(
-                    screenCoordinate = singleTapEvent.screenCoordinate,
-                    tolerance = 22.0,
-                    returnPopupsOnly = false
-                ).onSuccess { results ->
-                    try {
-                        results.forEach { result ->
-                            result.geoElements.firstOrNull {
-                                it is ArcGISFeature && (it.featureTable?.layer as? FeatureLayer)?.featureFormDefinition != null
-                            }?.let {
-                                if (_uiState.value is UIState.Editing) {
-                                    val currentState = _uiState.value as UIState.Editing
-                                    val newFeature = it as ArcGISFeature
-                                    _uiState.value = UIState.Switching(
-                                        oldState = currentState,
-                                        newFeature = newFeature
-                                    )
-                                } else if (_uiState.value is UIState.NotEditing) {
-                                    val feature = it as ArcGISFeature
-                                    val layer = feature.featureTable!!.layer as FeatureLayer
-                                    val featureForm =
-                                        FeatureForm(feature, layer.featureFormDefinition!!)
-                                    // select the feature
-                                    layer.selectFeature(feature)
-                                    // set the UI to an editing state with the FeatureForm
-                                    _uiState.value = UIState.Editing(featureForm)
-                                }
+    fun onSingleTapConfirmed(singleTapEvent: SingleTapConfirmedEvent) {
+        scope.launch {
+            proxy.identifyLayers(
+                screenCoordinate = singleTapEvent.screenCoordinate,
+                tolerance = 22.dp,
+                returnPopupsOnly = false
+            ).onSuccess { results ->
+                try {
+                    results.forEach { result ->
+                        result.geoElements.firstOrNull {
+                            it is ArcGISFeature && (it.featureTable?.layer as? FeatureLayer)?.featureFormDefinition != null
+                        }?.let {
+                            if (_uiState.value is UIState.Editing) {
+                                val currentState = _uiState.value as UIState.Editing
+                                val newFeature = it as ArcGISFeature
+                                _uiState.value = UIState.Switching(
+                                    oldState = currentState,
+                                    newFeature = newFeature
+                                )
+                            } else if (_uiState.value is UIState.NotEditing) {
+                                val feature = it as ArcGISFeature
+                                val layer = feature.featureTable!!.layer as FeatureLayer
+                                val featureForm =
+                                    FeatureForm(feature, layer.featureFormDefinition!!)
+                                // select the feature
+                                layer.selectFeature(feature)
+                                // set the UI to an editing state with the FeatureForm
+                                _uiState.value = UIState.Editing(featureForm)
                             }
                         }
-                    } catch (e: Exception) {
-                        e.printStackTrace()
+                    }
+                } catch (e: Exception) {
+                    e.printStackTrace()
+                    withContext(Dispatchers.Main) {
                         Toast.makeText(
-                            context,
+                            getApplication<Application>().applicationContext,
                             "failed to create a FeatureForm for the feature",
                             Toast.LENGTH_LONG
                         ).show()
                     }
                 }
             }
         }
+    }
+
 }
 
 /**
  * Returns the [FieldFormElement] with the given [fieldName] in the [FeatureForm]. If none exists
  * null is returned.
  */
-fun FeatureForm.getFormElement(fieldName: String): FieldFormElement? {
-    return elements.firstNotNullOfOrNull {
-        if (it is FieldFormElement && it.fieldName == fieldName) {
-            it
+fun List<FormElement>.getFormElement(fieldName: String): FieldFormElement? {
+    val fieldElements = filterIsInstance<FieldFormElement>()
+    val element = if (fieldElements.isNotEmpty()) {
+        fieldElements.firstNotNullOfOrNull {
+            if (it.fieldName == fieldName) it else null
+        }
+    } else {
+        null
+    }
+
+    return element ?: run {
+        val groupElements = filterIsInstance<GroupFormElement>()
+        if (groupElements.isNotEmpty()) {
+            groupElements.firstNotNullOfOrNull {
+                it.elements.getFormElement(fieldName)
+            }
         } else {
             null
         }