Package io.jmix.pivottable.component.impl

Class PivotTableExtensionImpl

java.lang.Object

io.jmix.pivottable.component.impl.PivotTableExtensionImpl

All Implemented Interfaces:

PivotTableExtension

public class PivotTableExtensionImpl
extends Object
implements PivotTableExtension

Field Summary

Fields

Modifier and Type	Field	Description
protected PivotExcelExporter	excelExporter
protected String	fileName
protected PivotTable	pivotTable
protected JmixPivotTableExtension	pivotTableExtension
static final Set<Renderer>	supportedRenderers

Constructor Summary

Constructors

Constructor	Description
PivotTableExtensionImpl(PivotTable pivotTable, PivotExcelExporter exporter)

Method Summary

Modifier and Type	Method	Description
protected void	checkRenderer(Renderer renderer)
protected void	checkSupportedRenderer()
void	exportTableToXls()	Exports PivotTable to Xls file.
void	exportTableToXls(Downloader downloader)	Exports PivotTable to Xls file.
String	getDateParseFormat()
String	getDateTimeParseFormat()
PivotExcelExporter.ExportFormat	getExportFormat()
String	getFileName()
PivotData	getPivotData()
String	getPivotDataJSON()
String	getTimeParseFormat()
boolean	isRendererSupported(Renderer renderer)	Checks whether renderer is supported by the exporter.
void	setDateParseFormat(String dateParseFormat)	Sets date format that will be used to finding dateTime value and exporting it to excel with date type.
void	setDateTimeParseFormat(String dateTimeParseFormat)	Sets dateTime format that will be used to finding dateTime value and exporting it to excel with dateTime type.
void	setExportFormat(PivotExcelExporter.ExportFormat exportFormat)	Sets export format XLS or XLSX.
void	setFileName(String fileName)	Sets the file name.
void	setTimeParseFormat(String timeParseFormat)	Sets date format that will be used to finding dateTime value and exporting it to excel with date type.
protected void	setupParseFormats()

Methods inherited from class java.lang.Object

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

Field Details

supportedRenderers

public static final Set<Renderer> supportedRenderers

pivotTableExtension

protected JmixPivotTableExtension pivotTableExtension

fileName

protected String fileName

excelExporter

protected PivotExcelExporter excelExporter

pivotTable

protected PivotTable pivotTable

Constructor Details

PivotTableExtensionImpl

public PivotTableExtensionImpl(PivotTable pivotTable,
 PivotExcelExporter exporter)

Method Details

exportTableToXls

public void exportTableToXls()

Description copied from interface: PivotTableExtension

Exports PivotTable to Xls file.

Specified by:

exportTableToXls in interface PivotTableExtension

exportTableToXls

public void exportTableToXls(Downloader downloader)

Description copied from interface: PivotTableExtension

Exports PivotTable to Xls file.

Specified by:

exportTableToXls in interface PivotTableExtension

Parameters:

downloader - downloader to save file

setFileName

public void setFileName(String fileName)

Description copied from interface: PivotTableExtension

Sets the file name.

Specified by:

setFileName in interface PivotTableExtension

Parameters:

fileName - file name

getFileName

public String getFileName()

Specified by:

getFileName in interface PivotTableExtension

Returns:

file name

getPivotDataJSON

public String getPivotDataJSON()

Specified by:

getPivotDataJSON in interface PivotTableExtension

Returns:

JSON string which represents PivotTable with aggregated data

getPivotData

public PivotData getPivotData()

Specified by:

getPivotData in interface PivotTableExtension

Returns:

serialized object from JSON which represents PivotTable with aggregated data

getDateTimeParseFormat

public String getDateTimeParseFormat()

Specified by:

getDateTimeParseFormat in interface PivotTableExtension

Returns:

dateTime format or null

setDateTimeParseFormat

public void setDateTimeParseFormat(String dateTimeParseFormat)

Description copied from interface: PivotTableExtension

Sets dateTime format that will be used to finding dateTime value and exporting it to excel with dateTime type.

Specified by:

setDateTimeParseFormat in interface PivotTableExtension

Parameters:

dateTimeParseFormat - dateTime format (e.g. dd/MM/yyyy HH:mm)

getDateParseFormat

public String getDateParseFormat()

Specified by:

getDateParseFormat in interface PivotTableExtension

Returns:

date format or null

setDateParseFormat

public void setDateParseFormat(String dateParseFormat)

Description copied from interface: PivotTableExtension

Sets date format that will be used to finding dateTime value and exporting it to excel with date type. If there is no format set, date properties will be recognized as text value.

Specified by:

setDateParseFormat in interface PivotTableExtension

Parameters:

dateParseFormat - date format (e.g. dd/MM/yyyy)

getTimeParseFormat

public String getTimeParseFormat()

Specified by:

getTimeParseFormat in interface PivotTableExtension

Returns:

time format or null

setTimeParseFormat

public void setTimeParseFormat(String timeParseFormat)

Description copied from interface: PivotTableExtension

Sets date format that will be used to finding dateTime value and exporting it to excel with date type. If there is no format set, time properties will be recognized as text value.

Specified by:

setTimeParseFormat in interface PivotTableExtension

Parameters:

timeParseFormat - time format (e.g. HH:mm)

isRendererSupported

public boolean isRendererSupported(Renderer renderer)

Description copied from interface: PivotTableExtension

Checks whether renderer is supported by the exporter.

Specified by:

isRendererSupported in interface PivotTableExtension

Parameters:

renderer - renderer to check

Returns:

true if renderer is supported by the exporter

getExportFormat

public PivotExcelExporter.ExportFormat getExportFormat()

Specified by:

getExportFormat in interface PivotTableExtension

Returns:

export format XLS or XLSX

setExportFormat

public void setExportFormat(PivotExcelExporter.ExportFormat exportFormat)

Description copied from interface: PivotTableExtension

Sets export format XLS or XLSX. The default value is XLSX.

Specified by:

setExportFormat in interface PivotTableExtension

Parameters:

exportFormat - format that should have exported file

setupParseFormats

protected void setupParseFormats()

checkSupportedRenderer

protected void checkSupportedRenderer()

checkRenderer

protected void checkRenderer(Renderer renderer)