All Classes and Interfaces
Class
Description
The Enum AttachmentType.
The Class BaseSheet.
The Class BooleanDropDown.
The Enum BorderType.
BorderType is used to switch the border setting in the algorithm.
BorderType is used to switch the border setting in the algorithm.
The Class BoxMessage.
The Class CalendarDropDown.
The Class CharacterDropDown.
The Class CsvData.
The Class CsvHeader.
The Interface CsvQueryComponent.
The Interface CsvRow.
The Class DateDropDown.
The Class DoubleDropDown.
The Class DropDown.
The Class DropDownCell.
The Class DynamicChart.
The Interface DynamicColumn.
The Class DynamicRowSheet.
The Interface EnableExcelGenerator.
The Class EnableExcelGeneratorConfiguration.
The Class ExcelAnnotationImpl.
The Interface ExcelAreaBorder.
ExcelAreaBorder is used to set a border on an area of cells.
ExcelAreaBorder is composed by: AreaRange - to define an area of cells Border - to set the border type IncludeSuperHeader - to enable/disable the area extension on the super header
ExcelAreaBorder is used to set a border on an area of cells.
ExcelAreaBorder is composed by: AreaRange - to define an area of cells Border - to set the border type IncludeSuperHeader - to enable/disable the area extension on the super header
The Class ExcelAttachment.
ExcelAttachment is used to attachment files within file excel.
It is composed by: Attachment - to define the file AttachmentType - to set type file FileName - to define file name The "attachment" field can be a byte array or a string, the string type represent the file path.
It is used by
ExcelAttachment is used to attachment files within file excel.
It is composed by: Attachment - to define the file AttachmentType - to set type file FileName - to define file name The "attachment" field can be a byte array or a string, the string type represent the file path.
It is used by
RowSheet classes.The Interface ExcelBarChartData.
The Class ExcelBooleanTextImpl.
The Interface ExcelBorder.
The Class ExcelBorder.
This class is a property on
This class is a property on
LayoutCell class.The Class ExcelBorderImpl.
The Interface ExcelBoxMessage.
The Class ExcelBoxImpl.
The Interface ExcelCellLayout.
The Class ExcelCellLayoutImpl.
The Interface ExcelChart.
The Interface ExcelChartCategory.
The Class ExcelChartCategoryImpl.
The Interface ExcelChartDataLabel.
The Class ExcelChartDataLabelImpl.
The Class ExcelChartImpl.
The Interface ExcelCharts.
The Class ExcelColor.
This class is used as a property on
This class is used as a property on
LayoutCell class.The Interface ExcelColumn.
The Class ExcelColumnImpl.
The Interface ExcelColumnWidth.
The Class ExcelColumnWidthImpl.
The Class ExcelConstant.
The Class ExcelDateImpl.
The Interface ExcelDropDown.
Excel Drop Down is used to create a drop down list that references another table within the Excel file.
Excel Drop Down is used to create a drop down list that references another table within the Excel file.
The Class ExcelDropDownImpl.
The Interface ExcelFont.
ExcelFont defines the following properties: Font - to set font type Bold - to enable/disable bold Italic - to enable/disable italic Underline - to set underline type Size - to set font size
It is a property of the following annotations:
ExcelFont defines the following properties: Font - to set font type Bold - to enable/disable bold Italic - to enable/disable italic Underline - to set underline type Size - to set font size
It is a property of the following annotations:
ExcelCellLayout
ExcelHeaderCellLayout
The Class ExcelFont.
This class is used as a property on LayoutCell class.
This class is used as a property on LayoutCell class.
The Class ExcelFontImpl.
The Interface ExcelFormulaAlias.
The Class ExcelFormulaAliasImpl.
The Interface ExcelFreezePane.
ExcelFreezePane is used to freeze rows and columns.
It is set on SheetData classes and it is composed from: ColumnFreez - to lock the number of columns RowFreez - to lock the number of rows
ExcelFreezePane is used to freeze rows and columns.
It is set on SheetData classes and it is composed from: ColumnFreez - to lock the number of columns RowFreez - to lock the number of rows
The Interface ExcelFunction.
ExcelFunction is used to define the excel functions through: Function - to set function NameFunction - function identifier AnotherTable - it is enabled if the function is referred to another table Here are a series of examples: How to sum the records on a column? - You must concatenate column name with RowStart and RowEnd, example sum(${fieldNameRowStart}:${fieldNameRowEnd}), in the same way on a merged cell you can obtain the sum of a group of rows.
The names of the two fields must be the same How to sum the records on a row? - Here You will use 2 different fields names and the function will be written as follows: sum(${fieldName1}:${fiedlName2}), indexes should not be written ExcelFunction is a property of the following annotations:
ExcelFunction is used to define the excel functions through: Function - to set function NameFunction - function identifier AnotherTable - it is enabled if the function is referred to another table Here are a series of examples: How to sum the records on a column? - You must concatenate column name with RowStart and RowEnd, example sum(${fieldNameRowStart}:${fieldNameRowEnd}), in the same way on a merged cell you can obtain the sum of a group of rows.
The names of the two fields must be the same How to sum the records on a row? - Here You will use 2 different fields names and the function will be written as follows: sum(${fieldName1}:${fiedlName2}), indexes should not be written ExcelFunction is a property of the following annotations:
ExcelFunctionMergeRow
ExcelFunctionRow
Below an example to calculate functions on rows and columns.The Class ExcelFunctionImpl.
The Interface ExcelFunctionMergeRow.
ExcelFunctionMergeRow is used to configure the cell layout merged and define the excel function.
It is composed from: ExcelCellsLayout - to define cell layout ExcelColumn - to define the header description and the position of column ExcelMergeRow - it is used to merge cells after checking the equality the reference field values ExcelFunction - to define the function ExcelColumnWidth - to set column widthinvalid input: '<'7li> ExcelHeaderCellLayout - to define header cell layout ExcelSubtotal - to execute subtotal function ExcelFunctionMergeRow is parameter of the annotation
ExcelFunctionMergeRow is used to configure the cell layout merged and define the excel function.
It is composed from: ExcelCellsLayout - to define cell layout ExcelColumn - to define the header description and the position of column ExcelMergeRow - it is used to merge cells after checking the equality the reference field values ExcelFunction - to define the function ExcelColumnWidth - to set column widthinvalid input: '<'7li> ExcelHeaderCellLayout - to define header cell layout ExcelSubtotal - to execute subtotal function ExcelFunctionMergeRow is parameter of the annotation
ExcelFunctionRows.The Class ExcelFunctionMergeRowImpl.
The Interface ExcelFunctionRow.
The Class ExcelFunctionRowImpl.
The Interface ExcelFunctionRows.
ExcelFunctionRows is used to manage 2 lists: excelFunctions excelFunctionMerges It must be managed on
ExcelFunctionRows is used to manage 2 lists: excelFunctions excelFunctionMerges It must be managed on
RowSheet classes.The Class ExcelFunctionRowsImpl.
The Interface ExcelHeaderCellLayout.
The Class ExcelHeaderCellLayoutImpl.
The Interface ExcelHeaderLayout.
ExcelHeaderLayout is used to configure the header of the table.
It is composed by: RowHeight - to set row height ExcelHeaderCellLayout - to set the header cell style It must be to managed in
ExcelHeaderLayout is used to configure the header of the table.
It is composed by: RowHeight - to set row height ExcelHeaderCellLayout - to set the header cell style It must be to managed in
SheetData classes.The Class ExcelHeaderLayoutImpl.
The Class ExcelHyperlink.
The Interface ExcelImage.
The ExcelImage is used to add image into cell, and it need to set the following properties.
PictureType - to define the picture type AnchorType - to define to anchor type ResizeHeight - to define the resize in height resize(1.0,1.0) - it keeps the original size. resize(0.5,0.5) it resizes to 50% of the original. resize(2.0,2.0) it resizes to 200% of the original. ResizeWidth - to define the resize in width resize(1.0,1.0) - it keeps the original size. resize(0.5,0.5) it resizes to 50% of the original. resize(2.0,2.0) it resizes to 200% of the original.
The ExcelImage is used to add image into cell, and it need to set the following properties.
PictureType - to define the picture type AnchorType - to define to anchor type ResizeHeight - to define the resize in height resize(1.0,1.0) - it keeps the original size. resize(0.5,0.5) it resizes to 50% of the original. resize(2.0,2.0) it resizes to 200% of the original. ResizeWidth - to define the resize in width resize(1.0,1.0) - it keeps the original size. resize(0.5,0.5) it resizes to 50% of the original. resize(2.0,2.0) it resizes to 200% of the original.
The Interface ExcelLabel.
ExcelLabel writes a label on the sheet and it must be added in the field within the
It is composed by: ExcelCellsLayout - to define cell layout ColumnMerge - to set the number of merged cells
ExcelLabel writes a label on the sheet and it must be added in the field within the
SheetData classes.It is composed by: ExcelCellsLayout - to define cell layout ColumnMerge - to set the number of merged cells
The Interface ExcelLocked.
ExcelLocked is used to protect sheet with password, to insert password use the "value" parameter.
The "locked" parameter is used to enable/disable the protection sheet.
ExcelLocked is used to protect sheet with password, to insert password use the "value" parameter.
The "locked" parameter is used to enable/disable the protection sheet.
The Interface ExcelMarginSheet.
ExcelMarginSheet is used to set the margin for all the cells of the sheet.
Top Bottom Left Right
ExcelMarginSheet is used to set the margin for all the cells of the sheet.
Top Bottom Left Right
The Interface ExcelMergeRow.
ExcelMergeRow works as follows:
It is used to merge cells after checking the equality the reference field values.
ReferenceField is empty only to the field identifier of the table and it must be in the first column.
ExcelMergeRow works only if the property "notMerge" in
ExcelMergeRow is an annotation of the fields within
ExcelMergeRow works as follows:
It is used to merge cells after checking the equality the reference field values.
ReferenceField is empty only to the field identifier of the table and it must be in the first column.
ExcelMergeRow works only if the property "notMerge" in
ExcelSheetLayout is disabled.ExcelMergeRow is an annotation of the fields within
RowSheet classes.The Class ExcelMergeRowImpl.
The Interface ExcelPivot.
ExcelPivot is used to create a pivot table, you can define the starting column through the property "startColumn".
This annotation is added within ${link bld.generator.report.excel.SheetData} classes.
ExcelPivot is used to create a pivot table, you can define the starting column through the property "startColumn".
This annotation is added within ${link bld.generator.report.excel.SheetData} classes.
The Interface ExcelPivotColumn.
ExcelPivotColumn is used to add the columns in the pivot table.
This annotation is added on fields of the ${link bld.generator.report.excel.RowSheet} classes.
You can set the order of the columns through the property "order".
ExcelPivotColumn is used to add the columns in the pivot table.
This annotation is added on fields of the ${link bld.generator.report.excel.RowSheet} classes.
You can set the order of the columns through the property "order".
The Interface ExcelPivotColumnFunction.
ExcelPivotColumnFunction is used to add a column with specific function within pivot table.
ExcelPivotColumnFunction is composed of the following properties: Order - to order the write of the column DataConsolidateFunction - to define the function This annotation is added on fields of the ${link bld.generator.report.excel.RowSheet} classes.
ExcelPivotColumnFunction is used to add a column with specific function within pivot table.
ExcelPivotColumnFunction is composed of the following properties: Order - to order the write of the column DataConsolidateFunction - to define the function This annotation is added on fields of the ${link bld.generator.report.excel.RowSheet} classes.
The Interface ExcelPivotFilter.
The Interface ExcelPivotRow.
ExcelPivotRow is used to add the rows in the pivot table.
This annotation is added on fields of the ${link bld.generator.report.excel.RowSheet} classes.
You can set the order of the rows through the property "order".
ExcelPivotRow is used to add the rows in the pivot table.
This annotation is added on fields of the ${link bld.generator.report.excel.RowSheet} classes.
You can set the order of the rows through the property "order".
The Interface ExcelQuery.
The Interface ExcelQueryComponent.
The Class ExcelQueryComponentImpl.
ExcelQueryComponentImpl is the class that manages the
ExcelQueryComponentImpl is the class that manages the
QuerySheetData classes and the annotation
ExcelQuery.The Interface ExcelRgbColor.
ExcelRgbColor is used to set the color by the RGB color model.
ExcelRgbColor is used to set the color by the RGB color model.
The Class ExcelRgbColorImpl.
The Interface ExcelRowHeight.
ExcelRowHeight is used to set the row height in centimeters.
It is set on
ExcelRowHeight is used to set the row height in centimeters.
It is set on
RowSheet classes or it added on field within of SheetSummary classes.The Class ExcelRowHeightImpl.
The Interface ExcelSelectCell.
ExcelSelectCell is use to select a cell within a cover file.
It is used on
ExcelSelectCell is use to select a cell within a cover file.
It is used on
ReportExcel classes.The Interface ExcelSheetLayout.
ExcelSheetLayout is used to configure the sheet layout through: Landscape - to enable/disable landscape NotMerge - to enable/disable merged cells SortAndFilter - to enable/disable sort and filter StartColumn - to set the column start StartRow - to set the row start Order - to set index on sheets list AreaBorder - to define the border areas showHeader - to enable/disable the writing of the header It is used on
ExcelSheetLayout is used to configure the sheet layout through: Landscape - to enable/disable landscape NotMerge - to enable/disable merged cells SortAndFilter - to enable/disable sort and filter StartColumn - to set the column start StartRow - to set the row start Order - to set index on sheets list AreaBorder - to define the border areas showHeader - to enable/disable the writing of the header It is used on
SheetData and SheetSummary classes.The Interface ExcelSubtotal.
ExcelSubtotal and
This annotation is added to fields within classes of type "
The property ExcelCellLayout define the cell layout.
ExcelSubtotal and
ExcelSubtotals are used To calculate the subtotals grouped by the value of the first column, the function type is defined by the "dataConsolidateFunction" property.This annotation is added to fields within classes of type "
RowSheet".The property ExcelCellLayout define the cell layout.
The Class ExcelSubtotalImpl.
The Interface ExcelSubtotals.
ExcelSubtotals and
This annotation is defined within classes of type "
The property ExcelCellLayout define the cell layout instead the property sumForGroup enable the subtotals grouped by the value of the first column.
ExcelSubtotals and
ExcelSubtotal are used To calculate the subtotals grouped by the value of the first column,
the function type is defined within of ExcelSubtotal, here instead you set the "startLabel" and "endLabel" properties to be concatenated to the first column and to define the subtotal label that groups all rows.This annotation is defined within classes of type "
RowSheet".The property ExcelCellLayout define the cell layout instead the property sumForGroup enable the subtotals grouped by the value of the first column.
The Interface ExcelSummary.
ExcelSummary is used to define the following properties: Title - to write the title of table Comment - to write a comment on header Layout - to set the cell style on cells of the first column widthColumn1 - to set the width on the first column widthColumn2 - to set the width on the second column It must be to used on
ExcelSummary is used to define the following properties: Title - to write the title of table Comment - to write a comment on header Layout - to set the cell style on cells of the first column widthColumn1 - to set the width on the first column widthColumn2 - to set the width on the second column It must be to used on
SheetSummary classesThe Interface ExcelSuperHeader.
ExcelSuperHeader defines the top level header cell and it sets the row height.
It is a property of the annotation
ExcelSuperHeader defines the top level header cell and it sets the row height.
It is a property of the annotation
ExcelSuperHeaders.The Interface ExcelSuperHeaderCell.
ExcelSuperHeaderCell is used to write the top level header cell.
It is composed by: ColumnName - to define the top level header name ColumnRange - to set the cell range address ExcelHeaderCellLayout - to set the style of the top level header cell It is a property of the annotation
ExcelSuperHeaderCell is used to write the top level header cell.
It is composed by: ColumnName - to define the top level header name ColumnRange - to set the cell range address ExcelHeaderCellLayout - to set the style of the top level header cell It is a property of the annotation
ExcelSuperHeader.The Interface ExcelSuperHeaders.
ExcelSuperHeaders manages a list of the top level header cell through superHeaders property.
It is used on
ExcelSuperHeaders manages a list of the top level header cell through superHeaders property.
It is used on
SheetData classes and it is not used on SheetDynamicData classesThe Class ExtraColumn.
The Class ExtraColumnAnnotation.
ExtraColumnAnnotation is used to configure the dynamic cells type and the style.
It must be set on mapExtraColumnAnnotation within the
ExtraColumnAnnotation is used to configure the dynamic cells type and the style.
It must be set on mapExtraColumnAnnotation within the
SheetDynamicData classes.The Class FloatDropDown.
The Enum FontType.
FontType is used to set font property on the following annotation
FontType is used to set font property on the following annotation
ExcelFont.The Class FunctionCell.
The Interface FunctionsTotal.
The Interface GenerateCsv.
The Interface GenerateExcel.
The Class GenerateExcelImpl.
In the GenerateExcelImpl class starts the process to generate the xls or xlsx file.
Below is a summary table with the features of the functions for generating excel files.
HSSF XSSF SXSSF Function createFileXls createFileXlsx createBigDataFileXlsx CPU and memory efficiency Varies varies Good Read Files Yes Yes No Write Files Yes Yes Yes Create sheets/rows/cells Yes Yes Yes Delete sheets/rows/cells Yes Yes No Styling cells Yes Yes Yes Shift rows Yes Yes No Cloning sheets Yes Yes No Formula evaluation Yes Yes No Cell comments Yes Yes No Picture Yes Yes No
In the GenerateExcelImpl class starts the process to generate the xls or xlsx file.
Below is a summary table with the features of the functions for generating excel files.
HSSF XSSF SXSSF Function createFileXls createFileXlsx createBigDataFileXlsx CPU and memory efficiency Varies varies Good Read Files Yes Yes No Write Files Yes Yes Yes Create sheets/rows/cells Yes Yes Yes Delete sheets/rows/cells Yes Yes No Styling cells Yes Yes Yes Shift rows Yes Yes No Cloning sheets Yes Yes No Formula evaluation Yes Yes No Cell comments Yes Yes No Picture Yes Yes No
The Interface IgnoreCheck.
IgnoreCheck is used to ignore some checks when starting the application and running some processes.
IgnoreCheck is used to ignore some checks when starting the application and running some processes.
The Class InfoChart.
The Class InfoColumn.
Instantiates a new info field.
The Class IntegerDropDown.
The Class LayoutCell.
Instantiates a new merge cell.
The Class MergeSheet.
The Class MultipleDatabaseConfiguration.
The classes that will extend @{link bld.generator.report.excel.config.MultipleDatabaseConfiguration} will need to implement abstract functions to configuration the n data sources.
The classes that will extend @{link bld.generator.report.excel.config.MultipleDatabaseConfiguration} will need to implement abstract functions to configuration the n data sources.
The Class NumberDropDown.
The Class PivotColumnComparator.
The Class PivotColumnFunctionComparator.
The Class PivotRowComparator.
The Class QueryCsvData.
The Class QuerySheetData.
The Class ReportExcel.
The Interface RowSheet.
The Interface ScopeGenerateExcel.
The Class ScopeGenerateExcelImpl.
ScopeGenerateExcelImpl is the heart of the generation of the xls or xlsx files.
ScopeGenerateExcelImpl is the heart of the generation of the xls or xlsx files.
The Class SheetColumnComparator.
SheetColumnComparator orders the columns on the table.
Sorting is relative to the index and column name.
SheetColumnComparator orders the columns on the table.
Sorting is relative to the index and column name.
The Interface SheetComponent.
The Class SheetData.
The Class SheetDynamicData.
The Class SheetDynamicFunctionTotal.
The Class SheetFunctionTotal.
The Class SheetHeader.
The Class SheetSummary.
The Class ExcelBaseDataSource.
The Interface ExcelDataSource.
The Class ExcelMultipleDataSource.
ExcelMultipleDataSource works if the "bld.commons.multiple.datasource" property is enabled
ExcelMultipleDataSource works if the "bld.commons.multiple.datasource" property is enabled
The Class ExcelSingleDataSource.
ExcelSingleDataSource works if the following properties match this conditions: spring.datasource.url - it is defined bld.commons.multiple.datasource - it is disabled or missing
ExcelSingleDataSource works if the following properties match this conditions: spring.datasource.url - it is defined bld.commons.multiple.datasource - it is disabled or missing
The Class StringDropDown.
The Class SubtotalRow.
The Class SuperGenerateExcelImpl.
The Class TimestampDropDown.
The Enum UnderlineType.