net.sf.jasperreports.engine.export

Class HtmlExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter<RC,C,HtmlExporterOutput,JRHtmlExporterContext>

net.sf.jasperreports.engine.export.AbstractHtmlExporter<HtmlReportConfiguration,HtmlExporterConfiguration>

net.sf.jasperreports.engine.export.HtmlExporter

All Implemented Interfaces:

JRExporter<ExporterInput,HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput>, Exporter<ExporterInput,HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput>

public class HtmlExporter
extends AbstractHtmlExporter<HtmlReportConfiguration,HtmlExporterConfiguration>

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HtmlExporter.CellElementVisitor
protected class	HtmlExporter.ExporterContext
protected class	HtmlExporter.TableVisitor

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 LinkedList<Color>	backcolorStack
static String	HTML_EXPORTER_KEY The exporter key, as used in GenericElementHandlerEnviroment.getElementHandler(JRGenericElementType, String).
static String	HTML_EXPORTER_PROPERTIES_PREFIX
protected Map<Pair<String,Rectangle>,String>	imageMaps
protected int	pageIndex
protected int	pointerEventsNoneStack
static String	PROPERTY_BORDER_COLLAPSE Deprecated. Replaced by HtmlReportConfiguration.PROPERTY_BORDER_COLLAPSE.
static String	PROPERTY_HTML_CLASS Property that provides the value for the class CSS style property to be applied to elements in the table generated for the report.
static String	PROPERTY_HTML_ID
static String	PROPERTY_IGNORE_HYPERLINK Deprecated. Replaced by HtmlReportConfiguration.PROPERTY_IGNORE_HYPERLINK.
protected RenderersCache	renderersCache
protected Map<String,String>	rendererToImagePathMap
protected int	reportIndex
protected ExporterFilter	tableFilter
protected JRHyperlinkTargetProducerFactory	targetProducerFactory
protected Writer	writer

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

CSS_TEXT_ALIGN_CENTER, CSS_TEXT_ALIGN_JUSTIFY, CSS_TEXT_ALIGN_LEFT, CSS_TEXT_ALIGN_RIGHT, DEFAULT_ZOOM, fontHandler, fontsToProcess, HTML_VERTICAL_ALIGN_BOTTOM, HTML_VERTICAL_ALIGN_MIDDLE, HTML_VERTICAL_ALIGN_TOP, IMAGE_NAME_PREFIX, IMAGE_NAME_PREFIX_LEGTH, imageHandler, JR_BOOKMARK_ANCHOR_PREFIX, JR_PAGE_ANCHOR_PREFIX, resourceHandler

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_INVALID_IMAGE_NAME, EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO, EXCEPTION_MESSAGE_KEY_MIXED_CALLS_NOT_ALLOWED, 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, itemConfiguration, jasperPrint, jasperReportsContext, noBackcolorSelector, noneSelector, numberFormatCache, parameters, propertiesUtil, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, rendererUtil, styledTextUtil, textValueClasses

Constructor Summary

Constructors

Constructor and Description
HtmlExporter()
HtmlExporter(JasperReportsContext jasperReportsContext)

Method Summary

Modifier and Type	Method and Description
protected Color	appendBackcolorStyle(TableCell cell, StringBuilder styleBuffer)
protected boolean	appendBorderStyle(JRLineBox box, StringBuilder styleBuffer)
protected void	appendElementCellGenericStyle(TableCell cell, StringBuilder styleBuffer)
protected boolean	appendPadding(StringBuilder sb, Integer padding, String side)
protected boolean	appendPaddingStyle(JRLineBox box, StringBuilder styleBuffer)
protected boolean	appendPen(StringBuilder sb, JRPen pen, String side)
protected void	appendSizeStyle(int width, int height, StringBuilder styleBuffer)
protected void	endCell()
protected void	endHyperlink()
protected void	ensureOutput()
void	exportElements(List<JRPrintElement> elements)
protected void	exportPage(JRPrintPage page)
void	exportReport() Performs the export.
protected void	exportReportToWriter()
protected void	exportStyledText(JRPrintText printText, JRStyledText styledText, String tooltip, boolean hyperlinkStarted)
protected void	exportStyledTextRun(Map<AttributedCharacterIterator.Attribute,Object> attributes, String text, String tooltip, Locale locale, LineSpacingEnum lineSpacing, Float lineSpacingSize, float lineSpacingFactor, Color backcolor, boolean hyperlinkStarted)
protected void	exportTable(HtmlExporter.TableVisitor tableVisitor, Table table, boolean whiteBackground, boolean isMainReportTable)
protected void	finishStartCell()
protected String	getCellProperty(JRPrintElement element, TableCell cell, String key)
protected Class<HtmlExporterConfiguration>	getConfigurationInterface()
String	getDataAttributes(JRPrintElement element, TableCell cell)
protected JRPrintElementIndex	getElementIndex(TableCell cell)
String	getExporterKey()
String	getExporterPropertiesPrefix() Returns the properties prefix for the current exporter.
protected String	getHyperlinkTarget(JRPrintHyperlink link)
protected String	getHyperlinkURL(JRPrintHyperlink link)
protected String	getImageHorizontalAlignmentStyle(JRPrintImage image)
protected String	getImageVerticalAlignmentStyle(JRPrintImage image)
protected Class<HtmlReportConfiguration>	getItemConfigurationInterface()
protected void	initExport()
protected void	initReport()
protected boolean	matchesBackcolor(Color backcolor)
protected String	resolveHyperlinkURL(int reportIndex, JRPrintHyperlink link)
protected void	restoreBackcolor()
protected void	setBackcolor(Color color)
protected void	setJasperReportsContext(JasperReportsContext jasperReportsContext)
protected String	setRotationStyles(JRPrintText text, String horizontalAlignment, StringBuilder spanStyleBuffer, StringBuilder divStyleBuffer)
protected void	startCell(int colSpan, int rowSpan)
protected void	startCell(JRPrintElement element, TableCell cell)
protected void	startCell(TableCell cell)
protected boolean	startHyperlink(JRPrintHyperlink link)
String	toSizeUnit(float size)
String	toSizeUnit(int size) Deprecated. Replaced by toSizeUnit(float).
protected float	toZoom(float size)
protected int	toZoom(int size) Deprecated. Replaced by toZoom(float).
protected void	writeEllipse(JRPrintEllipse ellipse, TableCell cell)
protected void	writeEmptyCell(int colSpan, int rowSpan)
protected void	writeFrameCell(TableCell cell)
protected void	writeGenericElement(JRGenericPrintElement element, TableCell cell)
protected void	writeImage(JRPrintImage image, TableCell cell)
protected void	writeImageAreaCoordinates(int[] coords)
protected void	writeImageAreaHyperlink(JRPrintHyperlink hyperlink)
protected void	writeImageMap(String imageMapName, JRPrintImage image, List<JRPrintImageAreaHyperlink> imageMapAreas)
protected void	writeLayers(List<Table> layers, HtmlExporter.TableVisitor tableVisitor, TableCell cell)
protected void	writeLine(JRPrintLine line, TableCell cell)
protected void	writeRectangle(JRPrintRectangle rectangle, TableCell cell)
protected void	writeStyle(StringBuilder styleBuffer)
protected void	writeSvgStyle(JRPrintGraphicElement element)
protected void	writeText(JRPrintText text, TableCell cell)

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

addFontFamily, getFontFamily, getFontHandler, getImage, getImage, getImageHandler, getImageName, getImageName, getPrintElementIndex, getResourceHandler, getStyledText, handleFont, isEmbeddedSvgUseFonts, isEmbedImage, resolveFontFamily, setFontHandler, setImageHandler, setResourceHandler

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

createFilter, defaultParseNumber, ensureInput, ensureJasperReportsContext, getBooleanCellValue, getCurrentConfiguration, getCurrentItemConfiguration, getCurrentJasperPrint, getCustomHandler, getDateCellValue, getDateFormat, getExporterContext, getExporterInput, getExporterOutput, getHyperlinkProducer, getJasperReportsContext, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getPageRange, getParameter, getParameters, getPropertiesUtil, getRendererUtil, getReportContext, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, insideFrame, reset, resetClassLoader, resetExportContext, restoreElementOffsets, setClassLoader, setConfiguration, setConfiguration, setCurrentExporterInputItem, setExporterInput, setExporterOutput, setFrameElementsOffset, setJasperPrint, 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

HTML_EXPORTER_KEY

public static final String HTML_EXPORTER_KEY

The exporter key, as used in GenericElementHandlerEnviroment.getElementHandler(JRGenericElementType, String).

See Also:

Constant Field Values

HTML_EXPORTER_PROPERTIES_PREFIX

public static final String HTML_EXPORTER_PROPERTIES_PREFIX

See Also:

Constant Field Values

PROPERTY_IGNORE_HYPERLINK

public static final String PROPERTY_IGNORE_HYPERLINK

Deprecated. Replaced by HtmlReportConfiguration.PROPERTY_IGNORE_HYPERLINK.

See Also:

Constant Field Values

PROPERTY_HTML_CLASS

public static final String PROPERTY_HTML_CLASS

Property that provides the value for the class CSS style property to be applied to elements in the table generated for the report. The value of this property will be used as the value for the class attribute of the <td> tag for the element when exported to HTML and/or the class attribute of the <span> or <div> tag for the element, when exported to XHTML/CSS.

See Also:

Constant Field Values

PROPERTY_HTML_ID

public static final String PROPERTY_HTML_ID

See Also:

Constant Field Values

PROPERTY_BORDER_COLLAPSE

public static final String PROPERTY_BORDER_COLLAPSE

Deprecated. Replaced by HtmlReportConfiguration.PROPERTY_BORDER_COLLAPSE.

See Also:

Constant Field Values

targetProducerFactory

protected JRHyperlinkTargetProducerFactory targetProducerFactory

rendererToImagePathMap

protected Map<String,String> rendererToImagePathMap

imageMaps

protected Map<Pair<String,Rectangle>,String> imageMaps

renderersCache

protected RenderersCache renderersCache

writer

protected Writer writer

reportIndex

protected int reportIndex

pageIndex

protected int pageIndex

backcolorStack

protected LinkedList<Color> backcolorStack

tableFilter

protected ExporterFilter tableFilter

pointerEventsNoneStack

protected int pointerEventsNoneStack

Constructor Detail

HtmlExporter

public HtmlExporter()

HtmlExporter

public HtmlExporter(JasperReportsContext jasperReportsContext)

Method Detail

getExporterKey

public String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

getExporterPropertiesPrefix

public String getExporterPropertiesPrefix()

Description copied from class: JRAbstractExporter

Returns the properties prefix for the current exporter.

Specified by:

getExporterPropertiesPrefix in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

Returns:

the properties prefix for the current exporter

exportReport

public void exportReport()
                  throws JRException

Description copied from interface: Exporter

Performs the export.

Specified by:

exportReport in interface Exporter<ExporterInput,HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput>

Specified by:

exportReport in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

Throws:

JRException

getConfigurationInterface

protected Class<HtmlExporterConfiguration> getConfigurationInterface()

Specified by:

getConfigurationInterface in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

getItemConfigurationInterface

protected Class<HtmlReportConfiguration> getItemConfigurationInterface()

Specified by:

getItemConfigurationInterface in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

ensureOutput

protected void ensureOutput()

Specified by:

ensureOutput in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

initExport

protected void initExport()

Overrides:

initExport in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

initReport

protected void initReport()

Overrides:

initReport in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

setJasperReportsContext

protected void setJasperReportsContext(JasperReportsContext jasperReportsContext)

Overrides:

setJasperReportsContext in class JRAbstractExporter<HtmlReportConfiguration,HtmlExporterConfiguration,HtmlExporterOutput,JRHtmlExporterContext>

exportReportToWriter

protected void exportReportToWriter()
                             throws JRException,
                                    IOException

Throws:

JRException

IOException

exportPage

protected void exportPage(JRPrintPage page)
                   throws IOException

Throws:

IOException

exportElements

public void exportElements(List<JRPrintElement> elements)
                    throws IOException

Throws:

IOException

exportTable

protected void exportTable(HtmlExporter.TableVisitor tableVisitor,
                           Table table,
                           boolean whiteBackground,
                           boolean isMainReportTable)
                    throws IOException

Throws:

IOException

writeText

protected void writeText(JRPrintText text,
                         TableCell cell)
                  throws IOException

Throws:

IOException

setRotationStyles

protected String setRotationStyles(JRPrintText text,
                                   String horizontalAlignment,
                                   StringBuilder spanStyleBuffer,
                                   StringBuilder divStyleBuffer)

appendSizeStyle

protected void appendSizeStyle(int width,
                               int height,
                               StringBuilder styleBuffer)

writeImage

protected void writeImage(JRPrintImage image,
                          TableCell cell)
                   throws IOException,
                          JRException

Throws:

IOException

JRException

getImageHorizontalAlignmentStyle

protected String getImageHorizontalAlignmentStyle(JRPrintImage image)

getImageVerticalAlignmentStyle

protected String getImageVerticalAlignmentStyle(JRPrintImage image)

getElementIndex

protected JRPrintElementIndex getElementIndex(TableCell cell)

writeImageMap

protected void writeImageMap(String imageMapName,
                             JRPrintImage image,
                             List<JRPrintImageAreaHyperlink> imageMapAreas)
                      throws IOException

Throws:

IOException

writeImageAreaCoordinates

protected void writeImageAreaCoordinates(int[] coords)
                                  throws IOException

Throws:

IOException

writeImageAreaHyperlink

protected void writeImageAreaHyperlink(JRPrintHyperlink hyperlink)
                                throws IOException

Throws:

IOException

writeRectangle

protected void writeRectangle(JRPrintRectangle rectangle,
                              TableCell cell)
                       throws IOException

Throws:

IOException

writeEllipse

protected void writeEllipse(JRPrintEllipse ellipse,
                            TableCell cell)
                     throws IOException

Throws:

IOException

writeSvgStyle

protected void writeSvgStyle(JRPrintGraphicElement element)
                      throws IOException

Throws:

IOException

writeLine

protected void writeLine(JRPrintLine line,
                         TableCell cell)
                  throws IOException

Throws:

IOException

writeGenericElement

protected void writeGenericElement(JRGenericPrintElement element,
                                   TableCell cell)
                            throws IOException

Throws:

IOException

writeLayers

protected void writeLayers(List<Table> layers,
                           HtmlExporter.TableVisitor tableVisitor,
                           TableCell cell)
                    throws IOException

Throws:

IOException

startCell

protected void startCell(JRPrintElement element,
                         TableCell cell)
                  throws IOException

Throws:

IOException

getDataAttributes

public String getDataAttributes(JRPrintElement element,
                                TableCell cell)

getCellProperty

protected String getCellProperty(JRPrintElement element,
                                 TableCell cell,
                                 String key)

startCell

protected void startCell(TableCell cell)
                  throws IOException

Throws:

IOException

startCell

protected void startCell(int colSpan,
                         int rowSpan)
                  throws IOException

Throws:

IOException

finishStartCell

protected void finishStartCell()
                        throws IOException

Throws:

IOException

endCell

protected void endCell()
                throws IOException

Throws:

IOException

writeEmptyCell

protected void writeEmptyCell(int colSpan,
                              int rowSpan)
                       throws IOException

Throws:

IOException

writeFrameCell

protected void writeFrameCell(TableCell cell)
                       throws IOException

Throws:

IOException

writeStyle

protected void writeStyle(StringBuilder styleBuffer)
                   throws IOException

Throws:

IOException

appendElementCellGenericStyle

protected void appendElementCellGenericStyle(TableCell cell,
                                             StringBuilder styleBuffer)

setBackcolor

protected void setBackcolor(Color color)

restoreBackcolor

protected void restoreBackcolor()

matchesBackcolor

protected boolean matchesBackcolor(Color backcolor)

appendBackcolorStyle

protected Color appendBackcolorStyle(TableCell cell,
                                     StringBuilder styleBuffer)

appendBorderStyle

protected boolean appendBorderStyle(JRLineBox box,
                                    StringBuilder styleBuffer)

appendPen

protected boolean appendPen(StringBuilder sb,
                            JRPen pen,
                            String side)

appendPaddingStyle

protected boolean appendPaddingStyle(JRLineBox box,
                                     StringBuilder styleBuffer)

appendPadding

protected boolean appendPadding(StringBuilder sb,
                                Integer padding,
                                String side)

startHyperlink

protected boolean startHyperlink(JRPrintHyperlink link)
                          throws IOException

Throws:

IOException

endHyperlink

protected void endHyperlink()
                     throws IOException

Throws:

IOException

getHyperlinkURL

protected String getHyperlinkURL(JRPrintHyperlink link)

resolveHyperlinkURL

protected String resolveHyperlinkURL(int reportIndex,
                                     JRPrintHyperlink link)

getHyperlinkTarget

protected String getHyperlinkTarget(JRPrintHyperlink link)

toSizeUnit

public String toSizeUnit(float size)

toSizeUnit

public String toSizeUnit(int size)

Deprecated. Replaced by toSizeUnit(float).

toZoom

protected float toZoom(float size)

toZoom

protected int toZoom(int size)

Deprecated. Replaced by toZoom(float).

exportStyledText

protected void exportStyledText(JRPrintText printText,
                                JRStyledText styledText,
                                String tooltip,
                                boolean hyperlinkStarted)
                         throws IOException

Throws:

IOException

exportStyledTextRun

protected void exportStyledTextRun(Map<AttributedCharacterIterator.Attribute,Object> attributes,
                                   String text,
                                   String tooltip,
                                   Locale locale,
                                   LineSpacingEnum lineSpacing,
                                   Float lineSpacingSize,
                                   float lineSpacingFactor,
                                   Color backcolor,
                                   boolean hyperlinkStarted)
                            throws IOException

Throws:

IOException