editor/joyfill.editors.document

Package-level declarations

Types

DecoratorCollection

interface DecoratorCollection

Runtime CRUD API for managing Decorator instances on document fields, rows, and columns.

DocumentEditor

interface DocumentEditor : Mappable

High-level editor for a Document.

GotoConfig

class GotoConfig(val open: Boolean = false, val animate: Boolean = true, val focus: Boolean = false)

Configuration for DocumentEditor.goto navigation.

GotoRowTarget

data class GotoRowTarget(val rowId: String, val rowIndex: Int, val rowManager: RowManager?, val rowEntry: RowEntry?, val openRowForm: Boolean = false, val animate: Boolean = true, val focus: Boolean = false, val columnId: String? = null)

Target for row navigation within a table or collection field. Used by TableEditor and CollectionEditor when navigateTo is invoked.

LayoutConfig

data class LayoutConfig(preferred: Viewer, forced: Boolean)

NavigationTarget

data class NavigationTarget(val scrollIndex: Int, val animate: Boolean = true, val focus: Boolean = true)

Request for field-level scroll navigation. Used by DocumentEditor when navigating to a field or when scrolling to bring a table/collection into view before row navigation.

NavResponse

interface NavResponse

Response from a DocumentEditor.goto navigation request.

Route

interface Route

Type-safe navigation routes for DocumentEditor.goto.

ValidationResult

interface ValidationResult

Viewer

enum Viewer : Enum<Viewer>

Functions

editorOf

fun editorOf(document: Document, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor

Creates a new DocumentEditor for the given document.

fun editorOf(json: String, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor

Creates a new DocumentEditor from the given json.

fun editorOf(map: MutableMap<String, Any?>, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor

Creates a new DocumentEditor from the given map.

fun editorOf(json: JsonObject, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor

Creates a new DocumentEditor for the given json.