kotose-form-phone/io.github.robinpcrd.kotose.form.fields/PhoneNumberField

PhoneNumberField

open class PhoneNumberField(tag: String? = null, val placeholder: StrRes? = null) : FocusableField<PhoneData>

Shared phone state; country-picker presentation belongs to the renderer.

With a PhoneNumberBackend the country is picked and the number parsed. Without one, the dial code and the number are typed separately: see setDialCode.

Constructors

PhoneNumberField

constructor(tag: String? = null, placeholder: StrRes? = null)

Properties

customCondition

var customCondition: CustomCondition?

dialCode

val dialCode: String

The digits of the value's dial code, empty when there is none.

displayCountry

val displayCountry: Country

errors

val errors: ImmutableList<ValidationError>

errorsState

val errorsState: State<ImmutableList<ValidationError>>

form

var form: Form?

hasCountryPicker

val hasCountryPicker: Boolean

Whether renderers show the country picker, which needs a PhoneNumberBackend.

hasErrorAndVisible

val hasErrorAndVisible: Boolean

hasErrorOrWarningAndVisible

val hasErrorOrWarningAndVisible: Boolean

hasErrors

val hasErrors: Boolean

hasErrorsNotSilent

val hasErrorsNotSilent: Boolean

hasErrorsNotSilentState

val hasErrorsNotSilentState: State<Boolean>

hasErrorsOrWarnings

val hasErrorsOrWarnings: Boolean

hasErrorsState

val hasErrorsState: State<Boolean>

hasWarningsState

val hasWarningsState: State<Boolean>

indexInGroup

val indexInGroup: Int

isCountrySelectionEnabled

open var isCountrySelectionEnabled: Boolean

isEnabled

val isEnabled: Boolean

isEnabledCondition

var isEnabledCondition: Condition

isEnabledState

val isEnabledState: State<Boolean>

isErrorField

val isErrorField: Boolean

isVisible

val isVisible: Boolean

isVisibleCondition

var isVisibleCondition: Condition

isVisibleState

val isVisibleState: State<Boolean>

key

val key: String

onValidationChange

var onValidationChange: () -> Unit

onValueChange

var onValueChange: (PhoneData?) -> Unit

parent

var parent: Group?

parentErrors

val parentErrors: List<ValidationError>

parentErrorState

val parentErrorState: State<List<ValidationError>>

placeholder

open val placeholder: StrRes?

rules

val rules: List<ValidationRule.Field<PhoneData>>

setOfAllowedRegion

open var setOfAllowedRegion: ImmutableSet<String>?

submittedValue

open override val submittedValue: Any?

tag

val tag: String?

validationOption

var validationOption: ValidationOption

value

var value: PhoneData?

valueState

val valueState: State<PhoneData?>

Functions

addRule

fun addRule(rule: ValidationRule.Field<PhoneData>)

clearValidationErrors

fun clearValidationErrors(triggerSource: ValidationTriggerSource)

evaluateCustomCondition

open fun evaluateCustomCondition()

evaluateEnabled

open override fun evaluateEnabled()

evaluateVisibility

open override fun evaluateVisibility()

onParentValidationChanged

open override fun onParentValidationChanged(errors: List<ValidationError>)

onValueChanged

open override fun onValueChanged()

remove

fun remove(reload: Boolean)

removeRule

fun removeRule(rule: ValidationRule.Field<PhoneData>)

selectableCountries

open fun selectableCountries(query: String = ""): ImmutableList<Country>

selectCountry

open fun selectCountry(country: Country)

open fun selectCountry(region: CountryRegion)

setBaseValue

open override fun setBaseValue(value: Any?)

setDialCode

fun setDialCode(dialCode: String)

Sets the typed dial code when there is no PhoneNumberBackend: digits only, at most 3, without a leading 0. Does nothing with a backend, where the country sets it.

setPhone

open fun setPhone(phone: String)

Parses phone with a backend; without one, keeps its digits as the number.

setValidationErrors

fun setValidationErrors(errors: List<ValidationError>, triggerSource: ValidationTriggerSource)

validate

open override fun validate(triggerSource: ValidationTriggerSource, includeHidden: Boolean): ImmutableList<ValidationError>