state/com.monkopedia.kodemirror.state/EditorState

EditorState

The editor state class is a persistent (immutable) data structure. To update a state, you create a Transaction, which produces a new state instance.

Types

Companion

object Companion

Properties

currentLine

val currentLine: Line

The line containing the primary cursor.

cursorPosition

val cursorPosition: DocPos

The character position of the primary cursor.

doc

val doc: Text

The current document.

lineBreak

val lineBreak: String

Get the proper line-break string for this state.

readOnly

val readOnly: Boolean

Returns true when the editor is configured to be read-only.

selectedText

val selectedText: String

The text currently selected by the primary selection, or empty string for cursors.

selection

val selection: EditorSelection

The current selection.

tabSize

val tabSize: Int

The size (in columns) of a tab in the document.

Functions

changeByRange

fun changeByRange(f: (SelectionRange) -> ChangeByRangeResult): TransactionSpec

Create a set of changes and a new selection by running the given function for each range in the active selection.

changes

fun changes(spec: ChangeSpec? = null): ChangeSet

Create a ChangeSet from the given change description.

charCategorizer

fun charCategorizer(at: DocPos): (String) -> CharCategory

Return a function that can categorize strings into one of: Word, Space, or Other.

facet

fun <Output> facet(reader: FacetReader<Output>): Output

Get the value of a state facet via a FacetReader.

fun <Output> facet(facet: Facet<*, Output>): Output

Get the value of a state facet.

field

fun <T> field(field: StateField<T>): T

Retrieve the value of a state field. Throws an error when the state doesn't have that field, unless you pass false as second parameter.

fun <T> field(field: StateField<T>, require: Boolean): T?

Retrieve the value of a state field, or null if the field is not present.

get

operator fun <T> get(field: StateField<T>): T

Retrieve the value of a state field using index syntax.

languageDataAt

fun <T> languageDataAt(key: LanguageDataKey<T>, pos: DocPos, side: Int = -1): List<T>

Find the values for a given language data field using a type-safe key.

fun <T> ~~languageDataAt~~(name: String, pos: DocPos, side: Int = -1): List<T>

Find the values for a given language data field by string name.

phrase

fun phrase(phrase: String, vararg insert: Any): String

Look up a translation for the given phrase.

replaceSelection

fun replaceSelection(text: Text): TransactionSpec

fun replaceSelection(text: String): TransactionSpec

Create a transaction spec that replaces every selection range with the given content.

sliceDoc

fun sliceDoc(from: DocPos = DocPos.ZERO, to: DocPos = doc.endPos): String

Return the given range of the document as a string.

toData

fun EditorState.toData(fields: Map<String, StateField<*>>? = null): EditorStateData

Serialize this state to an EditorStateData.

toJSON

fun ~~toJSON~~(fields: Map<String, StateField<*>>? = null): Map<String, Any?>

Convert this state to a JSON-serializable object.

toText

fun toText(string: String): Text

Using the state's line separator, create a Text instance from the given string.

update

fun update(vararg specs: TransactionSpec): Transaction

Create a Transaction that updates this state.

wordAt

fun wordAt(pos: DocPos): SelectionRange?

Find the word at the given position.