From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-responsive-grid-panel/-init-.html | 29 ++++ .../-responsive-grid-panel/add-all.html | 21 +++ .../-responsive-grid-panel/add.html | 37 ++++++ .../-responsive-grid-panel/align.html | 21 +++ .../-responsive-grid-panel/index.html | 147 +++++++++++++++++++++ .../-responsive-grid-panel/remove-at.html | 22 +++ .../-responsive-grid-panel/remove.html | 21 +++ .../responsive-grid-panel.html | 16 +++ 8 files changed, 314 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add-all.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/align.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/index.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove-at.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/responsive-grid-panel.html (limited to 'api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel') diff --git a/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/-init-.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/-init-.html new file mode 100644 index 00000000..7ff7e7ac --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/-init-.html @@ -0,0 +1,29 @@ + + + +ResponsiveGridPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel / <init>
+
+

<init>

+ +

ResponsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, classes: Set<String> = setOf(), init: ResponsiveGridPanel.() -> Unit = null)

Parameters

+gridSize - grid size

+rows - number of rows

+cols - number of columns

+align - text align of grid cells

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add-all.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add-all.html new file mode 100644 index 00000000..3a954a75 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add-all.html @@ -0,0 +1,21 @@ + + + +ResponsiveGridPanel.addAll - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel / addAll
+
+

addAll

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

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/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add.html new file mode 100644 index 00000000..6fc0842d --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/add.html @@ -0,0 +1,37 @@ + + + +ResponsiveGridPanel.add - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel / add
+
+

add

+ +open fun add(child: Component, col: Int, row: Int, size: Int = 0, offset: Int = 0): ResponsiveGridPanel +

Adds child component to the grid.

Parameters

+child - child component

+col - column number

+row - row number

+size - cell size (colspan)

+offset - cell offset

Return
+this container

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/align.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/align.html new file mode 100644 index 00000000..33f85022 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/align.html @@ -0,0 +1,21 @@ + + + +ResponsiveGridPanel.align - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel / align
+
+

align

+ +var align: Align? +

Text align of grid cells.

Getter
+

Text align of grid cells.

Setter
+

Text align of grid cells.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/index.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/index.html new file mode 100644 index 00000000..f3b5e3c4 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/index.html @@ -0,0 +1,147 @@ + + + +ResponsiveGridPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel
+
+

ResponsiveGridPanel

+open class ResponsiveGridPanel : SimplePanel +

The container with support for Bootstrap responsive grid layout.

Constructors

+ + + + + + + +

<init>

ResponsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, classes: Set<String> = setOf(), init: ResponsiveGridPanel.() -> Unit = null)

Properties

+ + + + + + + +

align

+var align: Align? +

Text align of grid cells.

Functions

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

+ add +	+`open fun add(child: Component, col: Int, row: Int, size: Int = 0, offset: Int = 0): ResponsiveGridPanel` + Adds child component to the grid. +`open fun add(child: Component): ResponsiveGridPanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): ResponsiveGridPanel` + Adds a list of components to the current container. +
+ remove +	+`open fun remove(child: Component): ResponsiveGridPanel` + Removes given component from the current container. +
+ removeAt +	+`open fun removeAt(col: Int, row: Int): ResponsiveGridPanel` + Removes child component at given location (column, row). +

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. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of 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. +

Companion Object Functions

+ + + + + + + +

responsiveGridPanel

fun Container.responsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, classes: Set<String> = setOf(), init: ResponsiveGridPanel.() -> Unit = null): ResponsiveGridPanel

DSL builder extension function.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove-at.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove-at.html new file mode 100644 index 00000000..1fed96f7 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove-at.html @@ -0,0 +1,22 @@ + + + +ResponsiveGridPanel.removeAt - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel / removeAt
+
+

removeAt

+ +open fun removeAt(col: Int, row: Int): ResponsiveGridPanel +

Removes child component at given location (column, row).

Parameters

+col - column number

+row - row number

Return
+this container

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove.html new file mode 100644 index 00000000..9ffe52af --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/remove.html @@ -0,0 +1,21 @@ + + + +ResponsiveGridPanel.remove - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel / remove
+
+

remove

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

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/responsive-grid-panel.html b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/responsive-grid-panel.html new file mode 100644 index 00000000..6635e0e3 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-responsive-grid-panel/responsive-grid-panel.html @@ -0,0 +1,16 @@ + + + +ResponsiveGridPanel.responsiveGridPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / ResponsiveGridPanel / responsiveGridPanel
+
+

responsiveGridPanel

+ +

fun Container.responsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, classes: Set<String> = setOf(), init: ResponsiveGridPanel.() -> Unit = null): ResponsiveGridPanel

DSL builder extension function.

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

+ + -- cgit