glok-core/uk.co.nickthecoder.glok.control/TextField

TextField

class TextField(val document: StringDocument) : TextInputControl

A single-line text editor. For multiple lines, use TextArea.

Theme DSL

"text_field" {

    columns( value : Number )

    caretImage( image : Image )
    caretImage( images : NamedImages, imageName : String )

    font( value : Font )

    selectionColor( value : Color )
    selectionColor( value : String )

    textColor( value : Color )
    textColor( value : String )

}

TextField inherits all the features of Region.

Constructors

TextField

constructor(text: String = "")

constructor(stringProperty: StringProperty)

constructor(document: StringDocument)

Properties

anchorIndex

var anchorIndex: Int

anchorIndexProperty

val anchorIndexProperty: IntProperty

Along with caretIndex, this defines the extent of the selection. If anchorIndex == caretIndex, then nothing is selected.

caretIndex

var caretIndex: Int

caretIndexProperty

val caretIndexProperty: IntProperty

document

val document: StringDocument

expectDigits

var expectDigits: Boolean

expectDigitsProperty

val expectDigitsProperty: BooleanProperty

If set to true, the prefColumnCount and minColumnCount will use the widths of digits, rather than the letter W to calculate evalPrefWidth and evalMinWidth.

minColumnCount

var minColumnCount: Int

minColumnCountProperty

val minColumnCountProperty: StylableIntProperty

prefColumnCount

var prefColumnCount: Int

prefColumnCountProperty

val prefColumnCountProperty: StylableIntProperty

promptText

var promptText: String

promptTextColor

var promptTextColor: Color

promptTextColorProperty

val promptTextColorProperty: StylableColorProperty

promptTextProperty

val promptTextProperty: StringProperty

Text to display when text is blank.

redoable

val redoable: Boolean

redoableProperty

val redoableProperty: ObservableBoolean

selectionEnd

val selectionEnd: Int

selectionEndProperty

val selectionEndProperty: ObservableInt

The maximum of anchorIndex and caretIndex

selectionStart

val selectionStart: Int

selectionStartProperty

val selectionStartProperty: ObservableInt

The minimum of anchorIndex and caretIndex

text

var text: String

textProperty

val textProperty: StringProperty

If you bind this property, you should also set readOnly to true, as Themes may style a read-only TextArea differently. If this is bound, then the TextArea cannot be altered by the user regardless of readOnly.

textSelected

open override val textSelected: Boolean

textSelectedProperty

open override val textSelectedProperty: ObservableBoolean

True iff caretIndex != anchorIndex

undoable

val undoable: Boolean

undoableProperty

val undoableProperty: ObservableBoolean

Functions

clear

fun clear()

delete

fun delete(from: Int, to: Int)

insert

fun insert(from: Int, str: String)

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.

prefDigits

fun TextField.prefDigits(digits: Int)

Sets TextField.expectDigits = true and TextField.prefColumnCount to digits.

readOnly

fun TextField.readOnly()

redo

fun redo(): Change?

replace

fun replace(from: Int, to: Int, str: String)

selectAll

fun selectAll()

selection

fun selection(): String

undo

fun undo(): Change?