Package net.sf.jasperreports.poi.export
Class JRXlsMetadataExporter
java.lang.Object
net.sf.jasperreports.engine.JRAbstractExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration,OutputStreamExporterOutput,JRXlsExporterContext>
net.sf.jasperreports.engine.export.ExcelAbstractExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration,JRXlsExporterContext>
net.sf.jasperreports.engine.export.JRXlsAbstractExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration,JRXlsExporterContext>
net.sf.jasperreports.engine.export.JRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration,JRXlsExporterContext>
net.sf.jasperreports.poi.export.JRXlsMetadataExporter
- All Implemented Interfaces:
Exporter<ExporterInput,XlsMetadataReportConfiguration, XlsMetadataExporterConfiguration, OutputStreamExporterOutput>
public class JRXlsMetadataExporter
extends JRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration,JRXlsExporterContext>
- Author:
- Sanda Zaharia (shertage@users.sourceforge.net)
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classprotected classprotected 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 static final Stringprotected org.apache.poi.hssf.usermodel.HSSFCellStyleprotected final DateFormatprotected Map<JRXlsMetadataExporter.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.JRXlsAbstractMetadataExporter
columnNames, columnNamesMap, currentRow, hasDefinedColumns, repeatedValues, rowIndexFields 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(org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle, Map<String, Object> cellValueMap, String currentColumnName) protected voidaddBlankElement(org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle, boolean repeatValue, String currentColumnName) protected voidaddCell(JRXlsMetadataExporter.CellSettings cellSettings, Map<String, Object> cellValueMap, String currentColumnName) protected voidaddRowBreak(int rowIndex) protected voidaddTextElement(JRXlsMetadataExporter.CellSettings cellSettings, String textStr, boolean repeatValue, String currentColumnName) protected voidadjustColumnWidth(String columnName, int columnWidth, Boolean columnAutofit) protected voidadjustRowHeight(int rowHeight, Boolean isAutofit) protected voidprotected voidprotected voidcreateSheet(CutsInfo xCuts, JRXlsAbstractExporter.SheetInfo sheetInfo) protected voidcreateSheet(JRXlsAbstractExporter.SheetInfo sheetInfo) protected voidexportFrame(JRPrintFrame frame) protected voidvoidexportImage(JRPrintImage element) protected voidexportLine(JRPrintLine line) protected voidexportRectangle(JRPrintGraphicElement element) protected voidexportText(JRPrintText textElement) protected static org.apache.poi.ss.usermodel.BorderStylegetBorderStyle(JRPen pen) protected Class<XlsMetadataExporterConfiguration> Returns the properties prefix for the current exporter.protected Class<XlsMetadataReportConfiguration> 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, JRXlsMetadataExporter.BoxStyle box, 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 ExporterNatureprotected static org.apache.poi.hssf.util.HSSFColorgetNearestColor(Color awtColor) protected org.apache.poi.hssf.usermodel.HSSFRichTextStringgetRichTextString(JRStyledText styledText, short forecolor, JRFont defaultFont, Locale locale) protected org.apache.poi.hssf.util.HSSFColorgetWorkbookColor(Color awtColor) protected voidprotected voidprotected voidprotected voidsetAutoFilter(String autoFilterRange) protected voidsetColumnName(String currentColumnName) protected voidsetColumnWidth(int col, int width) protected voidsetColumnWidth(int col, int width, boolean autoFit) protected voidsetFreezePane(int rowIndex, int colIndex) protected voidsetHyperlinkCell(JRPrintHyperlink hyperlink, JRXlsMetadataExporter.CellSettings cellSettings) protected voidsetRowHeight(int rowIndex, int lastRowHeight, Cut yCut, XlsRowLevelInfo levelInfo) protected voidsetRowHeight(org.apache.poi.hssf.usermodel.HSSFRow row) protected voidsetRowLevels(XlsRowLevelInfo levelInfo, String level) protected voidsetSheetName(String sheetName) protected voidupdateSheet(JRPrintElement element) protected voidprotected voidWrites the header column namesMethods inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractMetadataExporter
addBlankCell, addOccupiedCell, exportFrame, exportGenericElement, exportImage, exportLine, exportPage, exportRectangle, exportReportToStream, exportText, getFormula, getImageBorderCorrection, getSheetName, getStyledText, isColumnReadOnTime, setColumnNames, setRowHeightMethods inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractExporter
configureHeaderFooter, configurePrintSettings, exportEmptyReport, exportPage, 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, getMaxRowsPerSheet, getSheetName, 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 -
isoDateFormat
-
loadedCellStyles
protected Map<JRXlsMetadataExporter.StyleInfo,org.apache.poi.hssf.usermodel.HSSFCellStyle> loadedCellStyles -
anchorLinks
-
pageLinks
-
anchorNames
-
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 -
columnStylesMap
-
columnWidths
-
columnWidthRatios
-
formulaCellsMap
-
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 -
EMPTY_SHEET_NAME
- See Also:
-
-
Constructor Details
-
JRXlsMetadataExporter
public JRXlsMetadataExporter()- See Also:
-
JRXlsMetadataExporter
-
-
Method Details
-
getConfigurationInterface
-
getItemConfigurationInterface
-
initExport
protected void initExport() -
initReport
protected void initReport() -
openWorkbook
- Specified by:
openWorkbookin classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
createSheet
-
closeSheet
protected void closeSheet() -
closeWorkbook
- Specified by:
closeWorkbookin classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
setColumnWidth
protected void setColumnWidth(int col, int width) -
setRowHeight
protected void setRowHeight(org.apache.poi.hssf.usermodel.HSSFRow row) -
adjustRowHeight
-
adjustColumnWidth
-
addBlankCell
protected void addBlankCell(org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle, Map<String, Object> cellValueMap, String currentColumnName) throws JRException- Throws:
JRException
-
writeCurrentRow
protected void writeCurrentRow(Map<String, Object> currentRow, Map<String, throws JRExceptionObject> repeatedValues) - Specified by:
writeCurrentRowin classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
exportLine
- Specified by:
exportLinein classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
exportRectangle
- Specified by:
exportRectanglein classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
exportText
- Specified by:
exportTextin classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
setHyperlinkCell
protected void setHyperlinkCell(JRPrintHyperlink hyperlink, JRXlsMetadataExporter.CellSettings cellSettings) -
addTextElement
protected void addTextElement(JRXlsMetadataExporter.CellSettings cellSettings, String textStr, boolean repeatValue, String currentColumnName) throws JRException - Throws:
JRException
-
addBlankElement
protected void addBlankElement(org.apache.poi.hssf.usermodel.HSSFCellStyle cellStyle, boolean repeatValue, String currentColumnName) throws JRException - Throws:
JRException
-
addCell
protected void addCell(JRXlsMetadataExporter.CellSettings cellSettings, Map<String, Object> cellValueMap, String currentColumnName) throws JRException- Throws:
JRException
-
getRichTextString
protected org.apache.poi.hssf.usermodel.HSSFRichTextString getRichTextString(JRStyledText styledText, short forecolor, JRFont defaultFont, Locale locale) -
exportImage
- Specified by:
exportImagein classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
getLoadedCellStyle
protected org.apache.poi.hssf.usermodel.HSSFCellStyle getLoadedCellStyle(JRXlsMetadataExporter.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, JRXlsMetadataExporter.BoxStyle box, boolean isCellLocked, boolean isCellHidden, boolean isShrinkToFit) -
getBorderStyle
-
exportFrame
- Specified by:
exportFramein classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
exportGenericElement
- Specified by:
exportGenericElementin classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
getNature
-
getExporterKey
-
getExporterPropertiesPrefix
Description copied from class:JRAbstractExporterReturns the properties prefix for the current exporter.- Specified by:
getExporterPropertiesPrefixin classJRAbstractExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, OutputStreamExporterOutput, JRXlsExporterContext> - Returns:
- the properties prefix for the current exporter
-
setColumnName
-
writeReportHeader
Writes the header column names- Specified by:
writeReportHeaderin classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
setSheetName
-
setFreezePane
protected void setFreezePane(int rowIndex, int colIndex) -
setAutoFilter
-
setRowLevels
-
getWorkbookColor
-
getNearestColor
-
getLoadedFont
protected org.apache.poi.hssf.usermodel.HSSFFont getLoadedFont(JRFont font, short forecolor, Map<AttributedCharacterIterator.Attribute, Object> attributes, Locale locale) -
createSheet
-
setRowHeight
protected void setRowHeight(int rowIndex, int lastRowHeight, Cut yCut, XlsRowLevelInfo levelInfo) throws JRException - Specified by:
setRowHeightin classJRXlsAbstractMetadataExporter<XlsMetadataReportConfiguration,XlsMetadataExporterConfiguration, JRXlsExporterContext> - Throws:
JRException
-
addRowBreak
protected void addRowBreak(int rowIndex) -
setColumnWidth
protected void setColumnWidth(int col, int width, boolean autoFit) -
updateSheet
-