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 --- .../-check-input/-init-.html | 23 ++ .../-check-input/after-insert.html | 16 + .../-check-input/after-postpatch.html | 16 + .../-check-input/disabled.html | 15 + .../-check-input/extra-value.html | 15 + .../-check-input/get-sn-attrs.html | 18 + .../-check-input/get-sn-class.html | 18 + .../-check-input/index.html | 364 +++++++++++++++++++++ .../-check-input/name.html | 15 + .../-check-input/on-click.html | 15 + .../-check-input/render.html | 18 + .../-check-input/size.html | 15 + .../-check-input/start-value.html | 17 + .../-check-input/type.html | 15 + .../-check-input/value.html | 15 + 15 files changed, 595 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/name.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/on-click.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/render.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/size.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/start-value.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/type.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-check-input/value.html (limited to 'docs/api/pl.treksoft.kvision.form.check/-check-input') diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html new file mode 100644 index 00000000..bc452be0 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html @@ -0,0 +1,23 @@ + + + +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/docs/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html new file mode 100644 index 00000000..6767622a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html @@ -0,0 +1,16 @@ + + + +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/docs/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html new file mode 100644 index 00000000..e5033ca8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html @@ -0,0 +1,16 @@ + + + +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/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html new file mode 100644 index 00000000..9a839220 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html @@ -0,0 +1,15 @@ + + + +CheckInput.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckInput / disabled
+
+

disabled

+ +var disabled: Boolean +

Determines if the field is disabled.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html new file mode 100644 index 00000000..d1c95624 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html @@ -0,0 +1,15 @@ + + + +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.

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

CheckInput

+open class CheckInput : Widget +

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 +	+`var disabled: Boolean` + Determines if the field is disabled. +
+ extraValue +	+`var extraValue: String?` + The additional String value used for the radio button group. +
+ name +	+`var name: String?` + The name attribute of the generated HTML input element. +
+ size +	+`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

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

+ 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. +
+ afterPostpatch +	+`open fun afterPostpatch(node: VNode): Unit` + Method called after updating Snabbdom vnode. +
+ 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. +
+ 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. +
+ 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. +

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html new file mode 100644 index 00000000..4000cbea --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html @@ -0,0 +1,15 @@ + + + +CheckInput.name - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckInput / name
+
+

name

+ +var name: String? +

The name attribute of the generated HTML input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/on-click.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/on-click.html new file mode 100644 index 00000000..66f9330a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/on-click.html @@ -0,0 +1,15 @@ + + + +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/docs/api/pl.treksoft.kvision.form.check/-check-input/render.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/render.html new file mode 100644 index 00000000..f5a8b24f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/render.html @@ -0,0 +1,18 @@ + + + +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/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html new file mode 100644 index 00000000..fc447db2 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html @@ -0,0 +1,15 @@ + + + +CheckInput.size - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckInput / size
+
+

size

+ +var size: INPUTSIZE? +

The size of the input.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/start-value.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/start-value.html new file mode 100644 index 00000000..9789c839 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/start-value.html @@ -0,0 +1,17 @@ + + + +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.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html new file mode 100644 index 00000000..cad626e5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html @@ -0,0 +1,15 @@ + + + +CheckInput.type - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckInput / type
+
+

type

+ +var type: CHECKINPUTTYPE +

The type of the generated HTML input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html new file mode 100644 index 00000000..75d9a706 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html @@ -0,0 +1,15 @@ + + + +CheckInput.value - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckInput / value
+
+

value

+ +var value: Boolean +

The selection state of the input.

+ + -- cgit