open class CheckBox : SimplePanel, BoolFormControl
The form field component rendered as HTML input type="checkbox".
CheckBox(value: Boolean = false, label: String? = null, rich: Boolean = false) |
var circled: Boolean
Determines if the checkbox is rendered as a circle. |
|
open var disabled: Boolean
Determines if the field is disabled. |
|
val flabel: FieldLabel
Form field label. |
|
var inline: Boolean
Determines if the checkbox is rendered inline. |
|
val input: CheckInput
The actual input component. |
|
var label: String?
The label text bound to the input element. |
|
var name: String?
The name attribute of the generated HTML input element. |
|
var rich: Boolean
Determines if label can contain HTML code. |
|
open var size: INPUTSIZE?
The size of the input. |
|
var startValue: Boolean
The value attribute of the generated HTML input element. |
|
var style: CHECKBOXSTYLE?
The style (one of Bootstrap standard colors) of the input. |
|
val validationInfo: HelpBlock
Validation info component. |
|
open var value: Boolean
The selection state of the checkbox. |
open fun getSnClass(): List<StringBoolPair>
Returns list of CSS class names for current widget in the form of a List. |
|
open fun onClick(handler: CheckBox.(MouseEvent) -> Unit): CheckBox
A convenient helper for easy setting onClick event handler. |
|
open fun removeEventListeners(): Widget
Removes all event listeners from current widget. |
|
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. |
open fun add(child: Component): SimplePanel
Adds given component to the current container. |
|
open fun addAll(children: List<Component>): SimplePanel
Adds a list of components to the current container. |
|
fun addInternal(child: Component): SimplePanel
Protected and final method to add given component to the current container. |
|
open fun childrenVNodes(): Array<VNode>
Returns the array of the children Snabbdom vnodes. |
|
open fun getChildren(): List<Component>
Returns a list of children of the current container. |
|
open fun getValue(): Boolean
Returns the value of the control. |
|
open fun getValueAsString(): String?
Returns the value of the control as a String. |
|
open fun remove(child: Component): SimplePanel
Removes given component from the current container. |
|
open fun removeAll(): SimplePanel
Removes all children from the current container. |
|
open fun render(): VNode
Renders current component as a Snabbdom vnode. |
|
open fun setValue(v: Any?): Unit
Sets the value of the control. |
fun Container.checkBox(value: Boolean = false, label: String? = null, rich: Boolean = false, init: CheckBox.() -> Unit = null): Unit
DSL builder extension function |