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 --- .../-abstract-text-input/-init-.html | 21 - .../-abstract-text-input/after-insert.html | 16 - .../-abstract-text-input/after-postpatch.html | 16 - .../-abstract-text-input/autofocus.html | 21 - .../-abstract-text-input/blur.html | 15 - .../-abstract-text-input/disabled.html | 22 - .../-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 | 505 --------------------- .../-abstract-text-input/maxlength.html | 21 - .../-abstract-text-input/name.html | 22 - .../-abstract-text-input/placeholder.html | 21 - .../-abstract-text-input/readonly.html | 21 - .../-abstract-text-input/size.html | 22 - .../-abstract-text-input/start-value.html | 27 -- .../-abstract-text-input/value.html | 21 - 17 files changed, 822 deletions(-) delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/blur.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/disabled.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/focus.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-attrs.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/get-sn-class.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/index.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/maxlength.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/name.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/placeholder.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/size.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html delete mode 100644 api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/value.html (limited to 'api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input') diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html deleted file mode 100644 index 4bd1fbfc..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/-init-.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html deleted file mode 100644 index 2774cb23..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-insert.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html deleted file mode 100644 index eb1f1c60..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -AbstractTextInput.afterPostpatch - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / afterPostpatch
-
-

afterPostpatch

- -protected open fun afterPostpatch(node: VNode): Unit -

Overrides Widget.afterPostpatch

Method called after updating Snabbdom vnode.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html deleted file mode 100644 index e8409282..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/autofocus.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -AbstractTextInput.autofocus - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / autofocus
-
-

autofocus

- -var autofocus: Boolean? -

Determines if the text input is automatically focused.

Getter
-

Determines if the text input is automatically focused.

Setter
-

Determines if the text input is automatically focused.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/blur.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/blur.html deleted file mode 100644 index 9eabcc25..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/blur.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -AbstractTextInput.blur - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / blur
-
-

blur

- -open fun blur(): Unit -

Makes the input element blur.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/disabled.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/disabled.html deleted file mode 100644 index 4d0a8074..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/disabled.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -AbstractTextInput.disabled - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / disabled
-
-

disabled

- -open var disabled: Boolean -

Overrides FormInput.disabled

Determines if the field is disabled.

Getter
-

Determines if the field is disabled.

Setter
-

Determines if the field is disabled.

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

focus

- -open fun focus(): Unit -

Makes the input element focused.

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

AbstractTextInput

-abstract class AbstractTextInput : Widget, FormInput -

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 -	-`open var disabled: Boolean` - Determines if the field is disabled. -
- maxlength -	-`var maxlength: Int?` - Maximal length of the text input value. -
- name -	-`open 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 -	-`open 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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- draggable -	-`var draggable: Boolean?` - Determines if the current widget is draggable. -
- eventTarget -	-`var eventTarget: Widget?`
- id -	-`var id: String?` - An ID attribute of generated HTML element. -
- lastLanguage -	-`var lastLanguage: String?`
- parent -	-`open var parent: Container?` - Parent of the current component. -
- role -	-`var role: String?` - A role attribute of generated HTML element. -
- surroundingSpan -	-`var surroundingSpan: Boolean`
- 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. -
- afterPostpatch -	-`open fun afterPostpatch(node: VNode): Unit` - Method called after updating Snabbdom vnode. -
- 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. -
- clearDragDropData -	-`open fun clearDragDropData(): Unit` - Clears D&D data for the current widget. It also makes it not draggable. -
- dispatchEvent -	-`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
- 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. -
- setContextMenu -	-`open fun setContextMenu(contextMenu: ContextMenu): Widget` - Sets context menu for the current widget. -
- setDragDropData -	-`open fun setDragDropData(format: String, data: String): Unit` - Sets D&D data for the current widget. It also makes it draggable. -
- setDropTarget -	-`open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit` -`open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit` - Sets the current widget as a D&D drop target. -
- setDropTargetData -	-`open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit` - Sets the current widget as a D&D drop target with helper callback accepting String data. -
- 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. -
- translate -	-`fun translate(text: String?): String?`

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/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/maxlength.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/maxlength.html deleted file mode 100644 index caef8db7..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/maxlength.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -AbstractTextInput.maxlength - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / maxlength
-
-

maxlength

- -var maxlength: Int? -

Maximal length of the text input value.

Getter
-

Maximal length of the text input value.

Setter
-

Maximal length of the text input value.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/name.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/name.html deleted file mode 100644 index d740f0c6..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/name.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -AbstractTextInput.name - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / name
-
-

name

- -open var name: String? -

Overrides FormInput.name

The name attribute of the generated HTML input element.

Getter
-

The name attribute of the generated HTML input element.

Setter
-

The name attribute of the generated HTML input element.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/placeholder.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/placeholder.html deleted file mode 100644 index 4891bd0b..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/placeholder.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -AbstractTextInput.placeholder - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / placeholder
-
-

placeholder

- -var placeholder: String? -

The placeholder for the text input.

Getter
-

The placeholder for the text input.

Setter
-

The placeholder for the text input.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html deleted file mode 100644 index cb2b662d..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/readonly.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -AbstractTextInput.readonly - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / readonly
-
-

readonly

- -var readonly: Boolean? -

Determines if the text input is read-only.

Getter
-

Determines if the text input is read-only.

Setter
-

Determines if the text input is read-only.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/size.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/size.html deleted file mode 100644 index 10f0d165..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/size.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -AbstractTextInput.size - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / size
-
-

size

- -open var size: InputSize? -

Overrides FormInput.size

The size of the input.

Getter
-

The size of the input.

Setter
-

The size of the input.

- - diff --git a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html deleted file mode 100644 index 31d55e65..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/start-value.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -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.

Getter
-

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.

Setter
-

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/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/value.html b/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/value.html deleted file mode 100644 index 6c31c567..00000000 --- a/api/kvision/pl.treksoft.kvision.form.text/-abstract-text-input/value.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -AbstractTextInput.value - kvision - - - -kvision / pl.treksoft.kvision.form.text / AbstractTextInput / value
-
-

value

- -var value: String? -

Text input value.

Getter
-

Text input value.

Setter
-

Text input value.

- - -- cgit