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-input/-init-.html | 21 ++ .../-abstract-text-input/after-insert.html | 16 + .../-abstract-text-input/autofocus.html | 15 + .../-abstract-text-input/blur.html | 15 + .../-abstract-text-input/disabled.html | 15 + .../-abstract-text-input/focus.html | 15 + .../-abstract-text-input/get-sn-attrs.html | 18 + .../-abstract-text-input/get-sn-class.html | 18 + .../-abstract-text-input/index.html | 415 +++++++++++++++++++++ .../-abstract-text-input/maxlength.html | 15 + .../-abstract-text-input/name.html | 15 + .../-abstract-text-input/placeholder.html | 15 + .../-abstract-text-input/readonly.html | 15 + .../-abstract-text-input/size.html | 15 + .../-abstract-text-input/start-value.html | 17 + .../-abstract-text-input/value.html | 15 + 16 files changed, 655 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/blur.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/focus.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/maxlength.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/name.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/placeholder.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/size.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/value.html (limited to 'docs/api/pl.treksoft.kvision.form.text/-abstract-text-input') diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html new file mode 100644 index 00000000..4bd1fbfc --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html @@ -0,0 +1,21 @@ + + + +AbstractTextInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / <init>
+
+

<init>

+ +AbstractTextInput(value: String? = null, classes: Set<String> = setOf()) +

Parameters

+value - text input value

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html new file mode 100644 index 00000000..2774cb23 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html @@ -0,0 +1,16 @@ + + + +AbstractTextInput.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / afterInsert
+
+

afterInsert

+ +protected open fun afterInsert(node: VNode): Unit +

Overrides Widget.afterInsert

Method called after inserting Snabbdom vnode into the DOM.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html new file mode 100644 index 00000000..f27ab031 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html @@ -0,0 +1,15 @@ + + + +AbstractTextInput.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / 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-input/blur.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/blur.html new file mode 100644 index 00000000..9eabcc25 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/blur.html @@ -0,0 +1,15 @@ + + + +AbstractTextInput.blur - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / blur
+
+

blur

+ +open fun blur(): Unit +

Makes the input element blur.

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

disabled

+ +var disabled: Boolean +

Determines if the field is disabled.

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

focus

+ +open fun focus(): Unit +

Makes the input element focused.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-attrs.html new file mode 100644 index 00000000..b66c84ee --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +AbstractTextInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / getSnAttrs
+
+

getSnAttrs

+ +protected open fun getSnAttrs(): List<StringPair> +

Overrides Widget.getSnAttrs

Returns list of element attributes in the form of a List.

Return
+list of element attributes

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-class.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-class.html new file mode 100644 index 00000000..9411ae2f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-class.html @@ -0,0 +1,18 @@ + + + +AbstractTextInput.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / 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-input/index.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/index.html new file mode 100644 index 00000000..eadfd60b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/index.html @@ -0,0 +1,415 @@ + + + +AbstractTextInput - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput
+
+

AbstractTextInput

+abstract class AbstractTextInput : Widget +

Base class for basic text components.

Constructors

+ + + + + + + +

<init>

+AbstractTextInput(value: String? = null, classes: Set<String> = setOf())

Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the text input is automatically focused. +
+ disabled +	+`var disabled: Boolean` + Determines if the field is disabled. +
+ 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. +
+ size +	+`var size: INPUTSIZE?` + The size of the input. +
+ startValue +	+`var startValue: String?` + The value attribute of the generated HTML input element. +
+ value +	+`var value: String?` + Text input value. +

Inherited Properties

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

+ id +	+`var id: String?` + An ID attribute of generated HTML element. +
+ parent +	+`open var parent: Component?` + Parent of the current component. +
+ role +	+`var role: String?` + A role attribute of generated HTML element. +
+ title +	+`var title: String?` + A title attribute of generated HTML element. +
+ visible +	+`open var visible: Boolean` + Visibility state of the current component. +

Functions

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

+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +

Inherited Functions

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

+ addCssClass +	+`open fun addCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`open fun addSurroundingCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of parent component. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ afterDestroy +	+`open fun afterDestroy(): Unit` + Method called after destroying Snabbdom vnode. +
+ afterPostpatch +	+`open fun afterPostpatch(node: VNode): Unit` + Method called after updating Snabbdom vnode. +
+ getElement +	+`open fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`open fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`open fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ getSnHooks +	+`open fun getSnHooks(): Hooks?` + Returns list of hooks in the form of a Snabbdom Hooks object. +
+ getSnOn +	+`open fun getSnOn(): On?` + Returns list of event handlers in the form of a Snabbdom On object. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of current component. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ removeSurroundingCssClass +	+`open fun removeSurroundingCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of parent component. +
+ render +	+`open fun render(): VNode` +`open fun render(elementName: String): VNode` +`open fun render(elementName: String, children: Array<dynamic>): VNode` + Renders current component as a Snabbdom vnode. +
+ 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. +
+ show +	+`open fun show(): Widget` + Makes current widget visible. +
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +

Inheritors

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

+ RichTextInput +	+`open class RichTextInput : AbstractTextInput` + Basic rich text component. +
+ TextAreaInput +	+`open class TextAreaInput : AbstractTextInput` + Basic textarea component. +
+ TextInput +	+`open class TextInput : AbstractTextInput` + Basic text component. +

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

maxlength

+ +var maxlength: Int? +

Maximal length of the text input value.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/name.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/name.html new file mode 100644 index 00000000..b275bccd --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/name.html @@ -0,0 +1,15 @@ + + + +AbstractTextInput.name - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / 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-input/placeholder.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/placeholder.html new file mode 100644 index 00000000..33e918af --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/placeholder.html @@ -0,0 +1,15 @@ + + + +AbstractTextInput.placeholder - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / placeholder
+
+

placeholder

+ +var placeholder: String? +

The placeholder for the text input.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html new file mode 100644 index 00000000..e3e89acf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html @@ -0,0 +1,15 @@ + + + +AbstractTextInput.readonly - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / 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-input/size.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/size.html new file mode 100644 index 00000000..fd5d9a05 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/size.html @@ -0,0 +1,15 @@ + + + +AbstractTextInput.size - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / size
+
+

size

+ +var size: INPUTSIZE? +

The size of the input.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html new file mode 100644 index 00000000..0befba8d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html @@ -0,0 +1,17 @@ + + + +AbstractTextInput.startValue - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / 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-input/value.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/value.html new file mode 100644 index 00000000..bf175e06 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/value.html @@ -0,0 +1,15 @@ + + + +AbstractTextInput.value - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / value
+
+

value

+ +var value: String? +

Text input value.

+ + -- cgit