Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.sf.jasperreports.engine.export
Class JRHtmlExporter

java.lang.Object
  extended by net.sf.jasperreports.engine.JRAbstractExporter
      extended by net.sf.jasperreports.engine.export.JRHtmlExporter
All Implemented Interfaces:
JRExporterContext, JRHtmlExporterContext, JRExporter
public class JRHtmlExporter
extends JRAbstractExporter
implements JRHtmlExporterContext

Exports a JasperReports document to HTML format. It has character output type and exports the document to a grid-based layout.

Since classic AWT fonts can be sometimes very different from HTML fonts, a font mapping feature was added. By using the JRExporterParameter.FONT_MAP parameter, a logical font like "sansserif" can be mapped to a list of HTML specific fonts, like "Arial, Verdana, Tahoma". Both map keys and values are strings.

Version:
$Id: JRHtmlExporter.java 2355 2008-09-15 17:08:52Z lucianc $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary
protected static interface JRHtmlExporter.StringProvider
           
 
Nested classes/interfaces inherited from class net.sf.jasperreports.engine.JRAbstractExporter
JRAbstractExporter.ParameterOverriddenResolver, JRAbstractExporter.ParameterOverrideResolver, JRAbstractExporter.ParameterResolver
 
Field Summary
protected  java.lang.String betweenPagesHtml
           
protected static java.lang.String CSS_TEXT_ALIGN_CENTER
           
protected static java.lang.String CSS_TEXT_ALIGN_JUSTIFY
           
protected static java.lang.String CSS_TEXT_ALIGN_LEFT
           
protected static java.lang.String CSS_TEXT_ALIGN_RIGHT
           
protected  boolean deepGrid
           
protected  JRHtmlExporter.StringProvider emptyCellStringProvider
           
protected  java.lang.String encoding
           
protected  java.util.Map fontMap
           
static java.lang.String HTML_EXPORTER_KEY
          The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).
protected static java.lang.String HTML_VERTICAL_ALIGN_BOTTOM
           
protected static java.lang.String HTML_VERTICAL_ALIGN_MIDDLE
           
protected static java.lang.String HTML_VERTICAL_ALIGN_TOP
           
protected  java.lang.String htmlFooter
           
protected  java.lang.String htmlHeader
           
protected  JRHyperlinkProducerFactory hyperlinkProducerFactory
           
static java.lang.String IMAGE_NAME_PREFIX
           
protected static int IMAGE_NAME_PREFIX_LEGTH
           
protected  java.util.Map imageMaps
           
protected  java.util.Map imageNameToImageDataMap
           
protected  java.io.File imagesDir
           
protected  java.util.List imagesToProcess
           
protected  java.lang.String imagesURI
           
protected  boolean isIgnorePageMargins
           
protected  boolean isOutputImagesToDir
           
protected  boolean isPxImageLoaded
           
protected  boolean isRemoveEmptySpace
           
protected  boolean isUsingImagesToAlign
           
protected  boolean isWhitePageBackground
           
protected  boolean isWrapBreakWord
           
protected static java.lang.String JR_PAGE_ANCHOR_PREFIX
           
protected  ExporterNature nature
           
protected  int pageIndex
           
protected  JRExportProgressMonitor progressMonitor
           
static java.lang.String PROPERTY_FRAMES_AS_NESTED_TABLES
          Deprecated. Replaced by JRHtmlExporterParameter.PROPERTY_FRAMES_AS_NESTED_TABLES.
protected  java.util.Map rendererToImagePathMap
           
protected  int reportIndex
           
protected  java.lang.String sizeUnit
           
protected  java.io.Writer writer
           
 
Fields inherited from class net.sf.jasperreports.engine.JRAbstractExporter
classLoader, classLoaderSet, dateFormatCache, endPageIndex, fileResolver, fileResolverSet, filter, globalOffsetX, globalOffsetY, isModeBatch, jasperPrint, jasperPrintList, numberFormatCache, parameters, PROPERTY_CELL_FORMULA, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex, urlHandlerFactory, urlHandlerFactorySet
 
Constructor Summary
JRHtmlExporter()
           
 
Method Summary
protected  java.awt.Color appendBackcolorStyle(JRExporterGridCell gridCell, java.lang.StringBuffer styleBuffer)
           
protected  boolean appendBorderStyle(JRLineBox box, java.lang.StringBuffer styleBuffer)
           
protected  void endHyperlink()
           
protected  void exportFrame(JRPrintFrame frame, JRExporterGridCell gridCell)
           
protected  void exportGenericElement(JRGenericPrintElement element, JRExporterGridCell gridCell)
           
protected  void exportGrid(JRGridLayout gridLayout, boolean whitePageBackground)
           
protected  void exportImage(JRPrintImage image, JRExporterGridCell gridCell)
           
protected  void exportLine(JRPrintLine line, JRExporterGridCell gridCell)
           
protected  void exportPage(JRPrintPage page)
           
protected  void exportRectangle(JRPrintGraphicElement element, JRExporterGridCell gridCell)
           
 void exportReport()
          Actually starts the export process.
protected  void exportReportToWriter()
           
protected  void exportStyledText(JRStyledText styledText)
           
protected  void exportStyledText(JRStyledText styledText, java.lang.String tooltip)
           
protected  void exportStyledTextRun(java.util.Map attributes, java.lang.String text)
           
protected  void exportStyledTextRun(java.util.Map attributes, java.lang.String text, java.lang.String tooltip)
           
protected  void exportText(JRPrintText text, JRExporterGridCell gridCell)
           
protected  JRHyperlinkProducer getCustomHandler(JRPrintHyperlink link)
           
protected  JRPrintElementIndex getElementIndex(JRExporterGridCell gridCell)
           
 JasperPrint getExportedReport()
          Returns the report which is currently exported.
 java.util.Map getExportParameters()
          Returns the map of export parameters.
 java.lang.String getExportPropertiesPrefix()
          Returns the properties prefix for the current exporter.
protected  java.lang.String getHyperlinkTarget(JRPrintHyperlink link)
           
protected  java.lang.String getHyperlinkURL(JRPrintHyperlink link)
           
static JRPrintImage getImage(java.util.List jasperPrintList, JRPrintElementIndex imageIndex)
           
static JRPrintImage getImage(java.util.List jasperPrintList, java.lang.String imageName)
           
static java.lang.String getImageName(JRPrintElementIndex printElementIndex)
           
static JRPrintElementIndex getPrintElementIndex(java.lang.String imageName)
           
protected  void loadPxImage()
           
protected  void restoreBackcolor()
           
protected  void setBackcolor(java.awt.Color color)
           
protected  void setDeepGrid()
           
protected  void setHyperlinkProducerFactory()
           
protected  boolean startHyperlink(JRPrintHyperlink link)
           
protected  void writeCellTDStart(JRExporterGridCell gridCell)
           
protected  void writeEmptyCell(JRExporterGridCell cell, int rowHeight)
           
protected  void writeImageAreaCoordinates(int[] coords)
           
protected  void writeImageAreaHyperlink(JRPrintHyperlink hyperlink)
           
protected  void writeImageMap(java.lang.String imageMapName, JRPrintImage image, java.util.List imageMapAreas)
           
 
Methods inherited from class net.sf.jasperreports.engine.JRAbstractExporter
createFilter, defaultParseNumber, getBooleanCellValue, getBooleanParameter, getCharacterParameter, getDateCellValue, getDateFormat, getIntegerParameter, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getParameter, getParameterResolver, getParameters, getStringParameter, getStringParameterOrDefault, getStyledText, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, reset, resetClassLoader, resetExportContext, restoreElementOffsets, setClassLoader, setExportContext, setFrameElementsOffset, setInput, 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

HTML_EXPORTER_KEY

public static final java.lang.String HTML_EXPORTER_KEY
The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).

See Also:
Constant Field Values

PROPERTY_FRAMES_AS_NESTED_TABLES

public static final java.lang.String PROPERTY_FRAMES_AS_NESTED_TABLES
Deprecated. Replaced by JRHtmlExporterParameter.PROPERTY_FRAMES_AS_NESTED_TABLES.
See Also:
Constant Field Values

JR_PAGE_ANCHOR_PREFIX

protected static final java.lang.String JR_PAGE_ANCHOR_PREFIX
See Also:
Constant Field Values

CSS_TEXT_ALIGN_LEFT

protected static final java.lang.String CSS_TEXT_ALIGN_LEFT
See Also:
Constant Field Values

CSS_TEXT_ALIGN_RIGHT

protected static final java.lang.String CSS_TEXT_ALIGN_RIGHT
See Also:
Constant Field Values

CSS_TEXT_ALIGN_CENTER

protected static final java.lang.String CSS_TEXT_ALIGN_CENTER
See Also:
Constant Field Values

CSS_TEXT_ALIGN_JUSTIFY

protected static final java.lang.String CSS_TEXT_ALIGN_JUSTIFY
See Also:
Constant Field Values

HTML_VERTICAL_ALIGN_TOP

protected static final java.lang.String HTML_VERTICAL_ALIGN_TOP
See Also:
Constant Field Values

HTML_VERTICAL_ALIGN_MIDDLE

protected static final java.lang.String HTML_VERTICAL_ALIGN_MIDDLE
See Also:
Constant Field Values

HTML_VERTICAL_ALIGN_BOTTOM

protected static final java.lang.String HTML_VERTICAL_ALIGN_BOTTOM
See Also:
Constant Field Values

IMAGE_NAME_PREFIX

public static final java.lang.String IMAGE_NAME_PREFIX
See Also:
Constant Field Values

IMAGE_NAME_PREFIX_LEGTH

protected static final int IMAGE_NAME_PREFIX_LEGTH

writer

protected java.io.Writer writer

progressMonitor

protected JRExportProgressMonitor progressMonitor

rendererToImagePathMap

protected java.util.Map rendererToImagePathMap

imageMaps

protected java.util.Map imageMaps

imageNameToImageDataMap

protected java.util.Map imageNameToImageDataMap

imagesToProcess

protected java.util.List imagesToProcess

isPxImageLoaded

protected boolean isPxImageLoaded

reportIndex

protected int reportIndex

pageIndex

protected int pageIndex

imagesDir

protected java.io.File imagesDir

imagesURI

protected java.lang.String imagesURI

isOutputImagesToDir

protected boolean isOutputImagesToDir

isRemoveEmptySpace

protected boolean isRemoveEmptySpace

isWhitePageBackground

protected boolean isWhitePageBackground

encoding

protected java.lang.String encoding

sizeUnit

protected java.lang.String sizeUnit

isUsingImagesToAlign

protected boolean isUsingImagesToAlign

isWrapBreakWord

protected boolean isWrapBreakWord

isIgnorePageMargins

protected boolean isIgnorePageMargins

htmlHeader

protected java.lang.String htmlHeader

betweenPagesHtml

protected java.lang.String betweenPagesHtml

htmlFooter

protected java.lang.String htmlFooter

emptyCellStringProvider

protected JRHtmlExporter.StringProvider emptyCellStringProvider

fontMap

protected java.util.Map fontMap

hyperlinkProducerFactory

protected JRHyperlinkProducerFactory hyperlinkProducerFactory

deepGrid

protected boolean deepGrid

nature

protected ExporterNature nature
Constructor Detail

JRHtmlExporter

public JRHtmlExporter()
Method Detail

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

setHyperlinkProducerFactory

protected void setHyperlinkProducerFactory()

setDeepGrid

protected void setDeepGrid()

getImage

public static JRPrintImage getImage(java.util.List jasperPrintList,
                                    java.lang.String imageName)

getImage

public static JRPrintImage getImage(java.util.List jasperPrintList,
                                    JRPrintElementIndex imageIndex)

exportReportToWriter

protected void exportReportToWriter()
                             throws JRException,
                                    java.io.IOException
Throws:
JRException
java.io.IOException

exportPage

protected void exportPage(JRPrintPage page)
                   throws JRException,
                          java.io.IOException
Throws:
JRException
java.io.IOException

exportGrid

protected void exportGrid(JRGridLayout gridLayout,
                          boolean whitePageBackground)
                   throws java.io.IOException,
                          JRException
Throws:
java.io.IOException
JRException

writeEmptyCell

protected void writeEmptyCell(JRExporterGridCell cell,
                              int rowHeight)
                       throws java.io.IOException
Throws:
java.io.IOException

exportLine

protected void exportLine(JRPrintLine line,
                          JRExporterGridCell gridCell)
                   throws java.io.IOException
Throws:
java.io.IOException

writeCellTDStart

protected void writeCellTDStart(JRExporterGridCell gridCell)
                         throws java.io.IOException
Throws:
java.io.IOException

exportRectangle

protected void exportRectangle(JRPrintGraphicElement element,
                               JRExporterGridCell gridCell)
                        throws java.io.IOException
Throws:
java.io.IOException

exportStyledText

protected void exportStyledText(JRStyledText styledText)
                         throws java.io.IOException
Throws:
java.io.IOException

exportStyledText

protected void exportStyledText(JRStyledText styledText,
                                java.lang.String tooltip)
                         throws java.io.IOException
Throws:
java.io.IOException

exportStyledTextRun

protected void exportStyledTextRun(java.util.Map attributes,
                                   java.lang.String text)
                            throws java.io.IOException
Throws:
java.io.IOException

exportStyledTextRun

protected void exportStyledTextRun(java.util.Map attributes,
                                   java.lang.String text,
                                   java.lang.String tooltip)
                            throws java.io.IOException
Throws:
java.io.IOException

exportText

protected void exportText(JRPrintText text,
                          JRExporterGridCell gridCell)
                   throws java.io.IOException
Throws:
java.io.IOException

startHyperlink

protected boolean startHyperlink(JRPrintHyperlink link)
                          throws java.io.IOException
Throws:
java.io.IOException

getHyperlinkTarget

protected java.lang.String getHyperlinkTarget(JRPrintHyperlink link)

getHyperlinkURL

protected java.lang.String getHyperlinkURL(JRPrintHyperlink link)

getCustomHandler

protected JRHyperlinkProducer getCustomHandler(JRPrintHyperlink link)

endHyperlink

protected void endHyperlink()
                     throws java.io.IOException
Throws:
java.io.IOException

appendBorderStyle

protected boolean appendBorderStyle(JRLineBox box,
                                    java.lang.StringBuffer styleBuffer)

appendBackcolorStyle

protected java.awt.Color appendBackcolorStyle(JRExporterGridCell gridCell,
                                              java.lang.StringBuffer styleBuffer)

exportImage

protected void exportImage(JRPrintImage image,
                           JRExporterGridCell gridCell)
                    throws JRException,
                           java.io.IOException
Throws:
JRException
java.io.IOException

getElementIndex

protected JRPrintElementIndex getElementIndex(JRExporterGridCell gridCell)

writeImageMap

protected void writeImageMap(java.lang.String imageMapName,
                             JRPrintImage image,
                             java.util.List imageMapAreas)
                      throws java.io.IOException
Throws:
java.io.IOException

writeImageAreaCoordinates

protected void writeImageAreaCoordinates(int[] coords)
                                  throws java.io.IOException
Throws:
java.io.IOException

writeImageAreaHyperlink

protected void writeImageAreaHyperlink(JRPrintHyperlink hyperlink)
                                throws java.io.IOException
Throws:
java.io.IOException

loadPxImage

protected void loadPxImage()
                    throws JRException
Throws:
JRException

getImageName

public static java.lang.String getImageName(JRPrintElementIndex printElementIndex)

getPrintElementIndex

public static JRPrintElementIndex getPrintElementIndex(java.lang.String imageName)

exportFrame

protected void exportFrame(JRPrintFrame frame,
                           JRExporterGridCell gridCell)
                    throws java.io.IOException,
                           JRException
Throws:
java.io.IOException
JRException

setBackcolor

protected void setBackcolor(java.awt.Color color)

restoreBackcolor

protected void restoreBackcolor()

exportGenericElement

protected void exportGenericElement(JRGenericPrintElement element,
                                    JRExporterGridCell gridCell)
                             throws java.io.IOException
Throws:
java.io.IOException

getExportParameters

public java.util.Map getExportParameters()
Description copied from interface: JRExporterContext
Returns the map of export parameters.

The map uses JRExporterParameter instances as keys.

Specified by:
getExportParameters in interface JRExporterContext
Returns:
the map of export parameters

getExportPropertiesPrefix

public java.lang.String getExportPropertiesPrefix()
Description copied from interface: JRExporterContext
Returns the properties prefix for the current exporter.

Specified by:
getExportPropertiesPrefix in interface JRExporterContext
Returns:
the properties prefix for the current exporter

getExportedReport

public JasperPrint getExportedReport()
Description copied from interface: JRExporterContext
Returns the report which is currently exported.

Specified by:
getExportedReport in interface JRExporterContext
Returns:
currently exported report
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
© 2001-2006 JasperSoft Corporation www.jaspersoft.com