mosaic-runtime/org.unitedsoftware.mosaic.ui/TextFieldState

TextFieldState

@Stable

class TextFieldState(initialText: String = "")

The editable text of a TextField, the position of its cursor, and its selection.

The cursor is an index into text between two characters, where 0 is before the first one and the length of text is after the last one. The selection reaches from where it started, its anchor, to the cursor. Without a selection, the anchor is at the cursor.

Edits are recorded so that undo and redo can step through them, with typed characters grouped by word.

Constructors

constructor(initialText: String = "")

Properties

val canRedo: Boolean

val canUndo: Boolean

var cursor: Int

Setting the cursor moves it to the closest character boundary within the text, and removes the selection.

val hasSelection: Boolean

val selectedText: String

val selectionEnd: Int

The end of the selection. Without a selection, the cursor.

val selectionStart: Int

The start of the selection, at most selectionEnd. Without a selection, the cursor.

var text: String

Setting the text moves the cursor to its end, and is recorded like other edits.

Functions

fun clear()

fun insert(text: String)

Replaces the selection by text, or inserts it at the cursor, and moves the cursor after it.

fun redo(): Boolean

Repeats the last edit which was undone, and returns false when there is none.

fun select(anchor: Int, cursor: Int)

Selects from anchor to cursor, where the cursor is placed.

fun selectAll()

fun undo(): Boolean

Reverts the last edit, and returns false when there is none.