From 415afec335659ca6bc206b34bdd3c2fe4635718f Mon Sep 17 00:00:00 2001
From: Robert Jaros
+
+ Constructor Overrides Widget.afterInsert Method called after inserting Snabbdom vnode into the DOM. Overrides Widget.afterPostpatch Method called after updating Snabbdom vnode. DSL builder extension function. It takes the same parameters as the constructor of the built component. Determines if the field is disabled. Getter Determines if the field is disabled.
+
+<init>
+
+CheckInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf())
+Parameters
+type
- type of the input controlclasses
- a set of CSS class names
+
+
+afterInsert
+
+protected open fun afterInsert(node: VNode): Unit
+
+
+afterPostpatch
+
+protected open fun afterPostpatch(node: VNode): Unit
+
+
+checkInput
+
+fun Container.checkInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf(), init: CheckInput.() -> Unit = null): CheckInput
+
+
+disabled
+
+var disabled: Boolean
+
+
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 new file mode 100644 index 00000000..07e80196 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html @@ -0,0 +1,21 @@ + + + +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/get-sn-attrs.html b/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html new file mode 100644 index 00000000..01b63bf4 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +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
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
open class CheckInput : Widget
+The basic input component rendered as HTML input type="checkbox" or input type="radio".
++ + | +
+CheckInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf()) |
+
+ + | +
+var disabled: Boolean
+Determines if the field is disabled. + |
+
+ + | +
+var extraValue: String?
+The additional String value used for the radio button group. + |
+
+ + | +
+var name: String?
+The name attribute of the generated HTML input element. + |
+
+ + | +
+var size: InputSize?
+The size of the input. + |
+
+ + | +
+var startValue: Boolean
+The value attribute of the generated HTML input element. + |
+
+ + | +
+var type: CheckInputType
+The type of the generated HTML input element. + |
+
+ + | +
+var value: Boolean
+The selection state of the input. + |
+
+ + | +
+var draggable: Boolean?
+Determines if the current widget is draggable. + |
+
+ + | +
+var id: String?
+An ID attribute of generated HTML element. + |
+
+ + | +
+open var parent: Component?
+Parent of the current component. + |
+
+ + | +
+var role: String?
+A role attribute of generated HTML element. + |
+
+ + | +
+var title: String?
+A title attribute of generated HTML element. + |
+
+ + | +
+open var visible: Boolean
+Visibility state of the current component. + |
+
+ + | +
+open fun afterInsert(node: VNode): Unit
+Method called after inserting Snabbdom vnode into the DOM. + |
+
+ + | +
+open fun afterPostpatch(node: VNode): Unit
+Method called after updating Snabbdom vnode. + |
+
+ + | +
+open fun getSnAttrs(): List<StringPair>
+Returns list of element attributes in the form of a List. + |
+
+ + | +
+open fun getSnClass(): List<StringBoolPair>
+Returns list of CSS class names for current widget in the form of a List. + |
+
+ + | +
+open fun onClick(handler: CheckInput.(MouseEvent) -> Unit): CheckInput
+A convenient helper for easy setting onClick event handler. + |
+
+ + | +
+open fun render(): VNode
+Renders current component as a Snabbdom vnode. + |
+
+ + | +
+open fun addCssClass(css: String): Widget
+Adds given value to the set of CSS classes generated in html code of current component. + |
+
+ + | +
+open fun addSurroundingCssClass(css: String): Widget
+Adds given value to the set of CSS classes generated in html code of parent component. + |
+
+ + | +
+open fun afterCreate(node: VNode): Unit
+Method called after creating Snabbdom vnode. + |
+
+ + | +
+open fun afterDestroy(): Unit
+Method called after destroying Snabbdom vnode. + |
+
+ + | +
+open fun clearDragDropData(): Unit
+Clears D&D data for the current widget. It also makes it not draggable. + |
+
+ + | +
+open fun getElement(): Node?
+Returns DOM element bound to the current component. + |
+
+ + | +
+open fun getElementJQuery(): JQuery?
+Returns JQuery element bound to the current component. + |
+
+ + | +
+open fun getElementJQueryD(): dynamic
+Returns JQuery element bound to the current component as a dynamic type. + |
+
+ + | +
+open fun getSnHooks(): Hooks?
+Returns list of hooks in the form of a Snabbdom Hooks object. + |
+
+ + | +
+open fun getSnOn(): On?
+Returns list of event handlers in the form of a Snabbdom On object. + |
+
+ + | +
+open fun hide(): Widget
+Makes current widget invisible. + |
+
+ + | +
+open fun removeCssClass(css: String): Widget
+Removes given value from the set of CSS classes generated in html code of current component. + |
+
+ + | +
+open fun removeEventListeners(): Widget
+Removes all event listeners from current widget. + |
+
+ + | +
+open fun removeSurroundingCssClass(css: String): Widget
+Removes given value from the set of CSS classes generated in html code of parent component. + |
+
+ + | +
+open fun render(elementName: String): VNode + open fun render(elementName: String, children: Array<dynamic>): VNode
+Renders current component as a Snabbdom vnode. + |
+
+ + | +
+open fun setDragDropData(format: String, data: String): Unit
+Sets D&D data for the current widget. It also makes it draggable. + |
+
+ + | +
+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. + |
+
+ + | +
+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. + |
+
+ + | +
+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. + |
+
+ + | +
+open fun show(): Widget
+Makes current widget visible. + |
+
+ + | +
+open fun toggleVisible(): Widget
+Toggles visibility of current widget. + |
+
+ + | +
+fun Container.checkInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf(), init: CheckInput.() -> Unit = null): CheckInput
+DSL builder extension function. + |
+
var name: String?
+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 new file mode 100644 index 00000000..66f9330a --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-input/on-click.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..f5a8b24f --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-input/render.html @@ -0,0 +1,18 @@ + + + +protected open fun render(): VNode
+Overrides Widget.render
+Renders current component as a Snabbdom vnode.
+Return
+Snabbdom vnode
var size: InputSize?
+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 new file mode 100644 index 00000000..c113cc73 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-input/start-value.html @@ -0,0 +1,27 @@ + + + +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 new file mode 100644 index 00000000..660971b1 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-input/type.html @@ -0,0 +1,21 @@ + + + +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 new file mode 100644 index 00000000..5e6c7d08 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-input/value.html @@ -0,0 +1,21 @@ + + + +var value: Boolean
+The selection state of the input.
+Getter
+
The selection state of the input.
+ +Setter
+
The selection state of the input.
+ + + -- cgit