kvision/io.kvision.form/StringFormControl

StringFormControl

interface StringFormControl : GenericFormControl<String>

Base interface of a form control with a text value.

Inheritors

Properties

disabled

open var disabled: Boolean

Determines if the field is disabled.

flabel

abstract val flabel: FieldLabel

Form field label.

input

abstract val input: FormInput

The actual input component.

invalidFeedback

abstract val invalidFeedback: InvalidFeedback

Invalid feedback component.

name

open var name: String?

The name attribute of the generated HTML input element.

parent

abstract var parent: Container?

Parent of the current component.

size

open var size: InputSize?

Input control field size.

validationStatus

open var validationStatus: ValidationStatus?

Input control validation status.

validatorError

open var validatorError: String?

Validator error message.

value

abstract var value: String?

Generic value.

visible

abstract var visible: Boolean

Visibility state of the current component.

Functions

addAfterCreateHook

abstract fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

The supplied function is called after the component DOM element is created.

addAfterDestroyHook

abstract fun addAfterDestroyHook(hook: () -> Unit): Boolean

The supplied function is called after the component is removed from the DOM.

addAfterInsertHook

abstract fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

The supplied function is called after the component is inserted into the DOM.

addBeforeDisposeHook

abstract fun addBeforeDisposeHook(hook: () -> Unit): Boolean

The supplied function is called before the component is disposed.

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor)

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder)

addBsClearfix

fun Component.addBsClearfix()

addBsColor

fun Component.addBsColor(bsColor: BsColor)

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded)

addCssClass

abstract fun addCssClass(css: String)

Adds given value to the set of CSS classes generated in html code of current component.

addCssStyle

abstract fun addCssStyle(css: Style)

Adds given style object to the set of CSS classes generated in html code of current component.

addSurroundingCssClass

abstract fun addSurroundingCssClass(css: String)

Adds given value to the set of CSS classes generated in html code of parent component.

addSurroundingCssStyle

abstract fun addSurroundingCssStyle(css: Style)

Adds given style object to the set of CSS classes generated in html code of parent component.

blur

open fun blur()

Makes the element blur.

clearAfterCreateHooks

abstract fun clearAfterCreateHooks()

Remove all after create hooks functions.

clearAfterDestroyHooks

abstract fun clearAfterDestroyHooks()

Remove all after destroy hooks functions.

clearAfterInsertHooks

abstract fun clearAfterInsertHooks()

Remove all after insert hooks functions.

clearBeforeDisposeHooks

abstract fun clearBeforeDisposeHooks()

Remove all before dispose hooks functions.

focus

open fun focus()

Makes the element focused.

getAttribute

abstract fun getAttribute(name: String): String?

Returns the value of an additional attribute.

getElement

abstract fun getElement(): <Error class: unknown class>?

Returns DOM element bound to the current component.

getElementD

abstract fun getElementD(): dynamic

Returns DOM element bound to the current component as a dynamic type.

getElementJQuery

fun Component.getElementJQuery(): <Error class: unknown class>?

Returns JQuery element bound to the current component.

getElementJQueryD

fun Component.getElementJQueryD(): dynamic

Returns JQuery element bound to the current component as a dynamic type.

getValue

open override fun getValue(): String?

Returns the value of the control.

getValueAsString

open override fun getValueAsString(): String?

Returns the value of the control as a String.

hasCssClass

abstract fun hasCssClass(css: String): Boolean

Checks whether the given value is present in the set of CSS classes.

removeAfterCreateHook

abstract fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

Remove the after create hook function (the same function reference must be used).

removeAfterDestroyHook

abstract fun removeAfterDestroyHook(hook: () -> Unit): Boolean

Remove the after destroy hook function (the same function reference must be used).

removeAfterInsertHook

abstract fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

Remove the after insert hook function (the same function reference must be used).

removeAttribute

abstract fun removeAttribute(name: String)

Removes the value of additional attribute.

removeBeforeDisposeHook

abstract fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

Remove the before dispose hook function (the same function reference must be used).

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor)

removeBsBorder

fun Component.removeBsBorder(vararg bsBorder: BsBorder)

removeBsClearfix

fun Component.removeBsClearfix()

removeBsColor

fun Component.removeBsColor(bsColor: BsColor)

removeBsRounded

fun Component.removeBsRounded(vararg bsRounded: BsRounded)

removeCssClass

abstract fun removeCssClass(css: String)

Removes given value from the set of CSS classes generated in html code of current component.

removeCssStyle

abstract fun removeCssStyle(css: Style)

Removes given style object from the set of CSS classes generated in html code of current component.

removeSurroundingCssClass

abstract fun removeSurroundingCssClass(css: String)

Removes given value from the set of CSS classes generated in html code of parent component.

removeSurroundingCssStyle

abstract fun removeSurroundingCssStyle(css: Style)

Removes given style object from the set of CSS classes generated in html code of parent component.

setAttribute

abstract fun setAttribute(name: String, value: String)

Sets the value of additional attribute.

setValue

open override fun setValue(v: Any?)

Sets the value of the control.

singleRender

abstract fun <T> singleRender(block: () -> T): T

Executes given function within a single rendering process.

singleRenderAsync

abstract fun singleRenderAsync(block: () -> Unit)

Executes given function within a single rendering process asynchronously.

styleForHorizontalFormPanel

open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio)

Style form control element for horizontal form panel.

styleForInlineFormPanel

open fun styleForInlineFormPanel()

Style form control element for inline form panel.

styleForVerticalFormPanel

open fun styleForVerticalFormPanel()

Style form control element for vertical form panel.

abstract fun subscribe(observer: (String?) -> Unit): () -> Unit