From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-simple-panel/-init-.html | 21 + .../-simple-panel/add-all.html | 21 + .../-simple-panel/add-internal.html | 20 + .../-simple-panel/add.html | 21 + .../-simple-panel/children-v-nodes.html | 17 + .../-simple-panel/get-children.html | 18 + .../-simple-panel/index.html | 931 +++++++++++++++++++++ .../-simple-panel/remove-all.html | 18 + .../-simple-panel/remove.html | 21 + .../-simple-panel/render.html | 18 + .../-simple-panel/simple-panel.html | 16 + 11 files changed, 1122 insertions(+) create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/-init-.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/add-all.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/add-internal.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/add.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/get-children.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/index.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/remove-all.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/remove.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/render.html create mode 100644 api1/pl.treksoft.kvision.panel/-simple-panel/simple-panel.html (limited to 'api1/pl.treksoft.kvision.panel/-simple-panel') diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/-init-.html b/api1/pl.treksoft.kvision.panel/-simple-panel/-init-.html new file mode 100644 index 00000000..b3983d0a --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/-init-.html @@ -0,0 +1,21 @@ + + + +SimplePanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / <init>
+
+

<init>

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

Parameters

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/add-all.html b/api1/pl.treksoft.kvision.panel/-simple-panel/add-all.html new file mode 100644 index 00000000..caf06295 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/add-all.html @@ -0,0 +1,21 @@ + + + +SimplePanel.addAll - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / addAll
+
+

addAll

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

Overrides Container.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/add-internal.html b/api1/pl.treksoft.kvision.panel/-simple-panel/add-internal.html new file mode 100644 index 00000000..f3e5a52a --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/add-internal.html @@ -0,0 +1,20 @@ + + + +SimplePanel.addInternal - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / addInternal
+
+

addInternal

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

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

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/add.html b/api1/pl.treksoft.kvision.panel/-simple-panel/add.html new file mode 100644 index 00000000..09267d3f --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/add.html @@ -0,0 +1,21 @@ + + + +SimplePanel.add - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / add
+
+

add

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

Overrides Container.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html b/api1/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html new file mode 100644 index 00000000..9baee56a --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/children-v-nodes.html @@ -0,0 +1,17 @@ + + + +SimplePanel.childrenVNodes - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / childrenVNodes
+
+

childrenVNodes

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

Returns the array of the children Snabbdom vnodes.

Return
+array of children vnodes

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/get-children.html b/api1/pl.treksoft.kvision.panel/-simple-panel/get-children.html new file mode 100644 index 00000000..80176927 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/get-children.html @@ -0,0 +1,18 @@ + + + +SimplePanel.getChildren - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / getChildren
+
+

getChildren

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

Overrides Container.getChildren

Returns a list of children of the current container.

Return
+list of children

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/index.html b/api1/pl.treksoft.kvision.panel/-simple-panel/index.html new file mode 100644 index 00000000..f1ad6780 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/index.html @@ -0,0 +1,931 @@ + + + +SimplePanel - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel
+
+

SimplePanel

+open class SimplePanel : Widget, Container +

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

Constructors

+ + + + + + + +

<init>

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

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

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

+ add +	+`open fun add(child: Component): SimplePanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): SimplePanel` + Adds a list of components to the current container. +
+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ remove +	+`open fun remove(child: Component): SimplePanel` + Removes given component from the current container. +
+ 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

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

+ addCssClass +	+`open fun addCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of current component. +`open fun addCssClass(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. +`open fun addSurroundingCssClass(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. +`open fun removeCssClass(css: Style): Widget` + Removes given style object 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. +`open fun removeSurroundingCssClass(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. +
+ 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. +
+ showPopover +	+`open fun showPopover(): Widget` + Shows popover for the current widget. +
+ showTooltip +	+`open fun showTooltip(): Widget` + Shows tooltip for the current widget. +
+ singleRender +	+`fun <T> singleRender(block: () -> T): T`
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +
+ translate +	+`fun translate(text: String?): String?`

Companion Object Functions

+ + + + + + + +

simplePanel

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

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

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

+ AbstractText +	+`abstract class AbstractText : SimplePanel, StringFormControl` + Base class for form field text components. +
+ ButtonGroup +	+`open class ButtonGroup : SimplePanel` + The Bootstrap button group. +
+ CheckBox +	+`open class CheckBox : SimplePanel, BoolFormControl` + The form field component rendered as HTML input type="checkbox". +
+ DateTime +	+`open class DateTime : SimplePanel, DateFormControl` + Form field date/time chooser component. +
+ DockPanel +	+`open class DockPanel : SimplePanel` + The container with dock layout (up, down, left, right and center positions). +
+ DropDown +	+`open class DropDown : SimplePanel` + Bootstrap dropdown component. +
+ FlexPanel +	+`open class FlexPanel : SimplePanel` + The container with CSS flexbox layout support. +
+ FormPanel +	+`open class FormPanel<K : Any> : SimplePanel` + Bootstrap form component. +
+ GridPanel +	+`open class GridPanel : SimplePanel` + The container with CSS grid layout support. +
+ Link +	+`open class Link : SimplePanel` + Link component. +
+ ListTag +	+`open class ListTag : SimplePanel` + HTML list component. +
+ Modal +	+`open class Modal : SimplePanel` + Configurable modal window based on Bootstrap modal. +
+ Navbar +	+`open class Navbar : SimplePanel` + The Bootstrap Navbar container. +
+ ProgressBar +	+`open class ProgressBar : SimplePanel` + The Bootstrap progress bar. +
+ Radio +	+`open class Radio : SimplePanel, BoolFormControl` + The form field component rendered as HTML input type="radio". +
+ RadioGroup +	+`open class RadioGroup : SimplePanel, StringFormControl` + The form field component rendered as a group of HTML input type="radio" elements with the same name attribute. +
+ RadioGroupInput +	+`open class RadioGroupInput : SimplePanel, FormInput` + The input component rendered as a group of HTML input type="radio" elements with the same name attribute. +
+ ResponsiveGridPanel +	+`open class ResponsiveGridPanel : SimplePanel` + The container with support for Bootstrap responsive grid layout. +
+ Root +	+`class Root : SimplePanel` + Root container. +
+ Select +	+`open class Select : SimplePanel, StringFormControl` + The form field component for Select control. +
+ SelectInput +	+`open class SelectInput : SimplePanel, FormInput` + The basic component for Select control. +
+ SelectOptGroup +	+`open class SelectOptGroup : SimplePanel` + The helper container for adding option groups to Select. +
+ SelectRemote +	+`open class SelectRemote<T : Any> : SimplePanel, StringFormControl` + The form field component for SelectRemote control. +
+ SimpleSelect +	+`open class SimpleSelect : SimplePanel, StringFormControl` + The form field component for SimpleSelect control. +
+ SimpleSelectInput +	+`open class SimpleSelectInput : SimplePanel, FormInput` + Simple select component. +
+ Spinner +	+`open class Spinner : SimplePanel, NumberFormControl` + The form field component for spinner control. +
+ SplitPanel +	+`open class SplitPanel : SimplePanel` + The container with draggable splitter. +
+ StackPanel +	+`open class StackPanel : SimplePanel` + The container with only one active (visible) child at any moment. +
+ Table +	+`open class Table : SimplePanel` + HTML table component. +
+ TabPanel +	+`open class TabPanel : SimplePanel` + The container rendering it's children as tabs. +
+ Tag +	+`open class Tag : SimplePanel, Template` + HTML tag component. +
+ Toolbar +	+`open class Toolbar : SimplePanel` + The Bootstrap toolbar. +
+ Upload +	+`open class Upload : SimplePanel, KFilesFormControl` + The form field file upload component. +
+ WidgetWrapper +	+`open class WidgetWrapper : SimplePanel` + This class allows to wrap a component into separately styled DIV element. +
+ Window +	+`open class Window : SimplePanel` + Floating window container. +

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/remove-all.html b/api1/pl.treksoft.kvision.panel/-simple-panel/remove-all.html new file mode 100644 index 00000000..bd66f7ce --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/remove-all.html @@ -0,0 +1,18 @@ + + + +SimplePanel.removeAll - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides Container.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/remove.html b/api1/pl.treksoft.kvision.panel/-simple-panel/remove.html new file mode 100644 index 00000000..48ad9208 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/remove.html @@ -0,0 +1,21 @@ + + + +SimplePanel.remove - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / remove
+
+

remove

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

Overrides Container.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/render.html b/api1/pl.treksoft.kvision.panel/-simple-panel/render.html new file mode 100644 index 00000000..16297d87 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/render.html @@ -0,0 +1,18 @@ + + + +SimplePanel.render - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api1/pl.treksoft.kvision.panel/-simple-panel/simple-panel.html b/api1/pl.treksoft.kvision.panel/-simple-panel/simple-panel.html new file mode 100644 index 00000000..1b3114c7 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-simple-panel/simple-panel.html @@ -0,0 +1,16 @@ + + + +SimplePanel.simplePanel - kvision + + + +kvision / pl.treksoft.kvision.panel / SimplePanel / simplePanel
+
+

simplePanel

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

DSL builder extension function.

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

+ + -- cgit