From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-d-d/-d-i-s-a-b-l-e-d.html | 26 +++ .../-d-d/-h-e-a-d-e-r.html | 26 +++ .../-d-d/-s-e-p-a-r-a-t-o-r.html | 26 +++ .../pl.treksoft.kvision.dropdown/-d-d/index.html | 52 +++++ .../pl.treksoft.kvision.dropdown/-d-d/option.html | 14 ++ .../-drop-down/-init-.html | 29 +++ .../-drop-down/add-all.html | 21 ++ .../-drop-down/add.html | 21 ++ .../-drop-down/after-insert.html | 16 ++ .../-drop-down/block.html | 15 ++ .../-drop-down/disabled.html | 15 ++ .../-drop-down/dropup.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 | 221 +++++++++++++++++++++ .../-drop-down/remove-all.html | 18 ++ .../-drop-down/remove.html | 21 ++ .../-drop-down/size.html | 15 ++ .../-drop-down/style.html | 15 ++ .../-drop-down/text.html | 15 ++ .../-drop-down/toggle.html | 15 ++ .../-drop-down/width.html | 19 ++ docs/api/pl.treksoft.kvision.dropdown/index.html | 36 ++++ 25 files changed, 717 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-d-d/index.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-d-d/option.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/add.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/block.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/image.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/index.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/remove.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/size.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/style.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/text.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/toggle.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/-drop-down/width.html create mode 100644 docs/api/pl.treksoft.kvision.dropdown/index.html (limited to 'docs/api/pl.treksoft.kvision.dropdown') diff --git a/docs/api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html b/docs/api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html new file mode 100644 index 00000000..c5172948 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html @@ -0,0 +1,26 @@ + + + +DD.DISABLED - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / DISABLED
+
+

DISABLED

+ +DISABLED +

Inherited Properties

+ + + + + + + +
+

option

+		 +val option: String
+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html b/docs/api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html new file mode 100644 index 00000000..c0521931 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html @@ -0,0 +1,26 @@ + + + +DD.HEADER - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / HEADER
+
+

HEADER

+ +HEADER +

Inherited Properties

+ + + + + + + +
+

option

+		 +val option: String
+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html b/docs/api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html new file mode 100644 index 00000000..d518de3c --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html @@ -0,0 +1,26 @@ + + + +DD.SEPARATOR - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / SEPARATOR
+
+

SEPARATOR

+ +SEPARATOR +

Inherited Properties

+ + + + + + + +
+

option

+		 +val option: String
+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-d-d/index.html b/docs/api/pl.treksoft.kvision.dropdown/-d-d/index.html new file mode 100644 index 00000000..544e8952 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-d-d/index.html @@ -0,0 +1,52 @@ + + + +DD - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD
+
+

DD

+enum class DD +

Useful options for use in DropDown's elements parameter.

+

Enum Values

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

HEADER

+		 +
+

DISABLED

+		 +
+

SEPARATOR

+		 +
+

Properties

+ + + + + + + +
+

option

+		 +val option: String
+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-d-d/option.html b/docs/api/pl.treksoft.kvision.dropdown/-d-d/option.html new file mode 100644 index 00000000..518c5aed --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-d-d/option.html @@ -0,0 +1,14 @@ + + + +DD.option - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / option
+
+

option

+ +val option: String + + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html new file mode 100644 index 00000000..79743254 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html @@ -0,0 +1,29 @@ + + + +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, 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

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html new file mode 100644 index 00000000..464a2fea --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/add.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/add.html new file mode 100644 index 00000000..85081d14 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html new file mode 100644 index 00000000..1b4bb89d --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/block.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/block.html new file mode 100644 index 00000000..446d4803 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html new file mode 100644 index 00000000..9c25d116 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html new file mode 100644 index 00000000..27e68e8d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html @@ -0,0 +1,15 @@ + + + +DropDown.dropup - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / dropup
+
+

dropup

+ +var dropup: Boolean +

Determines if the dropdown is showing upwards.

+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html new file mode 100644 index 00000000..749b4086 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html new file mode 100644 index 00000000..c9d8031d --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html new file mode 100644 index 00000000..33c4950b --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/image.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/image.html new file mode 100644 index 00000000..56755e67 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/index.html new file mode 100644 index 00000000..141248f0 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -0,0 +1,221 @@ + + + +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, 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.

+
+

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.

+
+

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.

+
+

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.

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html new file mode 100644 index 00000000..e90b5611 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/remove.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/remove.html new file mode 100644 index 00000000..8b80a74c --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/size.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/size.html new file mode 100644 index 00000000..7b4f79c7 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/style.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/style.html new file mode 100644 index 00000000..be4742b8 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.dropdown/-drop-down/text.html b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/text.html new file mode 100644 index 00000000..48000a63 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/-drop-down/text.html @@ -0,0 +1,15 @@ + + + +DropDown.text - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / text
+
+

text

+ +var text: String +

Label of the dropdown button.

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

toggle

+ +open fun toggle(): Unit +

Toggles dropdown visibility.

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

width

+ +open var width: CssSize? +

Overrides StyledComponent.width

+

Width of the dropdown button.

+

Getter
+

Width of the current component.

+

+ + diff --git a/docs/api/pl.treksoft.kvision.dropdown/index.html b/docs/api/pl.treksoft.kvision.dropdown/index.html new file mode 100644 index 00000000..d8a75232 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.dropdown/index.html @@ -0,0 +1,36 @@ + + + +pl.treksoft.kvision.dropdown - kvision + + + +kvision / pl.treksoft.kvision.dropdown
+
+

Package pl.treksoft.kvision.dropdown

+

Bootstrap dropdown component.

+

Types

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

DD

+		 +enum class DD +

Useful options for use in DropDown's elements parameter.

+
+

DropDown

+		 +open class DropDown : SimplePanel +

Bootstrap dropdown component.

+
+ + -- cgit