kvision / pl.treksoft.kvision.form.spinner / Spinner

Spinner

open class Spinner : SimplePanel, NumberFormControl

The form field component for spinner control.

Constructors

Spinner(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, label: String? = null, rich: Boolean = false)

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	`open var disabled: Boolean` Determines if the field is disabled.
flabel	`val flabel: FieldLabel` Form field label.
forceType	`var forceType: FORCETYPE` Spinner force rounding type.
idc	`val idc: String`
input	`val input: SpinnerInput` The actual input component.
label	`var label: String?` The label text bound to the spinner input element.
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.
rich	`var rich: Boolean` Determines if label can contain HTML code.
size	`open var size: INPUTSIZE?` Input control size.
startValue	`var startValue: Number?` The value attribute of the generated HTML input element.
step	`var step: Double` Step value.
validationInfo	`val validationInfo: HelpBlock` Validation info component.
value	`open var value: Number?` Spinner value.

Functions

getSnClass	`open fun getSnClass(): List<StringBoolPair>` Returns list of CSS class names for current widget in the form of a List.
getValueAsString	`open fun getValueAsString(): String?` Returns the value of the control as a String.
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.
spinDown	`open fun spinDown(): Spinner` Change value in minus.
spinUp	`open fun spinUp(): Spinner` Change value in plus.

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(): Number?` Returns the value of the control.
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.

Companion Object Functions

spinner

fun Container.spinner(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, label: String? = null, rich: Boolean = false, init: Spinner.() -> Unit = null): Spinner

DSL builder extension function.