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 --- .../-text-area/-init-.html | 29 +++ .../-text-area/cols.html | 15 ++ .../-text-area/index.html | 242 +++++++++++++++++++++ .../-text-area/input.html | 16 ++ .../-text-area/rows.html | 15 ++ .../-text-area/text-area.html | 16 ++ .../-text-area/wrap-hard.html | 15 ++ 7 files changed, 348 insertions(+) create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area/-init-.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area/cols.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area/index.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area/input.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area/rows.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area/text-area.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area/wrap-hard.html (limited to 'api1/pl.treksoft.kvision.form.text/-text-area') diff --git a/api1/pl.treksoft.kvision.form.text/-text-area/-init-.html b/api1/pl.treksoft.kvision.form.text/-text-area/-init-.html new file mode 100644 index 00000000..7878587a --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area/-init-.html @@ -0,0 +1,29 @@ + + + +TextArea.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextArea / <init>
+
+

<init>

+ +TextArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false) +

Parameters

+

+cols - number of columns

+

+rows - number of rows

+

+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/api1/pl.treksoft.kvision.form.text/-text-area/cols.html b/api1/pl.treksoft.kvision.form.text/-text-area/cols.html new file mode 100644 index 00000000..2a2c9bc0 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area/cols.html @@ -0,0 +1,15 @@ + + + +TextArea.cols - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextArea / cols
+
+

cols

+ +var cols: Int? +

Number of columns.

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area/index.html b/api1/pl.treksoft.kvision.form.text/-text-area/index.html new file mode 100644 index 00000000..dca797f7 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area/index.html @@ -0,0 +1,242 @@ + + + +TextArea - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextArea
+
+

TextArea

+open class TextArea : AbstractText +

Form field textarea component.

+

Constructors

+ + + + + + + +
+

<init>

+
+TextArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false)
+

Properties

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

cols

+
+var cols: Int? +

Number of columns.

+
+

input

+
+val input: TextAreaInput +

The actual input component.

+
+

rows

+
+var rows: Int? +

Number of rows.

+
+

wrapHard

+
+var wrapHard: Boolean +

Determines if hard wrapping is enabled for the textarea element.

+
+

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

+ + + + + + + +
+

textArea

+
+fun Container.textArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: (TextArea.() -> Unit)? = null): TextArea +

DSL builder extension function.

+
+

Extension Functions

+ + + + + + + +
+

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

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

input

+ +val input: TextAreaInput +

Overrides AbstractText.input

+

The actual input component.

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area/rows.html b/api1/pl.treksoft.kvision.form.text/-text-area/rows.html new file mode 100644 index 00000000..a1c00d2d --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area/rows.html @@ -0,0 +1,15 @@ + + + +TextArea.rows - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextArea / rows
+
+

rows

+ +var rows: Int? +

Number of rows.

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area/text-area.html b/api1/pl.treksoft.kvision.form.text/-text-area/text-area.html new file mode 100644 index 00000000..17bd0fdf --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area/text-area.html @@ -0,0 +1,16 @@ + + + +TextArea.textArea - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextArea / textArea
+
+

textArea

+ +fun Container.textArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: (TextArea.() -> Unit)? = null): TextArea +

DSL builder extension function.

+

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

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area/wrap-hard.html b/api1/pl.treksoft.kvision.form.text/-text-area/wrap-hard.html new file mode 100644 index 00000000..2bbec808 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area/wrap-hard.html @@ -0,0 +1,15 @@ + + + +TextArea.wrapHard - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextArea / wrapHard
+
+

wrapHard

+ +var wrapHard: Boolean +

Determines if hard wrapping is enabled for the textarea element.

+ + -- cgit