shared/com.paligot.jsonforms.kotlin.models.uischema

Package-level declarations

Types

Condition

@Serializable

data class Condition(val scope: String, val schema: Property)

Represents a condition to be evaluated.

Control

@Serializable

@SerialName(value = "Control")

data class Control(val scope: String, var label: String? = null, val options: ControlOptions? = null, val elements: ImmutableList<UiSchema>? = null, val rule: Rule? = null) : UiSchema

A control element which represent a UI element in the form.

ControlOptions

@Serializable

data class ControlOptions(val format: Format? = null, val orientation: Orientation? = null, val verticalSpacing: String? = null, val horizontalSpacing: String? = null, val readOnly: Boolean = false, val showMaxCounter: Boolean = false, val hasFirstLetterCapitalized: Boolean = false, val weight: Float? = null) : Options

An option for a control element.

Effect

enum Effect : Enum<Effect>

The different rule effects.

Format

enum Format : Enum<Format>

The different formats.

GroupLayout

@Serializable

@SerialName(value = "Group")

data class GroupLayout(val label: String, val description: String? = null, val elements: ImmutableList<UiSchema> = persistentListOf(), val rule: Rule? = null, val options: LayoutOptions? = null) : UiSchema

A group resembles a vertical layout, but additionally might have a label. This layout is useful when grouping different elements by a certain criteria.

HorizontalLayout

@Serializable

@SerialName(value = "HorizontalLayout")

data class HorizontalLayout(val elements: ImmutableList<UiSchema> = persistentListOf(), val rule: Rule? = null, val options: LayoutOptions? = null) : UiSchema

A layout which orders its children horizontally (i.e. from left to right).

LayoutOptions

@Serializable

data class LayoutOptions(val verticalSpacing: String? = null, val horizontalSpacing: String? = null, val weight: Float? = null) : Options

Options for a layout element.

Options

interface Options

Orientation

enum Orientation : Enum<Orientation>

Rule

@Serializable

data class Rule(val effect: Effect, val condition: Condition)

A rule that may be attached to any UI schema element.

UiSchema

@Serializable

sealed class UiSchema

Common base sealed class for any UI schema element.

VerticalLayout

@Serializable

@SerialName(value = "VerticalLayout")

data class VerticalLayout(val elements: ImmutableList<UiSchema> = persistentListOf(), val rule: Rule? = null, val options: LayoutOptions? = null) : UiSchema

A layout which orders its child elements vertically (i.e. from top to bottom).