From 806edfceeefe7fda47924f97237974e99fe28a02 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 2 Apr 2018 01:35:47 +0200 Subject: API documentantion update --- .../-widget-wrapper/index.html | 264 ++------------------- .../-widget-wrapper/render.html | 2 +- .../-widget-wrapper/visible.html | 2 +- 3 files changed, 25 insertions(+), 243 deletions(-) (limited to 'api/pl.treksoft.kvision.core/-widget-wrapper') diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/index.html b/api/pl.treksoft.kvision.core/-widget-wrapper/index.html index 1c02a8b6..6db540f8 100644 --- a/api/pl.treksoft.kvision.core/-widget-wrapper/index.html +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / WidgetWrapper

WidgetWrapper

-open class WidgetWrapper : Widget +open class WidgetWrapper : SimplePanel

This class allows to wrap a component into separately styled DIV element.

Constructors

@@ -30,59 +30,7 @@

visible

- - -
-open var visible: Boolean -

Visibility state of the current component.

-
-

Inherited Properties

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

draggable

-		 -var draggable: Boolean? -

Determines if the current widget is draggable.

-
-

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.

-
@@ -105,231 +53,65 @@ -

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.

- - - - -

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

+

add

-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(elementName: String): VNode
-open fun render(elementName: String, children: Array<dynamic>): VNode -

Renders current component as a Snabbdom vnode.

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

Adds given component to the current container.

-

setDragDropData

+

addAll

-open fun setDragDropData(format: String, data: String): Unit -

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

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

Adds a list of components to the current container.

-

setDropTarget

+

addInternal

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

+fun addInternal(child: Component): SimplePanel +

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

-

setDropTargetData

+

childrenVNodes

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

+open fun childrenVNodes(): Array<VNode> +

Returns the array of the children Snabbdom vnodes.

-

setEventListener

+

getChildren

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

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

Returns a list of children of the current container.

-

show

+

remove

-open fun show(): Widget -

Makes current widget visible.

+open fun remove(child: Component): SimplePanel +

Removes given component from the current container.

-

toggleVisible

+

removeAll

-open fun toggleVisible(): Widget -

Toggles visibility of current widget.

+open fun removeAll(): SimplePanel +

Removes all children from the current container.

diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/render.html b/api/pl.treksoft.kvision.core/-widget-wrapper/render.html index 311aec9c..577b695c 100644 --- a/api/pl.treksoft.kvision.core/-widget-wrapper/render.html +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/render.html @@ -10,7 +10,7 @@

render

protected open fun render(): VNode -

Overrides Widget.render

+

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
Snabbdom vnode

diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html b/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html index b82b997e..4c6d0cc0 100644 --- a/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html @@ -11,6 +11,6 @@ open var visible: Boolean

Overrides Widget.visible

-

Visibility state of the current component.

+

Overrides Component.visible

-- cgit