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 --- .../-text/-init-.html | 27 +++ .../-text/autocomplete.html | 15 ++ api/pl.treksoft.kvision.form.text/-text/index.html | 233 +++++++++++++++++++++ api/pl.treksoft.kvision.form.text/-text/input.html | 16 ++ api/pl.treksoft.kvision.form.text/-text/text.html | 16 ++ api/pl.treksoft.kvision.form.text/-text/type.html | 15 ++ 6 files changed, 322 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.text/-text/-init-.html create mode 100644 api/pl.treksoft.kvision.form.text/-text/autocomplete.html create mode 100644 api/pl.treksoft.kvision.form.text/-text/index.html create mode 100644 api/pl.treksoft.kvision.form.text/-text/input.html create mode 100644 api/pl.treksoft.kvision.form.text/-text/text.html create mode 100644 api/pl.treksoft.kvision.form.text/-text/type.html (limited to 'api/pl.treksoft.kvision.form.text/-text') diff --git a/api/pl.treksoft.kvision.form.text/-text/-init-.html b/api/pl.treksoft.kvision.form.text/-text/-init-.html new file mode 100644 index 00000000..530d8779 --- /dev/null +++ b/api/pl.treksoft.kvision.form.text/-text/-init-.html @@ -0,0 +1,27 @@ + + + +Text.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.text / Text / <init>
+
+

<init>

+ +

Text(type: TextInputType = TextInputType.TEXT, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false)

Parameters

+type - text input type (default "text")

+value - text input value

+name - the name attribute of the generated HTML input element

+label - label text bound to the input element

+rich - determines if label can contain HTML code

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.text/-text/autocomplete.html b/api/pl.treksoft.kvision.form.text/-text/autocomplete.html new file mode 100644 index 00000000..51ad2ca4 --- /dev/null +++ b/api/pl.treksoft.kvision.form.text/-text/autocomplete.html @@ -0,0 +1,15 @@ + + + +Text.autocomplete - kvision + + + +kvision / pl.treksoft.kvision.form.text / Text / autocomplete
+
+

autocomplete

+ +var autocomplete: Boolean? +

Determines if autocomplete is enabled for the input element.

+ + diff --git a/api/pl.treksoft.kvision.form.text/-text/index.html b/api/pl.treksoft.kvision.form.text/-text/index.html new file mode 100644 index 00000000..e78ccda6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.text/-text/index.html @@ -0,0 +1,233 @@ + + + +Text - kvision + + + +kvision / pl.treksoft.kvision.form.text / Text
+
+

Text

+open class Text : AbstractText +

Form field text component.

Constructors

+ + + + + + + +

<init>

Text(type: TextInputType = TextInputType.TEXT, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false)

Properties

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

+ autocomplete +	+`var autocomplete: Boolean?` + Determines if autocomplete is enabled for the input element. +
+ input +	+`val input: TextInput` + The actual input component. +
+ type +	+`var type: TextInputType` + Text input type. +

Inherited Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the text input is automatically focused. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ label +	+`var label: String?` + The label text bound to the text input element. +
+ maxlength +	+`var maxlength: Int?` + Maximal length of the text input value. +
+ placeholder +	+`var placeholder: String?` + The placeholder for the text input. +
+ readonly +	+`var readonly: Boolean?` + Determines if the text input is read-only. +
+ rich +	+`var rich: Boolean` + Determines if label can contain HTML code. +
+ startValue +	+`var startValue: String?` + The value attribute of the generated HTML input element. +
+ validationInfo +	+`val validationInfo: HelpBlock` + Validation info component. +
+ value +	+`open var value: String?` + Text input value. +

Inherited Functions

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

+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ 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. +

Companion Object Functions

+ + + + + + + +

text

fun Container.text(type: TextInputType = TextInputType.TEXT, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: Text.() -> Unit = null): Text

DSL builder extension function.

Inheritors

+ + + + + + + +

Password

+open class Password : Text +

Form field password component.

+ + diff --git a/api/pl.treksoft.kvision.form.text/-text/input.html b/api/pl.treksoft.kvision.form.text/-text/input.html new file mode 100644 index 00000000..be0c9234 --- /dev/null +++ b/api/pl.treksoft.kvision.form.text/-text/input.html @@ -0,0 +1,16 @@ + + + +Text.input - kvision + + + +kvision / pl.treksoft.kvision.form.text / Text / input
+
+

input

+ +val input: TextInput +

Overrides AbstractText.input

The actual input component.

+ + diff --git a/api/pl.treksoft.kvision.form.text/-text/text.html b/api/pl.treksoft.kvision.form.text/-text/text.html new file mode 100644 index 00000000..3c06ae61 --- /dev/null +++ b/api/pl.treksoft.kvision.form.text/-text/text.html @@ -0,0 +1,16 @@ + + + +Text.text - kvision + + + +kvision / pl.treksoft.kvision.form.text / Text / text
+
+

text

+ +

fun Container.text(type: TextInputType = TextInputType.TEXT, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: Text.() -> Unit = null): Text

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api/pl.treksoft.kvision.form.text/-text/type.html b/api/pl.treksoft.kvision.form.text/-text/type.html new file mode 100644 index 00000000..1858490c --- /dev/null +++ b/api/pl.treksoft.kvision.form.text/-text/type.html @@ -0,0 +1,15 @@ + + + +Text.type - kvision + + + +kvision / pl.treksoft.kvision.form.text / Text / type
+
+

type

+ +var type: TextInputType +

Text input type.

+ + -- cgit