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

ObjectProperty

@Serializable

@SerialName(value = "object")

@ObjCName(name = "Schema")

data class ObjectProperty(val properties: ImmutableMap<String, Property>, val required: ImmutableList<String> = persistentListOf(), val anyOf: ImmutableList<ObjectProperty>? = null, 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) : Property

A property which configure a field with an object value.

Constructors

ObjectProperty

constructor(properties: ImmutableMap<String, Property>, required: ImmutableList<String> = persistentListOf(), anyOf: ImmutableList<ObjectProperty>? = null, title: String? = null, format: String? = null, description: String? = null, readOnly: Boolean? = null, const: JsonPrimitive? = null, not: Property? = null, pattern: Regex? = null)

Properties

anyOf

@Serializable(with = ImmutableListSerializer::class)

val anyOf: ImmutableList<ObjectProperty>? = null

An optional list of properties that are required if any of the properties in the anyOf array are present.

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.

format

open override val format: String? = null

An optional format.

not

open override val not: Property? = null

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

pattern

@Serializable(with = RegexSerializer::class)

open override val pattern: Regex? = null

An optional pattern to restrict the value of the property.

properties

@Serializable(with = ImmutableMapSerializer::class)

val properties: ImmutableMap<String, Property>

The child properties of this property.

readOnly

open override val readOnly: Boolean? = null

An optional boolean to know if it is interactive.

required

@Serializable(with = ImmutableListSerializer::class)

val required: ImmutableList<String>

An optional list of required properties.

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.

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.

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.