kotose-form-core/io.github.robinpcrd.kotose.form/Form

Form

class Form

Constructors

Form

constructor()

Types

DismissKeyboardEvent

object DismissKeyboardEvent

Properties

currentFocus

var currentFocus: FocusableField<*>?

customConditionMap

val customConditionMap: ImmutableMap<String, List<Element<*>>>

dismissKeyboardEvent

val dismissKeyboardEvent: State<Form.DismissKeyboardEvent?>

enabledMap

val enabledMap: ImmutableMap<String, List<Element<*>>>

errorScrollIndex

val errorScrollIndex: State<Int>

Compatibility view for renderers that still consume a scroll index.

events

val events: SharedFlow<SealedFormEvents>

fields

val fields: State<ImmutableList<Field<*>>>

groups

val groups: List<Group>

key

val key: String

navigationRequest

val navigationRequest: State<FormNavigationRequest?>

onValueChange

var onValueChange: (Map<String, Any?>) -> Unit?

visibilityMap

val visibilityMap: ImmutableMap<String, List<Element<*>>>

Functions

add

fun add(group: Group, reload: Boolean = false)

fun add(index: Int = -1, group: Group, reload: Boolean = false)

addAll

fun addAll(groups: Collection<Group>, reload: Boolean = false)

fun addAll(index: Int = -1, groups: Collection<Group>, reload: Boolean = false)

addListener

fun addListener(listener: FormEvent)

allNonNullValues

fun allNonNullValues(includeHidden: Boolean = false): Map<String, Any>

allValues

fun allValues(includeHidden: Boolean = false): Map<String, Any?>

Get all the values from the form

canFocus

fun canFocus(field: FocusableField<*>): Boolean

completeNavigation

fun completeNavigation(requestId: Long): Boolean

A stale renderer must not acknowledge a newer submission.

fieldValue

fun <T> fieldValue(tag: String): T?

focusNext

fun focusNext(field: Field<*>)

getFieldByTag

fun getFieldByTag(tag: String): Field<*>?

getFirstErrorIndex

fun getFirstErrorIndex(): Int

getGroupByTag

fun getGroupByTag(tag: String): Group?

getMultipleSelectionGroupByTag

inline fun <ValueType> Form.getMultipleSelectionGroupByTag(tag: String): SelectionGroup.Multiple<ValueType>?

getSelectionGroupByTag

inline fun <ValueType> Form.getSelectionGroupByTag(tag: String): SelectionGroup<ValueType>?

getSingleSelectionGroupByTag

inline fun <ValueType> Form.getSingleSelectionGroupByTag(tag: String): SelectionGroup.Single<ValueType>?

getTypedFieldByTag

inline fun <FieldType : Field<*>> getTypedFieldByTag(tag: String): FieldType?

hasScrollToError

fun hasScrollToError()

navigationIndex

fun navigationIndex(requestId: Long): Int

Resolve just before scrolling; a removed or hidden target has no current index.

nextFocusableField

fun nextFocusableField(field: Field<*>): FocusableField<*>?

nextFocusableFieldState

fun nextFocusableFieldState(field: Field<*>): State<FocusableField<*>?>

onFocusChanged

fun onFocusChanged(field: FocusableField<*>, focused: Boolean)

Report actual UI focus without creating another navigation request.

onKeyboardDismiss

fun onKeyboardDismiss()

previousFocusableField

fun previousFocusableField(field: Field<*>): FocusableField<*>?

reload

fun reload()

remove

fun remove(group: Group, reload: Boolean = false)

removeAll

fun removeAll(groups: Collection<Group>, reload: Boolean = false)

removeAllListeners

fun removeAllListeners()

removeAt

fun removeAt(index: Int, reload: Boolean = false)

removeListener

fun removeListener(listener: FormEvent)

setFocus

fun setFocus(field: FocusableField<*>)

setValues

fun setValues(values: Map<String, Any?>)

stopEditing

fun stopEditing(forceKeyboardDismiss: Boolean = false)

transaction

@JvmName(name = "formTransaction")

fun Form.transaction(reload: Boolean = true, init: Transaction.() -> Unit)

validate

fun validate(scrollToFirstError: Boolean = true, includeHidden: Boolean = false, warningAsError: Boolean = false): List<ValidationError>

Validate the form and return a list of errors. It also scrolls the form view to the first error.