From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- .../-string-form-control/get-value-as-string.html | 16 ++ .../-string-form-control/get-value.html | 18 ++ .../-string-form-control/index.html | 183 +++++++++++++++++++++ .../-string-form-control/set-value.html | 19 +++ .../-string-form-control/value.html | 15 ++ 5 files changed, 251 insertions(+) create mode 100644 api/pl.treksoft.kvision.form/-string-form-control/get-value-as-string.html create mode 100644 api/pl.treksoft.kvision.form/-string-form-control/get-value.html create mode 100644 api/pl.treksoft.kvision.form/-string-form-control/index.html create mode 100644 api/pl.treksoft.kvision.form/-string-form-control/set-value.html create mode 100644 api/pl.treksoft.kvision.form/-string-form-control/value.html (limited to 'api/pl.treksoft.kvision.form/-string-form-control') diff --git a/api/pl.treksoft.kvision.form/-string-form-control/get-value-as-string.html b/api/pl.treksoft.kvision.form/-string-form-control/get-value-as-string.html new file mode 100644 index 00000000..65693283 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/get-value-as-string.html @@ -0,0 +1,16 @@ + + + +StringFormControl.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form / StringFormControl / getValueAsString
+
+

getValueAsString

+ +open fun getValueAsString(): String? +

Overrides FormControl.getValueAsString

Returns the value of the control as a String.

+ + diff --git a/api/pl.treksoft.kvision.form/-string-form-control/get-value.html b/api/pl.treksoft.kvision.form/-string-form-control/get-value.html new file mode 100644 index 00000000..edfa3c58 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/get-value.html @@ -0,0 +1,18 @@ + + + +StringFormControl.getValue - kvision + + + +kvision / pl.treksoft.kvision.form / StringFormControl / getValue
+
+

getValue

+ +open fun getValue(): String? +

Overrides FormControl.getValue

Returns the value of the control.

Return
+the value

+ + diff --git a/api/pl.treksoft.kvision.form/-string-form-control/index.html b/api/pl.treksoft.kvision.form/-string-form-control/index.html new file mode 100644 index 00000000..2b6d030d --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/index.html @@ -0,0 +1,183 @@ + + + +StringFormControl - kvision + + + +kvision / pl.treksoft.kvision.form / StringFormControl
+
+

StringFormControl

+interface StringFormControl : FormControl +

Base interface of a form control with a text value.

Properties

+ + + + + + + +

value

+abstract var value: String? +

Text value.

Inherited Properties

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

+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ flabel +	+`abstract val flabel: FieldLabel` + Form field label. +
+ input +	+`abstract val input: FormInput` + The actual input component. +
+ name +	+`open var name: String?` + The name attribute of the generated HTML input element. +
+ size +	+`open var size: InputSize?` + Input control field size. +
+ validationInfo +	+`abstract val validationInfo: HelpBlock` + Validation info component. +
+ validatorError +	+`open var validatorError: String?` + Validator error message. +

Functions

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

+ 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. +
+ setValue +	+`open fun setValue(v: Any?): Unit` + Sets the value of the control. +

Inherited Functions

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

+ blur +	+`abstract fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`abstract fun focus(): Unit` + Makes the input element focused. +

Inheritors

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

+ AbstractText +	+`abstract class AbstractText : SimplePanel, StringFormControl` + Base class for form field text components. +
+ 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. +
+ Select +	+`open class Select : SimplePanel, StringFormControl` + The form field component for Select control. +

+ + diff --git a/api/pl.treksoft.kvision.form/-string-form-control/set-value.html b/api/pl.treksoft.kvision.form/-string-form-control/set-value.html new file mode 100644 index 00000000..7188abdc --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/set-value.html @@ -0,0 +1,19 @@ + + + +StringFormControl.setValue - kvision + + + +kvision / pl.treksoft.kvision.form / StringFormControl / setValue
+
+

setValue

+ +open fun setValue(v: Any?): Unit +

Overrides FormControl.setValue

Sets the value of the control.

Parameters

+v - the value

+ + diff --git a/api/pl.treksoft.kvision.form/-string-form-control/value.html b/api/pl.treksoft.kvision.form/-string-form-control/value.html new file mode 100644 index 00000000..d01cb792 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/value.html @@ -0,0 +1,15 @@ + + + +StringFormControl.value - kvision + + + +kvision / pl.treksoft.kvision.form / StringFormControl / value
+
+

value

+ +abstract var value: String? +

Text value.

+ + -- cgit