From 415afec335659ca6bc206b34bdd3c2fe4635718f Mon Sep 17 00:00:00 2001
From: Robert Jaros
+
+
+
+
+
+
+ Constructor Determines if the option should be disabled. Getter Determines if the option should be disabled.
+
+<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 optionlabel
- the label of the optionsubtext
- the small subtext after the label of the optionicon
- the icon before the label of the optiondivider
- renders this option as a dividerdisabled
- renders a disabled optionclasses
- a set of CSS class names
+
+
+disabled
+
+var disabled: Boolean
+
+
Setter
+
Determines if the option should be disabled.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-option/divider.html b/api/pl.treksoft.kvision.form.select/-select-option/divider.html new file mode 100644 index 00000000..262acbc5 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-option/divider.html @@ -0,0 +1,21 @@ + + + +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/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html b/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html new file mode 100644 index 00000000..50bea1eb --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +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
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/api/pl.treksoft.kvision.form.select/-select-option/index.html b/api/pl.treksoft.kvision.form.select/-select-option/index.html new file mode 100644 index 00000000..2cbb5142 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-option/index.html @@ -0,0 +1,392 @@ + + + +open class SelectOption : Widget
+The helper component for adding options to Select or SelectOptGroup.
++ + | +
+SelectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, classes: Set<String> = setOf()) |
+
+ + | +
+var disabled: Boolean
+Determines if the option should be disabled. + |
+
+ + | +
+var divider: Boolean
+Determines if the option should be rendered as divider. + |
+
+ + | +
+var icon: String?
+The icon before the label of the option. + |
+
+ + | +
+var label: String?
+The label of the option. + |
+
+ + | +
+var subtext: String?
+The subtext after the label of the option. + |
+
+ + | +
+var value: String?
+The value of the option. + |
+
+ + | +
+var draggable: Boolean?
+Determines if the current widget is draggable. + |
+
+ + | +
+var id: String?
+An ID attribute of generated HTML element. + |
+
+ + | +
+open var parent: Component?
+Parent of the current component. + |
+
+ + | +
+var role: String?
+A role attribute of generated HTML element. + |
+
+ + | +
+var title: String?
+A title attribute of generated HTML element. + |
+
+ + | +
+open var visible: Boolean
+Visibility state of the current component. + |
+
+ + | +
+open fun getSnAttrs(): List<StringPair>
+Returns list of element attributes in the form of a List. + |
+
+ + | +
+open fun render(): VNode
+Renders current component as a Snabbdom vnode. + |
+
+ + | +
+open fun addCssClass(css: String): Widget
+Adds given value to the set of CSS classes generated in html code of current component. + |
+
+ + | +
+open fun addSurroundingCssClass(css: String): Widget
+Adds given value to the set of CSS classes generated in html code of parent component. + |
+
+ + | +
+open fun afterCreate(node: VNode): Unit
+Method called after creating Snabbdom vnode. + |
+
+ + | +
+open fun afterDestroy(): Unit
+Method called after destroying Snabbdom vnode. + |
+
+ + | +
+open fun afterInsert(node: VNode): Unit
+Method called after inserting Snabbdom vnode into the DOM. + |
+
+ + | +
+open fun afterPostpatch(node: VNode): Unit
+Method called after updating Snabbdom vnode. + |
+
+ + | +
+open fun clearDragDropData(): Unit
+Clears D&D data for the current widget. It also makes it not draggable. + |
+
+ + | +
+open fun getElement(): Node?
+Returns DOM element bound to the current component. + |
+
+ + | +
+open fun getElementJQuery(): JQuery?
+Returns JQuery element bound to the current component. + |
+
+ + | +
+open fun getElementJQueryD(): dynamic
+Returns JQuery element bound to the current component as a dynamic type. + |
+
+ + | +
+open fun getSnClass(): List<StringBoolPair>
+Returns list of CSS class names for current widget in the form of a List. + |
+
+ + | +
+open fun getSnHooks(): Hooks?
+Returns list of hooks in the form of a Snabbdom Hooks object. + |
+
+ + | +
+open fun getSnOn(): On?
+Returns list of event handlers in the form of a Snabbdom On object. + |
+
+ + | +
+open fun hide(): Widget
+Makes current widget invisible. + |
+
+ + | +
+open fun removeCssClass(css: String): Widget
+Removes given value from the set of CSS classes generated in html code of current component. + |
+
+ + | +
+open fun removeEventListeners(): Widget
+Removes all event listeners from current widget. + |
+
+ + | +
+open fun removeSurroundingCssClass(css: String): Widget
+Removes given value from the set of CSS classes generated in html code of parent component. + |
+
+ + | +
+open fun render(elementName: String): VNode + open fun render(elementName: String, children: Array<dynamic>): VNode
+Renders current component as a Snabbdom vnode. + |
+
+ + | +
+open fun setDragDropData(format: String, data: String): Unit
+Sets D&D data for the current widget. It also makes it draggable. + |
+
+ + | +
+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. + |
+
+ + | +
+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 <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 show(): Widget
+Makes current widget visible. + |
+
+ + | +
+open fun toggleVisible(): Widget
+Toggles visibility of current widget. + |
+
var label: String?
+The label of the option.
+Getter
+
The label of the option.
+ +Setter
+
The label of the option.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-option/render.html b/api/pl.treksoft.kvision.form.select/-select-option/render.html new file mode 100644 index 00000000..b548132f --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-option/render.html @@ -0,0 +1,18 @@ + + + +protected open fun render(): VNode
+Overrides Widget.render
+Renders current component as a Snabbdom vnode.
+Return
+Snabbdom vnode
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/api/pl.treksoft.kvision.form.select/-select-option/value.html b/api/pl.treksoft.kvision.form.select/-select-option/value.html new file mode 100644 index 00000000..c31c0ece --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-option/value.html @@ -0,0 +1,21 @@ + + + +var value: String?
+The value of the option.
+Getter
+
The value of the option.
+ +Setter
+
The value of the option.
+ + + -- cgit