net.sf.jasperreports.engine.export

Class HtmlExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter

net.sf.jasperreports.engine.export.AbstractHtmlExporter

net.sf.jasperreports.engine.export.HtmlExporter

All Implemented Interfaces:

JRExporter

public class HtmlExporter
extends AbstractHtmlExporter

Version:

$Id: HtmlExporter.java 6706 2013-11-08 14:23:45Z lucianc $

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.ParameterOverriddenResolver, JRAbstractExporter.ParameterOverrideResolver, JRAbstractExporter.ParameterResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	accessibleHtml
protected LinkedList<Color>	backcolorStack
protected String	betweenPagesHtml
protected String	borderCollapse
protected static float	DEFAULT_ZOOM
protected String	encoding
protected JRHtmlExporterContext	exporterContext
protected boolean	flushOutput
protected Map<String,HtmlFont>	fontsToProcess
static String	HTML_EXPORTER_KEY
protected static String	HTML_EXPORTER_PROPERTIES_PREFIX
protected String	htmlFooter
protected String	htmlHeader
static String	IMAGE_NAME_PREFIX
protected Map<Pair<String,Rectangle>,String>	imageMaps
protected Map<String,byte[]>	imageNameToImageDataMap
protected boolean	isIgnorePageMargins
protected boolean	isWhitePageBackground
protected boolean	isWrapBreakWord
protected static String	JR_PAGE_ANCHOR_PREFIX
protected int	pageIndex
protected int	pointerEventsNoneStack
protected JRExportProgressMonitor	progressMonitor
static String	PROPERTY_BORDER_COLLAPSE Property that provides the value for the border-collapse CSS property to be applied to the table generated for the report.
static String	PROPERTY_IGNORE_HYPERLINK
protected Map<String,String>	rendererToImagePathMap
protected int	reportIndex
protected String	sizeUnit
protected ExporterFilter	tableFilter
protected JRHyperlinkTargetProducerFactory	targetProducerFactory
protected Writer	writer
protected float	zoom

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

fontHandler, imageHandler, resourceHandler

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

allSelector, dateFormatCache, endPageIndex, filter, fontMap, globalOffsetX, globalOffsetY, hyperlinkProducerFactory, isModeBatch, jasperPrint, jasperPrintList, jasperReportsContext, noBackcolorSelector, noneSelector, numberFormatCache, parameters, propertiesUtil, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex, styledTextUtil

Constructor Summary

Constructors

Constructor and Description
HtmlExporter()
HtmlExporter(JasperReportsContext jasperReportsContext)

Method Summary

Methods

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()
void	exportElements(List<JRPrintElement> elements)
protected void	exportPage(JRPrintPage page)
void	exportReport() Actually starts the export process.
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)
String	getDataAttributes(JRPrintElement element, TableCell cell)
protected JRPrintElementIndex	getElementIndex(TableCell cell)
String	getExporterKey()
protected String	getHyperlinkTarget(JRPrintHyperlink link)
protected String	getHyperlinkURL(JRPrintHyperlink link)
static JRPrintImage	getImage(List<JasperPrint> jasperPrintList, JRPrintElementIndex imageIndex)
static String	getImageName(JRPrintElementIndex printElementIndex)
protected double[]	getImageNormalSize(JRPrintImage image, Renderable renderer, int imageWidth, int imageHeight)
protected JRStyledText	getStyledText(JRPrintText textElement, boolean setBackcolor)
protected boolean	matchesBackcolor(Color backcolor)
protected static String	resolveHyperlinkURL(JRAbstractExporter exporter, int reportIndex, JRPrintHyperlink link)
protected void	restoreBackcolor()
protected void	setBackcolor(Color color)
protected void	setImageHorizontalAlignmentStyle(JRPrintImage image, StringBuilder styleBuffer)
protected void	setImageVerticalAlignmentStyle(JRPrintImage image, StringBuilder styleBuffer)
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(int size)
protected int	toZoom(int size)
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(JRPrintGraphicElement element, TableCell cell)
protected void	writeStyle(StringBuilder styleBuffer)
protected void	writeText(JRPrintText text, TableCell cell)

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

getFontHandler, getImageHandler, getResourceHandler, setFontHandler, setImageHandler, setResourceHandler

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

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

HTML_EXPORTER_KEY

public static final String HTML_EXPORTER_KEY

See Also:

Constant Field Values

HTML_EXPORTER_PROPERTIES_PREFIX

protected static final String HTML_EXPORTER_PROPERTIES_PREFIX

See Also:

Constant Field Values

PROPERTY_IGNORE_HYPERLINK

public static final String PROPERTY_IGNORE_HYPERLINK

See Also:

Constant Field Values

PROPERTY_BORDER_COLLAPSE

public static final String PROPERTY_BORDER_COLLAPSE

Property that provides the value for the border-collapse CSS property to be applied to the table generated for the report.

The property can be set globally and at report level. It defaults to collapse.

See Also:

Constant Field Values

DEFAULT_ZOOM

protected static final float DEFAULT_ZOOM

See Also:

Constant Field Values

IMAGE_NAME_PREFIX

public static final String IMAGE_NAME_PREFIX

See Also:

Constant Field Values

JR_PAGE_ANCHOR_PREFIX

protected static final String JR_PAGE_ANCHOR_PREFIX

See Also:

Constant Field Values

targetProducerFactory

protected JRHyperlinkTargetProducerFactory targetProducerFactory

progressMonitor

protected JRExportProgressMonitor progressMonitor

htmlHeader

protected String htmlHeader

betweenPagesHtml

protected String betweenPagesHtml

htmlFooter

protected String htmlFooter

encoding

protected String encoding

borderCollapse

protected String borderCollapse

isWhitePageBackground

protected boolean isWhitePageBackground

isWrapBreakWord

protected boolean isWrapBreakWord

isIgnorePageMargins

protected boolean isIgnorePageMargins

accessibleHtml

protected boolean accessibleHtml

sizeUnit

protected String sizeUnit

zoom

protected float zoom

flushOutput

protected boolean flushOutput

rendererToImagePathMap

protected Map<String,String> rendererToImagePathMap

imageMaps

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

imageNameToImageDataMap

protected Map<String,byte[]> imageNameToImageDataMap

fontsToProcess

protected Map<String,HtmlFont> fontsToProcess

writer

protected Writer writer

reportIndex

protected int reportIndex

pageIndex

protected int pageIndex

exporterContext

protected JRHtmlExporterContext exporterContext

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

getImageName

public static String getImageName(JRPrintElementIndex printElementIndex)

getImage

public static JRPrintImage getImage(List<JasperPrint> jasperPrintList,
                    JRPrintElementIndex imageIndex)

getExporterKey

public String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter

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

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

setImageHorizontalAlignmentStyle

protected void setImageHorizontalAlignmentStyle(JRPrintImage image,
                                    StringBuilder styleBuffer)

setImageVerticalAlignmentStyle

protected void setImageVerticalAlignmentStyle(JRPrintImage image,
                                  StringBuilder styleBuffer)

getImageNormalSize

protected double[] getImageNormalSize(JRPrintImage image,
                          Renderable renderer,
                          int imageWidth,
                          int imageHeight)
                               throws JRException

Throws:

JRException

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(JRPrintGraphicElement element,
                  TableCell cell)
                       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 static String resolveHyperlinkURL(JRAbstractExporter exporter,
                         int reportIndex,
                         JRPrintHyperlink link)

getHyperlinkTarget

protected String getHyperlinkTarget(JRPrintHyperlink link)

toSizeUnit

public String toSizeUnit(int size)

toZoom

protected int toZoom(int size)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement,
                         boolean setBackcolor)

Overrides:

getStyledText in class JRAbstractExporter

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