Package bld.generator.report.excel.annotation

In this package, each annotation is used to configure the Excel file by building objects composed of these annotations.

See: Description

Annotation Types Summary

Annotation Type	Description
ExcelAreaBorder	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
ExcelBarChartData	The Interface ExcelBarChartData.
ExcelBooleanText	The Interface ExcelBooleanText.
ExcelBorder	The Interface ExcelBorder.
ExcelBoxMessage	The Interface ExcelBoxMessage.
ExcelCellLayout	The Interface ExcelCellLayout.
ExcelChart	The Interface ExcelChart.
ExcelChartCategory	The Interface ExcelChartCategory.
ExcelChartDataLabel	The Interface ExcelChartDataLabel.
ExcelCharts	The Interface ExcelCharts.
ExcelColumn	The Interface ExcelColumn.
ExcelColumnWidth	The Interface ExcelColumnWidth.
ExcelDate	The Interface ExcelDate. ExcelDate is used to set the date format and it is set on fields of the classes: RowSheet SheetSummary
ExcelDropDown	The Interface ExcelDropDown. Excel Drop Down is used to create a drop down list that references another table within the Excel file.
ExcelFont	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: ExcelCellLayout ExcelHeaderCellLayout
ExcelFormulaAlias	The Interface ExcelFormulaAlias.
ExcelFreezePane	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
ExcelFunction	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: ExcelFunctionMergeRow ExcelFunctionRow Below an example to calculate functions on rows and columns.
ExcelFunctionMergeRow	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 width<7li> ExcelHeaderCellLayout - to define header cell layout ExcelSubtotal - to execute subtotal function ExcelFunctionMergeRow is parameter of the annotation ExcelFunctionRows.
ExcelFunctionRow	The Interface ExcelFunctionRow.
ExcelFunctionRows	The Interface ExcelFunctionRows. ExcelFunctionRows is used to manage 2 lists: excelFunctions excelFunctionMerges It must be managed on RowSheet classes.
ExcelHeaderCellLayout	The Interface ExcelHeaderCellLayout.
ExcelHeaderLayout	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 SheetData classes.
ExcelImage	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.
ExcelLabel	The Interface ExcelLabel. 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
ExcelMarginSheet	The Interface ExcelMarginSheet. ExcelMarginSheet is used to set the margin for all the cells of the sheet. Top Bottom Left Right
ExcelMergeRow	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 ExcelSheetLayout is disabled. ExcelMergeRow is an annotation of the fields within RowSheet classes.
ExcelPivot	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.
ExcelPivotColumn	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".
ExcelPivotColumnFunction	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.
ExcelPivotFilter	The Interface ExcelPivotFilter.
ExcelPivotRow	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".
ExcelQuery	The Interface ExcelQuery.
ExcelRgbColor	The Interface ExcelRgbColor. ExcelRgbColor is used to set the color by the RGB color model.
ExcelRowHeight	The Interface ExcelRowHeight. 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.
ExcelSelectCell	The Interface ExcelSelectCell. ExcelSelectCell is use to select a cell within a cover file. It is used on ReportExcel classes.
ExcelSheetLayout	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 SheetData and SheetSummary classes.
ExcelSubtotal	The Interface ExcelSubtotal. 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.
ExcelSubtotals	The Interface ExcelSubtotals. 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.
ExcelSummary	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 SheetSummary classes
ExcelSuperHeader	The Interface ExcelSuperHeader. ExcelSuperHeader defines the top level header cell and it sets the row height. It is a property of the annotation ExcelSuperHeaders.
ExcelSuperHeaderCell	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 ExcelSuperHeader.
ExcelSuperHeaders	The Interface ExcelSuperHeaders. 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 classes

Package bld.generator.report.excel.annotation Description

In this package, each annotation is used to configure the Excel file by building objects composed of these annotations.