eu.vaadinonkotlin.vaadin8

Class FilterBinderKt

eu.vaadinonkotlin.vaadin8.FilterBinderKt

public class FilterBinderKt

Method Summary

Modifier and Type

Method and Description

static <T,F> FilterRow<T,F>

generateFilterComponents(com.vaadin.ui.components.grid.HeaderRow $receiver, com.vaadin.ui.Grid<T> grid, kotlin.reflect.KClass<T> itemClass, eu.vaadinonkotlin.FilterFactory<F> filterFactory, FilterFieldFactory<T,F> filterFieldFactory, com.vaadin.shared.ui.ValueChangeMode valueChangeMode) Re-creates filters in this header row. Simply call grid.appendHeaderRow().generateFilterComponents(grid) to automatically attach filters to non-generated columns. Please note that filters are not re-generated when the container data source is changed.

Method Detail

generateFilterComponents

public static <T,F> FilterRow<T,F> generateFilterComponents(com.vaadin.ui.components.grid.HeaderRow $receiver,
                                                            com.vaadin.ui.Grid<T> grid,
                                                            kotlin.reflect.KClass<T> itemClass,
                                                            eu.vaadinonkotlin.FilterFactory<F> filterFactory,
                                                            FilterFieldFactory<T,F> filterFieldFactory,
                                                            com.vaadin.shared.ui.ValueChangeMode valueChangeMode)

Re-creates filters in this header row. Simply call grid.appendHeaderRow().generateFilterComponents(grid) to automatically attach filters to non-generated columns. Please note that filters are not re-generated when the container data source is changed.

Only use this function if you wish to use your custom filter hierarchy. However, typically you use VokDataProvider which uses vok-dataprovider filters and then you should use the other generateFilterComponents() function.

Type Parameters:

T - the type of items in the grid.

Parameters:

grid - the owner grid.

filterFieldFactory - used to create the filters themselves. If null, class DefaultFilterFieldFactory is used.

valueChangeMode - how eagerly to apply the filtering after the user changes the filter value. Only applied to HasValueChangeMode; typically only applies to inline filter components (most importantly com.vaadin.ui.TextField), typically ignored for popup components (such as com.github.vok.framework.NumberFilterPopup) where the values are applied after the user clicks the "Apply" button. Defaults to ValueChangeMode.LAZY.