editor/joyfill.editors.file/FileEditor

FileEditor

interface FileEditor : AbstractFileEditor

Editor for file attachment components.

Properties

Link copied to clipboard
abstract override val component: FileComponent

Strongly-typed file component backing this editor.

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 override val state: Live<FileEditorState>

Reactive state snapshot with current attachments.

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 add(attachment: Attachment)

Adds a single attachment

abstract fun add(url: String)

Adds a single URL

abstract fun add(urls: Collection<String>)

Adds a list of URLs

abstract fun add(attachments: List<Attachment>, origin: Origin)

Adds a list of attachments

Link copied to clipboard
abstract fun canSelectMultiple(): Boolean
Link copied to clipboard
abstract fun hide()

Hide the component and update editor state accordingly.

Link copied to clipboard
abstract fun remove(key: String?)

Removes a single key

abstract fun remove(keys: Collection<String>)

Removes a list of keys

abstract fun remove(attachment: Attachment?, origin: Origin)

Removes a single attachment

abstract fun remove(attachments: List<Attachment>, origin: Origin)

Removes a list of attachments

Link copied to clipboard
abstract fun resolveConditions()

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

Link copied to clipboard
abstract fun set(urls: Collection<String>)

Sets the list of URLs, replacing any existing URLs.

abstract fun set(attachments: List<Attachment>)

Sets the list of attachments, replacing any existing attachments.

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.

Link copied to clipboard
abstract fun value(v: List<Attachment>?, origin: Origin = Origin.User)

Set the attachments value.