Package-level declarations

A mutable view of a text document handed to DocumentState.edit. Calls made on it inside the edit { } block are applied to the document as one compound change, so the field observes a single settled edit rather than each intermediate step.

A hoistable state holder for a text component that owns the Document the component renders. The state and the bound component share one document, so an edit made through this state is what the component displays, and text the user types into the component is what this state reports - there is no value to keep in sync and no round-trip per keystroke. A caller who needs a document of their own supplies it at rememberDocumentState; content is otherwise read through text and changed through edit.

A hoistable state holder for a FormattedTextField: the value the field holds, whether the characters it currently shows parse, and the gesture that takes a typed edit on demand.

An EditorPane driven by a DocumentState. The pane renders the state's own document, so text typed into the pane and edits made through the state are the same content, and the caret is kept two-way with DocumentState.selection. The state is the single source of truth; there is no onValueChange.

An EditorPane driven by a raw HyperlinkListener instead of an onLinkActivate lambda. The listener hears every link event the pane publishes - entered and left as well as activated - and reaches the resolved URL and the source element behind each; pass a stable instance (e.g. remember {}) to avoid churn.

Rendered markup: markup is source written in the language contentType names, and the JEditorPane shows what the kit registered for that content type makes of it, so EditorPane("<h1>Report</h1>", { href -> open(href) }, contentType = "text/html") renders a heading rather than the characters that spell one.

A FormattedTextField driven by a FormattedValueState. The field renders the state's value and commits into it, and reports through the state whether the characters it currently shows parse. The state is the single source of truth; there is no onValueChange and no onEditValidChange.

A FormattedTextField driven by a raw PropertyChangeListener (bound to the value property) instead of an onValueChange lambda. The listener is attached as-is and removed on the same instance; pass a stable instance (e.g. remember {}) to avoid churn. Being attached as-is, it is notified of every change to the value property, including the one that applies value.

A single line of text standing for a typed value: a number, a date, or input matching a fixed mask. The JFormattedTextField renders the value as formatted text and parses what the user types back into a value of that type.

A PasswordField driven by a DocumentState. The field renders the state's own document, so masked text typed into the field and edits made through the state are the same content, and the caret is kept two-way with DocumentState.selection. The state is the single source of truth.

A PasswordField driven by a raw DocumentListener instead of an onValueChange lambda. The documentListener is attached to the field's document as-is and removed on the same instance; pass a stable instance (e.g. remember {}) to avoid churn. Being attached as-is, it observes every change to that document, including the one that applies value.

A single line of editable text the JPasswordField shows as masking characters rather than as what was typed. It holds the characters value declares and reports every edit as the field's whole contents.

Creates and remembers a DocumentState over an existing document, leaving its current content in place. The bound field renders this exact document, so a caller keeping a reference to it observes the same edits the state does.

Creates and remembers a DocumentState over a fresh document built by kit and seeded by reading initialText through it. Reach for this over the contentType form when the kit is configured - a style sheet of your own, a custom parser, a kit class the registry does not name.

Creates and remembers a DocumentState over a fresh document in the language contentType names, seeded with initialText.

Creates and remembers a FormattedValueState holding initialValue.

A TextArea driven by a DocumentState. The area renders the state's own document, so text typed into the area and edits made through the state are the same content, and the caret is kept two-way with DocumentState.selection. The state is the single source of truth; there is no onValueChange.

A TextArea driven by a raw DocumentListener instead of an onValueChange lambda. The documentListener is attached to the area's document as-is and removed on the same instance; pass a stable instance (e.g. remember {}) to avoid churn. Being attached as-is, it observes every change to that document, including the one that applies value.

Multiple lines of editable plain text. The JTextArea shows the text value declares, and every edit reports the area's whole text through onValueChange.

A TextField driven by a DocumentState. The field renders the state's own document, so text typed into the field and edits made through the state are the same content, and the caret is kept two-way with DocumentState.selection. The state is the single source of truth; there is no onValueChange.

A TextField driven by a raw DocumentListener instead of an onValueChange lambda. The documentListener is attached to the field's document as-is and removed on the same instance; pass a stable instance (e.g. remember {}) to avoid churn. It observes every change to that document, including the one that applies value.

A single line of editable plain text. The JTextField shows the text value declares, and every edit reports the field's whole text through onValueChange.

A TextPane driven by a DocumentState. The pane renders the state's own document, so text typed into the pane and edits made through the state are the same content, and the caret is kept two-way with DocumentState.selection. The state is the single source of truth; there is no onValueChange.

A TextPane driven by a raw DocumentListener instead of an onValueChange lambda. The listener observes the document the pane currently holds and follows it across a document swap; pass a stable instance (e.g. remember {}) to avoid churn. Being attached as-is, it observes every change to that document, including the one that applies value.

Editable text carrying graphical attributes - fonts, colors, embedded icons and components - over the styled document a JTextPane holds.