jsonforms-kotlin

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

Property

@Serializable

sealed class Property

Common base sealed class for any property element.

Inheritors

BooleanProperty

Properties

abstract val const: JsonPrimitive?

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

abstract val description: String?

An optional description.

abstract val format: String?

An optional format.

abstract val not: Property?

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

@Serializable(with = RegexSerializer::class)

abstract val pattern: Regex?

An optional pattern to restrict the value of the property.

abstract val readOnly: Boolean?

An optional boolean to know if it is interactive.

abstract val title: String?

An optional title.

Functions

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.

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.

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.