From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-bool-form-control/get-value-as-string.html | 16 ++ .../-bool-form-control/get-value.html | 18 ++ .../-bool-form-control/index.html | 188 +++++++++++++++++++++ .../-bool-form-control/set-value.html | 19 +++ .../-bool-form-control/value.html | 15 ++ 5 files changed, 256 insertions(+) create mode 100644 api1/pl.treksoft.kvision.form/-bool-form-control/get-value-as-string.html create mode 100644 api1/pl.treksoft.kvision.form/-bool-form-control/get-value.html create mode 100644 api1/pl.treksoft.kvision.form/-bool-form-control/index.html create mode 100644 api1/pl.treksoft.kvision.form/-bool-form-control/set-value.html create mode 100644 api1/pl.treksoft.kvision.form/-bool-form-control/value.html (limited to 'api1/pl.treksoft.kvision.form/-bool-form-control') diff --git a/api1/pl.treksoft.kvision.form/-bool-form-control/get-value-as-string.html b/api1/pl.treksoft.kvision.form/-bool-form-control/get-value-as-string.html new file mode 100644 index 00000000..051170f1 --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-bool-form-control/get-value-as-string.html @@ -0,0 +1,16 @@ + + + +BoolFormControl.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form / BoolFormControl / getValueAsString
+
+

getValueAsString

+ +open fun getValueAsString(): String? +

Overrides FormControl.getValueAsString

Returns the value of the control as a String.

+ + diff --git a/api1/pl.treksoft.kvision.form/-bool-form-control/get-value.html b/api1/pl.treksoft.kvision.form/-bool-form-control/get-value.html new file mode 100644 index 00000000..3e08a58c --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-bool-form-control/get-value.html @@ -0,0 +1,18 @@ + + + +BoolFormControl.getValue - kvision + + + +kvision / pl.treksoft.kvision.form / BoolFormControl / getValue
+
+

getValue

+ +open fun getValue(): Boolean +

Overrides FormControl.getValue

Returns the value of the control.

Return
+the value

+ + diff --git a/api1/pl.treksoft.kvision.form/-bool-form-control/index.html b/api1/pl.treksoft.kvision.form/-bool-form-control/index.html new file mode 100644 index 00000000..03a65771 --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-bool-form-control/index.html @@ -0,0 +1,188 @@ + + + +BoolFormControl - kvision + + + +kvision / pl.treksoft.kvision.form / BoolFormControl
+
+

BoolFormControl

+interface BoolFormControl : FormControl +

Base interface of a form control with a boolean value.

Properties

+ + + + + + + +

value

+abstract var value: Boolean +

Boolean 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(): Boolean` + 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. +

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

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

+ CheckBox +	+`open class CheckBox : SimplePanel, BoolFormControl` + The form field component rendered as HTML input type="checkbox". +
+ Radio +	+`open class Radio : SimplePanel, BoolFormControl` + The form field component rendered as HTML input type="radio". +

+ + diff --git a/api1/pl.treksoft.kvision.form/-bool-form-control/set-value.html b/api1/pl.treksoft.kvision.form/-bool-form-control/set-value.html new file mode 100644 index 00000000..66079b74 --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-bool-form-control/set-value.html @@ -0,0 +1,19 @@ + + + +BoolFormControl.setValue - kvision + + + +kvision / pl.treksoft.kvision.form / BoolFormControl / setValue
+
+

setValue

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

Overrides FormControl.setValue

Sets the value of the control.

Parameters

+v - the value

+ + diff --git a/api1/pl.treksoft.kvision.form/-bool-form-control/value.html b/api1/pl.treksoft.kvision.form/-bool-form-control/value.html new file mode 100644 index 00000000..83a96ef7 --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-bool-form-control/value.html @@ -0,0 +1,15 @@ + + + +BoolFormControl.value - kvision + + + +kvision / pl.treksoft.kvision.form / BoolFormControl / value
+
+

value

+ +abstract var value: Boolean +

Boolean value.

+ + -- cgit