aboutsummaryrefslogtreecommitdiff
path: root/src/main/kotlin/pl/treksoft/kvision/dropdown/ContextMenu.kt
blob: 5fac0494ed33b6e0a68331943cb6a1ff3601f84b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
 * 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 org.w3c.dom.events.MouseEvent
import pl.treksoft.kvision.core.Display
import pl.treksoft.kvision.core.Widget
import pl.treksoft.kvision.html.ListTag
import pl.treksoft.kvision.html.ListType
import pl.treksoft.kvision.panel.Root
import pl.treksoft.kvision.utils.px

/**
 * Context menu component.
 *
 * @constructor
 * @param element an element to bind
 * @param fixedPosition use fixed positioning
 * @param classes a set of CSS class names
 */
open class ContextMenu(
    element: Widget? = null,
    protected val fixedPosition: Boolean = false,
    classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null
) : ListTag(ListType.UL, classes = classes + "dropdown-menu") {

    init {
        @Suppress("LeakingThis")
        hide()
        @Suppress("LeakingThis")
        display = Display.BLOCK
        val root = element?.getRoot() ?: Root.getLastRoot()
        if (root != null) {
            @Suppress("LeakingThis")
            root.addContextMenu(this)
        } else {
            println("At least one Root object is required to create a context menu!")
        }
        @Suppress("LeakingThis")
        init?.invoke(this)
    }

    /**
     * Positions and shows a context menu based on a mouse event.
     * @param mouseEvent mouse event
     * @return current context menu
     */
    open fun positionMenu(mouseEvent: MouseEvent): ContextMenu {
        if (fixedPosition) {
            this.top = DEFAULT_FIXED_POS_Y.px
            this.left = DEFAULT_FIXED_POS_X.px
        } else {
            this.top = mouseEvent.pageY.toInt().px
            this.left = mouseEvent.pageX.toInt().px
        }
        this.show()
        return this
    }

    companion object {

        const val DEFAULT_FIXED_POS_X = 5
        const val DEFAULT_FIXED_POS_Y = 5

        /**
         * DSL builder extension function.
         *
         * It takes the same parameters as the constructor of the built component.
         */
        fun Widget.contextMenu(
            fixedPosition: Boolean = false,
            classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null
        ): ContextMenu {
            val contextMenu = ContextMenu(this, fixedPosition, classes).apply { init?.invoke(this) }
            this.setContextMenu(contextMenu)
            return contextMenu
        }
    }
}