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 --- .../-base-data-component/-init-.html | 15 + .../-base-data-component/index.html | 28 ++ .../pl.treksoft.kvision.data/-data-component.html | 28 ++ .../-data-container/-init-.html | 28 ++ .../-data-container/add-all.html | 21 ++ .../-data-container/add.html | 21 ++ .../-data-container/clear-on-update.html | 17 + .../-data-container/get-children.html | 18 ++ .../-data-container/index.html | 358 +++++++++++++++++++++ .../-data-container/on-update.html | 20 ++ .../-data-container/remove-all.html | 18 ++ .../-data-container/remove.html | 21 ++ .../-data-container/update.html | 16 + .../-data-container/visible.html | 23 ++ .../-data-updatable/index.html | 40 +++ .../-data-updatable/update.html | 14 + docs/api/pl.treksoft.kvision.data/index.html | 54 ++++ 17 files changed, 740 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.data/-base-data-component/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.data/-base-data-component/index.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-component.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/add-all.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/add.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/clear-on-update.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/get-children.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/index.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/on-update.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/remove-all.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/remove.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/update.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-container/visible.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-updatable/index.html create mode 100644 docs/api/pl.treksoft.kvision.data/-data-updatable/update.html create mode 100644 docs/api/pl.treksoft.kvision.data/index.html (limited to 'docs/api/pl.treksoft.kvision.data') diff --git a/docs/api/pl.treksoft.kvision.data/-base-data-component/-init-.html b/docs/api/pl.treksoft.kvision.data/-base-data-component/-init-.html new file mode 100644 index 00000000..11c98d32 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-base-data-component/-init-.html @@ -0,0 +1,15 @@ + + + +BaseDataComponent.<init> - kvision + + + +kvision / pl.treksoft.kvision.data / BaseDataComponent / <init>
+
+

<init>

+ +BaseDataComponent() +

Base abstract class for creating observable data model.

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-base-data-component/index.html b/docs/api/pl.treksoft.kvision.data/-base-data-component/index.html new file mode 100644 index 00000000..f7725300 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-base-data-component/index.html @@ -0,0 +1,28 @@ + + + +BaseDataComponent - kvision + + + +kvision / pl.treksoft.kvision.data / BaseDataComponent
+
+

BaseDataComponent

+abstract class BaseDataComponent : DataComponent +

Base abstract class for creating observable data model.

Constructors

+ + + + + + + +

<init>

+BaseDataComponent() +

Base abstract class for creating observable data model.

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-component.html b/docs/api/pl.treksoft.kvision.data/-data-component.html new file mode 100644 index 00000000..1bca7fb4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-component.html @@ -0,0 +1,28 @@ + + + +DataComponent - kvision + + + +kvision / pl.treksoft.kvision.data / DataComponent
+
+

DataComponent

+interface DataComponent +

Base interface for observable data model.

Inheritors

+ + + + + + + +

BaseDataComponent

+abstract class BaseDataComponent : DataComponent +

Base abstract class for creating observable data model.

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/-init-.html b/docs/api/pl.treksoft.kvision.data/-data-container/-init-.html new file mode 100644 index 00000000..2a282883 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/-init-.html @@ -0,0 +1,28 @@ + + + +DataContainer.<init> - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / <init>
+
+

<init>

+ +DataContainer(model: ObservableList<M>, binding: (Int) -> C, child: Container = VPanel()) +

Creates DataContainer bound to given data model.

Parameters

+M - base data model type

+C - base component type

+model - data model of type ObservableList

+binding - a function which creates component C from data model at given index

+child - internal container (defaults to VPanel)

Constructor
+Creates DataContainer bound to given data model.

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/add-all.html b/docs/api/pl.treksoft.kvision.data/-data-container/add-all.html new file mode 100644 index 00000000..258e9af8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/add-all.html @@ -0,0 +1,21 @@ + + + +DataContainer.addAll - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / addAll
+
+

addAll

+ +fun addAll(children: List<Component>): Container +

Overrides Container.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.data/-data-container/add.html b/docs/api/pl.treksoft.kvision.data/-data-container/add.html new file mode 100644 index 00000000..c759e280 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/add.html @@ -0,0 +1,21 @@ + + + +DataContainer.add - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / add
+
+

add

+ +fun add(child: Component): Container +

Overrides Container.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/clear-on-update.html b/docs/api/pl.treksoft.kvision.data/-data-container/clear-on-update.html new file mode 100644 index 00000000..4d57fe8e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/clear-on-update.html @@ -0,0 +1,17 @@ + + + +DataContainer.clearOnUpdate - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / clearOnUpdate
+
+

clearOnUpdate

+ +fun clearOnUpdate(): DataContainer<M, C> +

Clears notification handler.

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/get-children.html b/docs/api/pl.treksoft.kvision.data/-data-container/get-children.html new file mode 100644 index 00000000..60d6f289 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/get-children.html @@ -0,0 +1,18 @@ + + + +DataContainer.getChildren - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / getChildren
+
+

getChildren

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

Overrides Container.getChildren

Returns a list of children of the current container.

Return
+list of children

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/index.html b/docs/api/pl.treksoft.kvision.data/-data-container/index.html new file mode 100644 index 00000000..99155d7d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/index.html @@ -0,0 +1,358 @@ + + + +DataContainer - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer
+
+

DataContainer

+class DataContainer<M : DataComponent, C : Component> : Widget, Container, DataUpdatable +

A container class with support for observable data model.

Constructors

+ + + + + + + +

<init>

+DataContainer(model: ObservableList<M>, binding: (Int) -> C, child: Container = VPanel()) +

Creates DataContainer bound to given data model.

Properties

+ + + + + + + +

visible

+var visible: Boolean +

Visibility state of the current component.

Inherited Properties

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

+ id +	+`var id: String?` + An ID attribute of generated HTML element. +
+ parent +	+`open var parent: Component?` + Parent of the current component. +
+ role +	+`var role: String?` + A role attribute of generated HTML element. +
+ title +	+`var title: String?` + A title attribute of generated HTML element. +

Functions

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

+ add +	+`fun add(child: Component): Container` + Adds given component to the current container. +
+ addAll +	+`fun addAll(children: List<Component>): Container` + Adds a list of components to the current container. +
+ clearOnUpdate +	+`fun clearOnUpdate(): DataContainer<M, C>` + Clears notification handler. +
+ getChildren +	+`fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ onUpdate +	+`fun onUpdate(handler: () -> Unit): DataContainer<M, C>` + Sets a notification handler called after every update. +
+ remove +	+`fun remove(child: Component): Container` + Removes given component from the current container. +
+ removeAll +	+`fun removeAll(): Container` + Removes all children from the current container. +
+ update +	+`fun update(): Unit` + Updates view from the current data model state. +

Inherited Functions

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

+ addCssClass +	+`open fun addCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`open fun addSurroundingCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of parent component. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ afterDestroy +	+`open fun afterDestroy(): Unit` + Method called after destroying Snabbdom vnode. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ afterPostpatch +	+`open fun afterPostpatch(node: VNode): Unit` + Method called after updating Snabbdom vnode. +
+ getElement +	+`open fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`open fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`open fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ getSnHooks +	+`open fun getSnHooks(): Hooks?` + Returns list of hooks in the form of a Snabbdom Hooks object. +
+ getSnOn +	+`open fun getSnOn(): On?` + Returns list of event handlers in the form of a Snabbdom On object. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of current component. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ removeSurroundingCssClass +	+`open fun removeSurroundingCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of parent component. +
+ render +	+`open fun render(): VNode` +`open fun render(elementName: String): VNode` +`open fun render(elementName: String, children: Array<dynamic>): VNode` + Renders current component as a Snabbdom vnode. +
+ setEventListener +	+`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` + Sets an event listener for current widget, keeping the actual type of component. +`open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` + Sets an event listener for current widget. +
+ show +	+`open fun show(): Widget` + Makes current widget visible. +
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/on-update.html b/docs/api/pl.treksoft.kvision.data/-data-container/on-update.html new file mode 100644 index 00000000..97e7df54 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/on-update.html @@ -0,0 +1,20 @@ + + + +DataContainer.onUpdate - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / onUpdate
+
+

onUpdate

+ +fun onUpdate(handler: () -> Unit): DataContainer<M, C> +

Sets a notification handler called after every update.

Parameters

+handler - notification handler

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/remove-all.html b/docs/api/pl.treksoft.kvision.data/-data-container/remove-all.html new file mode 100644 index 00000000..8413c781 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/remove-all.html @@ -0,0 +1,18 @@ + + + +DataContainer.removeAll - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / removeAll
+
+

removeAll

+ +fun removeAll(): Container +

Overrides Container.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/remove.html b/docs/api/pl.treksoft.kvision.data/-data-container/remove.html new file mode 100644 index 00000000..009dae9e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/remove.html @@ -0,0 +1,21 @@ + + + +DataContainer.remove - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / remove
+
+

remove

+ +fun remove(child: Component): Container +

Overrides Container.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/update.html b/docs/api/pl.treksoft.kvision.data/-data-container/update.html new file mode 100644 index 00000000..d88fb8ee --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/update.html @@ -0,0 +1,16 @@ + + + +DataContainer.update - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / update
+
+

update

+ +fun update(): Unit +

Overrides DataUpdatable.update

Updates view from the current data model state.

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-container/visible.html b/docs/api/pl.treksoft.kvision.data/-data-container/visible.html new file mode 100644 index 00000000..420b7add --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-container/visible.html @@ -0,0 +1,23 @@ + + + +DataContainer.visible - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / visible
+
+

visible

+ +var visible: Boolean +

Overrides Widget.visible

Overrides Component.visible

Visibility state of the current component.

Getter
+

Visibility state of the current component.

Setter
+

Visibility state of the current component.

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-updatable/index.html b/docs/api/pl.treksoft.kvision.data/-data-updatable/index.html new file mode 100644 index 00000000..98f45f1b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-updatable/index.html @@ -0,0 +1,40 @@ + + + +DataUpdatable - kvision + + + +kvision / pl.treksoft.kvision.data / DataUpdatable
+
+

DataUpdatable

+interface DataUpdatable +

Interface for updatable container.

Functions

+ + + + + + + +

update

+abstract fun update(): Unit

Inheritors

+ + + + + + + +

DataContainer

+class DataContainer<M : DataComponent, C : Component> : Widget, Container, DataUpdatable +

A container class with support for observable data model.

+ + diff --git a/docs/api/pl.treksoft.kvision.data/-data-updatable/update.html b/docs/api/pl.treksoft.kvision.data/-data-updatable/update.html new file mode 100644 index 00000000..bafc1ca3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/-data-updatable/update.html @@ -0,0 +1,14 @@ + + + +DataUpdatable.update - kvision + + + +kvision / pl.treksoft.kvision.data / DataUpdatable / update
+
+

update

+ +abstract fun update(): Unit + + diff --git a/docs/api/pl.treksoft.kvision.data/index.html b/docs/api/pl.treksoft.kvision.data/index.html new file mode 100644 index 00000000..6fc51941 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.data/index.html @@ -0,0 +1,54 @@ + + + +pl.treksoft.kvision.data - kvision + + + +kvision / pl.treksoft.kvision.data
+
+

Package pl.treksoft.kvision.data

Base component and container class with data binding support for observable data model.

Types

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

+ BaseDataComponent +	+`abstract class BaseDataComponent : DataComponent` + Base abstract class for creating observable data model. +
+ DataComponent +	+`interface DataComponent` + Base interface for observable data model. +
+ DataContainer +	+`class DataContainer<M : DataComponent, C : Component> : Widget, Container, DataUpdatable` + A container class with support for observable data model. +
+ DataUpdatable +	+`interface DataUpdatable` + Interface for updatable container. +

+ + -- cgit