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 --- .../-spinner-input/-init-.html | 33 ++ .../-spinner-input/after-destroy.html | 16 + .../-spinner-input/after-insert.html | 16 + .../-spinner-input/autofocus.html | 21 + .../-spinner-input/blur.html | 15 + .../-spinner-input/buttons-type.html | 21 + .../-spinner-input/change-value.html | 14 + .../-spinner-input/decimals.html | 21 + .../-spinner-input/disabled.html | 22 + .../-spinner-input/focus.html | 15 + .../-spinner-input/force-type.html | 21 + .../-spinner-input/get-sn-attrs.html | 18 + .../-spinner-input/get-sn-class.html | 18 + .../-spinner-input/get-value-as-string.html | 17 + .../-spinner-input/index.html | 574 +++++++++++++++++++++ .../-spinner-input/max.html | 21 + .../-spinner-input/min.html | 21 + .../-spinner-input/name.html | 22 + .../-spinner-input/placeholder.html | 21 + .../-spinner-input/readonly.html | 21 + .../-spinner-input/render.html | 18 + .../-spinner-input/size.html | 22 + .../-spinner-input/spin-down.html | 15 + .../-spinner-input/spin-up.html | 15 + .../-spinner-input/spinner-input.html | 16 + .../-spinner-input/start-value.html | 27 + .../-spinner-input/step.html | 21 + .../-spinner-input/value.html | 21 + 28 files changed, 1103 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/autofocus.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/focus.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/get-value-as-string.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/max.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/min.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/name.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/placeholder.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/readonly.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/render.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/size.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/spin-down.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/spin-up.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/spinner-input.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/start-value.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/step.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/value.html (limited to 'api/pl.treksoft.kvision.form.spinner/-spinner-input') diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html new file mode 100644 index 00000000..3365a4f2 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html @@ -0,0 +1,33 @@ + + + +SpinnerInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / <init>
+
+

<init>

+ +SpinnerInput(value: Number? = null, min: Int = 0, max: Int = DEFAULT_MAX, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, classes: Set<String> = setOf()) +

Parameters

+

+value - spinner value

+

+min - minimal value (default 0)

+

+max - maximal value (default 100)

+

+step - step value (default 1)

+

+decimals - number of decimal digits (default 0)

+

+buttonsType - spinner buttons type

+

+forceType - spinner force rounding type

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html new file mode 100644 index 00000000..c3eee4ed --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html @@ -0,0 +1,16 @@ + + + +SpinnerInput.afterDestroy - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / afterDestroy
+
+

afterDestroy

+ +protected open fun afterDestroy(): Unit +

Overrides Widget.afterDestroy

+

Method called after destroying Snabbdom vnode.

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html new file mode 100644 index 00000000..433c0858 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html @@ -0,0 +1,16 @@ + + + +SpinnerInput.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/autofocus.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/autofocus.html new file mode 100644 index 00000000..4a8fb474 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/autofocus.html @@ -0,0 +1,21 @@ + + + +SpinnerInput.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the spinner is automatically focused.

+

Getter
+

Determines if the spinner is automatically focused.

+

+

Setter
+

Determines if the spinner is automatically focused.

+

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html new file mode 100644 index 00000000..930f316d --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html @@ -0,0 +1,15 @@ + + + +SpinnerInput.blur - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / blur
+
+

blur

+ +open fun blur(): Unit +

Makes the input element blur.

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html new file mode 100644 index 00000000..b9191d5b --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html @@ -0,0 +1,21 @@ + + + +SpinnerInput.buttonsType - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / buttonsType
+
+

buttonsType

+ +var buttonsType: ButtonsType +

Spinner buttons type.

+

Getter
+

Spinner buttons type.

+

+

Setter
+

Spinner buttons type.

+

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html new file mode 100644 index 00000000..9c778406 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html @@ -0,0 +1,14 @@ + + + +SpinnerInput.changeValue - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / changeValue
+
+

changeValue

+ +protected open fun changeValue(): Unit + + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html new file mode 100644 index 00000000..635e27b7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html @@ -0,0 +1,21 @@ + + + +SpinnerInput.decimals - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / decimals
+
+

decimals

+ +var decimals: Int +

Number of decimal digits value.

+

Getter
+

Number of decimal digits value.

+

+

Setter
+

Number of decimal digits value.

+

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html new file mode 100644 index 00000000..e77813f8 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html @@ -0,0 +1,22 @@ + + + +SpinnerInput.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/focus.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/focus.html new file mode 100644 index 00000000..c67a0286 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/focus.html @@ -0,0 +1,15 @@ + + + +SpinnerInput.focus - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / focus
+
+

focus

+ +open fun focus(): Unit +

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html new file mode 100644 index 00000000..047f35cb --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html @@ -0,0 +1,21 @@ + + + +SpinnerInput.forceType - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / forceType
+
+

forceType

+ +var forceType: ForceType +

Spinner force rounding type.

+

Getter
+

Spinner force rounding type.

+

+

Setter
+

Spinner force rounding type.

+

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html new file mode 100644 index 00000000..7cc57aff --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +SpinnerInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/get-sn-class.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-class.html new file mode 100644 index 00000000..a16c4e8e --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-class.html @@ -0,0 +1,18 @@ + + + +SpinnerInput.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/get-value-as-string.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-value-as-string.html new file mode 100644 index 00000000..7dbe23c7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-value-as-string.html @@ -0,0 +1,17 @@ + + + +SpinnerInput.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / getValueAsString
+
+

getValueAsString

+ +fun getValueAsString(): String? +

Returns the value of the spinner as a String.

+

Return
+value as a String

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html new file mode 100644 index 00000000..a80e5dcd --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html @@ -0,0 +1,574 @@ + + + +SpinnerInput - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput
+
+

SpinnerInput

+open class SpinnerInput : Widget, FormInput +

The basic component for spinner control.

+

Constructors

+ + + + + + + +
+

<init>

+		 +SpinnerInput(value: Number? = null, min: Int = 0, max: Int = DEFAULT_MAX, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, classes: Set<String> = setOf())
+

Properties

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

autofocus

+		 +var autofocus: Boolean? +

Determines if the spinner is automatically focused.

+
+

buttonsType

+		 +var buttonsType: ButtonsType +

Spinner buttons type.

+
+

decimals

+		 +var decimals: Int +

Number of decimal digits value.

+
+

disabled

+		 +open var disabled: Boolean +

Determines if the field is disabled.

+
+

forceType

+		 +var forceType: ForceType +

Spinner force rounding type.

+
+

max

+		 +var max: Int +

Maximal value.

+
+

min

+		 +var min: Int +

Minimal value.

+
+

name

+		 +open var name: String? +

The name attribute of the generated HTML input element.

+
+

placeholder

+		 +var placeholder: String? +

The placeholder for the spinner input.

+
+

readonly

+		 +var readonly: Boolean? +

Determines if the spinner is read-only.

+
+

size

+		 +open var size: InputSize? +

The size of the input.

+
+

startValue

+		 +var startValue: Number? +

The value attribute of the generated HTML input element.

+
+

step

+		 +var step: Double +

Step value.

+
+

value

+		 +var value: Number? +

Spinner 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

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

afterDestroy

+		 +open fun afterDestroy(): Unit +

Method called after destroying Snabbdom vnode.

+
+

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.

+
+

changeValue

+		 +open fun changeValue(): Unit
+

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.

+
+

getValueAsString

+		 +fun getValueAsString(): String? +

Returns the value of the spinner as a String.

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

spinDown

+		 +fun spinDown(): SpinnerInput +

Change value in minus.

+
+

spinUp

+		 +fun spinUp(): SpinnerInput +

Change value in plus.

+
+

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.

+
+

afterPostpatch

+		 +open fun afterPostpatch(node: VNode): Unit +

Method called after updating 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