From 6ce402754e01940fc641f8814eae03599a622b1c Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 9 Feb 2020 14:23:52 +0100 Subject: API documentation for KVision 2.10.0 --- .../-fieldset-panel/-init-.html | 23 + .../-fieldset-panel/index.html | 996 +++++++++++++++++++++ .../-fieldset-panel/legend-component.html | 15 + .../-fieldset-panel/legend.html | 15 + .../-fieldset-panel/render.html | 18 + 5 files changed, 1067 insertions(+) create mode 100644 api/pl.treksoft.kvision.panel/-fieldset-panel/-init-.html create mode 100644 api/pl.treksoft.kvision.panel/-fieldset-panel/index.html create mode 100644 api/pl.treksoft.kvision.panel/-fieldset-panel/legend-component.html create mode 100644 api/pl.treksoft.kvision.panel/-fieldset-panel/legend.html create mode 100644 api/pl.treksoft.kvision.panel/-fieldset-panel/render.html (limited to 'api/pl.treksoft.kvision.panel/-fieldset-panel') diff --git a/api/pl.treksoft.kvision.panel/-fieldset-panel/-init-.html b/api/pl.treksoft.kvision.panel/-fieldset-panel/-init-.html new file mode 100644 index 00000000..858cdef1 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-fieldset-panel/-init-.html @@ -0,0 +1,23 @@ + + + +FieldsetPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / FieldsetPanel / <init>
+
+

<init>

+ +FieldsetPanel(legend: String? = null, classes: Set<String> = setOf(), init: (FieldsetPanel.() -> Unit)? = null) +

Parameters

+

+legend - the legend of the fieldset

+

+classes - a set of CSS class names

+

+init - an initializer extension function

+

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.panel/-fieldset-panel/index.html b/api/pl.treksoft.kvision.panel/-fieldset-panel/index.html new file mode 100644 index 00000000..4b06177c --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-fieldset-panel/index.html @@ -0,0 +1,996 @@ + + + +FieldsetPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / FieldsetPanel
+
+

FieldsetPanel

+open class FieldsetPanel : SimplePanel +

The HTML fieldset container.

+

Constructors

+ + + + + + + +
+

<init>

+
+FieldsetPanel(legend: String? = null, classes: Set<String> = setOf(), init: (FieldsetPanel.() -> Unit)? = null)
+

Properties

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

legend

+
+var legend: String? +

The legend of the fieldset.

+
+

legendComponent

+
+val legendComponent: Tag +

The legend component.

+
+

Inherited Properties

+ + + + + + + +
+

children

+
+val children: MutableList<Component>
+

Functions

+ + + + + + + +
+

render

+
+open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

Inherited 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.

+
+

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.

+
+

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.

+
+

Extension Functions

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

addBsBgColor

+
+fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit
+

addBsBorder

+
+fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit
+

addBsClearfix

+
+fun Component.addBsClearfix(): Unit
+

addBsColor

+
+fun Component.addBsColor(bsColor: BsColor): Unit
+

addBsRounded

+
+fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit
+

bold

+
+fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold +

DSL builder extension function.

+
+

button

+
+fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button +

DSL builder extension function.

+
+

buttonGroup

+
+fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup +

DSL builder extension function.

+
+

canvas

+
+fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas +

DSL builder extension function.

+
+

chart

+
+fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: (Chart.() -> Unit)? = null): Chart +

DSL builder extension function.

+
+

checkBox

+
+fun Container.checkBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: (CheckBox.() -> Unit)? = null): CheckBox +

DSL builder extension function.

+
+

checkBoxInput

+
+fun Container.checkBoxInput(value: Boolean = false, classes: Set<String> = setOf(), init: (CheckInput.() -> Unit)? = null): CheckBoxInput +

DSL builder extension function.

+
+

contextMenu

+
+fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu +

DSL builder extension function.

+
+

createInstance

+
+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+

dataContainer

+
+fun <M, C : Component, CONT : Container> Container.dataContainer(model: MutableList<M>, factory: Container.(M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (CONT.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null, sorter: ((M) -> Comparable<*>?)? = null, sorterType: () -> SorterType = { SorterType.ASC }, init: (DataContainer<M, C, CONT>.() -> Unit)? = null): DataContainer<M, C, CONT> +

DSL builder extension function.

+fun <M, C : Component> Container.dataContainer(model: MutableList<M>, factory: Container.(M, Int, MutableList<M>) -> C,