• Home
• com.github.mvysny.karibudsl
• karibu-dsl
• 2.1.4
• source code
• ContextMenu.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.mvysny.karibudsl.v10.ContextMenu.kt Maven / Gradle / Ivy

package com.github.mvysny.karibudsl.v10

import com.vaadin.flow.component.ClickEvent
import com.vaadin.flow.component.Component
import com.vaadin.flow.component.ComponentEventListener
import com.vaadin.flow.component.contextmenu.ContextMenu
import com.vaadin.flow.component.contextmenu.HasMenuItems
import com.vaadin.flow.component.contextmenu.MenuItem
import com.vaadin.flow.component.grid.Grid
import com.vaadin.flow.component.grid.contextmenu.GridContextMenu
import com.vaadin.flow.component.grid.contextmenu.GridMenuItem

/**
 * Allows you to define context menu for any component as follows:
 *
 * ```
 * button("foo") {
 *   contextMenu {
 *     item("save", { e -> println("saved") })
 *     item("style") {
 *       item("bold", { e -> println("bold") })
 *       item("italic", { e -> println("italic") })
 *     }
 *     item("clear", { e -> println("clear") })
 *   }
 * }
 * ```
 */
@VaadinDsl
public fun (@VaadinDsl Component).contextMenu(block: ContextMenu.()->Unit = {}): ContextMenu {
    val menu = ContextMenu(this)
    menu.block()
    return menu
}

@VaadinDsl
public fun (@VaadinDsl HasMenuItems).item(text: String, clickListener: ((ClickEvent)->Unit)? = null,
                                          block: (@VaadinDsl MenuItem).()->Unit = {}): MenuItem =
        addItem(text, clickListener).apply { block() }

@VaadinDsl
public fun (@VaadinDsl MenuItem).item(text: String, clickListener: ((ClickEvent)->Unit)? = null,
                                          block: (@VaadinDsl MenuItem).()->Unit = {}): MenuItem =
        subMenu.item(text, clickListener, block)

@VaadinDsl
public fun (@VaadinDsl HasMenuItems).item(component: Component, clickListener: ((ClickEvent)->Unit)? = null,
                                          block: (@VaadinDsl MenuItem).()->Unit = {}): MenuItem =
        addItem(component, clickListener).apply { block() }

@VaadinDsl
public fun (@VaadinDsl MenuItem).item(component: Component, clickListener: ((ClickEvent)->Unit)? = null,
                               block: (@VaadinDsl MenuItem).()->Unit = {}): MenuItem =
        subMenu.item(component, clickListener, block)

/**
 * Akin to [Grid.addContextMenu], but allows you to configure the context menu via given [block], as follows:
 * ```
 * grid {
 *   gridContextMenu {
 *     item("edit", { person -> println("editing $person") })
 *     item("delete", { person -> person.delete(); println("deleted $person") })
 *   }
 * }
 * ```
 *
 * Note that you can attach both [GridContextMenu] and [ContextMenu] to the grid, but that's discouraged since both of
 * those will show on right click and will overlap.
 */
@VaadinDsl
public fun  (@VaadinDsl Grid).gridContextMenu(block: GridContextMenu.()->Unit = {}): GridContextMenu {
    val menu = addContextMenu()
    menu.block()
    return menu
}

private val  (((T?)->Unit)?).toListener: ComponentEventListener>? get() = when (this) {
    null -> null
    else -> ComponentEventListener { event -> this@toListener(event.item.orElse(null)) }
}

/**
 * @param clickListener may be invoked with null item if there are not enough rows in the grid and the user clicks the
 * empty space in the grid.
 */
@VaadinDsl
public fun  (@VaadinDsl GridContextMenu).item(text: String, clickListener: ((T?)->Unit)? = null,
                                   block: (@VaadinDsl GridMenuItem).()->Unit = {}): GridMenuItem =
        addItem(text, clickListener.toListener).apply { block() }

@VaadinDsl
public fun  (@VaadinDsl GridMenuItem).item(text: String, clickListener: ((T?)->Unit)? = null,
                               block: (@VaadinDsl GridMenuItem).()->Unit = {}): GridMenuItem =
        subMenu.addItem(text, clickListener.toListener).apply { block() }

@VaadinDsl
public fun  (@VaadinDsl GridContextMenu).item(component: Component, clickListener: ((T?)->Unit)? = null,
                                   block: (@VaadinDsl GridMenuItem).()->Unit = {}): GridMenuItem =
        addItem(component, clickListener.toListener).apply { block() }

@VaadinDsl
public fun  (@VaadinDsl GridMenuItem).item(component: Component, clickListener: ((T?)->Unit)? = null,
                               block: (@VaadinDsl GridMenuItem).()->Unit = {}): GridMenuItem =
        subMenu.addItem(component, clickListener.toListener).apply { block() }

@VaadinDsl
public fun (@VaadinDsl MenuItem).separator() {
    // use addSeparator() when https://github.com/vaadin/vaadin-context-menu-flow/issues/137 is fixed
    hr()
}

@VaadinDsl
public fun (@VaadinDsl GridMenuItem<*>).separator() {
    // use addSeparator() when https://github.com/vaadin/vaadin-context-menu-flow/issues/137 is fixed
    hr()
}

@VaadinDsl
public fun (@VaadinDsl ContextMenu).separator() {
    // use addSeparator() when https://github.com/vaadin/vaadin-context-menu-flow/issues/137 is fixed
    hr()
}

@VaadinDsl
public fun (@VaadinDsl GridContextMenu<*>).separator() {
    // use addSeparator() when https://github.com/vaadin/vaadin-context-menu-flow/issues/137 is fixed
    hr()
}