shared/com.paligot.jsonforms.kotlin.models.schema/StringProperty

StringProperty

@Serializable

@SerialName(value = "string")

data class StringProperty(val title: String? = null, val format: String? = null, val description: String? = null, val readOnly: Boolean? = null, val const: JsonPrimitive? = null, val not: Property? = null, val pattern: Regex? = null, val minLength: Int? = null, val maxLength: Int? = null, val enum: ImmutableList<String>? = null, val oneOf: ImmutableList<Property>? = null) : Property

A property which configure a field with a string value.

Constructors

StringProperty

constructor(title: String? = null, format: String? = null, description: String? = null, readOnly: Boolean? = null, const: JsonPrimitive? = null, not: Property? = null, pattern: Regex? = null, minLength: Int? = null, maxLength: Int? = null, enum: ImmutableList<String>? = null, oneOf: ImmutableList<Property>? = null)

Properties

const

open override val const: JsonPrimitive? = null

An optional const value to restrict the value of the property.

description

open override val description: String? = null

An optional description.

enum

@Serializable(with = ImmutableListSerializer::class)

val enum: ImmutableList<String>? = null

An optional enum value to restrict the value of the property.

format

open override val format: String? = null

An optional format.

maxLength

val maxLength: Int? = null

An optional maximum length to validate the string value.

minLength

val minLength: Int? = null

An optional minimum length to validate the string value.

not

open override val not: Property? = null

An optional not value to restrict the value of the property.

oneOf

@Serializable(with = ImmutableListSerializer::class)

val oneOf: ImmutableList<Property>? = null

An optional list of key-value to validate the string value.

pattern

@Serializable(with = RegexSerializer::class)

open override val pattern: Regex? = null

An optional pattern to restrict the value of the property.

readOnly

open override val readOnly: Boolean? = null

An optional boolean to know if it is interactive.

title

open override val title: String? = null

An optional title.

Functions

getMaxCounter

fun Property.getMaxCounter(value: String?, control: Control): Pair<Int, Int>?

Return a Pair of Int (current value length to max length), if the property is a TextInputProperty, control options showMaxCounter is true and has a max length specified.

isDropdown

fun StringProperty.isDropdown(): Boolean

Check if StringProperty is a dropdown based on the oneOf field.

isEmail

fun StringProperty.isEmail(control: Control): Boolean

Check if StringProperty is an email based on the format.

isEnabled

fun Property.isEnabled(control: Control, data: Map<String, Any?>): Boolean

Check if the property is enabled from the control rule if it exists. The data property is necessary because rules are based on a condition in relation to another field.

isPassword

fun StringProperty.isPassword(control: Control): Boolean

Check if StringProperty is a password based on the format.

isPhone

fun StringProperty.isPhone(control: Control): Boolean

Check if StringProperty is a phone based on the format.

isRadio

fun StringProperty.isRadio(control: Control): Boolean

Check if StringProperty is a radio based on the format and enum or oneOf fields.

label

fun Property.label(required: Boolean, control: Control): String?

Get the label of a field from the Property or the Control with '*' if it is required. If there is no title in the Property or label in the Control, it'll return null as label.