kvision / pl.treksoft.kvision.form.check / CheckBox

CheckBox

open class CheckBox : SimplePanel, BoolFormControl

The form field component rendered as HTML input type="checkbox".

Constructors

CheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false)

Properties

circled	`var circled: Boolean` Determines if the checkbox is rendered as a circle.
flabel	`val flabel: FieldLabel` Form field label.
inline	`var inline: Boolean` Determines if the checkbox is rendered inline.
input	`val input: CheckBoxInput` The actual input component.
label	`var label: String?` The label text bound to the input element.
rich	`var rich: Boolean` Determines if label can contain HTML code.
startValue	`var startValue: Boolean` The value attribute of the generated HTML input element.
style	`var style: CheckBoxStyle?` The style (one of Bootstrap standard colors) of the input.
validationInfo	`val validationInfo: HelpBlock` Validation info component.
value	`open var value: Boolean` The selection state of the checkbox.

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.
onClick	`open fun onClick(handler: CheckBox.(MouseEvent) -> Unit): CheckBox` A convenient helper for easy setting onClick event handler.
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(): Boolean` 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.

Companion Object Functions

checkBox

fun Container.checkBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: CheckBox.() -> Unit = null): CheckBox

DSL builder extension function.

Extension Functions

createInstance

fun <T> Any?.createInstance(vararg args: dynamic): T

Helper function for creating JavaScript objects from dynamic constructors.