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 --- .../-abstract-text/-init-.html | 21 ++ .../-abstract-text/autofocus.html | 15 + .../-abstract-text/blur.html | 15 + .../-abstract-text/disabled.html | 22 ++ .../-abstract-text/flabel.html | 16 + .../-abstract-text/focus.html | 15 + .../-abstract-text/get-sn-class.html | 18 ++ .../-abstract-text/index.html | 345 +++++++++++++++++++++ .../-abstract-text/input.html | 16 + .../-abstract-text/label.html | 15 + .../-abstract-text/maxlength.html | 15 + .../-abstract-text/name.html | 15 + .../-abstract-text/placeholder.html | 15 + .../-abstract-text/readonly.html | 15 + .../-abstract-text/remove-event-listeners.html | 18 ++ .../-abstract-text/rich.html | 15 + .../-abstract-text/set-event-listener.html | 54 ++++ .../-abstract-text/size.html | 22 ++ .../-abstract-text/start-value.html | 17 + .../-abstract-text/validation-info.html | 16 + .../-abstract-text/value.html | 22 ++ 21 files changed, 722 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/autofocus.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/blur.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/flabel.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/focus.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/input.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/label.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/maxlength.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/name.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/placeholder.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/readonly.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/remove-event-listeners.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/rich.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/set-event-listener.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/size.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/start-value.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/validation-info.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text/value.html (limited to 'docs/api/pl.treksoft.kvision.form.text/-abstract-text') diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/-init-.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/-init-.html new file mode 100644 index 00000000..42fd6dce --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/-init-.html @@ -0,0 +1,21 @@ + + + +AbstractText.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / <init>
+
+

<init>

+ +AbstractText(label: String? = null, rich: Boolean = false) +

Parameters

+label - label text bound to the input element

+rich - determines if label can contain HTML code

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/autofocus.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/autofocus.html new file mode 100644 index 00000000..15351f6f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/autofocus.html @@ -0,0 +1,15 @@ + + + +AbstractText.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the text input is automatically focused.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/blur.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/blur.html new file mode 100644 index 00000000..6d996135 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/blur.html @@ -0,0 +1,15 @@ + + + +AbstractText.blur - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / blur
+
+

blur

+ +open fun blur(): Unit +

Makes the input element blur.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/disabled.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/disabled.html new file mode 100644 index 00000000..b9fbde8e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/disabled.html @@ -0,0 +1,22 @@ + + + +AbstractText.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / disabled
+
+

disabled

+ +open var disabled: Boolean +

Overrides FormControl.disabled

Determines if the field is disabled.

Getter
+

Determines if the field is disabled.

Setter
+

Determines if the field is disabled.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/flabel.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/flabel.html new file mode 100644 index 00000000..733fcfc8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/flabel.html @@ -0,0 +1,16 @@ + + + +AbstractText.flabel - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / flabel
+
+

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

Form field label.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/focus.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/focus.html new file mode 100644 index 00000000..8efcf47a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/focus.html @@ -0,0 +1,15 @@ + + + +AbstractText.focus - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / focus
+
+

focus

+ +open fun focus(): Unit +

Makes the input element focused.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/get-sn-class.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/get-sn-class.html new file mode 100644 index 00000000..c08d18b0 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/get-sn-class.html @@ -0,0 +1,18 @@ + + + +AbstractText.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
+list of CSS class names

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/index.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/index.html new file mode 100644 index 00000000..6b924710 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/index.html @@ -0,0 +1,345 @@ + + + +AbstractText - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText
+
+

AbstractText

+abstract class AbstractText : SimplePanel, StringFormControl +

Base class for form field text components.

Constructors

+ + + + + + + +

<init>

+AbstractText(label: String? = null, rich: Boolean = false)

Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the text input is automatically focused. +
+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ input +	+`abstract val input: AbstractTextInput` + The actual input component. +
+ label +	+`var label: String?` + The label text bound to the text input element. +
+ maxlength +	+`var maxlength: Int?` + Maximal length of the text input value. +
+ name +	+`var name: String?` + The name attribute of the generated HTML input element. +
+ 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. +
+ size +	+`open var size: INPUTSIZE?` + Input control size. +
+ 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. +

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. +

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

Inheritors

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

+ RichText +	+`open class RichText : AbstractText` + Form field rich text component. +
+ Text +	+`open class Text : AbstractText` + Form field text component. +
+ TextArea +	+`open class TextArea : AbstractText` + Form field textarea component. +

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

input

+ +abstract val input: AbstractTextInput +

Overrides FormControl.input

The actual input component.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/label.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/label.html new file mode 100644 index 00000000..a7694d44 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/label.html @@ -0,0 +1,15 @@ + + + +AbstractText.label - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / label
+
+

label

+ +var label: String? +

The label text bound to the text input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/maxlength.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/maxlength.html new file mode 100644 index 00000000..cee6a3cd --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/maxlength.html @@ -0,0 +1,15 @@ + + + +AbstractText.maxlength - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / maxlength
+
+

maxlength

+ +var maxlength: Int? +

Maximal length of the text input value.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/name.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/name.html new file mode 100644 index 00000000..18cef6cf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/name.html @@ -0,0 +1,15 @@ + + + +AbstractText.name - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / name
+
+

name

+ +var name: String? +

The name attribute of the generated HTML input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/placeholder.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/placeholder.html new file mode 100644 index 00000000..a77ec12b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/placeholder.html @@ -0,0 +1,15 @@ + + + +AbstractText.placeholder - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / placeholder
+
+

placeholder

+ +var placeholder: String? +

The placeholder for the text input.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/readonly.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/readonly.html new file mode 100644 index 00000000..4fb522c5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/readonly.html @@ -0,0 +1,15 @@ + + + +AbstractText.readonly - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / readonly
+
+

readonly

+ +var readonly: Boolean? +

Determines if the text input is read-only.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/remove-event-listeners.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/remove-event-listeners.html new file mode 100644 index 00000000..bd341759 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/remove-event-listeners.html @@ -0,0 +1,18 @@ + + + +AbstractText.removeEventListeners - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / removeEventListeners
+
+

removeEventListeners

+ +open fun removeEventListeners(): Widget +

Overrides Widget.removeEventListeners

Removes all event listeners from current widget.

Return
+current widget

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/rich.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/rich.html new file mode 100644 index 00000000..91dbcb4a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/rich.html @@ -0,0 +1,15 @@ + + + +AbstractText.rich - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / rich
+
+

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/set-event-listener.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/set-event-listener.html new file mode 100644 index 00000000..b7e101f5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/set-event-listener.html @@ -0,0 +1,54 @@ + + + +AbstractText.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / setEventListener
+
+

setEventListener

+ +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +

Overrides Widget.setEventListener

Sets an event listener for current widget, keeping the actual type of component.

Parameters

+T - widget type

+block - event handler

Return
+

current widget

+ + +

Example:

+ + +

    button.setEventListener<Button> {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Button here
+        }
+    }

+ +open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget +

Overrides Widget.setEventListener

Sets an event listener for current widget.

Parameters

+block - event handler

Return
+

current widget

+ + +

Example:

+ + +

    button.setEventListener {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Widget here
+        }
+    }

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/size.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/size.html new file mode 100644 index 00000000..8221e61e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/size.html @@ -0,0 +1,22 @@ + + + +AbstractText.size - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / size
+
+

size

+ +open var size: INPUTSIZE? +

Overrides FormControl.size

Input control size.

Getter
+

Input control size.

Setter
+

Input control size.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/start-value.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/start-value.html new file mode 100644 index 00000000..01635bc7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/start-value.html @@ -0,0 +1,17 @@ + + + +AbstractText.startValue - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / startValue
+
+

startValue

+ +var startValue: String? +

The value attribute of the generated HTML input element.

This value is placed directly in generated HTML code, while the value property is dynamically +bound to the text input value.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/validation-info.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/validation-info.html new file mode 100644 index 00000000..2b8e832f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/validation-info.html @@ -0,0 +1,16 @@ + + + +AbstractText.validationInfo - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / validationInfo
+
+

validationInfo

+ +val validationInfo: HelpBlock +

Overrides FormControl.validationInfo

Validation info component.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text/value.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/value.html new file mode 100644 index 00000000..44673562 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text/value.html @@ -0,0 +1,22 @@ + + + +AbstractText.value - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractText / value
+
+

value

+ +open var value: String? +

Overrides StringFormControl.value

Text input value.

Getter
+

Text value.

Setter
+

Text value.

+ + -- cgit