Class GridExporter<T>
java.lang.Object
com.flowingcode.vaadin.addons.gridexporter.GridExporter<T>
- All Implemented Interfaces:
Serializable
- See Also:
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic <T> GridExporter<T>createFor(com.vaadin.flow.component.grid.Grid<T> grid) static <T> GridExporter<T>createFor(com.vaadin.flow.component.grid.Grid<T> grid, String excelCustomTemplate, String docxCustomTemplate) Get columns in the positions specified byGridExporter.setColumnPositionCharset to use when exporting the CSV file.com.vaadin.flow.server.StreamResourcecom.vaadin.flow.server.StreamResourcecom.vaadin.flow.server.StreamResourcegetDocxStreamResource(String template) com.vaadin.flow.server.StreamResourcecom.vaadin.flow.server.StreamResourcegetExcelStreamResource(String template) com.vaadin.flow.server.StreamResourcecom.vaadin.flow.server.StreamResourcegetPdfStreamResource(String template) intgetTitle()booleanbooleanbooleanbooleanbooleanbooleanbooleanvoidsetAdditionalPlaceHolders(Map<String, String> additionalPlaceHolders) Sets a map that will contain additional place holders that will be replaced with values when processing the exported filevoidsetAutoAttachExportButtons(boolean autoAttachExportButtons) If true, it will automatically generate export buttons in the asociated gridvoidsetAutoMergeTitle(boolean autoMergeTitle) If true the title cell will be merged with the next ones to create a single title cell that will span across the columnsvoidsetAutoSizeColumns(boolean autoSizeColumns) voidsetButtonsAlignment(ButtonsAlignment buttonsAlignment) voidsetColumnPosition(com.vaadin.flow.component.grid.Grid.Column<T> column, int position) Assigns the position of the column in the exported file.voidsetColumns(List<com.vaadin.flow.component.grid.Grid.Column<T>> columns) voidsetCsvCharset(com.vaadin.flow.function.SerializableSupplier<Charset> charset) voidsetCsvExportEnabled(boolean csvExportEnabled) voidsetCustomFooter(com.vaadin.flow.component.grid.Grid.Column<T> column, String header) Configures the exporter to use a custom string for a specific column's footer.voidsetCustomHeader(com.vaadin.flow.component.grid.Grid.Column<T> column, String header) Configures the exporter to use a custom string for a specific column's header.voidsetDateColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, String excelFormat) If the column is based on a LocalDate attribute of the item, rendered with a LocalDateRenderer, it configures the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a date that can be used in formulas.voidsetDateColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, DateFormat dateFormat, String excelFormat) If the column is based on a String, it configures a DateFormat to parse a date from the value of the column so it can be converted to a java.util.Date, and then allows to specify the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a date that can be used in formulas.voidsetDateColumnFormatProvider(com.vaadin.flow.component.grid.Grid.Column<T> column, DateFormat dateFormat, com.vaadin.flow.function.ValueProvider<T, String> excelFormatProvider) If the column is based on a String, it configures a DateFormat to parse a date from the value of the column so it can be converted to a java.util.Date, and then allows to specify the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a date that can be used in formulas.voidsetDocxExportEnabled(boolean docxExportEnabled) voidsetExcelExportEnabled(boolean excelExportEnabled) voidsetExportColumn(com.vaadin.flow.component.grid.Grid.Column<T> column, boolean export) Configure if the column is exported or notvoidsetExportValue(com.vaadin.flow.component.grid.Grid.Column<T> column, com.vaadin.flow.function.ValueProvider<T, ?> vp) Configure a value provider for a given column.voidsetFileName(String fileName) Sets the filename of the exported filevoidsetFooterToolbarItems(List<FooterToolbarItem> footerToolbarItems) voidsetNullValueHandler(com.vaadin.flow.function.SerializableSupplier<String> nullValueSupplier) voidsetNumberColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, String excelFormat) If the column is based on a number attribute of the item, rendered with a NumberRenderer, it configures the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a number that can be used in formulas.voidsetNumberColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, DecimalFormat decimalFormat, String excelFormat) If the column is based on a String, it configures a DecimalFormat to parse a number from the value of the column so it can be converted to a Double, and then allows to specify the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a number that can be used in formulas.voidsetNumberColumnFormatProvider(com.vaadin.flow.component.grid.Grid.Column<T> column, DecimalFormat decimalFormat, com.vaadin.flow.function.ValueProvider<T, String> excelFormatProvider) If the column is based on a String, it configures a DecimalFormat to parse a number from the value of the column so it can be converted to a Double, and then allows to specify the excel format to be applied to the cell when exported to excel with a provider, so the resulting cell is not a string but a number that can be used in formulas.voidsetPdfExportEnabled(boolean pdfExportEnabled) voidsetSheetNumber(int sheetNumber) Configures the excel sheet that will be inspected for placeholders to export the datavoidSets the title of the exported file
-
Field Details
-
totalcells
public int totalcells
-
-
Method Details
-
createFor
-
createFor
public static <T> GridExporter<T> createFor(com.vaadin.flow.component.grid.Grid<T> grid, String excelCustomTemplate, String docxCustomTemplate) -
setButtonsAlignment
-
getDocxStreamResource
public com.vaadin.flow.server.StreamResource getDocxStreamResource() -
getDocxStreamResource
-
getPdfStreamResource
public com.vaadin.flow.server.StreamResource getPdfStreamResource() -
getPdfStreamResource
-
getCsvStreamResource
public com.vaadin.flow.server.StreamResource getCsvStreamResource() -
getExcelStreamResource
public com.vaadin.flow.server.StreamResource getExcelStreamResource() -
getExcelStreamResource
-
getTitle
-
setTitle
Sets the title of the exported file- Parameters:
title-
-
getFileName
-
setFileName
Sets the filename of the exported file- Parameters:
fileName-
-
isAutoAttachExportButtons
public boolean isAutoAttachExportButtons() -
setAutoAttachExportButtons
public void setAutoAttachExportButtons(boolean autoAttachExportButtons) If true, it will automatically generate export buttons in the asociated grid- Parameters:
autoAttachExportButtons-
-
getAdditionalPlaceHolders
-
setAdditionalPlaceHolders
Sets a map that will contain additional place holders that will be replaced with values when processing the exported file- Parameters:
additionalPlaceHolders-
-
getSheetNumber
public int getSheetNumber() -
setSheetNumber
public void setSheetNumber(int sheetNumber) Configures the excel sheet that will be inspected for placeholders to export the data- Parameters:
sheetNumber-
-
isAutoMergeTitle
public boolean isAutoMergeTitle() -
setAutoMergeTitle
public void setAutoMergeTitle(boolean autoMergeTitle) If true the title cell will be merged with the next ones to create a single title cell that will span across the columns- Parameters:
autoMergeTitle-
-
isExcelExportEnabled
public boolean isExcelExportEnabled() -
setExcelExportEnabled
public void setExcelExportEnabled(boolean excelExportEnabled) -
isDocxExportEnabled
public boolean isDocxExportEnabled() -
setDocxExportEnabled
public void setDocxExportEnabled(boolean docxExportEnabled) -
isPdfExportEnabled
public boolean isPdfExportEnabled() -
setPdfExportEnabled
public void setPdfExportEnabled(boolean pdfExportEnabled) -
isCsvExportEnabled
public boolean isCsvExportEnabled() -
setCsvExportEnabled
public void setCsvExportEnabled(boolean csvExportEnabled) -
isAutoSizeColumns
public boolean isAutoSizeColumns() -
setAutoSizeColumns
public void setAutoSizeColumns(boolean autoSizeColumns) -
setExportValue
public void setExportValue(com.vaadin.flow.component.grid.Grid.Column<T> column, com.vaadin.flow.function.ValueProvider<T, ?> vp) Configure a value provider for a given column. If there is a value provider, that will be taken into account when exporting the column- Parameters:
column-vp-
-
setExportColumn
Configure if the column is exported or not- Parameters:
column-export- : true will be included in the exported file, false will not be included
-
setNullValueHandler
public void setNullValueHandler(com.vaadin.flow.function.SerializableSupplier<String> nullValueSupplier) -
setNumberColumnFormat
public void setNumberColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, DecimalFormat decimalFormat, String excelFormat) If the column is based on a String, it configures a DecimalFormat to parse a number from the value of the column so it can be converted to a Double, and then allows to specify the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a number that can be used in formulas.- Parameters:
column-decimalFormat-excelFormat-
-
setNumberColumnFormatProvider
public void setNumberColumnFormatProvider(com.vaadin.flow.component.grid.Grid.Column<T> column, DecimalFormat decimalFormat, com.vaadin.flow.function.ValueProvider<T, String> excelFormatProvider) If the column is based on a String, it configures a DecimalFormat to parse a number from the value of the column so it can be converted to a Double, and then allows to specify the excel format to be applied to the cell when exported to excel with a provider, so the resulting cell is not a string but a number that can be used in formulas.- Parameters:
column-decimalFormat-excelFormatProvider-
-
setDateColumnFormat
public void setDateColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, DateFormat dateFormat, String excelFormat) If the column is based on a String, it configures a DateFormat to parse a date from the value of the column so it can be converted to a java.util.Date, and then allows to specify the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a date that can be used in formulas.- Parameters:
column-dateFormat-excelFormat-
-
setDateColumnFormatProvider
public void setDateColumnFormatProvider(com.vaadin.flow.component.grid.Grid.Column<T> column, DateFormat dateFormat, com.vaadin.flow.function.ValueProvider<T, String> excelFormatProvider) If the column is based on a String, it configures a DateFormat to parse a date from the value of the column so it can be converted to a java.util.Date, and then allows to specify the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a date that can be used in formulas.- Parameters:
column-dateFormat-excelFormat-
-
setNumberColumnFormat
public void setNumberColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, String excelFormat) If the column is based on a number attribute of the item, rendered with a NumberRenderer, it configures the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a number that can be used in formulas.- Parameters:
column-excelFormat-
-
setDateColumnFormat
public void setDateColumnFormat(com.vaadin.flow.component.grid.Grid.Column<T> column, String excelFormat) If the column is based on a LocalDate attribute of the item, rendered with a LocalDateRenderer, it configures the excel format to be applied to the cell when exported to excel, so the resulting cell is not a string but a date that can be used in formulas.- Parameters:
column-excelFormat-
-
setCustomHeader
Configures the exporter to use a custom string for a specific column's header. Usefull when the header is a custom component.- Parameters:
column-header-
-
setColumnPosition
Assigns the position of the column in the exported file.- Parameters:
column-position-
-
setColumns
-
getColumns
-
getColumnsOrdered
Get columns in the positions specified byGridExporter.setColumnPosition- Returns:
-
getCsvCharset
Charset to use when exporting the CSV file.- Returns:
- CSV file charset or default one.
-
setCsvCharset
-