net.sf.jasperreports.engine.export

Class JRXlsAbstractExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter

net.sf.jasperreports.engine.export.JRXlsAbstractExporter

All Implemented Interfaces:

JRExporter

Direct Known Subclasses:

JExcelApiExporter, JRXlsExporter, JRXlsxExporter

public abstract class JRXlsAbstractExporter
extends JRAbstractExporter

Version:

$Id: JRXlsAbstractExporter.java 3842 2010-06-01 10:35:17Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	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.lang.String	currentSheetName
protected JRFont	defaultFont
protected java.util.Map	fontMap Deprecated.
protected boolean	isAutoDetectCellType
protected boolean	isCollapseRowSpan
protected boolean	isDetectCellType
protected boolean	isFontSizeFixEnabled
protected boolean	isIgnoreCellBackground
protected boolean	isIgnoreCellBorder
protected boolean	isIgnoreGraphics
protected boolean	isIgnorePageMargins
protected boolean	isImageBorderFixEnabled
protected boolean	isOnePagePerSheet
protected boolean	isRemoveEmptySpaceBetweenColumns
protected boolean	isRemoveEmptySpaceBetweenRows
protected boolean	isWhitePageBackground
protected java.util.List	loadedFonts
protected int	maxRowsPerSheet
protected int	pageIndex
protected JRExportProgressMonitor	progressMonitor
protected int	reportIndex
protected int	sheetIndex used for counting the total number of sheets
protected java.lang.String[]	sheetNames
protected java.util.Map	sheetNamesMap used when indexing the identical sheet generated names with ordering numbers; contains sheet names as keys and the number of occurrences of each sheet name as values
protected static java.lang.String	XLS_EXPORTER_PROPERTIES_PREFIX

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

classLoader, classLoaderSet, dateFormatCache, endPageIndex, fileResolver, fileResolverSet, filter, globalOffsetX, globalOffsetY, hyperlinkProducerFactory, isModeBatch, jasperPrint, jasperPrintList, numberFormatCache, parameters, PROPERTY_CELL_FORMULA, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex, urlHandlerFactory, urlHandlerFactorySet

Constructor Summary

Constructors

Constructor and Description
JRXlsAbstractExporter()

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(java.lang.String name)
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)
protected abstract void	exportImage(JRPrintImage image, JRExporterGridCell cell, int colIndex, int rowIndex, int emptyCols)
protected abstract void	exportLine(JRPrintLine line, JRExporterGridCell cell, int colIndex, int rowIndex)
protected int	exportPage(JRPrintPage page, CutsInfo xCuts, int startRow)
protected abstract void	exportRectangle(JRPrintGraphicElement element, JRExporterGridCell cell, int colIndex, int rowIndex)
void	exportReport() Actually starts the export process.
protected void	exportReportToStream(java.io.OutputStream os)
protected abstract void	exportText(JRPrintText text, JRExporterGridCell cell, int colIndex, int rowIndex)
protected JRFont	getDefaultFont()
protected int	getImageBorderCorrection(JRPen pen)
protected abstract ExporterNature	getNature()
protected JRStyledText	getStyledText(JRPrintText textElement)
protected static JRXlsAbstractExporter.TextAlignHolder	getTextAlignHolder(JRPrintText textElement)
protected abstract void	openWorkbook(java.io.OutputStream os)
protected abstract void	removeColumn(int col)
protected void	removeEmptyColumns(CutsInfo xCuts)
protected abstract void	setBackground()
protected abstract void	setCell(JRExporterGridCell gridCell, int colIndex, int rowIndex)
protected abstract void	setColumnWidth(int col, int width)
protected void	setColumnWidths(CutsInfo xCuts)
protected void	setParameters()
protected abstract void	setRowHeight(int rowIndex, int lastRowHeight)

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

createFilter, defaultParseNumber, getBooleanCellValue, getBooleanParameter, getCharacterParameter, getCustomHandler, getDateCellValue, getDateFormat, getExporterKey, getFloatParameter, getHyperlinkProducer, getIntegerParameter, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getParameter, getParameterResolver, getParameters, 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

Methods inherited from class java.lang.Object

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

Field Detail

XLS_EXPORTER_PROPERTIES_PREFIX

protected static final java.lang.String XLS_EXPORTER_PROPERTIES_PREFIX

See Also:

Constant Field Values

loadedFonts

protected java.util.List loadedFonts

isOnePagePerSheet

protected boolean isOnePagePerSheet

isRemoveEmptySpaceBetweenRows

protected boolean isRemoveEmptySpaceBetweenRows

isRemoveEmptySpaceBetweenColumns

protected boolean isRemoveEmptySpaceBetweenColumns

isWhitePageBackground

protected boolean isWhitePageBackground

isAutoDetectCellType

protected boolean isAutoDetectCellType

isDetectCellType

protected boolean isDetectCellType

isFontSizeFixEnabled

protected boolean isFontSizeFixEnabled

isImageBorderFixEnabled

protected boolean isImageBorderFixEnabled

isIgnoreGraphics

protected boolean isIgnoreGraphics

isCollapseRowSpan

protected boolean isCollapseRowSpan

isIgnoreCellBorder

protected boolean isIgnoreCellBorder

isIgnoreCellBackground

protected boolean isIgnoreCellBackground

maxRowsPerSheet

protected int maxRowsPerSheet

sheetNames

protected java.lang.String[] sheetNames

progressMonitor

protected JRExportProgressMonitor progressMonitor

reportIndex

protected int reportIndex

pageIndex

protected int pageIndex

fontMap

protected java.util.Map fontMap

Deprecated.

defaultFont

protected JRFont defaultFont

sheetIndex

protected int sheetIndex

used for counting the total number of sheets

sheetNamesMap

protected java.util.Map sheetNamesMap

used when indexing the identical sheet generated names with ordering numbers; contains sheet names as keys and the number of occurrences of each sheet name as values

currentSheetName

protected java.lang.String currentSheetName

isIgnorePageMargins

protected boolean isIgnorePageMargins

Constructor Detail

JRXlsAbstractExporter

public JRXlsAbstractExporter()

Method Detail

getDefaultFont

protected JRFont getDefaultFont()

exportReport

public void exportReport()
                  throws JRException

Description copied from interface: JRExporter

Actually starts the export process.

Specified by:

exportReport in interface JRExporter

Specified by:

exportReport in class JRAbstractExporter

Throws:

JRException

setParameters

protected void setParameters()

setBackground

protected abstract void setBackground()

exportReportToStream

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

Throws:

JRException

exportPage

protected int exportPage(JRPrintPage page,
             CutsInfo xCuts,
             int startRow)
                  throws JRException

Returns:

the number of rows added.

Throws:

JRException

setColumnWidths

protected void setColumnWidths(CutsInfo xCuts)

removeEmptyColumns

protected void removeEmptyColumns(CutsInfo xCuts)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement)

Overrides:

getStyledText in class JRAbstractExporter

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)

getNature

protected abstract ExporterNature getNature()

openWorkbook

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

Throws:

JRException

createSheet

protected abstract void createSheet(java.lang.String name)

closeWorkbook

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

Throws:

JRException

setColumnWidth

protected abstract void setColumnWidth(int col,
                  int width)

removeColumn

protected abstract void removeColumn(int col)

setRowHeight

protected abstract void setRowHeight(int rowIndex,
                int lastRowHeight)
                              throws JRException

Throws:

JRException

setCell

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

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)
                             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)
                                      throws JRException

Throws:

JRException