Package software.xdev.vaadin.grid_exporter

Class GridExporter<T>

java.lang.Object

software.xdev.vaadin.grid_exporter.GridExporter<T>

Type Parameters:

T - The grid bean type

public class GridExporter<T>
extends Object

Opens a wizard to export a Grid.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Format>	availableFormats
protected ColumnConfigurationBuilder	columnConfigurationBuilder
protected Predicate<com.vaadin.flow.component.grid.Grid.Column<T>>	columnFilter
protected String	fileName
protected final com.vaadin.flow.component.grid.Grid<T>	grid
protected Function<com.vaadin.flow.component.grid.Grid<T>,GridDataExtractor<T>>	gridDataExtractorSupplier
protected GridExportLocalizationConfig	localizationConfig
protected Format	preSelectedFormat

Constructor Summary

Constructors

Constructor	Description
GridExporter(com.vaadin.flow.component.grid.Grid<T> grid)

Method Summary

Modifier and Type	Method	Description
GridExporter<T>	addAvailableFormat(Format availableFormat)
protected List<ColumnConfiguration<T>>	generateAvailableColumns()
GridExporter<T>	loadFromProvider(GridExporterProvider provider)
static <T> GridExporter<T>	newWithDefaults(com.vaadin.flow.component.grid.Grid<T> grid)	Creates a new GridExporter with the default JasperReports exports.
void	open()	Opens the GridExporterWizard.
GridExporter<T>	withAvailableFormats(List<Format> availableFormats)
GridExporter<T>	withAvailableFormats(Format... availableFormats)
GridExporter<T>	withColumnConfigurationBuilder(ColumnConfigurationBuilder columnConfigurationBuilder)
GridExporter<T>	withColumnFilter(Predicate<com.vaadin.flow.component.grid.Grid.Column<T>> columnFilter)
GridExporter<T>	withFileName(String fileName)
GridExporter<T>	withGridDataExtractorSupplier(Function<com.vaadin.flow.component.grid.Grid<T>,GridDataExtractor<T>> dataExtractorSupplier)
GridExporter<T>	withLocalizationConfig(GridExportLocalizationConfig localizationConfig)
GridExporter<T>	withPreSelectedFormat(Format preSelectedFormat)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

grid

protected final com.vaadin.flow.component.grid.Grid<T> grid

localizationConfig

protected GridExportLocalizationConfig localizationConfig

columnFilter

protected Predicate<com.vaadin.flow.component.grid.Grid.Column<T>> columnFilter

columnConfigurationBuilder

protected ColumnConfigurationBuilder columnConfigurationBuilder

fileName

protected String fileName

availableFormats

protected List<Format> availableFormats

preSelectedFormat

protected Format preSelectedFormat

gridDataExtractorSupplier

protected Function<com.vaadin.flow.component.grid.Grid<T>,GridDataExtractor<T>> gridDataExtractorSupplier

Constructor Details

GridExporter

public GridExporter(com.vaadin.flow.component.grid.Grid<T> grid)

Method Details

loadFromProvider

public GridExporter<T> loadFromProvider(GridExporterProvider provider)

withLocalizationConfig

public GridExporter<T> withLocalizationConfig(GridExportLocalizationConfig localizationConfig)

withColumnFilter

public GridExporter<T> withColumnFilter(Predicate<com.vaadin.flow.component.grid.Grid.Column<T>> columnFilter)

withColumnConfigurationBuilder

public GridExporter<T> withColumnConfigurationBuilder(ColumnConfigurationBuilder columnConfigurationBuilder)

withFileName

public GridExporter<T> withFileName(String fileName)

withAvailableFormats

public GridExporter<T> withAvailableFormats(Format... availableFormats)

withAvailableFormats

public GridExporter<T> withAvailableFormats(List<Format> availableFormats)

addAvailableFormat

public GridExporter<T> addAvailableFormat(Format availableFormat)

withPreSelectedFormat

public GridExporter<T> withPreSelectedFormat(Format preSelectedFormat)

withGridDataExtractorSupplier

public GridExporter<T> withGridDataExtractorSupplier(Function<com.vaadin.flow.component.grid.Grid<T>,GridDataExtractor<T>> dataExtractorSupplier)

generateAvailableColumns

protected List<ColumnConfiguration<T>> generateAvailableColumns()

open

public void open()

Opens the GridExporterWizard.

newWithDefaults

public static <T> GridExporter<T> newWithDefaults(com.vaadin.flow.component.grid.Grid<T> grid)

Creates a new GridExporter with the default JasperReports exports.

Note: This may be removed or split into a separate module in the future.