From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-check-input/-init-.html | 23 - .../-check-input/after-insert.html | 16 - .../-check-input/after-postpatch.html | 16 - .../-check-input/blur.html | 15 - .../-check-input/check-input.html | 16 - .../-check-input/disabled.html | 22 - .../-check-input/extra-value.html | 21 - .../-check-input/focus.html | 15 - .../-check-input/get-sn-attrs.html | 18 - .../-check-input/get-sn-class.html | 18 - .../-check-input/index.html | 486 --------------------- .../-check-input/name.html | 22 - .../-check-input/on-click.html | 15 - .../-check-input/render.html | 18 - .../-check-input/size.html | 22 - .../-check-input/start-value.html | 27 -- .../-check-input/type.html | 21 - .../-check-input/value.html | 21 - 18 files changed, 812 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/-init-.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/after-insert.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/blur.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/check-input.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/disabled.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/extra-value.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/focus.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/index.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/name.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/on-click.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/render.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/size.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/start-value.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/type.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-input/value.html (limited to 'api/pl.treksoft.kvision.form.check/-check-input') diff --git a/api/pl.treksoft.kvision.form.check/-check-input/-init-.html b/api/pl.treksoft.kvision.form.check/-check-input/-init-.html deleted file mode 100644 index 79f981fb..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/-init-.html +++ /dev/null @@ -1,23 +0,0 @@ - - - -CheckInput.<init> - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / <init>
-
-

<init>

- -

CheckInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf())

Parameters

-type - type of the input control

-value - selection state

-classes - a set of CSS class names

Constructor
-

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html b/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html deleted file mode 100644 index 6767622a..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -CheckInput.afterInsert - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / 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/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html b/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html deleted file mode 100644 index e5033ca8..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -CheckInput.afterPostpatch - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / afterPostpatch
-
-

afterPostpatch

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

Overrides Widget.afterPostpatch

Method called after updating Snabbdom vnode.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/blur.html b/api/pl.treksoft.kvision.form.check/-check-input/blur.html deleted file mode 100644 index 34571d73..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/blur.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -CheckInput.blur - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / blur
-
-

blur

- -open fun blur(): Unit -

Makes the input element blur.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/check-input.html b/api/pl.treksoft.kvision.form.check/-check-input/check-input.html deleted file mode 100644 index 9ac1b396..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/check-input.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -CheckInput.checkInput - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / checkInput
-
-

checkInput

- -

fun Container.checkInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf(), init: CheckInput.() -> Unit = null): CheckInput

DSL builder extension function.

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

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/disabled.html b/api/pl.treksoft.kvision.form.check/-check-input/disabled.html deleted file mode 100644 index e39d705e..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/disabled.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -CheckInput.disabled - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / 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/pl.treksoft.kvision.form.check/-check-input/extra-value.html b/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html deleted file mode 100644 index 07e80196..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -CheckInput.extraValue - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / extraValue
-
-

extraValue

- -var extraValue: String? -

The additional String value used for the radio button group.

Getter
-

The additional String value used for the radio button group.

Setter
-

The additional String value used for the radio button group.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/focus.html b/api/pl.treksoft.kvision.form.check/-check-input/focus.html deleted file mode 100644 index 8598d046..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/focus.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -CheckInput.focus - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / focus
-
-

focus

- -open fun focus(): Unit -

Makes the input element focused.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html deleted file mode 100644 index 01b63bf4..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -CheckInput.getSnAttrs - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / 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/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html b/api/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html deleted file mode 100644 index ad4a5a60..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -CheckInput.getSnClass - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / 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/pl.treksoft.kvision.form.check/-check-input/index.html b/api/pl.treksoft.kvision.form.check/-check-input/index.html deleted file mode 100644 index be8a7947..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/index.html +++ /dev/null @@ -1,486 +0,0 @@ - - - -CheckInput - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput
-
-

CheckInput

-open class CheckInput : Widget, FormInput -

The basic input component rendered as HTML input type="checkbox" or input type="radio".

Constructors

- - - - - - - -

<init>

CheckInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf())

Properties

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

- disabled -	-`open var disabled: Boolean` - Determines if the field is disabled. -
- extraValue -	-`var extraValue: String?` - The additional String value used for the radio button group. -
- name -	-`open var name: String?` - The name attribute of the generated HTML input element. -
- size -	-`open var size: InputSize?` - The size of the input. -
- startValue -	-`var startValue: Boolean` - The value attribute of the generated HTML input element. -
- type -	-`var type: CheckInputType` - The type of the generated HTML input element. -
- value -	-`var value: Boolean` - The selection state of the input. -

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. -
- onClick -	-`open fun onClick(handler: CheckInput.(MouseEvent) -> Unit): CheckInput` - A convenient helper for easy setting onClick event handler. -
- render -	-`open fun render(): VNode` - Renders current component as a Snabbdom vnode. -

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(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?`

Companion Object Functions

- - - - - - - -

checkInput

fun Container.checkInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf(), init: CheckInput.() -> Unit = null): CheckInput

DSL builder extension function.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/name.html b/api/pl.treksoft.kvision.form.check/-check-input/name.html deleted file mode 100644 index 8a3c35b8..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/name.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -CheckInput.name - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / 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/pl.treksoft.kvision.form.check/-check-input/on-click.html b/api/pl.treksoft.kvision.form.check/-check-input/on-click.html deleted file mode 100644 index 66f9330a..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/on-click.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -CheckInput.onClick - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / onClick
-
-

onClick

- -open fun onClick(handler: CheckInput.(MouseEvent) -> Unit): CheckInput -

A convenient helper for easy setting onClick event handler.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/render.html b/api/pl.treksoft.kvision.form.check/-check-input/render.html deleted file mode 100644 index f5a8b24f..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/render.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -CheckInput.render - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / render
-
-

render

- -protected open fun render(): VNode -

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
-Snabbdom vnode

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/size.html b/api/pl.treksoft.kvision.form.check/-check-input/size.html deleted file mode 100644 index 7f23c262..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/size.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -CheckInput.size - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / 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/pl.treksoft.kvision.form.check/-check-input/start-value.html b/api/pl.treksoft.kvision.form.check/-check-input/start-value.html deleted file mode 100644 index c113cc73..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/start-value.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -CheckInput.startValue - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / startValue
-
-

startValue

- -var startValue: Boolean -

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 input selection state.

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 input selection state.

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 input selection state.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/type.html b/api/pl.treksoft.kvision.form.check/-check-input/type.html deleted file mode 100644 index 660971b1..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/type.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -CheckInput.type - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / type
-
-

type

- -var type: CheckInputType -

The type of the generated HTML input element.

Getter
-

The type of the generated HTML input element.

Setter
-

The type of the generated HTML input element.

- - diff --git a/api/pl.treksoft.kvision.form.check/-check-input/value.html b/api/pl.treksoft.kvision.form.check/-check-input/value.html deleted file mode 100644 index 5e6c7d08..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-input/value.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -CheckInput.value - kvision - - - -kvision / pl.treksoft.kvision.form.check / CheckInput / value
-
-

value

- -var value: Boolean -

The selection state of the input.

Getter
-

The selection state of the input.

Setter
-

The selection state of the input.

- - -- cgit