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 --- api1/pl.treksoft.kvision.html/-button/-init-.html | 27 + api1/pl.treksoft.kvision.html/-button/block.html | 21 + api1/pl.treksoft.kvision.html/-button/button.html | 16 + .../pl.treksoft.kvision.html/-button/disabled.html | 21 + .../-button/get-sn-attrs.html | 18 + .../-button/get-sn-class.html | 18 + api1/pl.treksoft.kvision.html/-button/icon.html | 21 + api1/pl.treksoft.kvision.html/-button/image.html | 21 + api1/pl.treksoft.kvision.html/-button/index.html | 625 +++++++++++++++++++++ .../pl.treksoft.kvision.html/-button/on-click.html | 15 + api1/pl.treksoft.kvision.html/-button/render.html | 18 + api1/pl.treksoft.kvision.html/-button/size.html | 21 + api1/pl.treksoft.kvision.html/-button/style.html | 21 + api1/pl.treksoft.kvision.html/-button/text.html | 21 + api1/pl.treksoft.kvision.html/-button/type.html | 21 + 15 files changed, 905 insertions(+) create mode 100644 api1/pl.treksoft.kvision.html/-button/-init-.html create mode 100644 api1/pl.treksoft.kvision.html/-button/block.html create mode 100644 api1/pl.treksoft.kvision.html/-button/button.html create mode 100644 api1/pl.treksoft.kvision.html/-button/disabled.html create mode 100644 api1/pl.treksoft.kvision.html/-button/get-sn-attrs.html create mode 100644 api1/pl.treksoft.kvision.html/-button/get-sn-class.html create mode 100644 api1/pl.treksoft.kvision.html/-button/icon.html create mode 100644 api1/pl.treksoft.kvision.html/-button/image.html create mode 100644 api1/pl.treksoft.kvision.html/-button/index.html create mode 100644 api1/pl.treksoft.kvision.html/-button/on-click.html create mode 100644 api1/pl.treksoft.kvision.html/-button/render.html create mode 100644 api1/pl.treksoft.kvision.html/-button/size.html create mode 100644 api1/pl.treksoft.kvision.html/-button/style.html create mode 100644 api1/pl.treksoft.kvision.html/-button/text.html create mode 100644 api1/pl.treksoft.kvision.html/-button/type.html (limited to 'api1/pl.treksoft.kvision.html/-button') diff --git a/api1/pl.treksoft.kvision.html/-button/-init-.html b/api1/pl.treksoft.kvision.html/-button/-init-.html new file mode 100644 index 00000000..35134291 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/-init-.html @@ -0,0 +1,27 @@ + + + +Button.<init> - kvision + + + +kvision / pl.treksoft.kvision.html / Button / <init>
+
+

<init>

+ +

Button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf())

Parameters

+text - button label

+icon - button icon

+style - button style

+disabled - button state

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/block.html b/api1/pl.treksoft.kvision.html/-button/block.html new file mode 100644 index 00000000..dab9f6c3 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/block.html @@ -0,0 +1,21 @@ + + + +Button.block - kvision + + + +kvision / pl.treksoft.kvision.html / Button / block
+
+

block

+ +var block: Boolean +

Determines if the button takes all the space horizontally.

Getter
+

Determines if the button takes all the space horizontally.

Setter
+

Determines if the button takes all the space horizontally.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/button.html b/api1/pl.treksoft.kvision.html/-button/button.html new file mode 100644 index 00000000..e48858ba --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/button.html @@ -0,0 +1,16 @@ + + + +Button.button - kvision + + + +kvision / pl.treksoft.kvision.html / Button / button
+
+

button

+ +

fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/disabled.html b/api1/pl.treksoft.kvision.html/-button/disabled.html new file mode 100644 index 00000000..6f924849 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/disabled.html @@ -0,0 +1,21 @@ + + + +Button.disabled - kvision + + + +kvision / pl.treksoft.kvision.html / Button / disabled
+
+

disabled

+ +var disabled: Boolean +

Determines if button is disabled.

Getter
+

Determines if button is disabled.

Setter
+

Determines if button is disabled.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/get-sn-attrs.html b/api1/pl.treksoft.kvision.html/-button/get-sn-attrs.html new file mode 100644 index 00000000..0c2ad719 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +Button.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.html / Button / getSnAttrs
+
+

getSnAttrs

+ +protected open fun getSnAttrs(): List<StringPair> +

Overrides Widget.getSnAttrs

Returns list of element attributes in the form of a List.

Return
+list of element attributes

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/get-sn-class.html b/api1/pl.treksoft.kvision.html/-button/get-sn-class.html new file mode 100644 index 00000000..b5d8f779 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Button.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.html / Button / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
+list of CSS class names

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/icon.html b/api1/pl.treksoft.kvision.html/-button/icon.html new file mode 100644 index 00000000..12fe9900 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/icon.html @@ -0,0 +1,21 @@ + + + +Button.icon - kvision + + + +kvision / pl.treksoft.kvision.html / Button / icon
+
+

icon

+ +var icon: String? +

Button icon.

Getter
+

Button icon.

Setter
+

Button icon.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/image.html b/api1/pl.treksoft.kvision.html/-button/image.html new file mode 100644 index 00000000..cdd1a4f2 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/image.html @@ -0,0 +1,21 @@ + + + +Button.image - kvision + + + +kvision / pl.treksoft.kvision.html / Button / image
+
+

image

+ +var image: ResString? +

Button image.

Getter
+

Button image.

Setter
+

Button image.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/index.html b/api1/pl.treksoft.kvision.html/-button/index.html new file mode 100644 index 00000000..715a4418 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/index.html @@ -0,0 +1,625 @@ + + + +Button - kvision + + + +kvision / pl.treksoft.kvision.html / Button
+
+

Button

+open class Button : Widget +

Button component.

Constructors

+ + + + + + + +

<init>

Button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf())

Properties

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

+ block +	+`var block: Boolean` + Determines if the button takes all the space horizontally. +
+ disabled +	+`var disabled: Boolean` + Determines if button is disabled. +
+ icon +	+`var icon: String?` + Button icon. +
+ image +	+`var image: ResString?` + Button image. +
+ size +	+`var size: ButtonSize?` + Button size. +
+ style +	+`var style: ButtonStyle` + Button style. +
+ text +	+`var text: String` + Button label. +
+ type +	+`var type: ButtonType` + Button types. +

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

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

+ 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. +
+ onClick +	+`open fun onClick(handler: Button.(MouseEvent) -> Unit): Button` + A convenient helper for easy setting onClick event handler. +
+ 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. +
+ 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. +
+ 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

+ + + + + + + +

button

fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/on-click.html b/api1/pl.treksoft.kvision.html/-button/on-click.html new file mode 100644 index 00000000..ca692506 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/on-click.html @@ -0,0 +1,15 @@ + + + +Button.onClick - kvision + + + +kvision / pl.treksoft.kvision.html / Button / onClick
+
+

onClick

+ +open fun onClick(handler: Button.(MouseEvent) -> Unit): Button +

A convenient helper for easy setting onClick event handler.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/render.html b/api1/pl.treksoft.kvision.html/-button/render.html new file mode 100644 index 00000000..1e23270e --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/render.html @@ -0,0 +1,18 @@ + + + +Button.render - kvision + + + +kvision / pl.treksoft.kvision.html / Button / 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.html/-button/size.html b/api1/pl.treksoft.kvision.html/-button/size.html new file mode 100644 index 00000000..1e7dd9e0 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/size.html @@ -0,0 +1,21 @@ + + + +Button.size - kvision + + + +kvision / pl.treksoft.kvision.html / Button / size
+
+

size

+ +var size: ButtonSize? +

Button size.

Getter
+

Button size.

Setter
+

Button size.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/style.html b/api1/pl.treksoft.kvision.html/-button/style.html new file mode 100644 index 00000000..53caf7b6 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/style.html @@ -0,0 +1,21 @@ + + + +Button.style - kvision + + + +kvision / pl.treksoft.kvision.html / Button / style
+
+

style

+ +var style: ButtonStyle +

Button style.

Getter
+

Button style.

Setter
+

Button style.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/text.html b/api1/pl.treksoft.kvision.html/-button/text.html new file mode 100644 index 00000000..6c2324b2 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/text.html @@ -0,0 +1,21 @@ + + + +Button.text - kvision + + + +kvision / pl.treksoft.kvision.html / Button / text
+
+

text

+ +var text: String +

Button label.

Getter
+

Button label.

Setter
+

Button label.

+ + diff --git a/api1/pl.treksoft.kvision.html/-button/type.html b/api1/pl.treksoft.kvision.html/-button/type.html new file mode 100644 index 00000000..697f0c9f --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-button/type.html @@ -0,0 +1,21 @@ + + + +Button.type - kvision + + + +kvision / pl.treksoft.kvision.html / Button / type
+
+

type

+ +var type: ButtonType +

Button types.

Getter
+

Button types.

Setter
+

Button types.

+ + -- cgit