Package io.jmix.uiexport.exporter

Interface TableExporter

All Known Implementing Classes:

AbstractTableExporter, ExcelExporter, JsonExporter

public interface TableExporter

Table exporter interface.
Just create an instance of ExportAction with withExporter method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TableExporter.ColumnValueContext	Describes a context for a column value provider.

Method Summary

Modifier and Type	Method	Description
void	addColumnValueProvider(String columnId, Function<TableExporter.ColumnValueContext,Object> columnValueProvider)	Adds a function to get value from the column.
void	exportDataGrid(Downloader downloader, DataGrid<Object> dataGrid, ExportMode exportMode)	download dataGrid content via downloader
void	exportTable(Downloader downloader, Table<Object> table, ExportMode exportMode)	download table content via downloader
String	getCaption()	returns exporter caption
Function<TableExporter.ColumnValueContext,Object>	getColumnValueProvider(String columnId)
void	removeColumnValueProvider(String columnId)	Removes an column value provider function by column id.

Method Details

exportTable

void exportTable(Downloader downloader,
 Table<Object> table,
 ExportMode exportMode)

download table content via downloader

exportDataGrid

void exportDataGrid(Downloader downloader,
 DataGrid<Object> dataGrid,
 ExportMode exportMode)

download dataGrid content via downloader

getCaption

String getCaption()

returns exporter caption

addColumnValueProvider

void addColumnValueProvider(String columnId,
 Function<TableExporter.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<TableExporter.ColumnValueContext,Object> getColumnValueProvider(String columnId)

Parameters:

columnId - column id

Returns:

column value provider function for the column id