From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- .../-data-container/index.html | 1149 ++++++-------------- 1 file changed, 324 insertions(+), 825 deletions(-) (limited to 'api/pl.treksoft.kvision.data/-data-container/index.html') diff --git a/api/pl.treksoft.kvision.data/-data-container/index.html b/api/pl.treksoft.kvision.data/-data-container/index.html index acb4ddde..2b0a3ea2 100644 --- a/api/pl.treksoft.kvision.data/-data-container/index.html +++ b/api/pl.treksoft.kvision.data/-data-container/index.html @@ -8,19 +8,19 @@ kvision / pl.treksoft.kvision.data / DataContainer

DataContainer

-class DataContainer<M, C : Component, CONT : Container> : Widget, Container, DataUpdatable +(js) class DataContainer<M, C : Component, CONT : Container> : Widget, Container, DataUpdatable

A container class with support for mutable/observable data model.

Constructors

+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)
-

<init>

+(js) +

<init>

 -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)

Creates DataContainer bound to given data model.

-
@@ -29,113 +29,12 @@ -

visible

+(js) +

visible

-var visible: Boolean

Visibility state of the current component.

- - - - -

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +var visible: Boolean
-

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.

-
-

popoverOptions

-		 -var popoverOptions: PopoverOptions?
-

role

-		 -var role: String? -

A role attribute of generated HTML element.

-
-

surroundingSpan

-		 -var surroundingSpan: Boolean
-

tabindex

-		 -var tabindex: Int? -

A tabindex attribute of generated HTML element.

-
-

title

-		 -var title: String? -

A title attribute of generated HTML element.

-
-

tooltipOptions

-		 -var tooltipOptions: TooltipOptions?
-

vnode

-		 -var vnode: VNode?
@@ -144,481 +43,75 @@ -

add

+(js) +

add

-fun add(child: Component): Container

Adds given component to the current container.

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

addAll

+(js) +

addAll

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

Adds a list of components to the current container.

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

clearOnUpdate

+(js) +

clearOnUpdate

-fun clearOnUpdate(): DataContainer<M, C, CONT>

Clears notification handler.

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

getChildren

+(js) +

getChildren

-fun getChildren(): List<Component>

Returns a list of children of the current container.

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

onUpdate

+(js) +

onUpdate

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

Sets a notification handler called after every update.

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

remove

+(js) +

remove

-fun remove(child: Component): Container

Removes given component from the current container.

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

removeAll

+(js) +

removeAll

-fun removeAll(): Container

Removes all children from the current container.

- +fun removeAll(): Container -

update

+(js) +

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.

-
-

addCssStyle

-		 -open fun addCssStyle(css: Style): Widget -

Adds given style object 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.

-
-

addSurroundingCssStyle

-		 -open fun addSurroundingCssStyle(css: Style): Widget -

Adds given style object 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.

-
-

clearDragDropData

-		 -open fun clearDragDropData(): Unit -

Clears D&D data for the current widget. It also makes it not draggable.

-
-

disablePopover

-		 -open fun disablePopover(): Widget -

Disables popover for the current widget.

-
-

disableTooltip

-		 -open fun disableTooltip(): Widget -

Disables tooltip for the current widget.

-
-

dispatchEvent

-		 -open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
-

enablePopover

-		 -open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget -

Enables popover for the current widget.

-
-

enableTooltip

-		 -open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget -

Enables tooltip for the current widget.

-
-

getAttribute

-		 -open fun getAttribute(name: String): String? -

Returns the value of an additional attribute.

-
-

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.

-
-

hidePopover

-		 -open fun hidePopover(): Widget -

Hides popover for the current widget.

-
-

hideTooltip

-		 -open fun hideTooltip(): Widget -

Hides tooltip for the current widget.

-
-

invoke

-		 -open operator fun invoke(vararg children: Component): Container -

Operator function for adding children in a DSL style.

-
-

refreshOnUpdate

-		 -fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-

removeAttribute

-		 -open fun removeAttribute(name: String): Widget -

Removes the value of additional attribute.

-
-

removeCssClass

-		 -open fun removeCssClass(css: String): Widget -

Removes given value from the set of CSS classes generated in html code of current component.

-
-

removeCssStyle

-		 -