com.github.mvysny.karibudsl.v8.Grid.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of karibu-dsl-v8 Show documentation
Karibu-DSL, Kotlin extensions/DSL for Vaadin
The newest version!
package com.github.mvysny.karibudsl.v8

import com.vaadin.data.SelectionModel
import com.vaadin.data.provider.DataProvider
import com.vaadin.data.provider.HierarchicalDataProvider
import com.vaadin.event.selection.SelectionEvent
import com.vaadin.shared.util.SharedUtil
import com.vaadin.ui.Grid
import com.vaadin.ui.Grid.Column
import com.vaadin.ui.HasComponents
import com.vaadin.ui.TreeGrid
import com.vaadin.ui.components.grid.FooterCell
import com.vaadin.ui.components.grid.FooterRow
import com.vaadin.ui.components.grid.HeaderCell
import com.vaadin.ui.components.grid.HeaderRow
import com.vaadin.ui.renderers.TextRenderer
import elemental.json.Json
import elemental.json.JsonValue
import kotlin.reflect.KClass
import kotlin.reflect.KProperty1

/**
 * Creates a grid.
 * @param itemClass host items of this class. If not null, columns are created automatically for this class. This is not recommended:
 * https://github.com/mvysny/karibu-dsl/issues/4
 */
@VaadinDsl
public fun  (@VaadinDsl HasComponents).grid(itemClass: KClass? = null, caption: String? = null, dataProvider: DataProvider? = null, block: (@VaadinDsl Grid).() -> Unit = {}): Grid {
    val grid: Grid = if (itemClass == null) Grid() else Grid(itemClass.java)
    grid.caption = caption
    if (dataProvider != null) {
        grid.dataProvider = dataProvider
    }
    return init(grid, block)
}

/**
 * Creates a tree grid.
 */
@VaadinDsl
public fun  (@VaadinDsl HasComponents).treeGrid(dataProvider: HierarchicalDataProvider? = null, block: (@VaadinDsl TreeGrid).() -> Unit = {}): TreeGrid {
    val grid = TreeGrid()
    if (dataProvider != null) {
        grid.dataProvider = dataProvider
    }
    return init(grid, block)
}

/**
 * Causes the Grid to only show given set of columns, and in given order.
 * @param ids show only this properties.
 */
public fun  (@VaadinDsl Grid).showColumns(vararg ids: KProperty1) {
    setColumns(*ids.map { it.name }.toTypedArray())
}

/**
 * Allows you to re-configure a particular column in a Grid. E.g.:
 * ```
 * grid(...) {
 *   showColumns(Person::name, Person::age)
 *   column(Person::age) { isSortable = false }
 * }
 * ```
 * @param prop the bean property for which to retrieve the column
 * @param block run this block with the column as a receiver
 */
@Suppress("UNCHECKED_CAST")
@VaadinDsl
public fun  (@VaadinDsl Grid).column(prop: KProperty1, block: (@VaadinDsl Grid.Column).() -> Unit = {}): Grid.Column =
        getColumnBy(prop).apply { block() }

/**
 * Removes column showing given [property].
 */
public fun  (@VaadinDsl Grid).removeColumn(property: KProperty1) {
    removeColumn(property.name)
}

/**
 * Refreshes the Grid and re-polls for data.
 */
public fun (@VaadinDsl Grid<*>).refresh() {
    dataProvider.refreshAll()
}

public val Grid<*>.isMultiSelect: Boolean get() = selectionModel is SelectionModel.Multi<*>
public val Grid<*>.isSingleSelect: Boolean get() = selectionModel is SelectionModel.Single<*>
public val SelectionEvent<*>.isSelectionEmpty: Boolean get() = !firstSelectedItem.isPresent

/**
 * Adds a new column for given [property] which is by default sortable. The [Grid.Column.setId]
 * is set to property name, the column caption is set by converting camelCase to Human Friendly.
 */
public fun  (@VaadinDsl Grid).addColumnFor(property: KProperty1, block: (@VaadinDsl Grid.Column).() -> Unit = {}): Grid.Column {
    val column: Column = addColumn(property)
    column.id = property.name
    column.caption = SharedUtil.propertyIdToHumanFriendly(property.name)
    column.block()
    return column
}

/**
 * Retrieves the column for given [property]; it matches the column ID to [KProperty1.name].
 * @throws IllegalArgumentException if no such column exists.
 */
@Suppress("UNCHECKED_CAST")
public fun  Grid.getColumnBy(property: KProperty1): Grid.Column = getColumnBy(property.name) as Grid.Column

/**
 * Retrieves the column for given [columnId].
 * @throws IllegalArgumentException if no such column exists.
 */
@Suppress("UNCHECKED_CAST")
public fun  Grid.getColumnBy(columnId: String): Grid.Column =
        getColumn(columnId) as Grid.Column?
                ?: throw IllegalArgumentException("No column with ID $columnId; available column IDs: ${columns.map { it.id }.filterNotNull()}")

public enum class VAlign { Left, Middle, Right }

/**
 * Aligns the text in the columns, by using [Column.setStyleGenerator] to set either `v-align-center` or `v-align-right` style.
 */
public var Grid.Column<*, *>.align: VAlign
    @Deprecated("Cannot read this property", level = DeprecationLevel.ERROR)
    get() = throw UnsupportedOperationException("Cannot read this property")
    set(value) {
        when (value) {
            VAlign.Left -> setStyleGenerator { null }
            // these styles are provided by the Vaadin Valo theme out-of-the-box, no need to add then to the app's stylesheet
            VAlign.Middle -> setStyleGenerator { "v-align-center" }
            VAlign.Right -> setStyleGenerator { "v-align-right" }
        }
    }

/**
 * Returns the cell on this row corresponding to the given property.
 * @param property the id of the column whose header cell to get, not null
 * @return the header cell
 * @throws IllegalArgumentException if there is no such column in the grid
 */
public fun HeaderRow.getCell(property: KProperty1<*, *>): HeaderCell = getCell(property.name)

/**
 * Returns the cell on this row corresponding to the given property.
 * @param property the id of the column whose footer cell to get, not null
 * @return the footer cell
 * @throws IllegalArgumentException if there is no such column in the grid
 */
public fun FooterRow.getCell(property: KProperty1<*, *>): FooterCell = getCell(property.name)