kvision / pl.treksoft.kvision.form.text / AbstractText

AbstractText

abstract class AbstractText : SimplePanel, StringFormControl

Base class for form field text components.

Constructors

<init>

AbstractText(label: String? = null, rich: Boolean = false)

Properties

autofocus

var autofocus: Boolean?

Determines if the text input is automatically focused.

disabled

open var disabled: Boolean

Determines if the field is disabled.

flabel

val flabel: FieldLabel

Form field label.

input

abstract val input: AbstractTextInput

The actual input component.

label

var label: String?

The label text bound to the text input element.

maxlength

var maxlength: Int?

Maximal length of the text input value.

name

var name: String?

The name attribute of the generated HTML input element.

placeholder

var placeholder: String?

The placeholder for the text input.

readonly

var readonly: Boolean?

Determines if the text input is read-only.

rich

var rich: Boolean

Determines if label can contain HTML code.

size

open var size: InputSize?

Input control size.

startValue

var startValue: String?

The value attribute of the generated HTML input element.

validationInfo

val validationInfo: HelpBlock

Validation info component.

value

open var value: String?

Text input value.

Functions

blur

open fun blur(): Unit

Makes the input element blur.

focus

open fun focus(): Unit

Makes the input element focused.

getSnClass

open fun getSnClass(): List<StringBoolPair>

Returns list of CSS class names for current widget in the form of a List.

removeEventListeners

open fun removeEventListeners(): Widget

Removes all event listeners from current widget.

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget

Sets an event listener for current widget, keeping the actual type of component.

open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget

Sets an event listener for current widget.

Inherited Functions

add

open fun add(child: Component): SimplePanel

Adds given component to the current container.

addAll

open fun addAll(children: List<Component>): SimplePanel

Adds a list of components to the current container.

addInternal

fun addInternal(child: Component): SimplePanel

Protected and final method to add given component to the current container.

childrenVNodes

open fun childrenVNodes(): Array<VNode>

Returns the array of the children Snabbdom vnodes.

getChildren

open fun getChildren(): List<Component>

Returns a list of children of the current container.

getValue

open fun getValue(): String?

Returns the value of the control.

getValueAsString

open fun getValueAsString(): String?

Returns the value of the control as a String.

remove

open fun remove(child: Component): SimplePanel

Removes given component from the current container.

removeAll

open fun removeAll(): SimplePanel

Removes all children from the current container.

render

open fun render(): VNode

Renders current component as a Snabbdom vnode.

setValue

open fun setValue(v: Any?): Unit

Sets the value of the control.

Inheritors

RichText

open class RichText : AbstractText

Form field rich text component.

Text

open class Text : AbstractText

Form field text component.

TextArea

open class TextArea : AbstractText

Form field textarea component.