net.sf.jasperreports.engine.export

Class JRXlsAbstractExporter<RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,E extends JRExporterContext>

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter<RC,C,OutputStreamExporterOutput,E>

net.sf.jasperreports.engine.export.JRXlsAbstractExporter<RC,C,E>

All Implemented Interfaces:

JRExporter<ExporterInput,RC,C,OutputStreamExporterOutput>, Exporter<ExporterInput,RC,C,OutputStreamExporterOutput>

Direct Known Subclasses:

JExcelApiExporter, JROdsExporter, JRXlsAbstractMetadataExporter, JRXlsExporter, JRXlsxExporter

public abstract class JRXlsAbstractExporter<RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,E extends JRExporterContext>
extends JRAbstractExporter<RC,C,OutputStreamExporterOutput,E>

Superclass for the Excel exporters.

Excel Exporters

For generating Excel files, there are currently two different exporter implementations available in JasperReports. The first to appear was the JRXlsExporter implementation, which uses the Apache POI library to export documents to the Microsoft Excel 2003 file format (XLS).

Later on, with the introduction of the Microsoft Excel 2007 file format (XLSX), a new exporter was added to JasperReports to support it. This exporter implementation is the JRXlsxExporter; it does not rely on any third party library to produce XLSX files.

Because in XLS and XLSX all document content is placed inside cells, the Excel exporters are considered typical grid exporters, and having their known limitations.

Configuring Sheets

An Excel file is structured in multiple sheets, and both exporters can be configured either to put all pages inside the source JasperPrint document on one sheet (one after the another), or to put each page on a separate sheet in the resulting Excel file. The choice is made by setting the isOnePagePerSheet() exporter configuration setting, which is set to Boolean.FALSE by default.

When isOnePagePerSheet() is set to true, or when you have to execute a batch export to XLS, multiple sheets are created in the worksheet. You can also combine two exporter settings to customize the maximum number of rows per page, and display each page of the report in a separate sheet. To do this, set the number of rows per sheet for net.sf.jasperreports.export.xls.max.rows.per.sheet property and set true for net.sf.jasperreports.export.xls.one.page.per.sheet property.

The JasperReports Excel exporters provide a simple but efficient sheet-naming mechanism. They use the getSheetNames() exporter configuration setting to read custom sheet names from the String array passed as value. This exporter setting can hold an array of strings, which are passed as sheet names in order. If no value is supplied for this setting or if the value contains fewer sheet names than actually needed by the final document, then the sheets are named by default Page i (where i represents the one-based sheet index).

Taking into account the sheet name's length limitation in Excel (31 characters), if a sheet name contains more than 31 characters it will be truncated as follows: the name of the sheet will be given by the first 31 characters minus the sheet index length characters of the document's name, followed by the sheet index, so that the entire name has exactly 31 characters.

For example, if the second sheet name is TheQuickBrownFoxJumpsOverTheLazyDog (35 chars), it will become TheQuickBrownFoxJumpsOverTheLa2 (the final zyDog gets truncated, and the second sheet index 2 will end the name). The name of the 12345-th sheet will become TheQuickBrownFoxJumpsOverT12345 (the final heLazyDog gets truncated, in order to make the exact room for 12345).

Multiple sheet names can be specified in the JRXML file as well, using the net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name} property at report level. Add the following to the JRXML file:

 <property name="net.sf.jasperreports.export.xls.sheet.names.all" value="Sheet A/Sheet B/Sheet C" />
 

Keep in mind the naming order is important, sheets will be named in the same order the names are provided in this property.

Sheets can be also named at element level, using the net.sf.jasperreports.export.xls.sheet.name element property. This name will be provided for the sheet the element belongs to.

Flow-Oriented Output

The JasperPrint documents are page-oriented. When they are exported to a single sheet Excel document, all the pages are rendered consecutively. Because all exporters try to adhere as closely as possible to the quality and layout of the source document's Graphics2D or PDF format, the page breaks are visible in Excel format. Sometimes this is not desirable. One way to make page breaks less obvious and the layout more flow-based is to suppress all the remaining blank space between cells on the vertical axis.

When set to Boolean.TRUE, the isRemoveEmptySpaceBetweenRows() exporter configuration flag ensures that all empty rows on the resulting sheet are collapsed. By default, the exporter preserves all the white space for a precise page layout. The provided /demo/samples/nopagebreak sample shows you how to use this setting when exporting to XLS to produce a more flow-based document layout.

To completely ignore pagination, use the built-in fill-time parameter IS_IGNORE_PAGINATION. You can modify the API to remove the empty space between rows and columns as well. You need to set net.sf.jasperreports.export.xls.remove.empty.space.between.rows property and/or net.sf.jasperreports.export.xls.remove.empty.space.between.columns property to true.

Keep in mind these settings are limited by your report layout. If it is too far away from a grid layout, these options cannot work. On a good grid layout, once you set net.sf.jasperreports.export.xls.remove.empty.space.between.rows property and/or net.sf.jasperreports.export.xls.remove.empty.space.between.columns property to true, the empty spaces are removed.

Cell Types

Inside the proprietary document format that JasperReports uses (represented by the JasperPrint object), all text elements are considered alphanumeric values. This means that if a numeric text field of type java.lang.Double is placed in the report template at design time, all the text elements inside the JasperPrint object resulting from it will hold java.lang.String values, even though they are actually numbers. Therefore, in a sense, data type information is lost during report filling. This is because the main goal of JasperReports is to create documents for viewing and printing, not necessarily for further data manipulation inside tools like Excel, where formulas could be added to numeric cells.

However, these resulting text elements found in the generated documents nowadays hold enough data type information (in addition to the alphanumeric content) for the original value of the text element to be re-created, if needed.

Both Excel exporters support the isDetectCellType() configuration flag, which forces the recreation of the original cell value in accordance with its declared data type, as specified in the report template.

Cell type detection is turned off by default. You can have JasperReports automatically detect the cell type by modifying the API. Set the net.sf.jasperreports.export.xls.detect.cell.type property to true. When you do this, instead of being prompted by Excel to convert the value manually, the value is automatically converted.

Format Pattern Conversions

It is important to keep in mind that standard Java format patterns are not completely supported by Microsoft Excel. There are rather few data patterns that make a perfect match between Java and Excel.

In the case that the Java pattern stored in the generated report does not match any of the supported Excel cell patterns, there is still a way to choose an appropriate Excel format pattern. The solution is to use the getFormatPatternsMap() export configuration setting and supply a java.util.Map as value. This map should contain Java format patterns as keys and corresponding Excel format patterns as values.

Another way to adjust the format pattern to Excel-compatible values is to set the net.sf.jasperreports.export.xls.pattern property at element level.

Font Size Correction

Currently, there is no way to control the line spacing in a spreadsheet cell, which results in the cell text not fitting exactly within the cell boundaries. As a workaround, in order to force the cell text to fit, one can use the isFontSizeFixEnabled() exporter configuration flag to decrease the font size by one point when generating the cell format. Alternatively, one can use the net.sf.jasperreports.export.xls.font.size.fix.enabled property at report level.

Background Color

Empty space found on each page in the source JasperPrint document normally results in empty cells on the corresponding sheet inside the Excel file. The background color of these empty cells is specified by the configuration of the Excel viewer itself. This makes the cells appear transparent. To force the document's background to be white, set the isWhitePageBackground() exporter configuration flag to Boolean.TRUE.

Excel Color Palette

In JasperReports, any color can be used for the background or the foreground of a report element. However, when exporting to Excel format, only a limited set of colors is supported, through what is called a color palette.

If the colors used in a report template do not match the colors in the color palette, then the Excel exporter will use a special algorithm to determine the closest matches by comparing the RGB levels. However, the results might not always be as expected. A possibility to optimize the use of supported colors is to create a custom color palette. This can be achieved by setting to true the isCreateCustomPalette() export configuration flag. If the flag is set, the nearest not yet modified color from the palette is chosen and modified to exactly match the report color. If all the colors from the palette are modified (the palette has a fixed size), the nearest color from the palette is chosen for further report colors.

To see other various exporter configuration settings, please consult the XlsReportConfiguration and XlsExporterConfiguration classes.

Version:

$Id: JRXlsAbstractExporter.java 7069 2014-04-30 14:17:04Z shertage $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

XlsExporterConfiguration, XlsReportConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JRXlsAbstractExporter.SheetInfo
protected static class	JRXlsAbstractExporter.TextAlignHolder

Nested classes/interfaces inherited from class net.sf.jasperreports.engine.JRAbstractExporter

JRAbstractExporter.BaseExporterContext, JRAbstractExporter.PageRange

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	autoFilterEnd
protected java.lang.String	autoFilterStart
static java.lang.String	DEFAULT_SHEET_NAME_PREFIX
protected JRFont	defaultFont
protected boolean	firstPageNotSet
protected int	gridColumnFreezeIndex
protected int	gridRowFreezeIndex
protected java.lang.String	invalidCharReplacement
protected boolean	isFreezeColumnEdge
protected boolean	isFreezeRowEdge
protected java.lang.Boolean	keepTemplateSheets
protected java.util.List<java.lang.Object>	loadedFonts
protected int	maxColumnFreezeIndex
protected int	maxRowFreezeIndex
protected ExporterNature	nature
protected java.util.Map<java.lang.Integer,java.lang.Boolean>	onePagePerSheetMap
protected int	pageIndex
static java.lang.String	PROPERTY_AUTO_FILTER This element-level property is used to indicate the boundaries of the autofilter data range in the current sheet.
static java.lang.String	PROPERTY_AUTO_FIT_COLUMN Flag property that indicates whether Excel should autofit the current column width.
static java.lang.String	PROPERTY_AUTO_FIT_ROW Flag property that indicates whether Excel should autofit the current row height.
static java.lang.String	PROPERTY_BREAK_AFTER_ROW Element level property specifying if a sheet will break after the row displaying that element.
static java.lang.String	PROPERTY_BREAK_BEFORE_ROW Element level property specifying if a sheet will break before the row displaying that element.
static java.lang.String	PROPERTY_CELL_FORMULA Property that stores the formula which has to be applied to a given cell in an excel sheet.
static java.lang.String	PROPERTY_CELL_HIDDEN Deprecated. Replaced by XlsReportConfiguration.PROPERTY_CELL_HIDDEN.
static java.lang.String	PROPERTY_CELL_LOCKED Deprecated. Replaced by XlsReportConfiguration.PROPERTY_CELL_LOCKED.
static java.lang.String	PROPERTY_CELL_PATTERN Property that stores the pattern which has to be applied to a given cell in an excel sheet.
static java.lang.String	PROPERTY_COLUMN_WIDTH Element-level property used to adjust the column width to values suitable for Excel output, taking into account that column widths are measured in Excel in Normal style default character width units.
static java.lang.String	PROPERTY_COLUMN_WIDTH_RATIO Deprecated. Replaced by XlsReportConfiguration.PROPERTY_COLUMN_WIDTH_RATIO.
static java.lang.String	PROPERTY_FIRST_PAGE_NUMBER Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FIRST_PAGE_NUMBER.
static java.lang.String	PROPERTY_FIT_HEIGHT Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FIT_HEIGHT.
static java.lang.String	PROPERTY_FIT_WIDTH Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FIT_WIDTH.
static java.lang.String	PROPERTY_FREEZE_COLUMN Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FREEZE_COLUMN.
static java.lang.String	PROPERTY_FREEZE_COLUMN_EDGE This property indicates the vertical edge of the freeze pane, relative to the current cell.
static java.lang.String	PROPERTY_FREEZE_ROW Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FREEZE_ROW.
static java.lang.String	PROPERTY_FREEZE_ROW_EDGE This property indicates the horizontal edge of the freeze pane, relative to the current cell.
static java.lang.String	PROPERTY_IGNORE_ANCHORS Deprecated. Replaced by XlsReportConfiguration.PROPERTY_IGNORE_ANCHORS.
static java.lang.String	PROPERTY_IGNORE_HYPERLINK Deprecated. Replaced by XlsReportConfiguration.PROPERTY_IGNORE_HYPERLINK.
static java.lang.String	PROPERTY_IMAGE_ANCHOR_TYPE Deprecated. Replaced by XlsReportConfiguration.PROPERTY_IMAGE_ANCHOR_TYPE.
static java.lang.String	PROPERTY_PAGE_SCALE Deprecated. Replaced by XlsReportConfiguration.PROPERTY_PAGE_SCALE.
static java.lang.String	PROPERTY_ROW_OUTLINE_LEVEL_PREFIX Property prefix used to indicate the current outline row level, and when necessary, the ending row of the current outline row group with the given level.
static java.lang.String	PROPERTY_SHEET_DIRECTION Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_DIRECTION.
static java.lang.String	PROPERTY_SHEET_FOOTER_CENTER Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_FOOTER_CENTER.
static java.lang.String	PROPERTY_SHEET_FOOTER_LEFT Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_FOOTER_LEFT.
static java.lang.String	PROPERTY_SHEET_FOOTER_RIGHT Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_FOOTER_RIGHT.
static java.lang.String	PROPERTY_SHEET_HEADER_CENTER Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_HEADER_CENTER.
static java.lang.String	PROPERTY_SHEET_HEADER_LEFT Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_HEADER_LEFT.
static java.lang.String	PROPERTY_SHEET_HEADER_RIGHT Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_HEADER_RIGHT.
static java.lang.String	PROPERTY_SHEET_NAME Property used to set the name of the sheet containing a given element.
static java.lang.String	PROPERTY_SHOW_GRIDLINES Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHOW_GRIDLINES.
static java.lang.String	PROPERTY_USE_TIMEZONE Deprecated. Replaced by XlsReportConfiguration.PROPERTY_USE_TIMEZONE.
static java.lang.String	PROPERTY_WORKBOOK_TEMPLATE Deprecated. Replaced by XlsExporterConfiguration.PROPERTY_WORKBOOK_TEMPLATE.
static java.lang.String	PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS Deprecated. Replaced by XlsExporterConfiguration.PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS.
static java.lang.String	PROPERTY_WRAP_TEXT Deprecated. Replaced by XlsReportConfiguration.PROPERTY_WRAP_TEXT.
protected int	reportIndex
protected int	sheetIndex Used for counting the total number of sheets.
protected java.lang.String[]	sheetNames
protected int	sheetNamesIndex Used for iterating through sheet names.
protected java.util.Map<java.lang.String,java.lang.Integer>	sheetNamesMap Used when indexing the identical sheet name.
protected int	sheetsBeforeCurrentReport
protected java.util.Map<java.lang.Integer,java.lang.Integer>	sheetsBeforeCurrentReportMap
protected java.lang.String	workbookTemplate
static java.lang.String	XLS_EXPORTER_PROPERTIES_PREFIX

Fields inherited from class net.sf.jasperreports.engine.JRAbstractExporter

allSelector, crtCompositeConfiguration, crtCompositeItemConfiguration, crtItem, dateFormatCache, EXCEPTION_MESSAGE_KEY_END_PAGE_INDEX_OUT_OF_RANGE, EXCEPTION_MESSAGE_KEY_PAGE_INDEX_OUT_OF_RANGE, EXCEPTION_MESSAGE_KEY_START_PAGE_INDEX_OUT_OF_RANGE, exporterConfiguration, exporterContext, exporterInput, exporterOutput, filter, itemConfiguration, jasperPrint, jasperReportsContext, noBackcolorSelector, noneSelector, numberFormatCache, parameters, propertiesUtil, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, styledTextUtil

Constructor Summary

Constructors

Constructor and Description
JRXlsAbstractExporter()
JRXlsAbstractExporter(JasperReportsContext jasperReportsContext)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addBlankCell(JRExporterGridCell gridCell, int colIndex, int rowIndex)
protected abstract void	addOccupiedCell(OccupiedGridCell occupiedGridCell, int colIndex, int rowIndex)
protected int	calculateHeightForDinAN(int n)
protected int	calculateHeightForDinBN(int n)
protected int	calculateHeightForDinCN(int n)
protected int	calculateWidthForDinAN(int n)
protected int	calculateWidthForDinBN(int n)
protected int	calculateWidthForDinCN(int n)
protected abstract void	closeWorkbook(java.io.OutputStream os)
protected abstract void	createSheet(CutsInfo xCuts, JRXlsAbstractExporter.SheetInfo sheetInfo)
protected void	ensureOutput()
protected abstract void	exportFrame(JRPrintFrame frame, JRExporterGridCell cell, int colIndex, int rowIndex)
protected abstract void	exportGenericElement(JRGenericPrintElement element, JRExporterGridCell cell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout)
protected abstract void	exportImage(JRPrintImage image, JRExporterGridCell cell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout)
protected abstract void	exportLine(JRPrintLine line, JRExporterGridCell cell, int colIndex, int rowIndex)
protected int	exportPage(JRPrintPage page, CutsInfo xCuts, int startRow, java.lang.String defaultSheetName)
protected abstract void	exportRectangle(JRPrintGraphicElement element, JRExporterGridCell cell, int colIndex, int rowIndex)
void	exportReport() Performs the export.
protected void	exportReportToStream(java.io.OutputStream os)
protected void	exportSheet(CutsInfo xCuts, CutsInfo yCuts, int startCutIndex, java.lang.String defaultSheetName)
protected abstract void	exportText(JRPrintText text, JRExporterGridCell cell, int colIndex, int rowIndex)
protected int	getColumnIndex(java.lang.String columnName)
protected java.lang.String	getColumnName(int columnIndex)
protected java.lang.String	getConvertedPattern(JRPrintText text, java.lang.String pattern)
protected JRFont	getDefaultFont()
protected java.lang.String	getFormula(JRPrintText text)
protected int	getImageBorderCorrection(JRPen pen)
protected ExporterNature	getNature()
protected JRXlsAbstractExporter.SheetInfo	getSheetProps(CutsInfo yCuts, int startCutIndex)
protected JRStyledText	getStyledText(JRPrintText textElement)
protected static JRXlsAbstractExporter.TextAlignHolder	getTextAlignHolder(JRPrintText textElement)
java.lang.String	getWorkbookTemplate() Deprecated. Replaced by XlsExporterConfiguration.getWorkbookTemplate().
protected boolean	hasGlobalSheetNames()
protected void	initExport()
protected void	initReport()
protected boolean	isCellHidden(JRPrintElement element)
protected boolean	isCellLocked(JRPrintElement element)
protected boolean	isUseTimeZone(JRPrintElement element)
protected boolean	isValidScale(java.lang.Integer scale)
boolean	isWorkbookTemplateKeepSheets() Deprecated. Replaced by XlsExporterConfiguration.isKeepWorkbookTemplateSheets().
protected boolean	isWrapText(JRPrintElement element)
protected void	mergeAndSetRowLevels(XlsRowLevelInfo levelInfo, java.util.SortedMap<java.lang.String,java.lang.Boolean> rowLevelMap, int rowIndex)
protected abstract void	openWorkbook(java.io.OutputStream os)
protected void	resetAutoFilters()
protected abstract void	setAutoFilter(java.lang.String autoFilterRange)
protected abstract void	setColumnWidth(int col, int width, boolean autoFit)
protected void	setColumnWidths(CutsInfo xCuts)
protected void	setFreezePane(int rowIndex, int colIndex)
protected abstract void	setFreezePane(int rowIndex, int colIndex, boolean isRowEdge, boolean isColumnEdge)
protected abstract void	setRowHeight(int rowIndex, int lastRowHeight, Cut yCut, XlsRowLevelInfo levelInfo)
protected abstract void	setRowLevels(XlsRowLevelInfo levelInfo, java.lang.String level)
protected abstract void	setScale(java.lang.Integer scale)
protected abstract void	setSheetName(java.lang.String sheetName)
protected void	setSheetNames()
void	setWorkbookTemplate(java.lang.String workbookTemplate) Deprecated. Replaced by XlsExporterConfiguration.getWorkbookTemplate().
void	setWorkbookTemplateKeepSheets(boolean keepTemplateSheets) Deprecated. Replaced by XlsExporterConfiguration.isKeepWorkbookTemplateSheets().
protected java.util.Date	translateDateValue(JRPrintText text, java.util.Date value)

Methods inherited from class net.sf.jasperreports.engine.JRAbstractExporter

createFilter, defaultParseNumber, ensureInput, ensureJasperReportsContext, getBooleanCellValue, getConfigurationInterface, getCurrentConfiguration, getCurrentItemConfiguration, getCurrentJasperPrint, getCustomHandler, getDateCellValue, getDateFormat, getExporterContext, getExporterInput, getExporterKey, getExporterOutput, getExporterPropertiesPrefix, getHyperlinkProducer, getItemConfigurationInterface, getJasperReportsContext, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getPageRange, getParameter, getParameters, getPropertiesUtil, getReportContext, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, reset, resetClassLoader, resetExportContext, restoreElementOffsets, setClassLoader, setConfiguration, setConfiguration, setCurrentExporterInputItem, setExporterInput, setExporterOutput, setFrameElementsOffset, setJasperPrint, setJasperReportsContext, setOffset, setOffset, setParameter, setParameters, setReportContext

Methods inherited from class java.lang.Object

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

Field Detail

XLS_EXPORTER_PROPERTIES_PREFIX

public static final java.lang.String XLS_EXPORTER_PROPERTIES_PREFIX

See Also:

Constant Field Values

DEFAULT_SHEET_NAME_PREFIX

public static final java.lang.String DEFAULT_SHEET_NAME_PREFIX

See Also:

Constant Field Values

PROPERTY_CELL_FORMULA

public static final java.lang.String PROPERTY_CELL_FORMULA

Property that stores the formula which has to be applied to a given cell in an excel sheet.

See Also:

Constant Field Values

PROPERTY_CELL_PATTERN

public static final java.lang.String PROPERTY_CELL_PATTERN

Property that stores the pattern which has to be applied to a given cell in an excel sheet.

See Also:

Constant Field Values

PROPERTY_SHEET_NAME

public static final java.lang.String PROPERTY_SHEET_NAME

Property used to set the name of the sheet containing a given element. Its value overrides the report-level settings for the sheet name. If several elements in the sheet contain this property, the engine will consider the value of the last exported element's property.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_WRAP_TEXT

public static final java.lang.String PROPERTY_WRAP_TEXT

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_WRAP_TEXT.

See Also:

Constant Field Values

PROPERTY_FIT_WIDTH

public static final java.lang.String PROPERTY_FIT_WIDTH

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FIT_WIDTH.

See Also:

Constant Field Values

PROPERTY_FIT_HEIGHT

public static final java.lang.String PROPERTY_FIT_HEIGHT

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FIT_HEIGHT.

See Also:

Constant Field Values

PROPERTY_CELL_LOCKED

public static final java.lang.String PROPERTY_CELL_LOCKED

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_CELL_LOCKED.

See Also:

Constant Field Values

PROPERTY_CELL_HIDDEN

public static final java.lang.String PROPERTY_CELL_HIDDEN

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_CELL_HIDDEN.

See Also:

Constant Field Values

PROPERTY_SHEET_HEADER_LEFT

public static final java.lang.String PROPERTY_SHEET_HEADER_LEFT

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_HEADER_LEFT.

See Also:

Constant Field Values

PROPERTY_SHEET_HEADER_CENTER

public static final java.lang.String PROPERTY_SHEET_HEADER_CENTER

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_HEADER_CENTER.

See Also:

Constant Field Values

PROPERTY_SHEET_HEADER_RIGHT

public static final java.lang.String PROPERTY_SHEET_HEADER_RIGHT

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_HEADER_RIGHT.

See Also:

Constant Field Values

PROPERTY_SHEET_FOOTER_LEFT

public static final java.lang.String PROPERTY_SHEET_FOOTER_LEFT

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_FOOTER_LEFT.

See Also:

Constant Field Values

PROPERTY_SHEET_FOOTER_CENTER

public static final java.lang.String PROPERTY_SHEET_FOOTER_CENTER

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_FOOTER_CENTER.

See Also:

Constant Field Values

PROPERTY_SHEET_FOOTER_RIGHT

public static final java.lang.String PROPERTY_SHEET_FOOTER_RIGHT

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_FOOTER_RIGHT.

See Also:

Constant Field Values

PROPERTY_SHEET_DIRECTION

public static final java.lang.String PROPERTY_SHEET_DIRECTION

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHEET_DIRECTION.

See Also:

Constant Field Values

PROPERTY_FREEZE_ROW

public static final java.lang.String PROPERTY_FREEZE_ROW

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FREEZE_ROW.

See Also:

Constant Field Values

PROPERTY_FREEZE_COLUMN

public static final java.lang.String PROPERTY_FREEZE_COLUMN

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FREEZE_COLUMN.

See Also:

Constant Field Values

PROPERTY_FREEZE_ROW_EDGE

public static final java.lang.String PROPERTY_FREEZE_ROW_EDGE

This property indicates the horizontal edge of the freeze pane, relative to the current cell. If set, it overrides the PROPERTY_FREEZE_ROW value. Allowed values are:

• Top - The current row is the first unlocked row in the sheet. All rows above are 'frozen'.
• Bottom - The current row is the last 'frozen' row in the sheet. All rows below are unlocked.

See Also:

Constant Field Values

PROPERTY_FREEZE_COLUMN_EDGE

public static final java.lang.String PROPERTY_FREEZE_COLUMN_EDGE

This property indicates the vertical edge of the freeze pane, relative to the current cell. If set, it overrides the PROPERTY_FREEZE_COLUMN and PROPERTY_FREEZE_SHEET_COLUMNS values. Allowed values are:

• Left - The current column is the first unlocked column in the sheet. All columns to the left are 'frozen'.
• Right - The current column is the last 'frozen' column in the sheet. All columns to the right are unlocked.

See Also:

Constant Field Values

PROPERTY_AUTO_FIT_ROW

public static final java.lang.String PROPERTY_AUTO_FIT_ROW

Flag property that indicates whether Excel should autofit the current row height. Allowed values are:

• true
• false - this is the default value.

Since:

4.5.1

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_AUTO_FIT_COLUMN

public static final java.lang.String PROPERTY_AUTO_FIT_COLUMN

Flag property that indicates whether Excel should autofit the current column width. Allowed values are:

• true
• false - this is the default value.

Since:

4.5.1

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_AUTO_FILTER

public static final java.lang.String PROPERTY_AUTO_FILTER

This element-level property is used to indicate the boundaries of the autofilter data range in the current sheet. Allowed values are:

• Start - The current cell will be marked as autofilter heading cell, and column data below/to the right of this cell can be considered as part of the autofilter data range. The starting point of the autofilter data range will be the next cell below the current cell (ie if the current cell reference is B4, the autofilter range will start with the "B5" cell reference: "B5:M20").
  If multiple autofilter Start values are found in the same sheet, only the last one will be considered. If the Start value is present but no End value is found in the sheet, then only the current column will be considered for the data range.
  If the autofilter Start value is set on the same row as the autofilter End value, the data range will include all data below this heading row, placed between the start column and the end column.
• End - The current cell will be marked as autofilter ending cell, and column data in this cell and above/to the left can be considered as part of the autofilter data range. The ending cell in the data range is the current cell reference (ie if the current cell reference is M20, the autofilter range will end in "M20": "B5:M20"). The heading cell for the current column will be placed in the same column on the row containing the autofilter Start value.
  Caution: If no autofilter Start value is found in the sheet, the autofilter End value will be considered as Start value instead.
  If multiple autofilter End value are found in the same sheet, only the last one will be considered.
  If the autofilter Start value is set on the same row as the autofilter End value, the data range will include all data below this heading row, placed between the start column and the end column.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_COLUMN_WIDTH

public static final java.lang.String PROPERTY_COLUMN_WIDTH

Element-level property used to adjust the column width to values suitable for Excel output, taking into account that column widths are measured in Excel in Normal style default character width units. The pixel-to-character width translation depends on the default normal style character width, so it cannot be always accurately fitted. In this case, one can adjust the current column width by setting this property with an integer value measured in pixels. The JR engine will perform the pixel-to-character width mapping using this value instead of the element's width attribute.
If defined, this property will override the PROPERTY_COLUMN_WIDTH_RATIO value for the current column

See Also:

XlsReportConfiguration.PROPERTY_COLUMN_WIDTH_RATIO, JRPropertiesUtil, Constant Field Values

PROPERTY_COLUMN_WIDTH_RATIO

public static final java.lang.String PROPERTY_COLUMN_WIDTH_RATIO

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_COLUMN_WIDTH_RATIO.

See Also:

Constant Field Values

PROPERTY_ROW_OUTLINE_LEVEL_PREFIX

public static final java.lang.String PROPERTY_ROW_OUTLINE_LEVEL_PREFIX

Property prefix used to indicate the current outline row level, and when necessary, the ending row of the current outline row group with the given level. The suffix of these properties is associated with the outline level, while the property value indicates if the current row group should continue or should end. The most recommended practice is to use the outline level itself as property suffix, although this is not mandatory. The suffix may take any other string value, but one has to keep in mind that suffixes are used as sorted row level descriptors. For instance, because "aaa" < "bbb", the outline level associated with the "aaa" suffix will be smaller than the level associated with the "bbb" suffix. The most intuitive representation of the row levels uses the row level as property suffix.
In such a case, The net.sf.jasperreports.export.xls.outline.level.2 property means that its value is correlated with the outline level 2, so the current row belongs to a level 2 row group. Based on Office Open XML specs, allowed values for outline levels are positive integers from 1 to 7.
The value of this property could be any expression (including null). When such a property occurrence is met, the suffix indicates the outline level for that row. If multiple properties with the same prefix are defined for the same row, the deepest outline level is considered for that row. To end an outline row group one has to set the related outline level property with the End value. This is a special property value instructing the JR engine that the current row group of that level ends on the current row.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_USE_TIMEZONE

public static final java.lang.String PROPERTY_USE_TIMEZONE

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_USE_TIMEZONE.

See Also:

Constant Field Values

PROPERTY_WORKBOOK_TEMPLATE

public static final java.lang.String PROPERTY_WORKBOOK_TEMPLATE

Deprecated. Replaced by XlsExporterConfiguration.PROPERTY_WORKBOOK_TEMPLATE.

See Also:

Constant Field Values

PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS

public static final java.lang.String PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS

Deprecated. Replaced by XlsExporterConfiguration.PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS.

See Also:

Constant Field Values

PROPERTY_IGNORE_ANCHORS

public static final java.lang.String PROPERTY_IGNORE_ANCHORS

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_IGNORE_ANCHORS.

See Also:

Constant Field Values

PROPERTY_PAGE_SCALE

public static final java.lang.String PROPERTY_PAGE_SCALE

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_PAGE_SCALE.

See Also:

Constant Field Values

PROPERTY_FIRST_PAGE_NUMBER

public static final java.lang.String PROPERTY_FIRST_PAGE_NUMBER

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_FIRST_PAGE_NUMBER.

See Also:

Constant Field Values

PROPERTY_SHOW_GRIDLINES

public static final java.lang.String PROPERTY_SHOW_GRIDLINES

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_SHOW_GRIDLINES.

See Also:

Constant Field Values

PROPERTY_IMAGE_ANCHOR_TYPE

public static final java.lang.String PROPERTY_IMAGE_ANCHOR_TYPE

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_IMAGE_ANCHOR_TYPE.

See Also:

Constant Field Values

PROPERTY_IGNORE_HYPERLINK

public static final java.lang.String PROPERTY_IGNORE_HYPERLINK

Deprecated. Replaced by XlsReportConfiguration.PROPERTY_IGNORE_HYPERLINK.

See Also:

Constant Field Values

PROPERTY_BREAK_BEFORE_ROW

public static final java.lang.String PROPERTY_BREAK_BEFORE_ROW

Element level property specifying if a sheet will break before the row displaying that element. It is very useful especially when displaying each report's group on a separate sheet is intended.

See Also:

Constant Field Values

PROPERTY_BREAK_AFTER_ROW

public static final java.lang.String PROPERTY_BREAK_AFTER_ROW

Element level property specifying if a sheet will break after the row displaying that element. It is very useful especially when displaying each report's group on a separate sheet is intended.

See Also:

Constant Field Values

loadedFonts

protected java.util.List<java.lang.Object> loadedFonts

nature

protected ExporterNature nature

sheetNames

protected java.lang.String[] sheetNames

reportIndex

protected int reportIndex

pageIndex

protected int pageIndex

onePagePerSheetMap

protected java.util.Map<java.lang.Integer,java.lang.Boolean> onePagePerSheetMap

sheetsBeforeCurrentReport

protected int sheetsBeforeCurrentReport

sheetsBeforeCurrentReportMap

protected java.util.Map<java.lang.Integer,java.lang.Integer> sheetsBeforeCurrentReportMap

defaultFont

protected JRFont defaultFont

sheetIndex

protected int sheetIndex

Used for counting the total number of sheets.

sheetNamesIndex

protected int sheetNamesIndex

Used for iterating through sheet names.

sheetNamesMap

protected java.util.Map<java.lang.String,java.lang.Integer> sheetNamesMap

Used when indexing the identical sheet name. Contains sheet names as keys and the number of occurrences of each sheet name as values.

gridRowFreezeIndex

protected int gridRowFreezeIndex

gridColumnFreezeIndex

protected int gridColumnFreezeIndex

maxRowFreezeIndex

protected int maxRowFreezeIndex

maxColumnFreezeIndex

protected int maxColumnFreezeIndex

isFreezeRowEdge

protected boolean isFreezeRowEdge

isFreezeColumnEdge

protected boolean isFreezeColumnEdge

autoFilterStart

protected java.lang.String autoFilterStart

autoFilterEnd

protected java.lang.String autoFilterEnd

firstPageNotSet

protected boolean firstPageNotSet

keepTemplateSheets

protected java.lang.Boolean keepTemplateSheets

workbookTemplate

protected java.lang.String workbookTemplate

invalidCharReplacement

protected java.lang.String invalidCharReplacement

Constructor Detail

JRXlsAbstractExporter

public JRXlsAbstractExporter()

See Also:

JRXlsAbstractExporter(JasperReportsContext)

JRXlsAbstractExporter

public JRXlsAbstractExporter(JasperReportsContext jasperReportsContext)

Method Detail

getDefaultFont

protected JRFont getDefaultFont()

exportReport

public void exportReport()
                  throws JRException

Description copied from interface: Exporter

Performs the export.

Specified by:

exportReport in interface Exporter<ExporterInput,RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,OutputStreamExporterOutput>

Specified by:

exportReport in class JRAbstractExporter<RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,OutputStreamExporterOutput,E extends JRExporterContext>

Throws:

JRException

ensureOutput

protected void ensureOutput()

Specified by:

ensureOutput in class JRAbstractExporter<RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,OutputStreamExporterOutput,E extends JRExporterContext>

initExport

protected void initExport()

Overrides:

initExport in class JRAbstractExporter<RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,OutputStreamExporterOutput,E extends JRExporterContext>

initReport

protected void initReport()

Overrides:

initReport in class JRAbstractExporter<RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,OutputStreamExporterOutput,E extends JRExporterContext>

exportReportToStream

protected void exportReportToStream(java.io.OutputStream os)
                             throws JRException,
                                    java.io.IOException

Throws:

JRException

java.io.IOException

exportPage

protected int exportPage(JRPrintPage page,
             CutsInfo xCuts,
             int startRow,
             java.lang.String defaultSheetName)
                  throws JRException

Returns:

the number of rows added.

Throws:

JRException

getSheetProps

protected JRXlsAbstractExporter.SheetInfo getSheetProps(CutsInfo yCuts,
                                            int startCutIndex)

exportSheet

protected void exportSheet(CutsInfo xCuts,
               CutsInfo yCuts,
               int startCutIndex,
               java.lang.String defaultSheetName)

mergeAndSetRowLevels

protected void mergeAndSetRowLevels(XlsRowLevelInfo levelInfo,
                        java.util.SortedMap<java.lang.String,java.lang.Boolean> rowLevelMap,
                        int rowIndex)

setColumnWidths

protected void setColumnWidths(CutsInfo xCuts)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement)

Overrides:

getStyledText in class JRAbstractExporter<RC extends XlsReportConfiguration,C extends XlsExporterConfiguration,OutputStreamExporterOutput,E extends JRExporterContext>

getTextAlignHolder

protected static JRXlsAbstractExporter.TextAlignHolder getTextAlignHolder(JRPrintText textElement)

getImageBorderCorrection

protected int getImageBorderCorrection(JRPen pen)

calculateWidthForDinAN

protected final int calculateWidthForDinAN(int n)

calculateHeightForDinAN

protected final int calculateHeightForDinAN(int n)

calculateWidthForDinBN

protected final int calculateWidthForDinBN(int n)

calculateHeightForDinBN

protected final int calculateHeightForDinBN(int n)

calculateWidthForDinCN

protected final int calculateWidthForDinCN(int n)

calculateHeightForDinCN

protected final int calculateHeightForDinCN(int n)

isWrapText

protected boolean isWrapText(JRPrintElement element)

isCellLocked

protected boolean isCellLocked(JRPrintElement element)

getFormula

protected java.lang.String getFormula(JRPrintText text)

setSheetNames

protected void setSheetNames()

hasGlobalSheetNames

protected boolean hasGlobalSheetNames()

isCellHidden

protected boolean isCellHidden(JRPrintElement element)

getConvertedPattern

protected java.lang.String getConvertedPattern(JRPrintText text,
                                   java.lang.String pattern)

getColumnIndex

protected int getColumnIndex(java.lang.String columnName)

Returns:

the calculated column index

getColumnName

protected java.lang.String getColumnName(int columnIndex)

Returns:

the calculated column name

setFreezePane

protected void setFreezePane(int rowIndex,
                 int colIndex)

resetAutoFilters

protected void resetAutoFilters()

isUseTimeZone

protected boolean isUseTimeZone(JRPrintElement element)

translateDateValue

protected java.util.Date translateDateValue(JRPrintText text,
                                java.util.Date value)

isValidScale

protected boolean isValidScale(java.lang.Integer scale)

isWorkbookTemplateKeepSheets

public boolean isWorkbookTemplateKeepSheets()

Deprecated. Replaced by XlsExporterConfiguration.isKeepWorkbookTemplateSheets().

setWorkbookTemplateKeepSheets

public void setWorkbookTemplateKeepSheets(boolean keepTemplateSheets)

Deprecated. Replaced by XlsExporterConfiguration.isKeepWorkbookTemplateSheets().

getWorkbookTemplate

public java.lang.String getWorkbookTemplate()

Deprecated. Replaced by XlsExporterConfiguration.getWorkbookTemplate().

setWorkbookTemplate

public void setWorkbookTemplate(java.lang.String workbookTemplate)

Deprecated. Replaced by XlsExporterConfiguration.getWorkbookTemplate().

getNature

protected ExporterNature getNature()

openWorkbook

protected abstract void openWorkbook(java.io.OutputStream os)
                              throws JRException,
                                     java.io.IOException

Throws:

JRException

java.io.IOException

createSheet

protected abstract void createSheet(CutsInfo xCuts,
               JRXlsAbstractExporter.SheetInfo sheetInfo)

closeWorkbook

protected abstract void closeWorkbook(java.io.OutputStream os)
                               throws JRException,
                                      java.io.IOException

Throws:

JRException

java.io.IOException

setColumnWidth

protected abstract void setColumnWidth(int col,
                  int width,
                  boolean autoFit)

setRowHeight

protected abstract void setRowHeight(int rowIndex,
                int lastRowHeight,
                Cut yCut,
                XlsRowLevelInfo levelInfo)
                              throws JRException

Throws:

JRException

addBlankCell

protected abstract void addBlankCell(JRExporterGridCell gridCell,
                int colIndex,
                int rowIndex)
                              throws JRException

Throws:

JRException

addOccupiedCell

protected abstract void addOccupiedCell(OccupiedGridCell occupiedGridCell,
                   int colIndex,
                   int rowIndex)
                                 throws JRException

Throws:

JRException

exportText

protected abstract void exportText(JRPrintText text,
              JRExporterGridCell cell,
              int colIndex,
              int rowIndex)
                            throws JRException

Throws:

JRException

exportImage

protected abstract void exportImage(JRPrintImage image,
               JRExporterGridCell cell,
               int colIndex,
               int rowIndex,
               int emptyCols,
               int yCutsRow,
               JRGridLayout layout)
                             throws JRException

Throws:

JRException

exportRectangle

protected abstract void exportRectangle(JRPrintGraphicElement element,
                   JRExporterGridCell cell,
                   int colIndex,
                   int rowIndex)
                                 throws JRException

Throws:

JRException

exportLine

protected abstract void exportLine(JRPrintLine line,
              JRExporterGridCell cell,
              int colIndex,
              int rowIndex)
                            throws JRException

Throws:

JRException

exportFrame

protected abstract void exportFrame(JRPrintFrame frame,
               JRExporterGridCell cell,
               int colIndex,
               int rowIndex)
                             throws JRException

Throws:

JRException

exportGenericElement

protected abstract void exportGenericElement(JRGenericPrintElement element,
                        JRExporterGridCell cell,
                        int colIndex,
                        int rowIndex,
                        int emptyCols,
                        int yCutsRow,
                        JRGridLayout layout)
                                      throws JRException

Throws:

JRException

setFreezePane

protected abstract void setFreezePane(int rowIndex,
                 int colIndex,
                 boolean isRowEdge,
                 boolean isColumnEdge)

setSheetName

protected abstract void setSheetName(java.lang.String sheetName)

setAutoFilter

protected abstract void setAutoFilter(java.lang.String autoFilterRange)

setRowLevels

protected abstract void setRowLevels(XlsRowLevelInfo levelInfo,
                java.lang.String level)

setScale

protected abstract void setScale(java.lang.Integer scale)