From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-radio/index.html | 304 +++++++++++++++++++++ 1 file changed, 304 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/index.html (limited to 'docs/api/pl.treksoft.kvision.form.check/-radio/index.html') diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/index.html b/docs/api/pl.treksoft.kvision.form.check/-radio/index.html new file mode 100644 index 00000000..914d5277 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/index.html @@ -0,0 +1,304 @@ + + + +Radio - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio
+
+

Radio

+open class Radio : SimplePanel, BoolFormControl +

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

Constructors

+ + + + + + + +

<init>

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

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ extraValue +	+`var extraValue: String?` + The additional String value used for the radio button group. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ inline +	+`var inline: Boolean` + Determines if the radio button is rendered inline. +
+ input +	+`val input: CheckInput` + The actual input component. +
+ label +	+`var label: String?` + The label text bound to the input element. +
+ name +	+`var name: String?` + The name attribute of the generated HTML input element. +
+ rich +	+`var rich: Boolean` + Determines if label can contain HTML code. +
+ size +	+`open var size: INPUTSIZE?` + The size of the input. +
+ squared +	+`var squared: Boolean` + Determines if the radio button is rendered as a square. +
+ startValue +	+`var startValue: Boolean` + The value attribute of the generated HTML input element. +
+ style +	+`var style: RADIOSTYLE?` + 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 radio button. +

Functions

+ + + + + + + + + + + + + + + + + + + +

+ 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: Radio.(MouseEvent) -> Unit): Radio` + 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. +

+ + -- cgit