FormScope 0.3.1 API

All Implemented Interfaces:


public interface FormScope<T extends Object>

A scope interface for Form objects

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract <V extends Any> FormField<V>`	`registerField(KProperty1<T, V> fieldClass)`	Registers the field and returns a singleton FormField instance
`abstract FormResult<T>`	`formValidate()`	Validate the form and collect the form data
`abstract Unit`	`formSetValues(T payload)`	Set all fields to the given form data
`abstract T`	`formGetValues()`	Get the current form values without validating them
`abstract Unit`	`formClear()`	Reset all fields to their default state
`abstract <V extends Any> V`	`formGetFieldValue(KProperty1<T, V> fieldClass)`	Get the value of a field
`abstract State<FormResult<T>>`	`getFormState()`
`abstract Boolean`	`getFormIsValid()`	True if the form is successfully validated
`abstract Boolean`	`getFormIsError()`	True if the form contains validation errors

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - registerField
```
 abstract <V extends Any> FormField<V> registerField(KProperty1<T, V> fieldClass)
```
    Registers the field and returns a singleton FormField instance
    
    Parameters:
    
    fieldClass - kotlin property reference of the field
  - formValidate
```
 abstract FormResult<T> formValidate()
```
    Validate the form and collect the form data
    
    Returns:
    
    FormResult object containing the validation status and data
  - formSetValues
```
 abstract Unit formSetValues(T payload)
```
    Set all fields to the given form data
  - formGetValues
```
 abstract T formGetValues()
```
    Get the current form values without validating them
  - formClear
```
 abstract Unit formClear()
```
    Reset all fields to their default state
  - formGetFieldValue
```
 abstract <V extends Any> V formGetFieldValue(KProperty1<T, V> fieldClass)
```
    Get the value of a field
  - getFormState
```
@Composable() abstract State<FormResult<T>> getFormState()
```
  - getFormIsValid
```
@Composable() abstract Boolean getFormIsValid()
```
    True if the form is successfully validated
  - getFormIsError
```
@Composable() abstract Boolean getFormIsError()
```
    True if the form contains validation errors