net.sf.jasperreports.engine.export

Class JRXlsExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter

net.sf.jasperreports.engine.export.JRXlsAbstractExporter

net.sf.jasperreports.engine.export.JRXlsExporter

All Implemented Interfaces:

JRExporter

public class JRXlsExporter
extends JRXlsAbstractExporter

Exports a JasperReports document to XLS format. It has binary output type and exports the document to a grid-based layout.

Version:

$Id: JRXlsExporter.java 4760 2011-10-27 13:26:51Z shertage $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JRXlsExporter.ExporterContext

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

JRXlsAbstractExporter.TextAlignHolder

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

JRAbstractExporter.BaseExporterContext, JRAbstractExporter.ParameterOverriddenResolver, JRAbstractExporter.ParameterOverrideResolver, JRAbstractExporter.ParameterResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<Hyperlink>>	anchorLinks
protected java.util.Map<java.lang.String,HSSFName>	anchorNames
protected short	backgroundMode
protected short	blackIndex
protected HSSFCell	cell
protected CreationHelper	createHelper
protected HSSFDataFormat	dataFormat
protected HSSFCellStyle	emptyCellStyle
protected JRXlsExporterContext	exporterContext
protected java.util.Map<net.sf.jasperreports.engine.export.StyleInfo,HSSFCellStyle>	loadedCellStyles
protected ExporterNature	nature
protected java.util.Map<java.lang.Integer,java.util.List<Hyperlink>>	pageLinks
protected java.lang.String	password
protected HSSFPatriarch	patriarch
protected HSSFRow	row
protected HSSFSheet	sheet
protected short	whiteIndex
protected HSSFWorkbook	workbook
static java.lang.String	XLS_EXPORTER_KEY The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).

Fields inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractExporter

autoFilterEnd, autoFilterStart, cellHidden, cellLocked, columnWidthRatio, createCustomPalette, defaultFont, fontMap, formatPatternsMap, gridColumnFreezeIndex, gridRowFreezeIndex, isCollapseRowSpan, isDetectCellType, isFontSizeFixEnabled, isFreezeColumnEdge, isFreezeRowEdge, isIgnoreCellBackground, isIgnoreCellBorder, isIgnoreGraphics, isIgnorePageMargins, isImageBorderFixEnabled, isOnePagePerSheet, isRemoveEmptySpaceBetweenColumns, isRemoveEmptySpaceBetweenRows, isWhitePageBackground, loadedFonts, MAX_COLUMN_INDEX, MAX_ROW_INDEX, maxColumnFreezeIndex, maxRowFreezeIndex, maxRowsPerSheet, pageIndex, progressMonitor, PROPERTY_AUTO_FILTER, PROPERTY_AUTO_FIT_COLUMN, PROPERTY_AUTO_FIT_ROW, PROPERTY_CELL_FORMULA, PROPERTY_CELL_HIDDEN, PROPERTY_CELL_LOCKED, PROPERTY_CELL_PATTERN, PROPERTY_COLUMN_WIDTH, PROPERTY_COLUMN_WIDTH_RATIO, PROPERTY_FIT_HEIGHT, PROPERTY_FIT_WIDTH, PROPERTY_FREEZE_COLUMN, PROPERTY_FREEZE_COLUMN_EDGE, PROPERTY_FREEZE_ROW, PROPERTY_FREEZE_ROW_EDGE, PROPERTY_ROW_OUTLINE_LEVEL_PREFIX, PROPERTY_SHEET_DIRECTION, PROPERTY_SHEET_FOOTER_CENTER, PROPERTY_SHEET_FOOTER_LEFT, PROPERTY_SHEET_FOOTER_RIGHT, PROPERTY_SHEET_HEADER_CENTER, PROPERTY_SHEET_HEADER_LEFT, PROPERTY_SHEET_HEADER_RIGHT, PROPERTY_WRAP_TEXT, reportIndex, sheetDirection, sheetFooterCenter, sheetFooterLeft, sheetFooterRight, sheetHeaderCenter, sheetHeaderLeft, sheetHeaderRight, sheetIndex, sheetNames, sheetNamesIndex, sheetNamesMap, wrapText, XLS_EXPORTER_PROPERTIES_PREFIX

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

dateFormatCache, endPageIndex, filter, globalOffsetX, globalOffsetY, hyperlinkProducerFactory, isModeBatch, jasperPrint, jasperPrintList, numberFormatCache, parameters, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex

Constructor Summary

Constructors

Constructor and Description
JRXlsExporter()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBlankCell(JRExporterGridCell gridCell, int colIndex, int rowIndex)
protected void	addOccupiedCell(OccupiedGridCell occupiedGridCell, int colIndex, int rowIndex)
protected void	closeWorkbook(java.io.OutputStream os)
protected void	createMergeRegion(JRExporterGridCell gridCell, int colIndex, int rowIndex, HSSFCellStyle cellStyle)
protected void	createSheet(java.lang.String name)
protected void	createTextCell(JRPrintText textElement, JRExporterGridCell gridCell, int colIndex, int rowIndex, JRStyledText styledText, net.sf.jasperreports.engine.export.StyleInfo baseStyle, short forecolor)
protected void	endCreateCell(HSSFCellStyle cellStyle)
protected void	exportFrame(JRPrintFrame frame, JRExporterGridCell gridCell, int x, int y)
protected void	exportGenericElement(JRGenericPrintElement element, JRExporterGridCell gridCell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout)
void	exportImage(JRPrintImage element, JRExporterGridCell gridCell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout)
protected void	exportLine(JRPrintLine line, JRExporterGridCell gridCell, int colIndex, int rowIndex)
protected void	exportRectangle(JRPrintGraphicElement element, JRExporterGridCell gridCell, int colIndex, int rowIndex)
void	exportText(JRPrintText textElement, JRExporterGridCell gridCell, int colIndex, int rowIndex)
protected static short	getBorderStyle(JRPen pen)
protected double	getColumnRelativePosition(JRGridLayout layout, int col, int offset)
protected java.lang.String	getExporterKey()
protected HSSFCellStyle	getLoadedCellStyle(short mode, short backcolor, short horizontalAlignment, short verticalAlignment, short rotation, HSSFFont font, net.sf.jasperreports.engine.export.BoxStyle box)
protected HSSFCellStyle	getLoadedCellStyle(short mode, short backcolor, short horizontalAlignment, short verticalAlignment, short rotation, HSSFFont font, net.sf.jasperreports.engine.export.BoxStyle box, boolean isCellLocked, boolean isCellHidden)
protected HSSFCellStyle	getLoadedCellStyle(short mode, short backcolor, short horizontalAlignment, short verticalAlignment, short rotation, HSSFFont font, JRExporterGridCell gridCell)
protected HSSFCellStyle	getLoadedCellStyle(short mode, short backcolor, short horizontalAlignment, short verticalAlignment, short rotation, HSSFFont font, JRExporterGridCell gridCell, boolean isCellLocked, boolean isCellHidden)
protected HSSFCellStyle	getLoadedCellStyle(net.sf.jasperreports.engine.export.StyleInfo style)
protected HSSFFont	getLoadedFont(JRFont font, short forecolor, java.util.Map<java.text.AttributedCharacterIterator.Attribute,java.lang.Object> attributes, java.util.Locale locale)
protected ExporterNature	getNature()
protected static HSSFColor	getNearestColor(java.awt.Color awtColor)
protected HSSFRichTextString	getRichTextString(JRStyledText styledText, short forecolor, JRFont defaultFont, java.util.Locale locale)
protected double	getRowRelativePosition(JRGridLayout layout, int row, int offset)
protected static HSSFColor	getWorkbookColor(java.awt.Color awtColor)
protected HSSFCellStyle	initCreateCell(JRExporterGridCell gridCell, int colIndex, int rowIndex, net.sf.jasperreports.engine.export.StyleInfo baseStyle)
protected void	openWorkbook(java.io.OutputStream os)
protected void	removeColumn(int colIndex)
protected void	setAutoFilter(java.lang.String autoFilterRange)
protected void	setBackground()
protected void	setCell(JRExporterGridCell gridCell, int colIndex, int rowIndex)
protected void	setColumnWidth(int col, int width, boolean autoFit)
protected void	setFreezePane(int rowIndex, int colIndex, boolean isRowEdge, boolean isColumnEdge) Creates a freeze pane for the current sheet.
protected void	setHyperlinkCell(JRPrintHyperlink hyperlink)
protected void	setParameters()
protected void	setRichTextStringCellValue(JRStyledText styledText, short forecolor, JRFont defaultFont, java.util.Locale locale)
protected void	setRowHeight(int rowIndex, int lastRowHeight, Cut yCut, XlsRowLevelInfo levelInfo)
protected void	setRowLevels(XlsRowLevelInfo levelInfo, java.lang.String level)
protected void	setSheetName(java.lang.String sheetName)
protected void	setStringCellValue(java.lang.String textStr)
protected void	updateColumn(int col, boolean autoFit)

Methods inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractExporter

calculateHeightForDinAN, calculateHeightForDinBN, calculateHeightForDinCN, calculateWidthForDinAN, calculateWidthForDinBN, calculateWidthForDinCN, exportPage, exportReport, exportReportToStream, getColumnIndex, getColumnName, getConvertedPattern, getDefaultFont, getFormula, getImageBorderCorrection, getStyledText, getTextAlignHolder, isCellHidden, isCellLocked, isWrapText, mergeAndSetRowLevels, resetAutoFilters, setColumnWidths, setExporterHints, setFreezePane, setSheetNames, updateColumns

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

createFilter, defaultParseNumber, getBooleanCellValue, getBooleanParameter, getCharacterParameter, getCustomHandler, getDateCellValue, getDateFormat, getFloatParameter, getHyperlinkProducer, getIntegerParameter, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getParameter, getParameterResolver, getParameters, getReportContext, getStringArrayParameter, getStringParameter, getStringParameterOrDefault, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, reset, resetClassLoader, resetExportContext, restoreElementOffsets, setClassLoader, setExportContext, setFrameElementsOffset, setHyperlinkProducerFactory, setInput, setJasperPrint, setOffset, setOffset, setOutput, setPageRange, 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_KEY

public static final java.lang.String XLS_EXPORTER_KEY

The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).

See Also:

Constant Field Values

loadedCellStyles

protected java.util.Map<net.sf.jasperreports.engine.export.StyleInfo,HSSFCellStyle> loadedCellStyles

anchorLinks

protected java.util.Map<java.lang.String,java.util.List<Hyperlink>> anchorLinks

pageLinks

protected java.util.Map<java.lang.Integer,java.util.List<Hyperlink>> pageLinks

anchorNames

protected java.util.Map<java.lang.String,HSSFName> anchorNames

workbook

protected HSSFWorkbook workbook

sheet

protected HSSFSheet sheet

row

protected HSSFRow row

cell

protected HSSFCell cell

emptyCellStyle

protected HSSFCellStyle emptyCellStyle

createHelper

protected CreationHelper createHelper

whiteIndex

protected short whiteIndex

blackIndex

protected short blackIndex

backgroundMode

protected short backgroundMode

dataFormat

protected HSSFDataFormat dataFormat

nature

protected ExporterNature nature

patriarch

protected HSSFPatriarch patriarch

password

protected java.lang.String password

exporterContext

protected JRXlsExporterContext exporterContext

Constructor Detail

JRXlsExporter

public JRXlsExporter()

Method Detail

setParameters

protected void setParameters()

Overrides:

setParameters in class JRXlsAbstractExporter

setBackground

protected void setBackground()

Specified by:

setBackground in class JRXlsAbstractExporter

openWorkbook

protected void openWorkbook(java.io.OutputStream os)

Specified by:

openWorkbook in class JRXlsAbstractExporter

createSheet

protected void createSheet(java.lang.String name)

Specified by:

createSheet in class JRXlsAbstractExporter

closeWorkbook

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

Specified by:

closeWorkbook in class JRXlsAbstractExporter

Throws:

JRException

setColumnWidth

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

Specified by:

setColumnWidth in class JRXlsAbstractExporter

updateColumn

protected void updateColumn(int col,
                boolean autoFit)

Specified by:

updateColumn in class JRXlsAbstractExporter

setRowHeight

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

Specified by:

setRowHeight in class JRXlsAbstractExporter

setCell

protected void setCell(JRExporterGridCell gridCell,
           int colIndex,
           int rowIndex)

Specified by:

setCell in class JRXlsAbstractExporter

removeColumn

protected void removeColumn(int colIndex)

Specified by:

removeColumn in class JRXlsAbstractExporter

addBlankCell

protected void addBlankCell(JRExporterGridCell gridCell,
                int colIndex,
                int rowIndex)

Specified by:

addBlankCell in class JRXlsAbstractExporter

addOccupiedCell

protected void addOccupiedCell(OccupiedGridCell occupiedGridCell,
                   int colIndex,
                   int rowIndex)

Specified by:

addOccupiedCell in class JRXlsAbstractExporter

exportLine

protected void exportLine(JRPrintLine line,
              JRExporterGridCell gridCell,
              int colIndex,
              int rowIndex)

Specified by:

exportLine in class JRXlsAbstractExporter

exportRectangle

protected void exportRectangle(JRPrintGraphicElement element,
                   JRExporterGridCell gridCell,
                   int colIndex,
                   int rowIndex)

Specified by:

exportRectangle in class JRXlsAbstractExporter

exportText

public void exportText(JRPrintText textElement,
              JRExporterGridCell gridCell,
              int colIndex,
              int rowIndex)
                throws JRException

Specified by:

exportText in class JRXlsAbstractExporter

Throws:

JRException

createTextCell

protected void createTextCell(JRPrintText textElement,
                  JRExporterGridCell gridCell,
                  int colIndex,
                  int rowIndex,
                  JRStyledText styledText,
                  net.sf.jasperreports.engine.export.StyleInfo baseStyle,
                  short forecolor)
                       throws JRException

Throws:

JRException

initCreateCell

protected HSSFCellStyle initCreateCell(JRExporterGridCell gridCell,
                           int colIndex,
                           int rowIndex,
                           net.sf.jasperreports.engine.export.StyleInfo baseStyle)

endCreateCell

protected void endCreateCell(HSSFCellStyle cellStyle)

setStringCellValue

protected final void setStringCellValue(java.lang.String textStr)

setRichTextStringCellValue

protected final void setRichTextStringCellValue(JRStyledText styledText,
                              short forecolor,
                              JRFont defaultFont,
                              java.util.Locale locale)

getRichTextString

protected HSSFRichTextString getRichTextString(JRStyledText styledText,
                                   short forecolor,
                                   JRFont defaultFont,
                                   java.util.Locale locale)

createMergeRegion

protected void createMergeRegion(JRExporterGridCell gridCell,
                     int colIndex,
                     int rowIndex,
                     HSSFCellStyle cellStyle)

getWorkbookColor

protected static HSSFColor getWorkbookColor(java.awt.Color awtColor)

getNearestColor

protected static HSSFColor getNearestColor(java.awt.Color awtColor)

getLoadedFont

protected HSSFFont getLoadedFont(JRFont font,
                     short forecolor,
                     java.util.Map<java.text.AttributedCharacterIterator.Attribute,java.lang.Object> attributes,
                     java.util.Locale locale)

getLoadedCellStyle

protected HSSFCellStyle getLoadedCellStyle(net.sf.jasperreports.engine.export.StyleInfo style)

getLoadedCellStyle

protected HSSFCellStyle getLoadedCellStyle(short mode,
                               short backcolor,
                               short horizontalAlignment,
                               short verticalAlignment,
                               short rotation,
                               HSSFFont font,
                               JRExporterGridCell gridCell)

getLoadedCellStyle

protected HSSFCellStyle getLoadedCellStyle(short mode,
                               short backcolor,
                               short horizontalAlignment,
                               short verticalAlignment,
                               short rotation,
                               HSSFFont font,
                               JRExporterGridCell gridCell,
                               boolean isCellLocked,
                               boolean isCellHidden)

getLoadedCellStyle

protected HSSFCellStyle getLoadedCellStyle(short mode,
                               short backcolor,
                               short horizontalAlignment,
                               short verticalAlignment,
                               short rotation,
                               HSSFFont font,
                               net.sf.jasperreports.engine.export.BoxStyle box)

getLoadedCellStyle

protected HSSFCellStyle getLoadedCellStyle(short mode,
                               short backcolor,
                               short horizontalAlignment,
                               short verticalAlignment,
                               short rotation,
                               HSSFFont font,
                               net.sf.jasperreports.engine.export.BoxStyle box,
                               boolean isCellLocked,
                               boolean isCellHidden)

getBorderStyle

protected static short getBorderStyle(JRPen pen)

exportImage

public void exportImage(JRPrintImage element,
               JRExporterGridCell gridCell,
               int colIndex,
               int rowIndex,
               int emptyCols,
               int yCutsRow,
               JRGridLayout layout)
                 throws JRException

Specified by:

exportImage in class JRXlsAbstractExporter

Throws:

JRException

getColumnRelativePosition

protected double getColumnRelativePosition(JRGridLayout layout,
                               int col,
                               int offset)

getRowRelativePosition

protected double getRowRelativePosition(JRGridLayout layout,
                            int row,
                            int offset)

exportFrame

protected void exportFrame(JRPrintFrame frame,
               JRExporterGridCell gridCell,
               int x,
               int y)

Specified by:

exportFrame in class JRXlsAbstractExporter

exportGenericElement

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

Specified by:

exportGenericElement in class JRXlsAbstractExporter

Throws:

JRException

getNature

protected ExporterNature getNature()

Specified by:

getNature in class JRXlsAbstractExporter

setHyperlinkCell

protected void setHyperlinkCell(JRPrintHyperlink hyperlink)

getExporterKey

protected java.lang.String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter

setFreezePane

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

Creates a freeze pane for the current sheet. Freeze pane row and column indexes defined at element level override indexes defined at report level. If multiple row freeze indexes are found in the same sheet, their maximum value is considered.

Specified by:

setFreezePane in class JRXlsAbstractExporter

Parameters:

rowIndex - the freeze 0-based row index

colIndex - the freeze 0-based column index

isRowEdge - specifies if the freeze row index is set at element level

isColumnEdge - specifies if the freeze column index is set at element level

setSheetName

protected void setSheetName(java.lang.String sheetName)

Specified by:

setSheetName in class JRXlsAbstractExporter

setAutoFilter

protected void setAutoFilter(java.lang.String autoFilterRange)

Specified by:

setAutoFilter in class JRXlsAbstractExporter

setRowLevels

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

Specified by:

setRowLevels in class JRXlsAbstractExporter