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 and Description
static class	TableExporter.ColumnValueContext Describes a context for a column value provider.

Method Summary

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

Method Detail

exportTable

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

download table content via downloader

exportDataGrid

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

download dataGrid content via downloader

getCaption

java.lang.String getCaption()

returns exporter caption

addColumnValueProvider

void addColumnValueProvider(java.lang.String columnId,
                            java.util.function.Function<TableExporter.ColumnValueContext,java.lang.Object> columnValueProvider)

Adds a function to get value from the column.

Parameters:

columnId - column id

columnValueProvider - column value provider function

removeColumnValueProvider

void removeColumnValueProvider(java.lang.String columnId)

Removes an column value provider function by column id.

Parameters:

columnId - column id

getColumnValueProvider

@Nullable
java.util.function.Function<TableExporter.ColumnValueContext,java.lang.Object> getColumnValueProvider(java.lang.String columnId)

Parameters:

columnId - column id

Returns:

column value provider function for the column id