From 61545b3f1fb1844af350d187edd26285e98f0466 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 26 Feb 2018 14:21:46 +0100 Subject: API documentation update --- .../-check-input/-init-.html | 4 +- .../-check-input/check-input.html | 4 +- .../-check-input/disabled.html | 6 +++ .../-check-input/extra-value.html | 6 +++ .../-check-input/index.html | 54 ++++++++++++++++++++-- .../-check-input/name.html | 6 +++ .../-check-input/size.html | 8 +++- .../-check-input/start-value.html | 10 ++++ .../-check-input/type.html | 8 +++- .../-check-input/value.html | 6 +++ 10 files changed, 102 insertions(+), 10 deletions(-) (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 index bc452be0..79f981fb 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form.check / CheckInput / <init>

<init>

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

Parameters

type - type of the input control

diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/check-input.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/check-input.html index d2fdf9a8..9ac1b396 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/check-input.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/check-input.html @@ -8,8 +8,8 @@ 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 + +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/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html index 9a839220..2e421730 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html @@ -11,5 +11,11 @@ var disabled: Boolean

Determines if the field is disabled.

+

Getter
+

Determines if the field is disabled.

+

+

Setter
+

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 index d1c95624..07e80196 100644 --- 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 @@ -11,5 +11,11 @@ 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/docs/api/pl.treksoft.kvision.form.check/-check-input/index.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/index.html index f6957f17..8c184ab7 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/index.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/index.html @@ -18,7 +18,7 @@

<init>

-CheckInput(type: CHECKINPUTTYPE = CHECKINPUTTYPE.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf()) +CheckInput(type: CheckInputType = CheckInputType.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf()) @@ -57,7 +57,7 @@

size

-var size: INPUTSIZE? +var size: InputSize?

The size of the input.

@@ -75,7 +75,7 @@

type

-var type: CHECKINPUTTYPE +var type: CheckInputType

The type of the generated HTML input element.

@@ -95,6 +95,15 @@ +

draggable

+ + +var draggable: Boolean? +

Determines if the current widget is draggable.

+ + + +

id

@@ -240,6 +249,15 @@ +

clearDragDropData

+ + +open fun clearDragDropData(): Unit +

Clears D&D data for the current widget. It also makes it not draggable.

+ + + +

getElement

@@ -331,6 +349,34 @@ +

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

@@ -368,7 +414,7 @@

checkInput

-fun Container.checkInput(type: CHECKINPUTTYPE = CHECKINPUTTYPE.CHECKBOX, value: Boolean = false, classes: Set<String> = setOf(), init: CheckInput.() -> Unit = null): 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/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html index 4000cbea..91e2bfd4 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html @@ -11,5 +11,11 @@ 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/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html index fc447db2..cafb49d6 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html @@ -9,7 +9,13 @@

size

-var size: INPUTSIZE? +var size: InputSize?

The size of the input.

+

Getter
+

The size of the input.

+

+

Setter
+

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 index 9789c839..c113cc73 100644 --- 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 @@ -13,5 +13,15 @@

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/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html index cad626e5..660971b1 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html @@ -9,7 +9,13 @@

type

-var type: CHECKINPUTTYPE +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/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html index 75d9a706..5e6c7d08 100644 --- a/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html @@ -11,5 +11,11 @@ var value: Boolean

The selection state of the input.

+

Getter
+

The selection state of the input.

+

+

Setter
+

The selection state of the input.

+

-- cgit