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:
JRExporter
public class JRHtmlExporter
extends JRAbstractExporter

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

Version:
$Id: JRHtmlExporter.java 5180 2012-03-29 13:23:12Z teodord $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary
protected  class JRHtmlExporter.ExporterContext
           
protected static interface JRHtmlExporter.StringProvider
           
 
Nested classes/interfaces inherited from class net.sf.jasperreports.engine.JRAbstractExporter
JRAbstractExporter.BaseExporterContext, JRAbstractExporter.ParameterOverriddenResolver, JRAbstractExporter.ParameterOverrideResolver, JRAbstractExporter.ParameterResolver
 
Field Summary
protected  boolean accessibleHtml
           
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 static float DEFAULT_ZOOM
           
protected  JRHtmlExporter.StringProvider emptyCellStringProvider
           
protected  java.lang.String encoding
           
protected  JRHtmlExporterContext exporterContext
           
protected  boolean flushOutput
           
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  boolean hyperlinkStarted
           
static java.lang.String IMAGE_NAME_PREFIX
           
protected static int IMAGE_NAME_PREFIX_LEGTH
           
protected  java.util.Map<Pair<java.lang.String,java.awt.Rectangle>,java.lang.String> imageMaps
           
protected  java.util.Map<java.lang.String,byte[]> imageNameToImageDataMap
           
protected  java.io.File imagesDir
           
protected  java.util.List<JRPrintElementIndex> 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_ACCESSIBLE
          Configuration property that determines the exporter to produce accessible HTML.
static java.lang.String PROPERTY_HTML_CLASS
           
static java.lang.String PROPERTY_HTML_ID
           
static java.lang.String PROPERTY_HTML_POPUP_COLUMN
           
static java.lang.String PROPERTY_HTML_POPUP_ID
           
static java.lang.String PROPERTY_HTML_UUID
           
protected  java.util.Map<java.lang.String,java.lang.String> rendererToImagePathMap
           
protected  int reportIndex
           
protected  java.lang.String sizeUnit
           
protected  JRHyperlinkTargetProducerFactory targetProducerFactory
           
protected  int thDepth
           
protected  java.io.Writer writer
           
protected  float zoom
           
 
Fields inherited from class net.sf.jasperreports.engine.JRAbstractExporter
dateFormatCache, endPageIndex, filter, fontMap, globalOffsetX, globalOffsetY, hyperlinkProducerFactory, isModeBatch, jasperPrint, jasperPrintList, jasperReportsContext, numberFormatCache, parameters, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex
 
Constructor Summary
JRHtmlExporter()
           
JRHtmlExporter(JasperReportsContext jasperReportsContext)
           
 
Method Summary
protected  java.awt.Color appendBackcolorStyle(JRExporterGridCell gridCell, java.lang.StringBuffer styleBuffer)
           
protected  boolean appendBorderStyle(JRLineBox box, java.lang.StringBuffer styleBuffer)
           
protected  boolean appendPaddingStyle(JRLineBox box, java.lang.StringBuffer styleBuffer)
           
protected  void endHyperlink()
           
protected  void exportFrame(JRPrintFrame frame, JRExporterGridCell gridCell)
           
protected  void exportGenericElement(JRGenericPrintElement element, JRExporterGridCell gridCell, int rowHeight)
           
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, java.util.Locale locale)
           
protected  void exportStyledText(JRStyledText styledText, java.lang.String tooltip, java.util.Locale locale)
           
protected  void exportStyledTextRun(java.util.Map<java.text.AttributedCharacterIterator.Attribute,java.lang.Object> attributes, java.lang.String text, java.util.Locale locale)
           
protected  void exportStyledTextRun(java.util.Map<java.text.AttributedCharacterIterator.Attribute,java.lang.Object> attributes, java.lang.String text, java.lang.String tooltip, java.util.Locale locale)
           
protected  void exportText(JRPrintText text, JRExporterGridCell gridCell)
           
protected  java.lang.String getCellTag(JRExporterGridCell gridCell)
           
protected  JRPrintElementIndex getElementIndex(JRExporterGridCell gridCell)
           
 JasperPrint getExportedReport()
           
protected  java.lang.String getExporterKey()
           
 java.util.Map<JRExporterParameter,java.lang.Object> getExportParameters()
           
 java.lang.String getExportPropertiesPrefix()
           
protected  java.lang.String getHyperlinkTarget(JRPrintHyperlink link)
           
protected  java.lang.String getHyperlinkURL(JRPrintHyperlink link)
           
static JRPrintImage getImage(java.util.List<JasperPrint> jasperPrintList, JRPrintElementIndex imageIndex)
           
static JRPrintImage getImage(java.util.List<JasperPrint> jasperPrintList, java.lang.String imageName)
           
static java.lang.String getImageName(JRPrintElementIndex printElementIndex)
           
static JRPrintElementIndex getPrintElementIndex(java.lang.String imageName)
           
protected  JRStyledText getStyledText(JRPrintText textElement, boolean setBackcolor)
           
protected  void loadPxImage()
           
protected  void restoreBackcolor()
           
protected  void setBackcolor(java.awt.Color color)
           
protected  boolean startHyperlink(JRPrintHyperlink link)
           
 java.lang.String toSizeUnit(int size)
           
 int toZoom(int size)
           
protected  void writeCellEnd(JRExporterGridCell gridCell)
           
protected  void writeCellStart(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<JRPrintImageAreaHyperlink> imageMapAreas)
           
 
Methods inherited from class net.sf.jasperreports.engine.JRAbstractExporter
createFilter, defaultParseNumber, getBooleanCellValue, getBooleanParameter, getCharacterParameter, 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, 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 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_HTML_CLASS

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

PROPERTY_HTML_POPUP_ID

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

PROPERTY_HTML_POPUP_COLUMN

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

PROPERTY_HTML_UUID

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

PROPERTY_HTML_ID

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

PROPERTY_ACCESSIBLE

public static final java.lang.String PROPERTY_ACCESSIBLE
Configuration property that determines the exporter to produce accessible HTML.

See Also:
Constant Field Values

JR_PAGE_ANCHOR_PREFIX

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

DEFAULT_ZOOM

protected static final float DEFAULT_ZOOM
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<java.lang.String,java.lang.String> rendererToImagePathMap

imageMaps

protected java.util.Map<Pair<java.lang.String,java.awt.Rectangle>,java.lang.String> imageMaps

imageNameToImageDataMap

protected java.util.Map<java.lang.String,byte[]> imageNameToImageDataMap

imagesToProcess

protected java.util.List<JRPrintElementIndex> 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

zoom

protected float zoom

isUsingImagesToAlign

protected boolean isUsingImagesToAlign

isWrapBreakWord

protected boolean isWrapBreakWord

isIgnorePageMargins

protected boolean isIgnorePageMargins

accessibleHtml

protected boolean accessibleHtml

flushOutput

protected boolean flushOutput

htmlHeader

protected java.lang.String htmlHeader

betweenPagesHtml

protected java.lang.String betweenPagesHtml

htmlFooter

protected java.lang.String htmlFooter

emptyCellStringProvider

protected JRHtmlExporter.StringProvider emptyCellStringProvider

targetProducerFactory

protected JRHyperlinkTargetProducerFactory targetProducerFactory

hyperlinkStarted

protected boolean hyperlinkStarted

thDepth

protected int thDepth

nature

protected ExporterNature nature

exporterContext

protected JRHtmlExporterContext exporterContext
Constructor Detail

JRHtmlExporter

public JRHtmlExporter()
See Also:
JRHtmlExporter(JasperReportsContext)

JRHtmlExporter

public JRHtmlExporter(JasperReportsContext jasperReportsContext)
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

getImage

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

getImage

public static JRPrintImage getImage(java.util.List<JasperPrint> 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

writeCellStart

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

writeCellEnd

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

getCellTag

protected java.lang.String getCellTag(JRExporterGridCell gridCell)

exportRectangle

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

exportStyledText

protected void exportStyledText(JRStyledText styledText,
                                java.util.Locale locale)
                         throws java.io.IOException
Throws:
java.io.IOException

exportStyledText

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

exportStyledTextRun

protected void exportStyledTextRun(java.util.Map<java.text.AttributedCharacterIterator.Attribute,java.lang.Object> attributes,
                                   java.lang.String text,
                                   java.util.Locale locale)
                            throws java.io.IOException
Throws:
java.io.IOException

exportStyledTextRun

protected void exportStyledTextRun(java.util.Map<java.text.AttributedCharacterIterator.Attribute,java.lang.Object> attributes,
                                   java.lang.String text,
                                   java.lang.String tooltip,
                                   java.util.Locale locale)
                            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)

endHyperlink

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

appendBorderStyle

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

appendPaddingStyle

protected boolean appendPaddingStyle(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<JRPrintImageAreaHyperlink> 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,
                                    int rowHeight)
                             throws java.io.IOException
Throws:
java.io.IOException

getExportParameters

public java.util.Map<JRExporterParameter,java.lang.Object> getExportParameters()

getExportPropertiesPrefix

public java.lang.String getExportPropertiesPrefix()

getExporterKey

protected java.lang.String getExporterKey()
Specified by:
getExporterKey in class JRAbstractExporter

getExportedReport

public JasperPrint getExportedReport()

toSizeUnit

public java.lang.String toSizeUnit(int size)

toZoom

public int toZoom(int size)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement,
                                     boolean setBackcolor)
Overrides:
getStyledText in class JRAbstractExporter
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-2010 Jaspersoft Corporation www.jaspersoft.com