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 --- .../-drop-down/-init-.html | 33 +++ .../-drop-down/add-all.html | 21 ++ .../-drop-down/add.html | 21 ++ .../-drop-down/after-insert.html | 16 ++ .../-drop-down/block.html | 15 ++ .../-drop-down/button-id.html | 14 ++ .../-drop-down/disabled.html | 15 ++ .../-drop-down/drop-down.html | 16 ++ .../-drop-down/dropup.html | 21 ++ .../-drop-down/for-navbar.html | 15 ++ .../-drop-down/get-children.html | 18 ++ .../-drop-down/get-sn-class.html | 18 ++ .../-drop-down/icon.html | 15 ++ .../-drop-down/image.html | 15 ++ .../-drop-down/index.html | 251 +++++++++++++++++++++ .../-drop-down/remove-all.html | 18 ++ .../-drop-down/remove.html | 21 ++ .../-drop-down/render.html | 18 ++ .../-drop-down/size.html | 15 ++ .../-drop-down/style.html | 15 ++ .../-drop-down/text.html | 15 ++ .../-drop-down/toggle.html | 15 ++ .../-drop-down/width.html | 16 ++ 23 files changed, 637 insertions(+) create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/add.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/block.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/icon.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/image.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/index.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/remove.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/render.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/size.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/style.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/text.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/toggle.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/width.html (limited to 'api/pl.treksoft.kvision.dropdown/-drop-down') diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html new file mode 100644 index 00000000..67e3cdef --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html @@ -0,0 +1,33 @@ + + + +DropDown.<init> - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / <init>
+
+

<init>

+ +

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf())

Parameters

+text - the label of the dropdown button

+elements - an optional list of link elements (special options from DD enum class can be used as values)

+icon - the icon of the dropdown button

+style - the style of the dropdown button

+disabled - determines if the component is disabled on start

+forNavbar - determines if the component will be used in a navbar

+withCaret - determines if the dropdown button renders caret

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html b/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html new file mode 100644 index 00000000..464a2fea --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html @@ -0,0 +1,21 @@ + + + +DropDown.addAll - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / addAll
+
+

addAll

+ +open fun addAll(children: List<Component>): SimplePanel +

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/add.html b/api/pl.treksoft.kvision.dropdown/-drop-down/add.html new file mode 100644 index 00000000..85081d14 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/add.html @@ -0,0 +1,21 @@ + + + +DropDown.add - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / add
+
+

add

+ +open fun add(child: Component): SimplePanel +

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html b/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html new file mode 100644 index 00000000..1b4bb89d --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html @@ -0,0 +1,16 @@ + + + +DropDown.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / 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.dropdown/-drop-down/block.html b/api/pl.treksoft.kvision.dropdown/-drop-down/block.html new file mode 100644 index 00000000..446d4803 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/block.html @@ -0,0 +1,15 @@ + + + +DropDown.block - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / block
+
+

block

+ +var block: Boolean +

Determines if the dropdown button takes all the space horizontally.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html b/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html new file mode 100644 index 00000000..abac1ea0 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html @@ -0,0 +1,14 @@ + + + +DropDown.buttonId - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / buttonId
+
+

buttonId

+ +fun buttonId(): String? + + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html b/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html new file mode 100644 index 00000000..9c25d116 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html @@ -0,0 +1,15 @@ + + + +DropDown.disabled - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / disabled
+
+

disabled

+ +var disabled: Boolean +

Determines if the dropdown is disabled.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html new file mode 100644 index 00000000..0c1af12f --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html @@ -0,0 +1,16 @@ + + + +DropDown.dropDown - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / dropDown
+
+

dropDown

+ +

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html b/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html new file mode 100644 index 00000000..40a56d7b --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html @@ -0,0 +1,21 @@ + + + +DropDown.dropup - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / dropup
+
+

dropup

+ +var dropup: Boolean +

Determines if the dropdown is showing upwards.

Getter
+

Determines if the dropdown is showing upwards.

Setter
+

Determines if the dropdown is showing upwards.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html new file mode 100644 index 00000000..33497640 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html @@ -0,0 +1,15 @@ + + + +DropDown.forNavbar - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / forNavbar
+
+

forNavbar

+ +val forNavbar: Boolean +

determines if the component will be used in a navbar

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html b/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html new file mode 100644 index 00000000..749b4086 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html @@ -0,0 +1,18 @@ + + + +DropDown.getChildren - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / getChildren
+
+

getChildren

+ +open fun getChildren(): List<Component> +

Overrides SimplePanel.getChildren

Returns a list of children of the current container.

Return
+list of children

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html b/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html new file mode 100644 index 00000000..c9d8031d --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html @@ -0,0 +1,18 @@ + + + +DropDown.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / 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.dropdown/-drop-down/icon.html b/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html new file mode 100644 index 00000000..33c4950b --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html @@ -0,0 +1,15 @@ + + + +DropDown.icon - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / icon
+
+

icon

+ +var icon: String? +

The icon of the dropdown button.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/image.html b/api/pl.treksoft.kvision.dropdown/-drop-down/image.html new file mode 100644 index 00000000..56755e67 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/image.html @@ -0,0 +1,15 @@ + + + +DropDown.image - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / image
+
+

image

+ +var image: ResString? +

The image on the dropdown button.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html new file mode 100644 index 00000000..a15ebb28 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -0,0 +1,251 @@ + + + +DropDown - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown
+
+

DropDown

+open class DropDown : SimplePanel +

Bootstrap dropdown component.

Constructors

+ + + + + + + +

<init>

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf())

Properties

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

+ block +	+`var block: Boolean` + Determines if the dropdown button takes all the space horizontally. +
+ disabled +	+`var disabled: Boolean` + Determines if the dropdown is disabled. +
+ dropup +	+`var dropup: Boolean` + Determines if the dropdown is showing upwards. +
+ forNavbar +	+`val forNavbar: Boolean` + determines if the component will be used in a navbar +
+ icon +	+`var icon: String?` + The icon of the dropdown button. +
+ image +	+`var image: ResString?` + The image on the dropdown button. +
+ size +	+`var size: ButtonSize?` + The size of the dropdown button. +
+ style +	+`var style: ButtonStyle` + The style of the dropdown button. +
+ text +	+`var text: String` + Label of the dropdown button. +
+ width +	+`open var width: CssSize?` + Width of the dropdown button. +

Functions

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

+ add +	+`open fun add(child: Component): SimplePanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): SimplePanel` + Adds a list of components to the current container. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ buttonId +	+`fun buttonId(): String?`
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ remove +	+`open fun remove(child: Component): SimplePanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): SimplePanel` + Removes all children from the current container. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +
+ toggle +	+`open fun toggle(): Unit` + Toggles dropdown visibility. +

Inherited Functions

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

+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +

Companion Object Functions

+ + + + + + + +

dropDown

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html b/api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html new file mode 100644 index 00000000..e90b5611 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html @@ -0,0 +1,18 @@ + + + +DropDown.removeAll - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/remove.html b/api/pl.treksoft.kvision.dropdown/-drop-down/remove.html new file mode 100644 index 00000000..8b80a74c --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/remove.html @@ -0,0 +1,21 @@ + + + +DropDown.remove - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / remove
+
+

remove

+ +open fun remove(child: Component): SimplePanel +

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/render.html b/api/pl.treksoft.kvision.dropdown/-drop-down/render.html new file mode 100644 index 00000000..6f4b3a6b --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/render.html @@ -0,0 +1,18 @@ + + + +DropDown.render - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/size.html b/api/pl.treksoft.kvision.dropdown/-drop-down/size.html new file mode 100644 index 00000000..e29a3169 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/size.html @@ -0,0 +1,15 @@ + + + +DropDown.size - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / size
+
+

size

+ +var size: ButtonSize? +

The size of the dropdown button.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/style.html b/api/pl.treksoft.kvision.dropdown/-drop-down/style.html new file mode 100644 index 00000000..15e06226 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/style.html @@ -0,0 +1,15 @@ + + + +DropDown.style - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / style
+
+

style

+ +var style: ButtonStyle +

The style of the dropdown button.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/text.html b/api/pl.treksoft.kvision.dropdown/-drop-down/text.html new file mode 100644 index 00000000..48000a63 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/text.html @@ -0,0 +1,15 @@ + + + +DropDown.text - kvision + + + +