From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-check-input/-init-.html | 23 + .../-check-input/after-insert.html | 16 + .../-check-input/blur.html | 16 + .../-check-input/disabled.html | 22 + .../-check-input/extra-value.html | 21 + .../-check-input/focus.html | 16 + .../-check-input/get-sn-attrs.html | 18 + .../-check-input/get-sn-class.html | 18 + .../-check-input/index.html | 643 +++++++++++++++++++++ .../-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 + 16 files changed, 939 insertions(+) create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/-init-.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/after-insert.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/blur.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/disabled.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/extra-value.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/focus.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/index.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/name.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/on-click.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/render.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/size.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/start-value.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/type.html create mode 100644 api1/pl.treksoft.kvision.form.check/-check-input/value.html (limited to 'api1/pl.treksoft.kvision.form.check/-check-input') diff --git a/api1/pl.treksoft.kvision.form.check/-check-input/-init-.html b/api1/pl.treksoft.kvision.form.check/-check-input/-init-.html new file mode 100644 index 00000000..79f981fb --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.form.check/-check-input/after-insert.html b/api1/pl.treksoft.kvision.form.check/-check-input/after-insert.html new file mode 100644 index 00000000..6767622a --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.form.check/-check-input/blur.html b/api1/pl.treksoft.kvision.form.check/-check-input/blur.html new file mode 100644 index 00000000..1a2b5f74 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.check/-check-input/blur.html @@ -0,0 +1,16 @@ + + + +CheckInput.blur - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckInput / blur
+
+

blur

+ +open fun blur(): Unit +

Overrides FormInput.blur

Makes the input element blur.

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

focus

+ +open fun focus(): Unit +

Overrides FormInput.focus

Makes the input element focused.

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

CheckInput

+abstract 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. +
+ popoverOptions +	+`var popoverOptions: PopoverOptions?`
+ 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. +
+ tooltipOptions +	+`var tooltipOptions: TooltipOptions?`
+ visible +	+`open var visible: Boolean` + Visibility state of the current component. +
+ vnode +	+`var vnode: VNode?`

Functions

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

+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ 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. +`open fun addCssClass(css: Style): Widget` + Adds given style object 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. +`open fun addSurroundingCssClass(css: Style): Widget` + Adds given style object 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. +
+ disablePopover +	+`open fun disablePopover(): Widget` + Disables popover for the current widget. +
+ disableTooltip +	+`open fun disableTooltip(): Widget` + Disables tooltip for the current widget. +
+ dispatchEvent +	+`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
+ enablePopover +	+`open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget` + Enables popover for the current widget. +
+ enableTooltip +	+`open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget` + Enables tooltip for the current widget. +
+ getAttribute +	+`open fun getAttribute(name: String): String?` + Returns the value of an additional attribute. +
+ 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. +
+ hidePopover +	+`open fun hidePopover(): Widget` + Hides popover for the current widget. +
+ hideTooltip +	+`open fun hideTooltip(): Widget` + Hides tooltip for the current widget. +
+ refreshOnUpdate +	+`fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>` +`fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>`
+ removeAttribute +	+`open fun removeAttribute(name: String): Widget` + Removes the value of additional attribute. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of current component. +`open fun removeCssClass(css: Style): Widget` + Removes given style object 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. +`open fun removeSurroundingCssClass(css: Style): Widget` + Removes given style object 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. +
+ setAttribute +	+`open fun setAttribute(name: String, value: String): Widget` + Sets the value of additional attribute. +
+ 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. +
+ showPopover +	+`open fun showPopover(): Widget` + Shows popover for the current widget. +
+ showTooltip +	+`open fun showTooltip(): Widget` + Shows tooltip for the current widget. +
+ singleRender +	+`fun <T> singleRender(block: () -> T): T`
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +
+ translate +	+`fun translate(text: String?): String?`

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

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

+ CheckBoxInput +	+`open class CheckBoxInput : CheckInput` + The basic input component rendered as HTML input type="checkbox". +
+ RadioInput +	+`open class RadioInput : CheckInput` + The basic input component rendered as HTML input type="radio". +

+ + diff --git a/api1/pl.treksoft.kvision.form.check/-check-input/name.html b/api1/pl.treksoft.kvision.form.check/-check-input/name.html new file mode 100644 index 00000000..8a3c35b8 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.check/-check-input/name.html @@ -0,0 +1,22 @@ + + + +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/api1/pl.treksoft.kvision.form.check/-check-input/on-click.html b/api1/pl.treksoft.kvision.form.check/-check-input/on-click.html new file mode 100644 index 00000000..66f9330a --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.form.check/-check-input/render.html b/api1/pl.treksoft.kvision.form.check/-check-input/render.html new file mode 100644 index 00000000..f5a8b24f --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.form.check/-check-input/size.html b/api1/pl.treksoft.kvision.form.check/-check-input/size.html new file mode 100644 index 00000000..7f23c262 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.check/-check-input/size.html @@ -0,0 +1,22 @@ + + + +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/api1/pl.treksoft.kvision.form.check/-check-input/start-value.html b/api1/pl.treksoft.kvision.form.check/-check-input/start-value.html new file mode 100644 index 00000000..c113cc73 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.check/-check-input/start-value.html @@ -0,0 +1,27 @@ + + + +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/api1/pl.treksoft.kvision.form.check/-check-input/type.html b/api1/pl.treksoft.kvision.form.check/-check-input/type.html new file mode 100644 index 00000000..660971b1 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.check/-check-input/type.html @@ -0,0 +1,21 @@ + + + +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/api1/pl.treksoft.kvision.form.check/-check-input/value.html b/api1/pl.treksoft.kvision.form.check/-check-input/value.html new file mode 100644 index 00000000..5e6c7d08 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.check/-check-input/value.html @@ -0,0 +1,21 @@ + + + +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