com.stimulsoft.report.export.service
Class StiHtmlExportService

java.lang.Object
  extended by com.stimulsoft.report.export.service.StiExportService
      extended by com.stimulsoft.report.export.service.StiHtmlExportService

public class StiHtmlExportService
extends StiExportService

Class represent export for HTML format Copyright Stimulsoft


Field Summary
 StiHtmlChartType chartType
           
 java.util.Hashtable<java.lang.String,java.lang.String> hashBookmarkGuid
           
static double LINE_HEIGHT_CORRECTION
           
 java.lang.String openLinksTarget
           
 
Fields inherited from class com.stimulsoft.report.export.service.StiExportService
currentPassNumber, DATE_1900, maximumPassNumber, MILLISECONDS_IN_DAY, ONE_HOUR
 
Constructor Summary
StiHtmlExportService()
           
 
Method Summary
 void addCoord(StiRectangle rect)
          Add coordinates to map
 void clear()
          Clear
static java.lang.String convertTextWithHtmlTagsToHtmlText(StiText stiText, java.lang.String text, double zoom)
          Convert html text to html
 void export(StiReport report, java.io.OutputStream outputStream, StiExportSettings exportSettings)
          Export StiReport
 void exportHtml(StiReport report, java.io.OutputStream stream, StiHtmlExportSettings settings)
          Exports a document to the HTML.
 java.lang.String formatColor(StiColor color)
          Convert StiColor to String value
 java.util.HashMap<StiComponent,java.lang.String> getChartData()
           
 java.lang.String getChartScript()
           
 StiExportFormat getExportFormat()
          Returs service export format
 StiHtmlExportQuality getExportQuality()
           
 byte[] getFile(java.lang.String filePath)
          Convert file to byte array
 java.lang.String getFileName()
           
 java.lang.String getGuid(StiComponent comp)
           
 StiHtmlImageHost getHtmlImageHost()
           
 StiHtmlTextWriter getHtmlWriter()
           
 StiImageFormat getImageFormat()
           
 float getImageQuality()
           
 float getImageResolution()
           
 java.util.Hashtable<java.lang.Object,java.lang.Object> getInteractionComponents()
           
 boolean getMultipleFiles()
          Gets a value indicating a number of files in exported document as a result of export
 StiHorAlignment getPageHorAlignment()
           
 StiReport getReport()
           
 java.util.ArrayList<StiCellStyle> getStyles()
           
 StiHtmlTableRender getTableRender()
           
 double getZoom()
           
 boolean isClearOnFinish()
           
 boolean isFileStreamMode()
           
 boolean isRemoveEmptySpaceAtBottom()
           
 boolean isRenderAsDocument()
           
 boolean isRenderStyles()
           
 boolean isRenderWebInteractions()
           
 boolean isRenderWebViewer()
           
 boolean isUseStylesTable()
           
 java.lang.String prepareChartData(StiHtmlTextWriter writer, StiChart chart, double width, double height)
           
 java.lang.String prepareGaugeData(StiHtmlTextWriter writer, StiGauge gauge, double width, double height)
           
 java.lang.String prepareMapData(StiHtmlTextWriter writer, StiMap map, double width, double height)
           
 java.lang.String prepareTextForHtml(java.lang.String text, boolean processWhiteSpaces)
           
 void renderBackColor(StiHtmlTableCell cell, StiColor color)
          Render backward color
 void renderBookmarkScript()
          Render bookmark script
 void renderBorder(StiBorder border)
          Render border
 void renderBorder(StiComponent comp)
          Render StiComponent border
 void renderBorder(StiHtmlTableCell cell, StiBorderSide border, java.lang.String side)
          Render border
 void renderEndDoc()
          Render end doucment
 void renderFont(StiHtmlTableCell cell, StiFont font)
          Render font
 void renderImage(java.awt.image.BufferedImage image, java.lang.String imageURL, double zoom, int margin)
          Render BufferedImage
 void renderImage(IStiExportImage exportImage, java.lang.String imageURL)
          Render image
 void renderImage(StiComponent comp)
          Render StiComponent image
 void renderPage(StiPagesCollection pages, boolean useBookmarksTree, int bookmarkWidth, StiHtmlExportSettings settings)
          Render pages
 void renderPosition(StiComponent comp)
          Render StiComponent position
 void renderStartDoc(StiHtmlTableRender render, boolean asTable, boolean useBookmarks, boolean exportBookmarksOnly, java.util.Hashtable<java.lang.String,java.lang.String> cssStyles, StiPagesCollection pages, java.nio.charset.Charset charset)
          Render start document
 void renderTextAngle(StiTextOptions textOptions)
          Render text angle
 void renderTextColor(StiHtmlTableCell cell, StiColor color)
          Render text color
 void renderTextDirection(StiHtmlTableCell cell, StiTextOptions textOptions)
          Render text direction
 void renderTextHorAlignment(StiHtmlTableCell cell, StiCellStyle style)
          Render text horizontal alignmeng
 void renderVertAlignment(StiHtmlTableCell cell, StiVertAlignment textVertAlignment)
          Render vertical alignment
 void setChartData(java.util.HashMap<StiComponent,java.lang.String> chartData)
           
 void setClearOnFinish(boolean clearOnFinish)
           
 void setExportQuality(StiHtmlExportQuality exportQuality)
           
 void setFileStreamMode(boolean fileStreamMode)
           
 void setHtmlImageHost(StiHtmlImageHost htmlImageHost)
           
 void setHtmlWriter(StiHtmlTextWriter htmlWriter)
           
 void setImageQuality(float imageQuality)
           
 void setImageResolution(float imageResolution)
           
 void setInteractionComponents(java.util.Hashtable<java.lang.Object,java.lang.Object> interactionComponents)
           
 void setRenderAsDocument(boolean renderAsDocument)
           
 void setRenderStyles(boolean renderStyles)
           
 void setRenderWebInteractions(boolean renderWebInteractions)
           
 void setRenderWebViewer(boolean renderWebViewer)
           
 void setReport(StiReport report)
           
 void setStyles(java.util.ArrayList<StiCellStyle> styles)
           
 void setUseStylesTable(boolean useStylesTable)
           
 void setZoom(double zoom)
           
 
Methods inherited from class com.stimulsoft.report.export.service.StiExportService
export, export, export, export, getExFile, getExportedFiles, getExportSettings, getStatusString, invokeExporting, invokeExporting, invokeExporting, isStoped, setExFile, setExportReport, setExportSettings, setOutputStream, setProgress, setStatusString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LINE_HEIGHT_CORRECTION

public static double LINE_HEIGHT_CORRECTION

hashBookmarkGuid

public java.util.Hashtable<java.lang.String,java.lang.String> hashBookmarkGuid

openLinksTarget

public java.lang.String openLinksTarget

chartType

public StiHtmlChartType chartType
Constructor Detail

StiHtmlExportService

public StiHtmlExportService()
Method Detail

isRenderWebInteractions

public boolean isRenderWebInteractions()
Returns:
the renderWebInteractions

setRenderWebInteractions

public void setRenderWebInteractions(boolean renderWebInteractions)
Parameters:
renderWebInteractions - the renderWebInteractions to set

isRenderWebViewer

public boolean isRenderWebViewer()
Returns:
the renderWebViewer

setRenderWebViewer

public void setRenderWebViewer(boolean renderWebViewer)
Parameters:
renderWebViewer - the renderWebViewer to set

getChartData

public java.util.HashMap<StiComponent,java.lang.String> getChartData()
Returns:
the chartData

setChartData

public void setChartData(java.util.HashMap<StiComponent,java.lang.String> chartData)
Parameters:
chartData - the chartData to set

addCoord

public void addCoord(StiRectangle rect)
Add coordinates to map

Parameters:
rect - StiRectangle

formatColor

public java.lang.String formatColor(StiColor color)
Convert StiColor to String value

Parameters:
color -
Returns:
Formatted color

renderFont

public void renderFont(StiHtmlTableCell cell,
                       StiFont font)
                throws java.io.IOException
Render font

Parameters:
cell - StiHtmlTableCell
font - StiFont
Throws:
java.io.IOException

renderTextHorAlignment

public void renderTextHorAlignment(StiHtmlTableCell cell,
                                   StiCellStyle style)
                            throws java.io.IOException
Render text horizontal alignmeng

Parameters:
cell - StiHtmlTableCell
style - StiCellStyle
Throws:
java.io.IOException

renderVertAlignment

public void renderVertAlignment(StiHtmlTableCell cell,
                                StiVertAlignment textVertAlignment)
                         throws java.io.IOException
Render vertical alignment

Parameters:
cell - StiHtmlTableCell
textVertAlignment - StiVertAlignment
Throws:
java.io.IOException

renderTextAngle

public void renderTextAngle(StiTextOptions textOptions)
                     throws java.io.IOException
Render text angle

Parameters:
textOptions - StiTextOptions
Throws:
java.io.IOException

renderTextDirection

public void renderTextDirection(StiHtmlTableCell cell,
                                StiTextOptions textOptions)
                         throws java.io.IOException
Render text direction

Parameters:
cell - StiHtmlTableCell
textOptions - StiTextOptions
Throws:
java.io.IOException

renderBackColor

public void renderBackColor(StiHtmlTableCell cell,
                            StiColor color)
                     throws java.io.IOException
Render backward color

Parameters:
cell - StiHtmlTableCell
color - StiColor
Throws:
java.io.IOException

renderTextColor

public void renderTextColor(StiHtmlTableCell cell,
                            StiColor color)
                     throws java.io.IOException
Render text color

Parameters:
cell - StiHtmlTableCell
color - StiColor
Throws:
java.io.IOException

renderBorder

public void renderBorder(StiComponent comp)
                  throws java.io.IOException
Render StiComponent border

Parameters:
comp - StiComponent
Throws:
java.io.IOException

renderBorder

public void renderBorder(StiBorder border)
                  throws java.io.IOException
Render border

Parameters:
border - StiBorder
Throws:
java.io.IOException

renderBorder

public void renderBorder(StiHtmlTableCell cell,
                         StiBorderSide border,
                         java.lang.String side)
                  throws java.io.IOException
Render border

Parameters:
cell - StiHtmlTableCell
border - StiBorderSide
side -
Throws:
java.io.IOException

renderPosition

public void renderPosition(StiComponent comp)
                    throws java.io.IOException
Render StiComponent position

Parameters:
comp - StiComponent
Throws:
java.io.IOException

renderImage

public void renderImage(StiComponent comp)
                 throws java.io.IOException
Render StiComponent image

Parameters:
comp - StiComponent
Throws:
java.io.IOException

renderImage

public void renderImage(IStiExportImage exportImage,
                        java.lang.String imageURL)
                 throws java.io.IOException
Render image

Parameters:
exportImage - IStiExportImage
imageURL -
Throws:
java.io.IOException

renderImage

public void renderImage(java.awt.image.BufferedImage image,
                        java.lang.String imageURL,
                        double zoom,
                        int margin)
                 throws java.io.IOException
Render BufferedImage

Parameters:
image - BufferedImage
imageURL -
zoom -
Throws:
java.io.IOException

renderPage

public void renderPage(StiPagesCollection pages,
                       boolean useBookmarksTree,
                       int bookmarkWidth,
                       StiHtmlExportSettings settings)
                throws java.io.IOException
Render pages

Parameters:
pages - StiPagesCollection of rendered pages
useBookmarksTree -
bookmarkWidth -
Throws:
java.io.IOException

renderStartDoc

public void renderStartDoc(StiHtmlTableRender render,
                           boolean asTable,
                           boolean useBookmarks,
                           boolean exportBookmarksOnly,
                           java.util.Hashtable<java.lang.String,java.lang.String> cssStyles,
                           StiPagesCollection pages,
                           java.nio.charset.Charset charset)
                    throws java.io.IOException
Render start document

Parameters:
render - StiHtmlTableRender
asTable -
useBookmarks -
exportBookmarksOnly -
cssStyles -
pages -
charset -
Throws:
java.io.IOException

renderBookmarkScript

public void renderBookmarkScript()
                          throws java.io.IOException
Render bookmark script

Throws:
java.io.IOException

getGuid

public java.lang.String getGuid(StiComponent comp)

renderEndDoc

public void renderEndDoc()
                  throws java.io.IOException
Render end doucment

Throws:
java.io.IOException

prepareTextForHtml

public java.lang.String prepareTextForHtml(java.lang.String text,
                                           boolean processWhiteSpaces)

convertTextWithHtmlTagsToHtmlText

public static java.lang.String convertTextWithHtmlTagsToHtmlText(StiText stiText,
                                                                 java.lang.String text,
                                                                 double zoom)
Convert html text to html

Parameters:
stiText - StiText
text -
Returns:
Converted html

getFile

public byte[] getFile(java.lang.String filePath)
Convert file to byte array

Parameters:
filePath -
Returns:
Byte array of image

prepareChartData

public java.lang.String prepareChartData(StiHtmlTextWriter writer,
                                         StiChart chart,
                                         double width,
                                         double height)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         javax.xml.transform.TransformerException
Throws:
javax.xml.parsers.ParserConfigurationException
java.io.IOException
javax.xml.transform.TransformerException

prepareGaugeData

public java.lang.String prepareGaugeData(StiHtmlTextWriter writer,
                                         StiGauge gauge,
                                         double width,
                                         double height)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         javax.xml.transform.TransformerException
Throws:
javax.xml.parsers.ParserConfigurationException
java.io.IOException
javax.xml.transform.TransformerException

prepareMapData

public java.lang.String prepareMapData(StiHtmlTextWriter writer,
                                       StiMap map,
                                       double width,
                                       double height)
                                throws java.lang.Exception
Throws:
java.lang.Exception

getChartScript

public java.lang.String getChartScript()
                                throws java.io.IOException
Throws:
java.io.IOException

clear

public void clear()
Clear


export

public void export(StiReport report,
                   java.io.OutputStream outputStream,
                   StiExportSettings exportSettings)
            throws StiException
Export StiReport

Specified by:
export in class StiExportService
Parameters:
report - StiReport to export
outputStream - OutputStream for export
exportSettings - StiExportSettings
Throws:
StiException

exportHtml

public void exportHtml(StiReport report,
                       java.io.OutputStream stream,
                       StiHtmlExportSettings settings)
                throws StiException
Exports a document to the HTML.

Parameters:
report - A rendered StiReport which is to be exported.
stream - A OutputStream for export of a document.
settings - StiHtmlExportSettings
Throws:
java.io.IOException
StiException

isUseStylesTable

public boolean isUseStylesTable()
Returns:
the useStylesTable

setUseStylesTable

public void setUseStylesTable(boolean useStylesTable)
Parameters:
useStylesTable - the useStylesTable to set

getZoom

public double getZoom()
Returns:
the zoom

setZoom

public void setZoom(double zoom)
Parameters:
zoom - the zoom to set

getExportQuality

public StiHtmlExportQuality getExportQuality()
Returns:
the exportQuality

setExportQuality

public void setExportQuality(StiHtmlExportQuality exportQuality)
Parameters:
exportQuality - the exportQuality to set

getInteractionComponents

public java.util.Hashtable<java.lang.Object,java.lang.Object> getInteractionComponents()
Returns:
the interactionComponents

setInteractionComponents

public void setInteractionComponents(java.util.Hashtable<java.lang.Object,java.lang.Object> interactionComponents)
Parameters:
interactionComponents - the interactionComponents to set

getImageQuality

public float getImageQuality()
Returns:
the imageQuality

setImageQuality

public void setImageQuality(float imageQuality)
Parameters:
imageQuality - the imageQuality to set

getImageResolution

public float getImageResolution()
Returns:
the imageResolution

setImageResolution

public void setImageResolution(float imageResolution)
Parameters:
imageResolution - the imageResolution to set

getHtmlImageHost

public StiHtmlImageHost getHtmlImageHost()
Returns:
the htmlImageHost

setHtmlImageHost

public void setHtmlImageHost(StiHtmlImageHost htmlImageHost)
Parameters:
htmlImageHost - the htmlImageHost to set

getReport

public StiReport getReport()
Returns:
the report

setReport

public void setReport(StiReport report)
Parameters:
report - the report to set

getHtmlWriter

public StiHtmlTextWriter getHtmlWriter()
Returns:
the htmlWriter

setHtmlWriter

public void setHtmlWriter(StiHtmlTextWriter htmlWriter)
Parameters:
htmlWriter - the htmlWriter to set

getStyles

public java.util.ArrayList<StiCellStyle> getStyles()
Returns:
the styles

setStyles

public void setStyles(java.util.ArrayList<StiCellStyle> styles)
Parameters:
styles - the styles to set

getImageFormat

public StiImageFormat getImageFormat()
Returns:
the imageFormat

isFileStreamMode

public boolean isFileStreamMode()
Returns:
the fileStreamMode

setFileStreamMode

public void setFileStreamMode(boolean fileStreamMode)
Parameters:
fileStreamMode - the fileStreamMode to set

getFileName

public java.lang.String getFileName()
Returns:
the fileName

getExportFormat

public StiExportFormat getExportFormat()
Returs service export format

Specified by:
getExportFormat in class StiExportService
Returns:
StiExportFormat

getTableRender

public StiHtmlTableRender getTableRender()
Returns:
the tableRender

isRenderAsDocument

public boolean isRenderAsDocument()
Returns:
the renderAsDocument

setRenderAsDocument

public void setRenderAsDocument(boolean renderAsDocument)
Parameters:
renderAsDocument - the renderAsDocument to set

isClearOnFinish

public boolean isClearOnFinish()
Returns:
the clearOnFinish

setClearOnFinish

public void setClearOnFinish(boolean clearOnFinish)
Parameters:
clearOnFinish - the clearOnFinish to set

isRenderStyles

public boolean isRenderStyles()
Returns:
the renderStyles

setRenderStyles

public void setRenderStyles(boolean renderStyles)
Parameters:
renderStyles - the renderStyles to set

isRemoveEmptySpaceAtBottom

public boolean isRemoveEmptySpaceAtBottom()
Returns:
the removeEmptySpaceAtBottom

getPageHorAlignment

public StiHorAlignment getPageHorAlignment()
Returns:
the pageHorAlignment

getMultipleFiles

public boolean getMultipleFiles()
Gets a value indicating a number of files in exported document as a result of export

Specified by:
getMultipleFiles in class StiExportService
Returns:
Support multiple files