Package net.sf.jasperreports.poi.export
Class JRXlsExporter
java.lang.Object
- All Implemented Interfaces:
Exporter<ExporterInput,XlsReportConfiguration, XlsExporterConfiguration, OutputStreamExporterOutput>
public class JRXlsExporter
extends JRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration,JRXlsExporterContext>
Exports a JasperReports document to XLS format. It has binary output type and exports the document to
a grid-based layout.
- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classprotected classNested classes/interfaces inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractExporter
JRXlsAbstractExporter.SheetInfoNested classes/interfaces inherited from class net.sf.jasperreports.engine.export.ExcelAbstractExporter
ExcelAbstractExporter.NameScope, ExcelAbstractExporter.TextAlignHolderNested classes/interfaces inherited from class net.sf.jasperreports.engine.JRAbstractExporter
JRAbstractExporter.BaseExporterContext, JRAbstractExporter.PageRange -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.apache.poi.ss.usermodel.FillPatternTypeprotected shortprotected org.apache.poi.hssf.usermodel.HSSFCellprotected org.apache.poi.ss.usermodel.CreationHelperprotected shortprotected org.apache.poi.hssf.usermodel.HSSFDataFormatprotected org.apache.poi.hssf.usermodel.HSSFCellStyleprotected Map<JRXlsExporter.StyleInfo, org.apache.poi.hssf.usermodel.HSSFCellStyle> static shortstatic shortprotected org.apache.poi.hssf.usermodel.HSSFPatriarchprotected org.apache.poi.hssf.usermodel.HSSFRowprotected org.apache.poi.hssf.usermodel.HSSFSheetprotected shortprotected org.apache.poi.hssf.usermodel.HSSFWorkbookstatic final StringThe exporter key, as used inGenericElementHandlerEnviroment.getElementHandler(JRGenericElementType, String).Fields inherited from class net.sf.jasperreports.engine.export.ExcelAbstractExporter
autoFilterEnd, autoFilterStart, collapseRowSpan, CURRENT_ROW_AUTOFIT, CURRENT_ROW_HEIGHT, DEFAULT_DEFINED_NAME_SCOPE, DEFAULT_DEFINED_NAME_SCOPE_SEPARATOR, DEFAULT_SHEET_NAME_PREFIX, defaultCellHidden, defaultCellLocked, defaultFont, defaultIgnoreHyperlink, defaultIgnoreTextFormatting, defaultImageAnchorType, defaultShrinkToFit, defaultUseTimeZone, defaultWrapText, definedNamesMap, detectCellType, EXCEPTION_MESSAGE_KEY_CANNOT_ADD_CELL, EXCEPTION_MESSAGE_KEY_CANNOT_MERGE_CELLS, EXCEPTION_MESSAGE_KEY_CELL_FORMAT_TEMPLATE_ERROR, EXCEPTION_MESSAGE_KEY_COLUMN_INDEX_BEYOND_LIMIT, EXCEPTION_MESSAGE_KEY_LOADED_FONTS_ERROR, EXCEPTION_MESSAGE_KEY_NEGATIVE_COLUMN_INDEX, EXCEPTION_MESSAGE_KEY_REPORT_GENERATION_ERROR, EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND, firstPageNotSet, formatPatternsMap, ignoreAnchors, imageBorderFixEnabled, invalidCharReplacement, keepTemplateSheets, loadedFonts, maxColumnIndex, nature, onePagePerSheet, onePagePerSheetMap, pageFormat, pageIndex, PROPERTY_AUTO_FILTER, PROPERTY_AUTO_FIT_COLUMN, PROPERTY_AUTO_FIT_ROW, PROPERTY_AVERAGE_CHAR_WIDTH_FACTOR, PROPERTY_BREAK_AFTER_ROW, PROPERTY_BREAK_BEFORE_ROW, PROPERTY_CELL_FORMULA, PROPERTY_CELL_PATTERN, PROPERTY_COLUMN_NAME, PROPERTY_COLUMN_WIDTH, PROPERTY_COLUMN_WIDTH_METADATA, PROPERTY_DATA, PROPERTY_FREEZE_COLUMN_EDGE, PROPERTY_FREEZE_ROW_EDGE, PROPERTY_IGNORE_ROW_HEIGHT, PROPERTY_REPEAT_VALUE, PROPERTY_ROW_OUTLINE_LEVEL_PREFIX, PROPERTY_SHEET_NAME, renderersCache, reportIndex, sheetIndex, sheetInfo, sheetNames, sheetNamesIndex, sheetNamesMap, sheetsBeforeCurrentReport, sheetsBeforeCurrentReportMap, workbookTemplate, XLS_EXPORTER_PROPERTIES_PREFIXFields inherited from class net.sf.jasperreports.engine.JRAbstractExporter
allSelector, crtCompositeConfiguration, crtCompositeItemConfiguration, crtItem, dateFormatCache, EXCEPTION_MESSAGE_KEY_EMPTY_INPUT_SOURCE_IN_BATCH_MODE, EXCEPTION_MESSAGE_KEY_END_PAGE_INDEX_OUT_OF_RANGE, EXCEPTION_MESSAGE_KEY_INVALID_IMAGE_NAME, EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO, EXCEPTION_MESSAGE_KEY_NO_INPUT_SOURCE, EXCEPTION_MESSAGE_KEY_NO_OUTPUT_SPECIFIED, EXCEPTION_MESSAGE_KEY_OUTPUT_WRITER_ERROR, EXCEPTION_MESSAGE_KEY_PAGE_INDEX_OUT_OF_RANGE, EXCEPTION_MESSAGE_KEY_START_PAGE_INDEX_OUT_OF_RANGE, exporterConfiguration, exporterContext, exporterInput, exporterOutput, filter, fontUtil, hyperlinkProducerFactory, itemConfiguration, jasperPrint, jasperReportsContext, noBackcolorSelector, noneSelector, numberFormatCache, propertiesUtil, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, rendererUtil, styledTextUtil, textValueClasses -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddBlankCell(JRExporterGridCell gridCell, int colIndex, int rowIndex) protected voidaddOccupiedCell(OccupiedGridCell occupiedGridCell, int colIndex, int rowIndex) protected voidaddRowBreak(int rowIndex) protected voidprotected voidprotected voidcreateMergeRegion(JRExporterGridCell gridCell, int colIndex, int rowIndex, org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle) protected voidcreateSheet(CutsInfo xCuts, JRXlsAbstractExporter.SheetInfo sheetInfo) protected voidcreateTextCell(JRPrintText textElement, JRExporterGridCell gridCell, int colIndex, int rowIndex, JRStyledText styledText, JRXlsExporter.StyleInfo baseStyle, short forecolor) protected voidendCreateCell(org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle) protected voidexportFrame(JRPrintFrame frame, JRExporterGridCell gridCell, int x, int y) protected voidexportGenericElement(JRGenericPrintElement element, JRExporterGridCell gridCell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout) voidexportImage(JRPrintImage element, JRExporterGridCell gridCell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout) protected voidexportLine(JRPrintLine line, JRExporterGridCell gridCell, int colIndex, int rowIndex) protected voidexportRectangle(JRPrintGraphicElement element, JRExporterGridCell gridCell, int colIndex, int rowIndex) voidexportText(JRPrintText textElement, JRExporterGridCell gridCell, int colIndex, int rowIndex) static org.apache.poi.ss.usermodel.ClientAnchor.AnchorTypegetAnchorType(ImageAnchorTypeEnum anchorType) protected static org.apache.poi.ss.usermodel.BorderStylegetBorderStyle(JRPen pen) protected doublegetColumnRelativePosition(JRGridLayout layout, int col, int offset) protected Class<XlsExporterConfiguration> Returns the properties prefix for the current exporter.protected Class<XlsReportConfiguration> protected org.apache.poi.hssf.usermodel.HSSFCellStyleprotected org.apache.poi.hssf.usermodel.HSSFCellStylegetLoadedCellStyle(org.apache.poi.ss.usermodel.FillPatternType mode, short backcolor, org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlignment, org.apache.poi.ss.usermodel.VerticalAlignment verticalAlignment, short rotation, org.apache.poi.hssf.usermodel.HSSFFont font, JRExporterGridCell gridCell, boolean isWrapText, boolean isCellLocked, boolean isCellHidden, boolean isShrinkToFit) protected org.apache.poi.hssf.usermodel.HSSFCellStylegetLoadedCellStyle(org.apache.poi.ss.usermodel.FillPatternType mode, short backcolor, org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlignment, org.apache.poi.ss.usermodel.VerticalAlignment verticalAlignment, short rotation, org.apache.poi.hssf.usermodel.HSSFFont font, net.sf.jasperreports.poi.export.JRXlsExporter.BoxStyle box, boolean isWrapText, boolean isCellLocked, boolean isCellHidden, boolean isShrinkToFit) protected org.apache.poi.hssf.usermodel.HSSFFontgetLoadedFont(JRFont font, short forecolor, Map<AttributedCharacterIterator.Attribute, Object> attributes, Locale locale) protected Integerprotected org.apache.poi.hssf.util.HSSFColorgetNearestColor(Color awtColor) protected org.apache.poi.hssf.usermodel.HSSFRichTextStringgetRichTextString(JRStyledText styledText, short forecolor, JRFont defaultFont, Locale locale) protected doublegetRowRelativePosition(JRGridLayout layout, int row, int offset) protected org.apache.poi.hssf.util.HSSFColorgetWorkbookColor(Color awtColor) protected org.apache.poi.hssf.usermodel.HSSFCellStyleinitCreateCell(JRExporterGridCell gridCell, int colIndex, int rowIndex, JRXlsExporter.StyleInfo baseStyle) protected voidprotected voidprotected voidprotected voidsetAutoFilter(String autoFilterRange) protected voidsetColumnWidth(int col, int width, boolean autoFit) protected voidsetFreezePane(int rowIndex, int colIndex) Creates a freeze pane for the current sheet.protected voidsetHyperlinkCell(JRPrintHyperlink hyperlink) protected final voidsetRichTextStringCellValue(JRStyledText styledText, short forecolor, JRFont defaultFont, Locale locale) protected voidsetRowHeight(int rowIndex, int lastRowHeight, Cut yCut, XlsRowLevelInfo levelInfo) protected voidsetRowLevels(XlsRowLevelInfo levelInfo, String level) protected voidsetSheetName(String sheetName) protected final voidsetStringCellValue(String textStr) Methods inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractExporter
configureHeaderFooter, configurePrintSettings, exportEmptyReport, exportPage, exportReportToStream, exportSheet, getSheetProps, setColumnWidthsMethods inherited from class net.sf.jasperreports.engine.export.ExcelAbstractExporter
calculateHeightForDinAN, calculateHeightForDinBN, calculateHeightForDinCN, calculateWidthForDinAN, calculateWidthForDinBN, calculateWidthForDinCN, configureDefinedNames, configureDefinedNames, configureDefinedNames, ensureInput, exportReport, getColumIndexName, getColumnIndex, getColumnName, getConvertedPattern, getDefaultFont, getFormula, getImageBorderCorrection, getNature, getSheetName, getSheetName, getStyledText, getTextAlignHolder, hasGlobalSheetNames, isCellHidden, isCellLocked, isIgnoreTextFormatting, isShrinkToFit, isUseTimeZone, isValidScale, isWrapText, mergeAndSetRowLevels, resetAutoFilters, setSheetNames, toExcelName, translateDateValue, updateHeaderFooter, updatePrintSettingsMethods inherited from class net.sf.jasperreports.engine.JRAbstractExporter
checkInterrupted, createFilter, defaultParseNumber, ensureJasperReportsContext, ensureOutput, getBooleanCellValue, getCurrentConfiguration, getCurrentItemConfiguration, getCurrentJasperPrint, getDateCellValue, getDateFormat, getExporterConfiguration, getExporterContext, getExporterInput, getExporterOutput, getHyperlinkProducer, getJasperReportsContext, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getPageRange, getPropertiesUtil, getRendererUtil, getReportContext, getReportExportConfiguration, getRepository, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, insideFrame, reset, resetExportContext, restoreElementOffsets, setConfiguration, setConfiguration, setCurrentExporterInputItem, setExporterInput, setExporterOutput, setFrameElementsOffset, setJasperReportsContext, setOffset, setOffset, setReportContext
-
Field Details
-
XLS_EXPORTER_KEY
The exporter key, as used inGenericElementHandlerEnviroment.getElementHandler(JRGenericElementType, String).- See Also:
-
MAX_COLOR_INDEX
public static short MAX_COLOR_INDEX -
MIN_COLOR_INDEX
public static short MIN_COLOR_INDEX -
loadedCellStyles
-
anchorLinks
-
pageLinks
-
anchorNames
-
autofitColumns
-
workbook
protected org.apache.poi.hssf.usermodel.HSSFWorkbook workbook -
sheet
protected org.apache.poi.hssf.usermodel.HSSFSheet sheet -
row
protected org.apache.poi.hssf.usermodel.HSSFRow row -
cell
protected org.apache.poi.hssf.usermodel.HSSFCell cell -
emptyCellStyle
protected org.apache.poi.hssf.usermodel.HSSFCellStyle emptyCellStyle -
createHelper
protected org.apache.poi.ss.usermodel.CreationHelper createHelper -
whiteIndex
protected short whiteIndex -
blackIndex
protected short blackIndex -
customColorIndex
protected short customColorIndex -
backgroundMode
protected org.apache.poi.ss.usermodel.FillPatternType backgroundMode -
dataFormat
protected org.apache.poi.hssf.usermodel.HSSFDataFormat dataFormat -
patriarch
protected org.apache.poi.hssf.usermodel.HSSFPatriarch patriarch -
formulaCellsMap
-
-
Constructor Details
-
JRXlsExporter
public JRXlsExporter()- See Also:
-
JRXlsExporter
-
-
Method Details
-
getConfigurationInterface
-
getItemConfigurationInterface
-
initExport
protected void initExport()- Overrides:
initExportin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
initReport
protected void initReport()- Overrides:
initReportin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
openWorkbook
- Specified by:
openWorkbookin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
createSheet
- Specified by:
createSheetin classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
closeSheet
protected void closeSheet()- Specified by:
closeSheetin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
closeWorkbook
- Specified by:
closeWorkbookin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
setColumnWidth
protected void setColumnWidth(int col, int width, boolean autoFit) - Specified by:
setColumnWidthin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
setRowHeight
- Specified by:
setRowHeightin classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
addRowBreak
protected void addRowBreak(int rowIndex) - Specified by:
addRowBreakin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
addBlankCell
- Specified by:
addBlankCellin classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
addOccupiedCell
- Specified by:
addOccupiedCellin classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
exportLine
protected void exportLine(JRPrintLine line, JRExporterGridCell gridCell, int colIndex, int rowIndex) - Specified by:
exportLinein classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
exportRectangle
protected void exportRectangle(JRPrintGraphicElement element, JRExporterGridCell gridCell, int colIndex, int rowIndex) - Specified by:
exportRectanglein classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
exportText
public void exportText(JRPrintText textElement, JRExporterGridCell gridCell, int colIndex, int rowIndex) throws JRException - Specified by:
exportTextin classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
createTextCell
protected void createTextCell(JRPrintText textElement, JRExporterGridCell gridCell, int colIndex, int rowIndex, JRStyledText styledText, JRXlsExporter.StyleInfo baseStyle, short forecolor) throws JRException - Throws:
JRException
-
initCreateCell
protected org.apache.poi.hssf.usermodel.HSSFCellStyle initCreateCell(JRExporterGridCell gridCell, int colIndex, int rowIndex, JRXlsExporter.StyleInfo baseStyle) -
endCreateCell
protected void endCreateCell(org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle) -
setStringCellValue
-
setRichTextStringCellValue
protected final void setRichTextStringCellValue(JRStyledText styledText, short forecolor, JRFont defaultFont, Locale locale) -
getRichTextString
protected org.apache.poi.hssf.usermodel.HSSFRichTextString getRichTextString(JRStyledText styledText, short forecolor, JRFont defaultFont, Locale locale) -
createMergeRegion
protected void createMergeRegion(JRExporterGridCell gridCell, int colIndex, int rowIndex, org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle) -
getWorkbookColor
-
getNearestColor
-
getLoadedFont
protected org.apache.poi.hssf.usermodel.HSSFFont getLoadedFont(JRFont font, short forecolor, Map<AttributedCharacterIterator.Attribute, Object> attributes, Locale locale) -
getLoadedCellStyle
protected org.apache.poi.hssf.usermodel.HSSFCellStyle getLoadedCellStyle(JRXlsExporter.StyleInfo style) -
getLoadedCellStyle
protected org.apache.poi.hssf.usermodel.HSSFCellStyle getLoadedCellStyle(org.apache.poi.ss.usermodel.FillPatternType mode, short backcolor, org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlignment, org.apache.poi.ss.usermodel.VerticalAlignment verticalAlignment, short rotation, org.apache.poi.hssf.usermodel.HSSFFont font, JRExporterGridCell gridCell, boolean isWrapText, boolean isCellLocked, boolean isCellHidden, boolean isShrinkToFit) -
getLoadedCellStyle
protected org.apache.poi.hssf.usermodel.HSSFCellStyle getLoadedCellStyle(org.apache.poi.ss.usermodel.FillPatternType mode, short backcolor, org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlignment, org.apache.poi.ss.usermodel.VerticalAlignment verticalAlignment, short rotation, org.apache.poi.hssf.usermodel.HSSFFont font, net.sf.jasperreports.poi.export.JRXlsExporter.BoxStyle box, boolean isWrapText, boolean isCellLocked, boolean isCellHidden, boolean isShrinkToFit) -
getBorderStyle
-
exportImage
public void exportImage(JRPrintImage element, JRExporterGridCell gridCell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout) throws JRException - Specified by:
exportImagein classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
getColumnRelativePosition
-
getRowRelativePosition
-
exportFrame
- Specified by:
exportFramein classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
exportGenericElement
protected void exportGenericElement(JRGenericPrintElement element, JRExporterGridCell gridCell, int colIndex, int rowIndex, int emptyCols, int yCutsRow, JRGridLayout layout) throws JRException - Specified by:
exportGenericElementin classJRXlsAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
setHyperlinkCell
-
getMaxRowsPerSheet
-
getExporterKey
-
getExporterPropertiesPrefix
Description copied from class:JRAbstractExporterReturns the properties prefix for the current exporter.- Specified by:
getExporterPropertiesPrefixin classJRAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, OutputStreamExporterOutput, JRXlsExporterContext> - Returns:
- the properties prefix for the current exporter
-
setFreezePane
protected void setFreezePane(int rowIndex, int colIndex) 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:
setFreezePanein classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext> - Parameters:
rowIndex- the freeze 0-based row indexcolIndex- the freeze 0-based column index
-
setSheetName
- Specified by:
setSheetNamein classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
setAutoFilter
- Specified by:
setAutoFilterin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
setRowLevels
- Specified by:
setRowLevelsin classExcelAbstractExporter<XlsReportConfiguration,XlsExporterConfiguration, JRXlsExporterContext>
-
getAnchorType
public static org.apache.poi.ss.usermodel.ClientAnchor.AnchorType getAnchorType(ImageAnchorTypeEnum anchorType)
-