diff options
Diffstat (limited to 'src/main/kotlin/pl/treksoft/kvision/dropdown')
| -rw-r--r-- | src/main/kotlin/pl/treksoft/kvision/dropdown/DropDown.kt | 87 |
1 files changed, 76 insertions, 11 deletions
diff --git a/src/main/kotlin/pl/treksoft/kvision/dropdown/DropDown.kt b/src/main/kotlin/pl/treksoft/kvision/dropdown/DropDown.kt index 2e32ff7c..b80c6dc5 100644 --- a/src/main/kotlin/pl/treksoft/kvision/dropdown/DropDown.kt +++ b/src/main/kotlin/pl/treksoft/kvision/dropdown/DropDown.kt @@ -1,31 +1,69 @@ +/* + * Copyright (c) 2017-present Robert Jaros + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ package pl.treksoft.kvision.dropdown import com.github.snabbdom.VNode import pl.treksoft.kvision.core.Component import pl.treksoft.kvision.core.CssSize +import pl.treksoft.kvision.core.StringBoolPair +import pl.treksoft.kvision.core.StringPair import pl.treksoft.kvision.html.BUTTONSTYLE import pl.treksoft.kvision.html.Button -import pl.treksoft.kvision.html.LIST +import pl.treksoft.kvision.html.LISTTYPE import pl.treksoft.kvision.html.Link import pl.treksoft.kvision.html.ListTag import pl.treksoft.kvision.html.TAG import pl.treksoft.kvision.html.Tag import pl.treksoft.kvision.panel.SimplePanel -import pl.treksoft.kvision.core.StringBoolPair -import pl.treksoft.kvision.core.StringPair import pl.treksoft.kvision.utils.obj -enum class DD(val type: String) { +/** + * Useful options for use in DropDown's *elements* parameter. + */ +enum class DD(val option: String) { HEADER("DD#HEADER"), DISABLED("DD#DISABLED"), SEPARATOR("DD#SEPARATOR") } +/** + * Bootstrap dropdown component. + * + * @constructor + * @param text the label of the dropdown button + * @param elements an optional list of link elements (special options from [DD] enum class can be used as values) + * @param icon the icon of the dropdown button + * @param style the style of the dropdown button + * @param disabled determines if the component is disabled on start + * @param classes a set of CSS class names + */ open class DropDown( text: String, elements: List<StringPair>? = null, icon: String? = null, style: BUTTONSTYLE = BUTTONSTYLE.DEFAULT, disabled: Boolean = false, classes: Set<String> = setOf() ) : SimplePanel(classes) { + /** + * Label of the dropdown button. + */ var text get() = button.text set(value) { @@ -36,41 +74,65 @@ open class DropDown( field = value setChildrenFromElements() } + /** + * The icon of the dropdown button. + */ var icon get() = button.icon set(value) { button.icon = value } + /** + * The style of the dropdown button. + */ var style get() = button.style set(value) { button.style = value } + /** + * The size of the dropdown button. + */ var size get() = button.size set(value) { button.size = value } + /** + * Determines if the dropdown button takes all the space horizontally. + */ var block get() = button.block set(value) { button.block = value } + /** + * Determines if the dropdown is disabled. + */ var disabled get() = button.disabled set(value) { button.disabled = value } + /** + * The image on the dropdown button. + */ var image get() = button.image set(value) { button.image = value } + /** + * Determines if the dropdown is showing upwards. + */ var dropup = false set(value) { field = value refresh() } + /** + * Width of the dropdown button. + */ override var width: CssSize? get() = super.width set(value) { @@ -93,7 +155,7 @@ open class DropDown( } companion object { - var counter = 0 + internal var counter = 0 } override fun add(child: Component): SimplePanel { @@ -126,13 +188,13 @@ open class DropDown( elements?.let { elems -> val c = elems.map { when (it.second) { - DD.HEADER.type -> Tag(TAG.LI, it.first, classes = setOf("dropdown-header")) - DD.SEPARATOR.type -> { + DD.HEADER.option -> Tag(TAG.LI, it.first, classes = setOf("dropdown-header")) + DD.SEPARATOR.option -> { val tag = Tag(TAG.LI, it.first, classes = setOf("divider")) tag.role = "separator" tag } - DD.DISABLED.type -> { + DD.DISABLED.option -> { val tag = Tag(TAG.LI, classes = setOf("disabled")) tag.add(Link(it.first, "#")) tag @@ -169,12 +231,15 @@ open class DropDown( return cl } + /** + * Toggles dropdown visibility. + */ open fun toggle() { this.list.getElementJQueryD()?.dropdown("toggle") } } -open class DropDownButton( +internal class DropDownButton( id: String, text: String, icon: String? = null, style: BUTTONSTYLE = BUTTONSTYLE.DEFAULT, disabled: Boolean = false, classes: Set<String> = setOf() ) : @@ -192,8 +257,8 @@ open class DropDownButton( } } -open class DropDownListTag(private val ariaId: String, classes: Set<String> = setOf()) : ListTag( - LIST.UL, null, +internal class DropDownListTag(private val ariaId: String, classes: Set<String> = setOf()) : ListTag( + LISTTYPE.UL, null, false, classes ) { |