kvision / pl.treksoft.kvision.form.check / RadioGroup

RadioGroup

open class RadioGroup : SimplePanel, StringFormControl

The form field component rendered as a group of HTML input type="radio" elements with the same name attribute.

The radio group can be populated directly from options parameter or manually by adding Radio components to the container.

Constructors

<init>

RadioGroup(options: List<StringPair>? = null, value: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false)

Properties

disabled

open var disabled: Boolean

Determines if the field is disabled.

flabel

val flabel: FieldLabel

Form field label.

inline

var inline: Boolean

Determines if the options are rendered inline.

input

val input: Widget

The actual input component.

label

var label: String?

The label text of the options group.

options

var options: List<StringPair>?

A list of options (label to value pairs) for the group.

rich

var rich: Boolean

Determines if label can contain HTML code.

size

open var size: INPUTSIZE?

Input control size.

validationInfo

val validationInfo: HelpBlock

Validation info component.

value

open var value: String?

A value of the selected option.

Functions

getSnClass

open fun getSnClass(): List<StringBoolPair>

Returns list of CSS class names for current widget in the form of a List.

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(): String?

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

radioGroup

fun Container.radioGroup(options: List<StringPair>? = null, value: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false, init: RadioGroup.() -> Unit = null): Unit

DSL builder extension function