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 --- .../-rich-text/-init-.html | 23 +++ .../-rich-text/index.html | 223 +++++++++++++++++++++ .../-rich-text/input-height.html | 15 ++ .../-rich-text/input.html | 16 ++ 4 files changed, 277 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.text/-rich-text/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-rich-text/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-rich-text/input-height.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-rich-text/input.html (limited to 'docs/api/pl.treksoft.kvision.form.text/-rich-text') diff --git a/docs/api/pl.treksoft.kvision.form.text/-rich-text/-init-.html b/docs/api/pl.treksoft.kvision.form.text/-rich-text/-init-.html new file mode 100644 index 00000000..d0880ff1 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-rich-text/-init-.html @@ -0,0 +1,23 @@ + + + +RichText.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.text / RichText / <init>
+
+

<init>

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

Parameters

+value - text input value

+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/-rich-text/index.html b/docs/api/pl.treksoft.kvision.form.text/-rich-text/index.html new file mode 100644 index 00000000..af015e58 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-rich-text/index.html @@ -0,0 +1,223 @@ + + + +RichText - kvision + + + +kvision / pl.treksoft.kvision.form.text / RichText
+
+

RichText

+open class RichText : AbstractText +

Form field rich text component.

Constructors

+ + + + + + + +

<init>

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

Properties

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

+ input +	+`val input: RichTextInput` + The actual input component. +
+ inputHeight +	+`var inputHeight: CssSize?` + Rich input control height. +

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

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

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-rich-text/input-height.html b/docs/api/pl.treksoft.kvision.form.text/-rich-text/input-height.html new file mode 100644 index 00000000..13c8d8dd --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-rich-text/input-height.html @@ -0,0 +1,15 @@ + + + +RichText.inputHeight - kvision + + + +kvision / pl.treksoft.kvision.form.text / RichText / inputHeight
+
+

inputHeight

+ +var inputHeight: CssSize? +

Rich input control height.

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

input

+ +val input: RichTextInput +

Overrides AbstractText.input

The actual input component.

+ + -- cgit