Package net.sf.jasperreports.poi.export

Interface GenericElementXlsMetadataHandler

  • All Superinterfaces:
    GenericElementHandler
    public interface GenericElementXlsMetadataHandler
extends GenericElementHandler
    A generic print element XLS export handler.
    Author:
    Sanda Zaharia (shertage@users.sourceforge.net)

    • Method Detail

      • exportElement

        int exportElement​(JRXlsExporterContext exporterContext,
                  JRGenericPrintElement element,
                  Map<String,​Object> currentRow,
                  Map<String,​Object> repeatedValues,
                  List<String> columnNames,
                  Map<String,​Integer> columnNamesMap,
                  String currentColumnName,
                  int colIndex,
                  int rowIndex,
                  boolean repeatValue)
        Exports a generic element.

        Access to the exporter output and environment is provided via the JRXlsExporterContext argument.

        Parameters:
        exporterContext - the exporter context
        element - the generic element to export
        currentRow - the map with column names as keys and exported CellSettings objects as values
        repeatedValues - the map containing CellSettings objects to be placed instead in the currentRow map when the exported object is null
        columnNames - the list of column names
        columnNamesMap - the map containing the mapping between column names and column indexes
        currentColumnName - the current column's name
        colIndex - the current column index
        rowIndex - the current row index
        repeatValue - the flag specifying if null values should be replaced with objects from the repeatedValues map
        Returns:
        int value representing the resulting row index, if this was incremented during export