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 --- .../-select-option/-init-.html | 31 ++ .../-select-option/disabled.html | 21 + .../-select-option/divider.html | 21 + .../-select-option/get-sn-attrs.html | 18 + .../-select-option/icon.html | 21 + .../-select-option/index.html | 609 +++++++++++++++++++++ .../-select-option/label.html | 21 + .../-select-option/render.html | 18 + .../-select-option/select-option.html | 20 + .../-select-option/selected.html | 21 + .../-select-option/subtext.html | 21 + .../-select-option/value.html | 21 + 12 files changed, 843 insertions(+) create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/-init-.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/disabled.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/divider.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/icon.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/index.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/label.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/render.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/select-option.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/selected.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/subtext.html create mode 100644 api1/pl.treksoft.kvision.form.select/-select-option/value.html (limited to 'api1/pl.treksoft.kvision.form.select/-select-option') diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/-init-.html b/api1/pl.treksoft.kvision.form.select/-select-option/-init-.html new file mode 100644 index 00000000..86ab1574 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/-init-.html @@ -0,0 +1,31 @@ + + + +SelectOption.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / <init>
+
+

<init>

+ +

SelectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf())

Parameters

+value - the value of the option

+label - the label of the option

+subtext - the small subtext after the label of the option

+icon - the icon before the label of the option

+divider - renders this option as a divider

+disabled - renders a disabled option

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/disabled.html b/api1/pl.treksoft.kvision.form.select/-select-option/disabled.html new file mode 100644 index 00000000..0852372b --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/disabled.html @@ -0,0 +1,21 @@ + + + +SelectOption.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / disabled
+
+

disabled

+ +var disabled: Boolean +

Determines if the option should be disabled.

Getter
+

Determines if the option should be disabled.

Setter
+

Determines if the option should be disabled.

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/divider.html b/api1/pl.treksoft.kvision.form.select/-select-option/divider.html new file mode 100644 index 00000000..262acbc5 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/divider.html @@ -0,0 +1,21 @@ + + + +SelectOption.divider - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / divider
+
+

divider

+ +var divider: Boolean +

Determines if the option should be rendered as divider.

Getter
+

Determines if the option should be rendered as divider.

Setter
+

Determines if the option should be rendered as divider.

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html b/api1/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html new file mode 100644 index 00000000..50bea1eb --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +SelectOption.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / 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.form.select/-select-option/icon.html b/api1/pl.treksoft.kvision.form.select/-select-option/icon.html new file mode 100644 index 00000000..a40159bc --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/icon.html @@ -0,0 +1,21 @@ + + + +SelectOption.icon - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / icon
+
+

icon

+ +var icon: String? +

The icon before the label of the option.

Getter
+

The icon before the label of the option.

Setter
+

The icon before the label of the option.

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/index.html b/api1/pl.treksoft.kvision.form.select/-select-option/index.html new file mode 100644 index 00000000..19f660cd --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/index.html @@ -0,0 +1,609 @@ + + + +SelectOption - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption
+
+

SelectOption

+open class SelectOption : Widget +

The helper component for adding options to Select or SelectOptGroup.

Constructors

+ + + + + + + +

<init>

SelectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf())

Properties

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

+ disabled +	+`var disabled: Boolean` + Determines if the option should be disabled. +
+ divider +	+`var divider: Boolean` + Determines if the option should be rendered as divider. +
+ icon +	+`var icon: String?` + The icon before the label of the option. +
+ label +	+`var label: String?` + The label of the option. +
+ selected +	+`var selected: Boolean` + Determines if the option is selected. +
+ subtext +	+`var subtext: String?` + The subtext after the label of the option. +
+ value +	+`var value: String?` + The value of the option. +

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

+ + + + + + + +

selectOption

fun Select.selectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf(), init: (SelectOption.() -> Unit)? = null): SelectOption

fun SelectInput.selectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf(), init: (SelectOption.() -> Unit)? = null): SelectOption

fun SelectOptGroup.selectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf(), init: (SelectOption.() -> Unit)? = null): SelectOption

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.form.select/-select-option/label.html b/api1/pl.treksoft.kvision.form.select/-select-option/label.html new file mode 100644 index 00000000..ddc9572d --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/label.html @@ -0,0 +1,21 @@ + + + +SelectOption.label - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / label
+
+

label

+ +var label: String? +

The label of the option.

Getter
+

The label of the option.

Setter
+

The label of the option.

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/render.html b/api1/pl.treksoft.kvision.form.select/-select-option/render.html new file mode 100644 index 00000000..b548132f --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/render.html @@ -0,0 +1,18 @@ + + + +SelectOption.render - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / 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.form.select/-select-option/select-option.html b/api1/pl.treksoft.kvision.form.select/-select-option/select-option.html new file mode 100644 index 00000000..a9900d46 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/select-option.html @@ -0,0 +1,20 @@ + + + +SelectOption.selectOption - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / selectOption
+
+

selectOption

+ +

fun Select.selectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf(), init: (SelectOption.() -> Unit)? = null): SelectOption

+ +

fun SelectInput.selectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf(), init: (SelectOption.() -> Unit)? = null): SelectOption

+ +

fun SelectOptGroup.selectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, selected: Boolean = false, classes: Set<String> = setOf(), init: (SelectOption.() -> Unit)? = null): SelectOption

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/selected.html b/api1/pl.treksoft.kvision.form.select/-select-option/selected.html new file mode 100644 index 00000000..0aa4d26c --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/selected.html @@ -0,0 +1,21 @@ + + + +SelectOption.selected - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / selected
+
+

selected

+ +var selected: Boolean +

Determines if the option is selected.

Getter
+

Determines if the option is selected.

Setter
+

Determines if the option is selected.

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/subtext.html b/api1/pl.treksoft.kvision.form.select/-select-option/subtext.html new file mode 100644 index 00000000..276a4323 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/subtext.html @@ -0,0 +1,21 @@ + + + +SelectOption.subtext - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / subtext
+
+

subtext

+ +var subtext: String? +

The subtext after the label of the option.

Getter
+

The subtext after the label of the option.

Setter
+

The subtext after the label of the option.

+ + diff --git a/api1/pl.treksoft.kvision.form.select/-select-option/value.html b/api1/pl.treksoft.kvision.form.select/-select-option/value.html new file mode 100644 index 00000000..c31c0ece --- /dev/null +++ b/api1/pl.treksoft.kvision.form.select/-select-option/value.html @@ -0,0 +1,21 @@ + + + +SelectOption.value - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / value
+
+

value

+ +var value: String? +

The value of the option.

Getter
+

The value of the option.

Setter
+

The value of the option.

+ + -- cgit