The caret is the vertical flashing bar between two characters, where text can be typed. When text is selected, caretPosition can be either end of the selection. See selectionStartProperty and selectionEndProperty.

children

override val children: ObservableList<Node>

The base class Node has no children, so this is an empty list.

commands

val commands: Commands

The behaviour for each Action in TextAreaActions.

document

val document: D

lineHeight

var lineHeight: Float

lineHeightProperty

val lineHeightProperty: StylableFloatProperty

The distance from the top of one line of text to the top of the next line, as a proportion of the font's height. i.e. 1 for the 'normal' distance. However, 1 looks a little cramped, and therefore 1.2 is often the 'standard' value.

prefColumnCount

var prefColumnCount: Int

prefColumnCountProperty

val prefColumnCountProperty: StylableIntProperty

Used to calculate the preferred width of this Node.

prefRowCount

var prefRowCount: Int

prefRowCountProperty

val prefRowCountProperty: StylableIntProperty

Used to calculate the preferred height of this Node.

redoable

val redoable: Boolean

redoableProperty

val redoableProperty: ObservableBoolean

See History.redoableProperty.

selectionEnd

val selectionEnd: TextPosition

selectionEndProperty

val selectionEndProperty: ObservableTextPosition

The maximum of caretPosition and anchorPosition

selectionStart

val selectionStart: TextPosition

selectionStartProperty

val selectionStartProperty: ObservableTextPosition

The minimum of caretPosition and anchorPosition

showLineNumbers

var showLineNumbers: Boolean

showLineNumbersProperty

val showLineNumbersProperty: StylableBooleanProperty

text

var text: String

textProperty

val textProperty: StringProperty

TextArea does NOT store the document as a String, it is stored as a list of strings where each item in the list does NOT contain a new line character.

textSelected

override val textSelected: Boolean

textSelectedProperty

override val textSelectedProperty: ObservableBoolean

True iff caretPosition != anchorPosition

undoable

val undoable: Boolean

undoableProperty

val undoableProperty: ObservableBoolean

See History.undoableProperty.

Functions

clear

fun clear()

delete

fun delete(from: TextPosition, to: TextPosition)

insert

fun insert(at: TextPosition, text: String)

moveCaretAndAnchor

fun moveCaretAndAnchor(position: TextPosition?, scrollTo: Boolean = true, focus: Boolean = true)

nodeMinHeight

open override fun nodeMinHeight(): Float

Each subclass of node can determine the minimum width it requires. This can be overridden on an ad-hoc basis using overrideMinHeight. The default implementation returns 0.

nodeMinWidth

open override fun nodeMinWidth(): Float

Each subclass of node can determine the minimum width it requires. This can be overridden on an ad-hoc basis using overrideMinWidth. The default implementation returns 0.

nodePrefHeight

open override fun nodePrefHeight(): Float

Each subclass of node can determine its preferred height. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.

nodePrefWidth

open override fun nodePrefWidth(): Float

Each subclass of node can determine its preferred width. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.

redo

fun redo()

replace

fun replace(from: TextPosition, to: TextPosition, text: String)

replaceSelection

fun replaceSelection(replacement: String)

Replaces the text between anchorPosition and caretPosition with replacement text. The caret is advanced to the end of the replaced text.

scrollToCaret

fun scrollToCaret()

selection

fun selection(): String

undo

fun undo()