editor/joyfill.editors.components/ComponentEditor

ComponentEditor

interface ComponentEditor : ValidateEditor, Schema

Base contract for all component editors.

Exposes the underlying component, validation, and visibility controls. Implementations propagate value changes to dependent components and re-evaluate conditions that may hide/disable the component.

Inheritors

Properties

Link copied to clipboard
abstract val component: Component

Underlying component being edited.

Link copied to clipboard
abstract val disabled: Boolean

Whether the component is currently disabled.

Link copied to clipboard
abstract var hidden: Boolean
Link copied to clipboard
abstract var id: String
Link copied to clipboard
abstract var identifier: String

Unique editor identifier; affects formula dependency resolution.

Link copied to clipboard
abstract var required: Boolean
Link copied to clipboard
abstract val state: Live<ComponentValidityState>

Reactive validity state of the editor.

Link copied to clipboard
abstract val tip: ToolTip?

Optional tooltip associated with the component.

Link copied to clipboard
abstract var title: String
Link copied to clipboard
abstract var type: Type

Functions

Link copied to clipboard
abstract fun hide()

Hide the component and update editor state accordingly.

Link copied to clipboard
abstract fun resolveConditions()

Re-compute conditional logic (hide/disable, etc.) for this component.

Link copied to clipboard
abstract fun setHiddenTo(value: Boolean, reason: HiddenReason, liveUpdate: Boolean = false)

Set hidden state explicitly.

Link copied to clipboard
abstract fun show()

Show the component and update editor state accordingly.

Link copied to clipboard
fun ComponentEditor.tableEditor(rowId: String? = null, schemaId: String? = null, parentPath: String? = null): TableEditor?

Resolve a TableEditor for this ComponentEditor.

Link copied to clipboard
abstract fun toJsonObject(): JsonObject
Link copied to clipboard
abstract fun toJsonString(): String
Link copied to clipboard
abstract fun toMap(): MutableMap<String, Any?>
Link copied to clipboard
abstract fun updateDependentsValues()

Recompute and push values to dependents driven by this component.

Link copied to clipboard
abstract fun validate(): ComponentValidity

Compute validity based on current data and constraints.