io.jmix.uiexport.exporter.excel

Class ExcelExporter

java.lang.Object

io.jmix.uiexport.exporter.AbstractTableExporter<ExcelExporter>

io.jmix.uiexport.exporter.excel.ExcelExporter

All Implemented Interfaces:

TableExporter

@Component(value="ui_ExcelExporter")
 @Scope(value="prototype")
public class ExcelExporter
extends AbstractTableExporter<ExcelExporter>

Use this class to export Table into Excel format
Just create an instance of ExportAction with withExporter method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExcelExporter.ExportFormat

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.poi.ss.usermodel.Font	boldFont
protected static int	COL_WIDTH_MAGIC
protected org.apache.poi.ss.usermodel.CellStyle	dateFormatCellStyle
protected org.apache.poi.ss.usermodel.CellStyle	dateTimeFormatCellStyle
protected org.apache.poi.ss.usermodel.CellStyle	doubleFormatCellStyle
protected boolean	exportAggregation
protected java.lang.Boolean	exportExpanded
protected ExcelExporter.ExportFormat	exportFormat
protected org.apache.poi.ss.usermodel.CellStyle	integerFormatCellStyle
protected boolean	isRowNumberExceeded
static int	MAX_ROW_COUNT
protected org.apache.poi.ss.usermodel.Sheet	sheet
protected ExcelAutoColumnSizer[]	sizers
protected org.apache.poi.ss.usermodel.Font	stdFont
protected org.apache.poi.ss.usermodel.CellStyle	timeFormatCellStyle
protected org.apache.poi.ss.usermodel.Workbook	wb

Fields inherited from class io.jmix.uiexport.exporter.AbstractTableExporter

coreProperties, datatypeRegistry, fileName, formatters, messages, messageTools, metadataTools, uiProperties

Constructor Summary

Constructors

Constructor and Description
ExcelExporter()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkIsRowNumberExceed(int r)
protected int	createAggregatableRow(Table<java.lang.Object> table, java.util.List<Table.Column<java.lang.Object>> columns, int rowNumber, int aggregatableRow)
protected void	createAutoColumnSizers(int count)
protected int	createDataGridHierarchicalRow(TreeDataGrid dataGrid, TreeDataGridItems<java.lang.Object> treeDataGridItems, java.util.List<DataGrid.Column<java.lang.Object>> columns, int startColumn, int rowNumber, java.lang.Object item)
protected void	createDataGridRow(DataGrid dataGrid, java.util.List<DataGrid.Column<java.lang.Object>> columns, int startColumn, int rowNumber, java.lang.Object itemId)
protected void	createFonts()
protected void	createFormats()
protected int	createGroupRow(GroupTable<java.lang.Object> table, java.util.List<Table.Column<java.lang.Object>> columns, int rowNumber, GroupInfo<?> groupInfo, int groupNumber)
protected int	createHierarchicalRow(TreeTable<java.lang.Object> table, java.util.List<Table.Column<java.lang.Object>> columns, java.lang.Boolean exportExpanded, int rowNumber, java.lang.Object itemId)
protected java.util.function.Function<java.lang.Object,InstanceContainer<java.lang.Object>>	createInstanceContainerProvider(DataGrid dataGrid, java.lang.Object item)
protected void	createRow(Table<java.lang.Object> table, java.util.List<Table.Column<java.lang.Object>> columns, int startColumn, int rowNumber, java.lang.Object itemId)
protected java.lang.String	createSpaceString(int level)
protected void	createWorkbookWithSheet()
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
protected void	formatValueCell(org.apache.poi.ss.usermodel.Cell cell, java.lang.Object cellValue, io.jmix.core.metamodel.model.MetaPropertyPath metaPropertyPath, int sizersIndex, int notificationRequired, int level, java.lang.Integer groupChildCount)
java.lang.String	getCaption() returns exporter caption
boolean	getExportAggregation()
java.lang.Boolean	getExportExpanded()
protected boolean	hasAggregatableColumn(Table<java.lang.Object> table) Checks that at least one column in table is aggregatable.
protected boolean	isXlsMaxRowNumberExceeded()
void	setExportAggregation(boolean exportAggregation) Export table with aggregation
void	setExportExpanded(java.lang.Boolean exportExpanded) Export tree table with expanded rows
ExcelExporter	withExportAggregation(java.lang.Boolean exportAggregation) Export table with aggregation
ExcelExporter	withExportExpanded(java.lang.Boolean exportExpanded) Export tree table with expanded rows

Methods inherited from class io.jmix.uiexport.exporter.AbstractTableExporter

formatValue, getColumnValue, getColumnValue, getFileName, getFileName, getFileName, getFormatters, getMetaClassName, setFileName, setFormatters, withFileName, withFormatters

Methods inherited from class java.lang.Object

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

Field Detail

COL_WIDTH_MAGIC

protected static final int COL_WIDTH_MAGIC

See Also:

Constant Field Values

MAX_ROW_COUNT

public static final int MAX_ROW_COUNT

See Also:

Constant Field Values

wb

protected org.apache.poi.ss.usermodel.Workbook wb

boldFont

protected org.apache.poi.ss.usermodel.Font boldFont

stdFont

protected org.apache.poi.ss.usermodel.Font stdFont

sheet

protected org.apache.poi.ss.usermodel.Sheet sheet

timeFormatCellStyle

protected org.apache.poi.ss.usermodel.CellStyle timeFormatCellStyle

dateFormatCellStyle

protected org.apache.poi.ss.usermodel.CellStyle dateFormatCellStyle

dateTimeFormatCellStyle

protected org.apache.poi.ss.usermodel.CellStyle dateTimeFormatCellStyle

integerFormatCellStyle

protected org.apache.poi.ss.usermodel.CellStyle integerFormatCellStyle

doubleFormatCellStyle

protected org.apache.poi.ss.usermodel.CellStyle doubleFormatCellStyle

sizers

protected ExcelAutoColumnSizer[] sizers

exportAggregation

protected boolean exportAggregation

exportExpanded

protected java.lang.Boolean exportExpanded

exportFormat

protected ExcelExporter.ExportFormat exportFormat

isRowNumberExceeded

protected boolean isRowNumberExceeded

Constructor Detail

ExcelExporter

public ExcelExporter()

Method Detail

createWorkbookWithSheet

protected void createWorkbookWithSheet()

createFonts

protected void createFonts()

createAutoColumnSizers

protected void createAutoColumnSizers(int count)

exportTable

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

Description copied from interface: TableExporter

download table content via downloader

exportDataGrid

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

Description copied from interface: TableExporter

download dataGrid content via downloader

createDataGridHierarchicalRow

protected int createDataGridHierarchicalRow(TreeDataGrid dataGrid,
                                            TreeDataGridItems<java.lang.Object> treeDataGridItems,
                                            java.util.List<DataGrid.Column<java.lang.Object>> columns,
                                            int startColumn,
                                            int rowNumber,
                                            java.lang.Object item)

createDataGridRow

protected void createDataGridRow(DataGrid dataGrid,
                                 java.util.List<DataGrid.Column<java.lang.Object>> columns,
                                 int startColumn,
                                 int rowNumber,
                                 java.lang.Object itemId)

createInstanceContainerProvider

protected java.util.function.Function<java.lang.Object,InstanceContainer<java.lang.Object>> createInstanceContainerProvider(DataGrid dataGrid,
                                                                                                                            java.lang.Object item)

Overrides:

createInstanceContainerProvider in class AbstractTableExporter<ExcelExporter>

createFormats

protected void createFormats()

createHierarchicalRow

protected int createHierarchicalRow(TreeTable<java.lang.Object> table,
                                    java.util.List<Table.Column<java.lang.Object>> columns,
                                    java.lang.Boolean exportExpanded,
                                    int rowNumber,
                                    java.lang.Object itemId)

createAggregatableRow

protected int createAggregatableRow(Table<java.lang.Object> table,
                                    java.util.List<Table.Column<java.lang.Object>> columns,
                                    int rowNumber,
                                    int aggregatableRow)

createGroupRow

protected int createGroupRow(GroupTable<java.lang.Object> table,
                             java.util.List<Table.Column<java.lang.Object>> columns,
                             int rowNumber,
                             GroupInfo<?> groupInfo,
                             int groupNumber)

createRow

protected void createRow(Table<java.lang.Object> table,
                         java.util.List<Table.Column<java.lang.Object>> columns,
                         int startColumn,
                         int rowNumber,
                         java.lang.Object itemId)

createSpaceString

protected java.lang.String createSpaceString(int level)

formatValueCell

protected void formatValueCell(org.apache.poi.ss.usermodel.Cell cell,
                               @Nullable
                               java.lang.Object cellValue,
                               @Nullable
                               io.jmix.core.metamodel.model.MetaPropertyPath metaPropertyPath,
                               int sizersIndex,
                               int notificationRequired,
                               int level,
                               @Nullable
                               java.lang.Integer groupChildCount)

checkIsRowNumberExceed

protected boolean checkIsRowNumberExceed(int r)

isXlsMaxRowNumberExceeded

protected boolean isXlsMaxRowNumberExceeded()

Returns:

true if exported table contains more than 65536 records

setExportAggregation

public void setExportAggregation(boolean exportAggregation)

Export table with aggregation

Parameters:

exportAggregation - set to true to export table with aggregation

getExportAggregation

public boolean getExportAggregation()

Returns:

export aggregation

withExportAggregation

public ExcelExporter withExportAggregation(java.lang.Boolean exportAggregation)

Export table with aggregation

Parameters:

exportAggregation - set to true to export table with aggregation

Returns:

exporter instance

hasAggregatableColumn

protected boolean hasAggregatableColumn(Table<java.lang.Object> table)

Checks that at least one column in table is aggregatable.

Parameters:

table - table

Returns:

true if at least one column is aggregatable

getExportExpanded

public java.lang.Boolean getExportExpanded()

Returns:

tree table export expanded

setExportExpanded

public void setExportExpanded(java.lang.Boolean exportExpanded)

Export tree table with expanded rows

Parameters:

exportExpanded - set to true to export collapsed items in expanded view

withExportExpanded

public ExcelExporter withExportExpanded(java.lang.Boolean exportExpanded)

Export tree table with expanded rows

Parameters:

exportExpanded - set to true to export collapsed items in expanded view

Returns:

exporter instance

getCaption

public java.lang.String getCaption()

Description copied from interface: TableExporter

returns exporter caption