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 --- .../-simple-panel/-init-.html | 2 +- .../-simple-panel/add-all.html | 3 +- .../-simple-panel/add-internal.html | 2 +- .../-simple-panel/add.html | 3 +- .../-simple-panel/children-v-nodes.html | 2 +- .../-simple-panel/children.html | 2 +- .../-simple-panel/get-children.html | 3 +- .../-simple-panel/index.html | 1379 +++++++------------- .../-simple-panel/remove-all.html | 3 +- .../-simple-panel/remove.html | 3 +- .../-simple-panel/render.html | 3 +- 11 files changed, 446 insertions(+), 959 deletions(-) (limited to 'api/pl.treksoft.kvision.panel/-simple-panel') diff --git a/api/pl.treksoft.kvision.panel/-simple-panel/-init-.html b/api/pl.treksoft.kvision.panel/-simple-panel/-init-.html index b3983d0a..4f3131d4 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/-init-.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / SimplePanel / <init>

<init>

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

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-simple-panel/add-all.html b/api/pl.treksoft.kvision.panel/-simple-panel/add-all.html index caf06295..a63cad94 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/add-all.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / SimplePanel / addAll

addAll

- +(js) open fun addAll(children: List<Component>): SimplePanel -

Overrides Container.addAll

Adds a list of components to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-simple-panel/add-internal.html b/api/pl.treksoft.kvision.panel/-simple-panel/add-internal.html index f3e5a52a..51b19418 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/add-internal.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/add-internal.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / SimplePanel / addInternal

addInternal

- +(js) protected fun addInternal(child: Component): SimplePanel

Protected and final method to add given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-simple-panel/add.html b/api/pl.treksoft.kvision.panel/-simple-panel/add.html index 09267d3f..55a4bff0 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/add.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / SimplePanel / add

add

- +(js) open fun add(child: Component): SimplePanel -

Overrides Container.add

Adds given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html b/api/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html index 9baee56a..b9943c4b 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / SimplePanel / childrenVNodes

childrenVNodes

- +(js) protected open fun childrenVNodes(): Array<VNode>

Returns the array of the children Snabbdom vnodes.

Return
diff --git a/api/pl.treksoft.kvision.panel/-simple-panel/children.html b/api/pl.treksoft.kvision.panel/-simple-panel/children.html index 5d01b469..211c4973 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/children.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/children.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / SimplePanel / children

children

- +(js) protected val children: MutableList<Component> diff --git a/api/pl.treksoft.kvision.panel/-simple-panel/get-children.html b/api/pl.treksoft.kvision.panel/-simple-panel/get-children.html index 80176927..a809d0d2 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/get-children.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/get-children.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / SimplePanel / getChildren

getChildren

- +(js) open 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.panel/-simple-panel/index.html b/api/pl.treksoft.kvision.panel/-simple-panel/index.html index 0a9d8219..3b59d345 100644 --- a/api/pl.treksoft.kvision.panel/-simple-panel/index.html +++ b/api/pl.treksoft.kvision.panel/-simple-panel/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.panel / SimplePanel

SimplePanel

-open class SimplePanel : Widget, Container +(js) open class SimplePanel : Widget, Container

Basic container class, rendered as a DIV element with all children directly within.

Constructors

@@ -27,602 +28,88 @@
-

<init>

+(js) +

<init>

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

children

+(js) +

children

 val children: MutableList<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.

-
-

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

visible

-		 -open var visible: Boolean -

Visibility state of the current component.

-
-

vnode

-		 -var vnode: VNode?

Functions

+open fun add(child: Component): SimplePanel +open fun addAll(children: List<Component>): SimplePanel +fun addInternal(child: Component): SimplePanel +open fun childrenVNodes(): Array<VNode> +open fun getChildren(): List<Component> +open fun remove(child: Component): SimplePanel - - - - - - -
-

add

+(js) +

add

 -open fun add(child: Component): SimplePanel

Adds given component to the current container.

-
-

addAll

+(js) +

addAll

 -open fun addAll(children: List<Component>): SimplePanel

Adds a list of components to the current container.

-
-

addInternal

+(js) +

addInternal

 -fun addInternal(child: Component): SimplePanel

Protected and final method to add given component to the current container.

-
-

childrenVNodes

+(js) +

childrenVNodes

 -open fun childrenVNodes(): Array<VNode>

Returns the array of the children Snabbdom vnodes.

-
-

getChildren

+(js) +

getChildren

 -open fun getChildren(): List<Component>

Returns a list of children of the current container.

-
-

remove

+(js) +

remove

 -open fun remove(child: Component): SimplePanel

Removes given component from the current container.

-
-

removeAll

+(js) +

removeAll

 -open fun removeAll(): SimplePanel

Removes all children from the current container.

-
-

render

-		 -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

-
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun removeAll(): SimplePanel - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

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

+(js) +

render

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

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

-
-

removeCssStyle

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

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

-
-

removeEventListener

-		 -open fun removeEventListener(id: Int): Widget -

Removes event listener from current widget.

-
-

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.

-
-

removeSurroundingCssStyle

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

Removes given style object from the set of CSS classes generated in html code of parent component.

-
-

render

-		 -open fun render(elementName: String): VNode
-open fun render(elementName: String, children: Array<dynamic>): VNode

Renders current component as a Snabbdom vnode.

-
-

setAttribute

-		 -open fun setAttribute(name: String, value: String): Widget -

Sets the value of additional attribute.

-
-

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>.() ->&nb