From 70ed562ae730f65671defed6ed79d08d8126d467 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 5 Mar 2018 08:46:18 +0100 Subject: API doc update --- api/pl.treksoft.kvision.table/-table/-init-.html | 29 +++ api/pl.treksoft.kvision.table/-table/add-all.html | 21 +++ .../-table/add-header-cell.html | 20 +++ api/pl.treksoft.kvision.table/-table/add.html | 21 +++ api/pl.treksoft.kvision.table/-table/caption.html | 21 +++ .../-table/children-v-nodes.html | 18 ++ .../-table/get-children.html | 18 ++ .../-table/get-sn-class.html | 18 ++ .../-table/header-names.html | 21 +++ api/pl.treksoft.kvision.table/-table/index.html | 199 +++++++++++++++++++++ .../-table/remove-all.html | 18 ++ .../-table/remove-header-cell.html | 20 +++ .../-table/remove-header-cells.html | 17 ++ api/pl.treksoft.kvision.table/-table/remove.html | 21 +++ api/pl.treksoft.kvision.table/-table/render.html | 18 ++ .../-table/responsive.html | 21 +++ api/pl.treksoft.kvision.table/-table/table.html | 16 ++ api/pl.treksoft.kvision.table/-table/types.html | 21 +++ 18 files changed, 538 insertions(+) create mode 100644 api/pl.treksoft.kvision.table/-table/-init-.html create mode 100644 api/pl.treksoft.kvision.table/-table/add-all.html create mode 100644 api/pl.treksoft.kvision.table/-table/add-header-cell.html create mode 100644 api/pl.treksoft.kvision.table/-table/add.html create mode 100644 api/pl.treksoft.kvision.table/-table/caption.html create mode 100644 api/pl.treksoft.kvision.table/-table/children-v-nodes.html create mode 100644 api/pl.treksoft.kvision.table/-table/get-children.html create mode 100644 api/pl.treksoft.kvision.table/-table/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.table/-table/header-names.html create mode 100644 api/pl.treksoft.kvision.table/-table/index.html create mode 100644 api/pl.treksoft.kvision.table/-table/remove-all.html create mode 100644 api/pl.treksoft.kvision.table/-table/remove-header-cell.html create mode 100644 api/pl.treksoft.kvision.table/-table/remove-header-cells.html create mode 100644 api/pl.treksoft.kvision.table/-table/remove.html create mode 100644 api/pl.treksoft.kvision.table/-table/render.html create mode 100644 api/pl.treksoft.kvision.table/-table/responsive.html create mode 100644 api/pl.treksoft.kvision.table/-table/table.html create mode 100644 api/pl.treksoft.kvision.table/-table/types.html (limited to 'api/pl.treksoft.kvision.table/-table') diff --git a/api/pl.treksoft.kvision.table/-table/-init-.html b/api/pl.treksoft.kvision.table/-table/-init-.html new file mode 100644 index 00000000..1122d707 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/-init-.html @@ -0,0 +1,29 @@ + + + +Table.<init> - kvision + + + +kvision / pl.treksoft.kvision.table / Table / <init>
+
+

<init>

+ +

Table(headerNames: List<String>? = null, types: Set<TableType> = setOf(), caption: String? = null, responsive: Boolean = false, classes: Set<String> = setOf(), init: Table.() -> Unit = null)

Parameters

+headerNames - a list of table headers names

+types - a set of table types

+caption - table caption

+responsive - determines if the table is responsive

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.table/-table/add-all.html b/api/pl.treksoft.kvision.table/-table/add-all.html new file mode 100644 index 00000000..6b7370b3 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/add-all.html @@ -0,0 +1,21 @@ + + + +Table.addAll - kvision + + + +kvision / pl.treksoft.kvision.table / Table / 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.table/-table/add-header-cell.html b/api/pl.treksoft.kvision.table/-table/add-header-cell.html new file mode 100644 index 00000000..e71ba99b --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/add-header-cell.html @@ -0,0 +1,20 @@ + + + +Table.addHeaderCell - kvision + + + +kvision / pl.treksoft.kvision.table / Table / addHeaderCell
+
+

addHeaderCell

+ +fun addHeaderCell(cell: HeaderCell): Table +

Adds new header cell to the table.

Parameters

+cell - header cell

Return
+this table

+ + diff --git a/api/pl.treksoft.kvision.table/-table/add.html b/api/pl.treksoft.kvision.table/-table/add.html new file mode 100644 index 00000000..528e6452 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/add.html @@ -0,0 +1,21 @@ + + + +Table.add - kvision + + + +kvision / pl.treksoft.kvision.table / Table / 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.table/-table/caption.html b/api/pl.treksoft.kvision.table/-table/caption.html new file mode 100644 index 00000000..4e491611 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/caption.html @@ -0,0 +1,21 @@ + + + +Table.caption - kvision + + + +kvision / pl.treksoft.kvision.table / Table / caption
+
+

caption

+ +var caption: String? +

Table caption.

Getter
+

Table caption.

Setter
+

Table caption.

+ + diff --git a/api/pl.treksoft.kvision.table/-table/children-v-nodes.html b/api/pl.treksoft.kvision.table/-table/children-v-nodes.html new file mode 100644 index 00000000..23ec3435 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/children-v-nodes.html @@ -0,0 +1,18 @@ + + + +Table.childrenVNodes - kvision + + + +kvision / pl.treksoft.kvision.table / Table / childrenVNodes
+
+

childrenVNodes

+ +protected open fun childrenVNodes(): Array<VNode> +

Overrides SimplePanel.childrenVNodes

Returns the array of the children Snabbdom vnodes.

Return
+array of children vnodes

+ + diff --git a/api/pl.treksoft.kvision.table/-table/get-children.html b/api/pl.treksoft.kvision.table/-table/get-children.html new file mode 100644 index 00000000..e203feba --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/get-children.html @@ -0,0 +1,18 @@ + + + +Table.getChildren - kvision + + + +kvision / pl.treksoft.kvision.table / Table / 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.table/-table/get-sn-class.html b/api/pl.treksoft.kvision.table/-table/get-sn-class.html new file mode 100644 index 00000000..60b5664f --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Table.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.table / Table / 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.table/-table/header-names.html b/api/pl.treksoft.kvision.table/-table/header-names.html new file mode 100644 index 00000000..a4c3986e --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/header-names.html @@ -0,0 +1,21 @@ + + + +Table.headerNames - kvision + + + +kvision / pl.treksoft.kvision.table / Table / headerNames
+
+

headerNames

+ +var headerNames: List<String>? +

Table headers names.

Getter
+

Table headers names.

Setter
+

Table headers names.

+ + diff --git a/api/pl.treksoft.kvision.table/-table/index.html b/api/pl.treksoft.kvision.table/-table/index.html new file mode 100644 index 00000000..ab632080 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/index.html @@ -0,0 +1,199 @@ + + + +Table - kvision + + + +kvision / pl.treksoft.kvision.table / Table
+
+

Table

+open class Table : SimplePanel +

HTML table component.

Constructors

+ + + + + + + +

<init>

Table(headerNames: List<String>? = null, types: Set<TableType> = setOf(), caption: String? = null, responsive: Boolean = false, classes: Set<String> = setOf(), init: Table.() -> Unit = null)

Properties

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

+ caption +	+`var caption: String?` + Table caption. +
+ headerNames +	+`var headerNames: List<String>?` + Table headers names. +
+ responsive +	+`var responsive: Boolean` + Determines if the table is responsive. +
+ types +	+`var types: Set<TableType>` + Table types. +

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. +
+ addHeaderCell +	+`fun addHeaderCell(cell: HeaderCell): Table` + Adds new header cell to the table. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ 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. +
+ removeHeaderCell +	+`fun removeHeaderCell(cell: HeaderCell): Table` + Removes given header cell from the table. +
+ removeHeaderCells +	+`fun removeHeaderCells(): Table` + Removes all header cells from table. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Inherited Functions

+ + + + + + + +

addInternal

+fun addInternal(child: Component): SimplePanel +

Protected and final method to add given component to the current container.

Companion Object Functions

+ + + + + + + +

table

fun Container.table(headerNames: List<String>? = null, types: Set<TableType> = setOf(), caption: String? = null, responsive: Boolean = false, classes: Set<String> = setOf(), init: Table.() -> Unit = null): Table

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.table/-table/remove-all.html b/api/pl.treksoft.kvision.table/-table/remove-all.html new file mode 100644 index 00000000..b962ab19 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/remove-all.html @@ -0,0 +1,18 @@ + + + +Table.removeAll - kvision + + + +kvision / pl.treksoft.kvision.table / Table / 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.table/-table/remove-header-cell.html b/api/pl.treksoft.kvision.table/-table/remove-header-cell.html new file mode 100644 index 00000000..ec7a17ca --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/remove-header-cell.html @@ -0,0 +1,20 @@ + + + +Table.removeHeaderCell - kvision + + + +kvision / pl.treksoft.kvision.table / Table / removeHeaderCell
+
+

removeHeaderCell

+ +fun removeHeaderCell(cell: HeaderCell): Table +

Removes given header cell from the table.

Parameters

+cell - header cell

Return
+this table

+ + diff --git a/api/pl.treksoft.kvision.table/-table/remove-header-cells.html b/api/pl.treksoft.kvision.table/-table/remove-header-cells.html new file mode 100644 index 00000000..f0d7c23a --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/remove-header-cells.html @@ -0,0 +1,17 @@ + + + +Table.removeHeaderCells - kvision + + + +kvision / pl.treksoft.kvision.table / Table / removeHeaderCells
+
+

removeHeaderCells

+ +fun removeHeaderCells(): Table +

Removes all header cells from table.

Return
+this table

+ + diff --git a/api/pl.treksoft.kvision.table/-table/remove.html b/api/pl.treksoft.kvision.table/-table/remove.html new file mode 100644 index 00000000..b04ba52b --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/remove.html @@ -0,0 +1,21 @@ + + + +Table.remove - kvision + + + +kvision / pl.treksoft.kvision.table / Table / 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.table/-table/render.html b/api/pl.treksoft.kvision.table/-table/render.html new file mode 100644 index 00000000..0d844a94 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/render.html @@ -0,0 +1,18 @@ + + + +Table.render - kvision + + + +kvision / pl.treksoft.kvision.table / Table / 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.table/-table/responsive.html b/api/pl.treksoft.kvision.table/-table/responsive.html new file mode 100644 index 00000000..5002c89d --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/responsive.html @@ -0,0 +1,21 @@ + + + +Table.responsive - kvision + + + +kvision / pl.treksoft.kvision.table / Table / responsive
+
+

responsive

+ +var responsive: Boolean +

Determines if the table is responsive.

Getter
+

Determines if the table is responsive.

Setter
+

Determines if the table is responsive.

+ + diff --git a/api/pl.treksoft.kvision.table/-table/table.html b/api/pl.treksoft.kvision.table/-table/table.html new file mode 100644 index 00000000..3fe2c07e --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/table.html @@ -0,0 +1,16 @@ + + + +Table.table - kvision + + + +kvision / pl.treksoft.kvision.table / Table / table
+
+

table

+ +

fun Container.table(headerNames: List<String>? = null, types: Set<TableType> = setOf(), caption: String? = null, responsive: Boolean = false, classes: Set<String> = setOf(), init: Table.() -> Unit = null): Table

DSL builder extension function.

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

+ + diff --git a/api/pl.treksoft.kvision.table/-table/types.html b/api/pl.treksoft.kvision.table/-table/types.html new file mode 100644 index 00000000..70588e53 --- /dev/null +++ b/api/pl.treksoft.kvision.table/-table/types.html @@ -0,0 +1,21 @@ + + + +Table.types - kvision + + + +kvision / pl.treksoft.kvision.table / Table / types
+
+

types

+ +var types: Set<TableType> +

Table types.

Getter
+

Table types.

Setter
+

Table types.

+ + -- cgit