8.2.0

kvision-imask/io.kvision.form.number/ImaskNumericInput

ImaskNumericInput

open class ImaskNumericInput(value: Number? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), thousandsSeparator: Char? = I18n.detectThousandsSeparator(), padFractionalZeros: Boolean = false, normalizeZeros: Boolean = true, className: String? = null, init: ImaskNumericInput.() -> Unit? = null) : Widget, GenericFormComponent<Number?> , FormInput, MutableState<Number?> (source)

Numeric input component with masked input.

Parameters

value

numeric input value

min

minimal value

max

maximal value

decimals

the number of decimal digits (default 2)

decimalSeparator

the decimal separator (default: auto detect)

thousandsSeparator

the thousands separator (default: auto detect)

padFractionalZeros

pads fractional zeros at end to the length of scale

normalizeZeros

appends or removes zeros at the end

className

CSS class names

init

an initializer extension function

Constructors

ImaskNumericInput

constructor(value: Number? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), thousandsSeparator: Char? = I18n.detectThousandsSeparator(), padFractionalZeros: Boolean = false, normalizeZeros: Boolean = true, className: String? = null, init: ImaskNumericInput.() -> Unit? = null)

Types

object Companion

Properties

open var alignContent: AlignContent?

open var alignItems: AlignItems?

open var alignSelf: AlignItems?

var autofocus: Boolean?

Determines if the numeric input is automatically focused.

open var background: Background?

open var border: Border?

open var borderBottom: Border?

open var borderLeft: Border?

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

open var borderRight: Border?

open var borderTop: Border?

open var bottom: CssSize?

open var boxShadow: BoxShadow?

open var boxShadowList: List<BoxShadow>?

open var clear: Clear?

open var color: Color?

open var colorHex: Int?

open var colorName: Col?

open var cursor: Cursor?

var decimals: Int

The number of decimal digits.

decimalSeparator

var decimalSeparator: Char

The decimal separator.

open override var disabled: Boolean

Determines if the field is disabled.

open var display: Display?

var draggable: Boolean?

var eventTarget: Widget?

open var flexBasis: CssSize?

open var flexDirection: FlexDirection?

open var flexGrow: Int?

open var flexShrink: Int?

open var flexWrap: FlexWrap?

open var float: PosFloat?

open var fontFamily: String?

open var fontSize: CssSize?

open var fontStyle: FontStyle?

open var fontVariant: FontVariant?

open var fontWeight: FontWeight?

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

open var gridAutoFlow: GridAutoFlow?

open var gridAutoRows: String?

open var gridColumnEnd: String?

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

open var gridRowEnd: String?

open var gridRowGap: Int?

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

open var height: CssSize?

var id: String?

open var justifyContent: JustifyContent?

open var justifyItems: JustifyItems?

open var justifySelf: JustifyItems?

var kvscope: dynamic

open var left: CssSize?

open var letterSpacing: CssSize?

open var lineBreak: LineBreak?

open var lineHeight: CssSize?

open var listStyle: ListStyle?

open var margin: CssSize?

open var marginBottom: CssSize?

open var marginLeft: CssSize?

open var marginRight: CssSize?

open var marginTop: CssSize?

var max: Number?

Maximal value.

open var maxHeight: CssSize?

open var maxWidth: CssSize?

var min: Number?

Minimal value.

open var minHeight: CssSize?

open var minWidth: CssSize?

open override var name: String?

The name attribute of the generated HTML input element.

var normalizeZeros: Boolean

Appends or removes zeros at the end.

open var opacity: Double?

open var order: Int?

open var outline: Outline?

open var overflow: Overflow?

open var overflowWrap: OverflowWrap?

open var overflowX: Overflow?

open var overflowY: Overflow?

open var padding: CssSize?

open var paddingBottom: CssSize?

open var paddingLeft: CssSize?

open var paddingRight: CssSize?

open var paddingTop: CssSize?

padFractionalZeros

var padFractionalZeros: Boolean

Pads fractional zeros at end to the length of scale.

open override var parent: Container?

var placeholder: String?

The placeholder for the numeric input.

popoverHooksActive

var popoverHooksActive: Boolean

var popoverOptions: dynamic

open var position: Position?

var readonly: Boolean?

Determines if the numeric input is read-only.

open var resize: Resize?

open var right: CssSize?

var role: String?

open override var size: InputSize?

The size of the input.

var startValue: Number?

The value attribute of the generated HTML input element.

var tabindex: Int?

open var textAlign: TextAlign?

open var textDecoration: TextDecoration?

open var textDirection: Direction?

open var textIndent: CssSize?

open var textOverflow: TextOverflow?

open var textShadow: TextShadow?

open var textTransform: TextTransform?

thousandsSeparator

var thousandsSeparator: Char?

The thousands separator.

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

var tooltipOptions: dynamic

open var top: CssSize?

open var transition: Transition?

open var transitionList: List<Transition>?

open var unicodeBidi: UnicodeBidi?

validationStatus

open override var validationStatus: ValidationStatus?

The validation status of the input.

open override var value: Number?

Spinner input value.

open var verticalAlign: VerticalAlign?

open override var visible: Boolean

open var whiteSpace: WhiteSpace?

open var width: CssSize?

open var wordBreak: WordBreak?

open var wordSpacing: CssSize?

open var zIndex: Int?

Functions

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

open override fun addCssClass(css: String)

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

open fun blur()

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

clearDragDropData

open fun clearDragDropData()

open override fun clearParent()

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

open override fun dispose()

open fun focus()

open override fun getAttribute(name: String): String?

open override fun getElement(): HTMLElement?

open override fun getElementD(): dynamic

open override fun getRoot(): Root?

open fun getSnStyle(): dynamic

open override fun getState(): Number?

fun getStyle(name: String): String?

getValueAsString

fun getValueAsString(): String?

Returns the value of the numeric input as a String.

open override fun hasCssClass(css: String): Boolean

open fun hide()

open fun installMask()

Install the input mask controller.

open override fun refresh()

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

removeAttribute

open override fun removeAttribute(name: String)

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

open override fun removeCssClass(css: String)

open override fun removeCssStyle(css: Style)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

fun removeStyle(name: String)

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

open override fun renderVNode(): VNode

open override fun setAttribute(name: String, value: String)

setDragDropData

open fun setDragDropData(format: String, data: String)

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

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

open override fun setState(state: Number?)

fun setStyle(name: String, value: String)

open fun show()

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

open override fun subscribe(observer: (Number?) -> Unit): () -> Unit

open fun toggleVisible()

open fun translate(text: String): String

open fun translate(text: String?): String?

open fun uninstallMask()

Uninstall the input mask controller.

useSnabbdomDistinctKey

open fun useSnabbdomDistinctKey()