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 --- .../-data-container/-init-.html | 34 -- .../-data-container/add-all.html | 21 - .../-data-container/add.html | 21 - .../-data-container/clear-on-update.html | 17 - .../-data-container/data-container.html | 16 - .../-data-container/get-children.html | 18 - .../-data-container/index.html | 471 --------------------- .../-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 | 17 - 12 files changed, 690 deletions(-) delete mode 100644 api/pl.treksoft.kvision.data/-data-container/-init-.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/add-all.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/add.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/clear-on-update.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/data-container.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/get-children.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/index.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/on-update.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/remove-all.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/remove.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/update.html delete mode 100644 api/pl.treksoft.kvision.data/-data-container/visible.html (limited to 'api/pl.treksoft.kvision.data/-data-container') diff --git a/api/pl.treksoft.kvision.data/-data-container/-init-.html b/api/pl.treksoft.kvision.data/-data-container/-init-.html deleted file mode 100644 index 5fc34642..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/-init-.html +++ /dev/null @@ -1,34 +0,0 @@ - - - -DataContainer.<init> - kvision - - - -kvision / pl.treksoft.kvision.data / DataContainer / <init>
-
-

<init>

- -

DataContainer(model: ObservableList<M>, factory: (Int, M) -> C, filter: (Int, M) -> Boolean = null, mapping: (List<Pair<Int, M>>) -> List<Pair<Int, M>> = null, container: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null)

Creates DataContainer bound to given data model.

Parameters

-M - data model type

-C - visual component type

-model - data model of type ObservableList

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

-filter - a filtering function

-mapping - a mapping function

-container - internal container (defaults to VPanel)

-init - an initializer extension function

Constructor
-Creates DataContainer bound to given data model.

- - diff --git a/api/pl.treksoft.kvision.data/-data-container/add-all.html b/api/pl.treksoft.kvision.data/-data-container/add-all.html deleted file mode 100644 index 258e9af8..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/add.html b/api/pl.treksoft.kvision.data/-data-container/add.html deleted file mode 100644 index c759e280..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/add.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/clear-on-update.html b/api/pl.treksoft.kvision.data/-data-container/clear-on-update.html deleted file mode 100644 index 4d57fe8e..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/clear-on-update.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/data-container.html b/api/pl.treksoft.kvision.data/-data-container/data-container.html deleted file mode 100644 index 920b49cf..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/data-container.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DataContainer.dataContainer - kvision - - - -kvision / pl.treksoft.kvision.data / DataContainer / dataContainer
-
-

dataContainer

- -

fun <M, C : Component> Container.dataContainer(model: ObservableList<M>, factory: (Int, M) -> C, filter: (Int, M) -> Boolean = null, mapping: (List<Pair<Int, M>>) -> List<Pair<Int, M>> = null, container: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null): DataContainer<M, C>

DSL builder extension function.

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

- - diff --git a/api/pl.treksoft.kvision.data/-data-container/get-children.html b/api/pl.treksoft.kvision.data/-data-container/get-children.html deleted file mode 100644 index 60d6f289..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/get-children.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/index.html b/api/pl.treksoft.kvision.data/-data-container/index.html deleted file mode 100644 index c5db6a9b..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/index.html +++ /dev/null @@ -1,471 +0,0 @@ - - - -DataContainer - kvision - - - -kvision / pl.treksoft.kvision.data / DataContainer
-
-

DataContainer

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

A container class with support for observable data model.

Constructors

- - - - - - - -

<init>

DataContainer(model: ObservableList<M>, factory: (Int, M) -> C, filter: (Int, M) -> Boolean = null, mapping: (List<Pair<Int, M>>) -> List<Pair<Int, M>> = null, container: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null)

Creates DataContainer bound to given data model.

Properties

- - - - - - - -

visible

-var visible: Boolean -

Visibility state of the current component.

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- draggable -	-`var draggable: Boolean?` - Determines if the current widget is draggable. -
- eventTarget -	-`var eventTarget: Widget?`
- id -	-`var id: String?` - An ID attribute of generated HTML element. -
- lastLanguage -	-`var lastLanguage: String?`
- parent -	-`open var parent: Container?` - Parent of the current component. -
- role -	-`var role: String?` - A role attribute of generated HTML element. -
- surroundingSpan -	-`var surroundingSpan: Boolean`
- 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. -
- clearDragDropData -	-`open fun clearDragDropData(): Unit` - Clears D&D data for the current widget. It also makes it not draggable. -
- dispatchEvent -	-`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
- 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. -
- invoke -	-`open operator fun invoke(vararg children: Component): Container` - Operator function for adding children in a DSL style. -
- 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. -
- setContextMenu -	-`open fun setContextMenu(contextMenu: ContextMenu): Widget` - Sets context menu for the current widget. -
- setDragDropData -	-`open fun setDragDropData(format: String, data: String): Unit` - Sets D&D data for the current widget. It also makes it draggable. -
- setDropTarget -	-`open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit` -`open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit` - Sets the current widget as a D&D drop target. -
- setDropTargetData -	-`open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit` - Sets the current widget as a D&D drop target with helper callback accepting String data. -
- 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. -
- translate -	-`fun translate(text: String?): String?`

Companion Object Functions

- - - - - - - -

dataContainer

fun <M, C : Component> Container.dataContainer(model: ObservableList<M>, factory: (Int, M) -> C, filter: (Int, M) -> Boolean = null, mapping: (List<Pair<Int, M>>) -> List<Pair<Int, M>> = null, container: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null): DataContainer<M, C>

DSL builder extension function.

- - diff --git a/api/pl.treksoft.kvision.data/-data-container/on-update.html b/api/pl.treksoft.kvision.data/-data-container/on-update.html deleted file mode 100644 index 97e7df54..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/on-update.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/remove-all.html b/api/pl.treksoft.kvision.data/-data-container/remove-all.html deleted file mode 100644 index 8413c781..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/remove-all.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/remove.html b/api/pl.treksoft.kvision.data/-data-container/remove.html deleted file mode 100644 index 009dae9e..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/remove.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/update.html b/api/pl.treksoft.kvision.data/-data-container/update.html deleted file mode 100644 index d88fb8ee..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/update.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/api/pl.treksoft.kvision.data/-data-container/visible.html b/api/pl.treksoft.kvision.data/-data-container/visible.html deleted file mode 100644 index 0ffafba8..00000000 --- a/api/pl.treksoft.kvision.data/-data-container/visible.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -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.

- - -- cgit