FormSchema

class FormSchema(val definedControls: Map<String, Control<*>>, val contentOrder: List<String>, val actionBarOrder: List<String>)

Form schema - the structure and layout of the controls.

FormSchema holds the complete form definition, including:

  • All controls with their configuration

  • The display order in the main area

  • The display order in the action bar

The schema is created by FormSchemaBuilder and does not change afterwards.

Parameters

controls

Map of all form controls (key = unique name).

contentOrder

Names of the controls shown in the main area of the form.

actionBarOrder

Names of the controls shown in the bottom action bar.

Throws

if names in the order lists do not exist in the controls map.

Constructors

Link copied to clipboard
constructor(definedControls: Map<String, Control<*>>, contentOrder: List<String>, actionBarOrder: List<String>)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
private val definedControls: Map<String, Control<*>>

Functions

Link copied to clipboard

Returns all controls defined in this schema

Link copied to clipboard
fun getControl(name: String): Control<*>?

Returns the control with the given name

Link copied to clipboard

Top-level controls of the definition, with a context without a parent. The engine walks down the tree from them through Control.childContexts.