Package io.jmix.gridexportui.exporter.excel

Class ExcelExporter

java.lang.Object

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

io.jmix.gridexportui.exporter.excel.ExcelExporter

All Implemented Interfaces:

TableExporter

@Component("grdexp_ExcelExporter")
@Scope("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/interfaces inherited from interface io.jmix.gridexportui.exporter.TableExporter

TableExporter.ColumnValueContext

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.poi.ss.usermodel.Font	boldFont
protected static final 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 Boolean	exportExpanded
protected GridExportProperties	gridExportProperties
protected org.apache.poi.ss.usermodel.CellStyle	integerFormatCellStyle
protected boolean	isRowNumberExceeded
static final 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.gridexportui.exporter.AbstractTableExporter

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

Constructor Summary

Constructors

Constructor	Description
ExcelExporter(GridExportProperties gridExportProperties, CurrentAuthentication currentAuthentication, AllEntitiesLoaderFactory allEntitiesLoaderFactory)

Method Summary

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

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

addColumnValueProvider, formatValue, formatValue, getColumnValue, getColumnValue, getColumnValueProvider, getFileName, getFileName, getFileName, getMetaClassName, removeColumnValueProvider, setFileName, withFileName

Methods inherited from class java.lang.Object

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

Field Details

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

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 Boolean exportExpanded

isRowNumberExceeded

protected boolean isRowNumberExceeded

gridExportProperties

protected GridExportProperties gridExportProperties

Constructor Details

ExcelExporter

public ExcelExporter(GridExportProperties gridExportProperties,
 CurrentAuthentication currentAuthentication,
 AllEntitiesLoaderFactory allEntitiesLoaderFactory)

Method Details

createWorkbookWithSheet

protected void createWorkbookWithSheet()

createFonts

protected void createFonts()

createAutoColumnSizers

protected void createAutoColumnSizers(int count)

exportTable

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

Description copied from interface: TableExporter

download table content via downloader

exportDataGrid

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

Description copied from interface: TableExporter

download dataGrid content via downloader

createDataGridHierarchicalRow

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

createDataGridRow

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

createDataGridRowForEntityInstance

protected void createDataGridRowForEntityInstance(DataGrid dataGrid,
 List<DataGrid.Column<Object>> columns,
 int startColumn,
 int rowNumber,
 Object entityInstance,
 boolean addLevelPadding)

createInstanceContainerProvider

protected Function<Object,InstanceContainer<Object>> createInstanceContainerProvider(DataGrid dataGrid,
 Object item)

Overrides:

createInstanceContainerProvider in class AbstractTableExporter<ExcelExporter>

createFormats

protected void createFormats()

createHierarchicalRow

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

createAggregatableRow

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

createGroupRow

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

createRow

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

createRowForEntityInstance

protected void createRowForEntityInstance(Table<Object> table,
 List<Table.Column<Object>> columns,
 int startColumn,
 int rowNumber,
 Object entityInstance,
 boolean addLevelPadding)

createSpaceString

protected String createSpaceString(int level)

formatValueCell

protected void formatValueCell(org.apache.poi.ss.usermodel.Cell cell,
 @Nullable
 Object cellValue,
 @Nullable
 MetaPropertyPath metaPropertyPath,
 int sizersIndex,
 int notificationRequired,
 int level,
 @Nullable
 Integer groupChildCount)

checkIsRowNumberExceed

protected boolean checkIsRowNumberExceed(int r)

isXlsxMaxRowNumberExceeded

protected boolean isXlsxMaxRowNumberExceeded()

Returns:

true if exported table contains more than MAX_ROW_COUNT records

showWarnNotification

protected void showWarnNotification(Component.BelongToFrame belongToFrame)

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(Boolean exportAggregation)

Export table with aggregation

Parameters:

exportAggregation - set to true to export table with aggregation

Returns:

exporter instance

hasAggregatableColumn

protected boolean hasAggregatableColumn(Table<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 Boolean getExportExpanded()

Returns:

tree table export expanded

setExportExpanded

public void setExportExpanded(Boolean exportExpanded)

Export tree table with expanded rows

Parameters:

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

withExportExpanded

public ExcelExporter withExportExpanded(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 String getCaption()

Description copied from interface: TableExporter

returns exporter caption

disposeWorkBook

protected void disposeWorkBook()