From 4ffe1bee99a55e985bb71dacff3839263cb4316f Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Tue, 3 Mar 2020 10:53:33 +0100 Subject: API Documentation for KVision 3.0.0 --- .../-upload/index.html | 59 ++++++++++++++++++++-- .../-upload/remove-event-listener.html | 21 ++++++++ .../-upload/set-event-listener.html | 27 +--------- 3 files changed, 77 insertions(+), 30 deletions(-) create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/remove-event-listener.html (limited to 'api/pl.treksoft.kvision.form.upload/-upload') diff --git a/api/pl.treksoft.kvision.form.upload/-upload/index.html b/api/pl.treksoft.kvision.form.upload/-upload/index.html index 7f6d6f06..e4b844ca 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/index.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/index.html @@ -322,6 +322,15 @@ If not set the upload button action will default to form submission.

+

removeEventListener

+ + +open fun removeEventListener(id: Int): Widget +

Removes event listener from current widget.

+ + + +

removeEventListeners

@@ -343,10 +352,8 @@ If not set the upload button action will default to form submission.

setEventListener

-open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

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.

@@ -464,6 +471,32 @@ If not set the upload button action will default to form submission.

+

Extension Properties

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

changeFlow

+		 +val <T : Widget> T.changeFlow: <ERROR CLASS><T>
+

clickFlow

+		 +val <T : Widget> T.clickFlow: <ERROR CLASS><T>
+

inputFlow

+		 +val <T : Widget> T.inputFlow: <ERROR CLASS><T>

Extension Functions

@@ -641,6 +674,13 @@ If not set the upload button action will default to form submission.

+ + + + + + + + @@ -833,7 +882,7 @@ If not set the upload button action will default to form submission.

onEvent

+fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Int
+

eventFlow

+		 +fun <T : Widget> T.eventFlow(event: String): <ERROR CLASS><Pair<T, Event>>

fieldLabel

 @@ -821,10 +861,19 @@ If not set the upload button action will default to form submission.

+

maps

+		 +fun Container.maps(lat: Number, lng: Number, zoom: Number, classes: Set<String> = setOf(), init: (Maps.() -> Unit)? = null): Maps +

DSL builder extension function.

+

navbar

 -fun Container.navbar(label: String? = null, link: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor = NavbarColor.LIGHT, bgColor: BsBgColor = BsBgColor.LIGHT, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null): Navbar +fun Container.navbar(label: String? = null, link: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor = NavbarColor.LIGHT, bgColor: BsBgColor = BsBgColor.LIGHT, collapseOnClick: Boolean = false, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null): Navbar

DSL builder extension function.
-fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget
diff --git a/api/pl.treksoft.kvision.form.upload/-upload/remove-event-listener.html b/api/pl.treksoft.kvision.form.upload/-upload/remove-event-listener.html new file mode 100644 index 00000000..ec25ea94 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/remove-event-listener.html @@ -0,0 +1,21 @@ + + + +Upload.removeEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / removeEventListener
+
+

removeEventListener

+ +open fun removeEventListener(id: Int): Widget +

Overrides Widget.removeEventListener

+

Removes event listener from current widget.

+

Parameters

+

+id - the id of the handler returned by onEvent

+

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html b/api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html index 66ae3acc..a59ffe86 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html @@ -9,7 +9,7 @@

setEventListener

-open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

Overrides Widget.setEventListener

Sets an event listener for current widget, keeping the actual type of component.

Parameters

@@ -18,7 +18,7 @@

block - event handler

Return
-

current widget

+

id of the handler

Example:

@@ -30,28 +30,5 @@ // self is of type Button here } }

- -open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget -

Overrides Widget.setEventListener

-
-Deprecated: Use onEvent extension function instead.
-
-

Sets an event listener for current widget.

-

Parameters

-

-block - event handler

-

Return
-

current widget

- - -

Example:

- - -
    button.setEventListener {
-        dblclick = {
-            Alert.show("Button double clicked!")
-            // self is of type Widget here
-        }
-    }

-- cgit