Package io.jmix.gridexportflowui.exporter

Interface DataGridExporter

All Known Implementing Classes:

AbstractDataGridExporter, ExcelExporter, JsonExporter

public interface DataGridExporter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataGridExporter.ColumnValueContext

Method Summary

Modifier and Type	Method	Description
void	addColumnValueProvider(String columnId, Function<DataGridExporter.ColumnValueContext,Object> columnValueProvider)	Adds a function to get value from the column.
void	exportDataGrid(Downloader downloader, com.vaadin.flow.component.grid.Grid<Object> dataGrid, ExportMode exportMode)	download dataGrid content via downloader
Function<DataGridExporter.ColumnValueContext,Object>	getColumnValueProvider(String columnId)
String	getLabel()
void	removeColumnValueProvider(String columnId)	Removes an column value provider function by column id.
void	setFileName(String fileName)

Method Details

setFileName

void setFileName(String fileName)

exportDataGrid

void exportDataGrid(Downloader downloader,
 com.vaadin.flow.component.grid.Grid<Object> dataGrid,
 ExportMode exportMode)

download dataGrid content via downloader

getLabel

String getLabel()

Returns:

exporter label

addColumnValueProvider

void addColumnValueProvider(String columnId,
 Function<DataGridExporter.ColumnValueContext,Object> columnValueProvider)

Adds a function to get value from the column.

Parameters:

columnId - column id

columnValueProvider - column value provider function

removeColumnValueProvider

void removeColumnValueProvider(String columnId)

Removes an column value provider function by column id.

Parameters:

columnId - column id

getColumnValueProvider

@Nullable
Function<DataGridExporter.ColumnValueContext,Object> getColumnValueProvider(String columnId)

Parameters:

columnId - column id

Returns:

column value provider function for the column id