kvision / pl.treksoft.kvision.form.spinner / SpinnerInput

SpinnerInput

open class SpinnerInput : Widget

The basic component for spinner control.

Constructors

SpinnerInput(value: Number? = null, min: Int = 0, max: Int = DEFAULT_MAX, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: BUTTONSTYPE = BUTTONSTYPE.VERTICAL, forceType: FORCETYPE = FORCETYPE.NONE, classes: Set<String> = setOf())

Properties

autofocus	`var autofocus: Boolean?` Determines if the spinner is automatically focused.
buttonsType	`var buttonsType: BUTTONSTYPE` Spinner buttons type.
decimals	`var decimals: Int` Number of decimal digits value.
disabled	`var disabled: Boolean` Determines if the field is disabled.
forceType	`var forceType: FORCETYPE` Spinner force rounding type.
max	`var max: Int` Maximal value.
min	`var min: Int` Minimal value.
name	`var name: String?` The name attribute of the generated HTML input element.
placeholder	`var placeholder: String?` The placeholder for the spinner input.
readonly	`var readonly: Boolean?` Determines if the spinner is read-only.
size	`var size: INPUTSIZE?` The size of the input.
startValue	`var startValue: Number?` The value attribute of the generated HTML input element.
step	`var step: Double` Step value.
value	`var value: Number?` Spinner value.

Inherited Properties

id	`var id: String?` An ID attribute of generated HTML element.
parent	`open var parent: Component?` Parent of the current component.
role	`var role: String?` A role attribute of generated HTML element.
title	`var title: String?` A title attribute of generated HTML element.
visible	`open var visible: Boolean` Visibility state of the current component.

Functions

afterDestroy	`open fun afterDestroy(): Unit` Method called after destroying Snabbdom vnode.
afterInsert	`open fun afterInsert(node: VNode): Unit` Method called after inserting Snabbdom vnode into the DOM.
changeValue	`open fun changeValue(): Unit`
getSnAttrs	`open fun getSnAttrs(): List<StringPair>` Returns list of element attributes in the form of a List.
getSnClass	`open fun getSnClass(): List<StringBoolPair>` Returns list of CSS class names for current widget in the form of a List.
getValueAsString	`fun getValueAsString(): String?` Returns the value of the spinner as a String.
render	`open fun render(): VNode` Renders current component as a Snabbdom vnode.
spinDown	`fun spinDown(): SpinnerInput` Change value in minus.
spinUp	`fun spinUp(): SpinnerInput` Change value in plus.

Inherited Functions

addCssClass	`open fun addCssClass(css: String): Widget` Adds given value to the set of CSS classes generated in html code of current component.
addSurroundingCssClass	`open fun addSurroundingCssClass(css: String): Widget` Adds given value to the set of CSS classes generated in html code of parent component.
afterCreate	`open fun afterCreate(node: VNode): Unit` Method called after creating Snabbdom vnode.
afterPostpatch	`open fun afterPostpatch(node: VNode): Unit` Method called after updating Snabbdom vnode.
getElement	`open fun getElement(): Node?` Returns DOM element bound to the current component.
getElementJQuery	`open fun getElementJQuery(): JQuery?` Returns JQuery element bound to the current component.
getElementJQueryD	`open fun getElementJQueryD(): dynamic` Returns JQuery element bound to the current component as a dynamic type.
getSnHooks	`open fun getSnHooks(): Hooks?` Returns list of hooks in the form of a Snabbdom Hooks object.
getSnOn	`open fun getSnOn(): On?` Returns list of event handlers in the form of a Snabbdom On object.
hide	`open fun hide(): Widget` Makes current widget invisible.
removeCssClass	`open fun removeCssClass(css: String): Widget` Removes given value from the set of CSS classes generated in html code of current component.
removeEventListeners	`open fun removeEventListeners(): Widget` Removes all event listeners from current widget.
removeSurroundingCssClass	`open fun removeSurroundingCssClass(css: String): Widget` Removes given value from the set of CSS classes generated in html code of parent component.
render	`open fun render(elementName: String): VNode` `open fun render(elementName: String, children: Array<dynamic>): VNode` Renders current component as a Snabbdom vnode.
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.
show	`open fun show(): Widget` Makes current widget visible.
toggleVisible	`open fun toggleVisible(): Widget` Toggles visibility of current widget.

Companion Object Functions

spinnerInput

fun Container.spinnerInput(value: Number? = null, min: Int = 0, max: Int = DEFAULT_MAX, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: BUTTONSTYPE = BUTTONSTYPE.VERTICAL, forceType: FORCETYPE = FORCETYPE.NONE, classes: Set<String> = setOf(), init: SpinnerInput.() -> Unit = null): SpinnerInput

DSL builder extension function.