FieldEvent

data class FieldEvent<out E : ComponentEditor>(val source: E, val page: Page, val id: String, val identifier: String, val fieldId: String = source.id, val fieldIdentifier: String = source.identifier, val pageId: String = page.id, val fileId: String, val fieldPositionId: String, val target: String = Target.field_update) : ComponentEvent<E>

Field-level interaction carrying editor and field context.

Constructors

Link copied to clipboard
constructor(source: E, page: Page, id: String, identifier: String, fieldId: String = source.id, fieldIdentifier: String = source.identifier, pageId: String = page.id, fileId: String, fieldPositionId: String, target: String = Target.field_update)

Properties

Link copied to clipboard
open override val fieldId: String

Field id (defaults to source.id). Used for change targeting.

Link copied to clipboard
open override val fieldIdentifier: String

Field identifier (defaults to source.identifier).

Link copied to clipboard
open override val fieldPositionId: String

Layout position id for the field instance.

Link copied to clipboard
open override val fileId: String

File id that contains the page/field.

Link copied to clipboard
open override val id: String

Document id for the event.

Link copied to clipboard
open override val identifier: String

Document external identifier.

Link copied to clipboard
open override val multi: Boolean?

Whether the underlying file component supports multiple selection (if applicable).

Link copied to clipboard
open override val page: Page

The page containing the field.

Link copied to clipboard
open override val pageId: String

Page id where the field resides.

Link copied to clipboard
open override val source: E

The originating editor.

Link copied to clipboard
open override val target: String

Change target identifier (defaults to Target.field_update).