From f3c9d405382dd81d426c7eab1f6390ec8e6dad00 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 5 Mar 2018 08:45:25 +0100 Subject: Documentation update. --- .../-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 | 392 --------------------- .../-select-option/label.html | 21 -- .../-select-option/render.html | 18 - .../-select-option/subtext.html | 21 -- .../-select-option/value.html | 21 -- 10 files changed, 585 deletions(-) delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/icon.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/index.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/label.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/render.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/subtext.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/value.html (limited to 'docs/api/pl.treksoft.kvision.form.select/-select-option') diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html deleted file mode 100644 index 4bbd977b..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html +++ /dev/null @@ -1,31 +0,0 @@ - - - -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, 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/docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html deleted file mode 100644 index 0852372b..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html deleted file mode 100644 index 262acbc5..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html deleted file mode 100644 index 50bea1eb..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select-option/icon.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/icon.html deleted file mode 100644 index a40159bc..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/icon.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select-option/index.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/index.html deleted file mode 100644 index 2cbb5142..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/index.html +++ /dev/null @@ -1,392 +0,0 @@ - - - -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, 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. -
- 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. -
- 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. -
- visible -	-`open var visible: Boolean` - Visibility state of the current component. -

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. -
- 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. -
- 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 -	-`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. -
- 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. -
- toggleVisible -	-`open fun toggleVisible(): Widget` - Toggles visibility of current widget. -

- - diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/label.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/label.html deleted file mode 100644 index ddc9572d..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/label.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select-option/render.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/render.html deleted file mode 100644 index b548132f..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/render.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select-option/subtext.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/subtext.html deleted file mode 100644 index 276a4323..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/subtext.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select-option/value.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/value.html deleted file mode 100644 index c31c0ece..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select-option/value.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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