Package com.stimulsoft.report.export.service

Class StiHtmlExportService

java.lang.Object

com.stimulsoft.report.export.service.StiExportService

com.stimulsoft.report.export.service.StiHtmlExportService

public class StiHtmlExportService
extends StiExportService

Class represent export for HTML format Copyright Stimulsoft

Field Summary

Fields

Modifier and Type	Field	Description
StiHtmlChartType	chartType
Hashtable<String,String>	hashBookmarkGuid
static double	LINE_HEIGHT_CORRECTION
String	openLinksTarget
List<StiPage>	pageSizeList

Fields inherited from class com.stimulsoft.report.export.service.StiExportService

currentPassNumber, DATE_1900, exFile, exportedFiles, exportReport, maximumPassNumber, MILLISECONDS_IN_DAY, multipleFiles, ONE_HOUR, outputStream, RenderedPagesCount, statusString

Constructor Summary

Constructors

Constructor	Description
StiHtmlExportService()

Method Summary

Modifier and Type	Method	Description
void	addCoord(StiRectangle rect)	Add coordinates to map
void	clear()	Clear
static String	convertTextWithHtmlTagsToHtmlText(StiText stiText, String text, double zoom)	Convert html text to html
void	export(StiReport report, OutputStream outputStream, StiExportSettings exportSettings)	Export StiReport
void	exportHtml(StiReport report, OutputStream stream, StiHtmlExportSettings settings)	Exports a document to the HTML.
void	exportHtmlWithoutEvents(StiReport report, OutputStream stream, StiHtmlExportSettings settings)
String	formatColor(StiColor color)	Convert StiColor to String value
HashMap<StiComponent,String>	getChartData()
String	getChartScript()
StiExportFormat	getExportFormat()	Returs service export format
StiHtmlExportQuality	getExportQuality()
byte[]	getFile(String filePath)	Convert file to byte array
String	getFileName()
static double	getFontHeightCorrection(String font)
String	getGuid(StiComponent comp)
StiHtmlImageHost	getHtmlImageHost()
StiHtmlTextWriter	getHtmlWriter()
StiImageFormat	getImageFormat()
float	getImageQuality()
float	getImageResolution()
Hashtable<Object,Object>	getInteractionComponents()
boolean	getMultipleFiles()	Gets a value indicating a number of files in exported document as a result of export
StiHorAlignment	getPageHorAlignment()
int	getPageSizeIndex(StiPage page)
StiReport	getReport()
ArrayList<StiCellStyle>	getStyles()
StiHtmlTableRender	getTableRender()
double	getZoom()
boolean	isClearOnFinish()
boolean	isFileStreamMode()
boolean	isRemoveEmptySpaceAtBottom()
boolean	isRenderAsDocument()
boolean	isRenderStyles()
boolean	isRenderWebInteractions()
boolean	isRenderWebViewer()
boolean	isUseStylesTable()
String	prepareChartData(StiHtmlTextWriter writer, StiChart chart, double width, double height)
String	prepareGaugeData(StiHtmlTextWriter writer, StiGauge gauge, double width, double height)
String	prepareMapData(StiHtmlTextWriter writer, StiMap map, double width, double height)
String	prepareTextForHtml(String text, boolean processWhiteSpaces)
String	prepareTextForHtml(String text, boolean processWhiteSpaces, boolean isJustify)
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, String side)	Render border
void	renderEndDoc()	Render end doucment
void	renderFont(StiHtmlTableCell cell, StiFont font)	Render font
void	renderImage(StiComponent comp)	Render StiComponent image
void	renderImage(StiComponent component, String imageURL)	Render image
void	renderImage(BufferedImage image, StiComponent component, String imageURL, double zoom, int margin)	Render BufferedImage
void	renderPage(StiPagesCollection pages, boolean useBookmarksTree, int bookmarkWidth, StiPage page, boolean writePageBreak)	Render pages
String	renderPosition(StiComponent comp, boolean returnSize, boolean asImage)	Render StiComponent position
void	renderStartDoc(StiHtmlTableRender render, boolean asTable, boolean useBookmarks, boolean exportBookmarksOnly, Hashtable<String,String> cssStyles, StiPagesCollection pages, 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, StiTextOptions textOptions, StiTextHorAlignment textHorAlignment)	Render text horizontal alignmeng
void	renderVertAlignment(StiHtmlTableCell cell, StiVertAlignment textVertAlignment, StiTextOptions textOptions, boolean allowHtmlTags)	Render vertical alignment
void	setChartData(HashMap<StiComponent,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(Hashtable<Object,Object> interactionComponents)
void	setRenderAsDocument(boolean renderAsDocument)
void	setRenderStyles(boolean renderStyles)
void	setRenderWebInteractions(boolean renderWebInteractions)
void	setRenderWebViewer(boolean renderWebViewer)
void	setReport(StiReport report)
void	setStyles(ArrayList<StiCellStyle> styles)
void	setUseStylesTable(boolean useStylesTable)
void	setZoom(double zoom)

Methods inherited from class com.stimulsoft.report.export.service.StiExportService

closeProgress, export, export, export, export, getExFile, getExportedFiles, getExportSettings, getStatusString, invokeExporting, invokeExporting, invokeExporting, isStoped, processFile, sendEMail, sendEMail, setExFile, setExportReport, setExportSettings, setOutputStream, setProgress, setStatusString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LINE_HEIGHT_CORRECTION

public static double LINE_HEIGHT_CORRECTION

hashBookmarkGuid

public Hashtable<String,String> hashBookmarkGuid

openLinksTarget

public String openLinksTarget

chartType

public StiHtmlChartType chartType

pageSizeList

public List<StiPage> pageSizeList

Constructor Details

StiHtmlExportService

public StiHtmlExportService()

Method Details

getPageSizeIndex

public int getPageSizeIndex(StiPage page)

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 HashMap<StiComponent,String> getChartData()

Returns:

the chartData

setChartData

public void setChartData(HashMap<StiComponent,String> chartData)

Parameters:

chartData - the chartData to set

addCoord

public void addCoord(StiRectangle rect)

Add coordinates to map

Parameters:

rect - StiRectangle

formatColor

public String formatColor(StiColor color)

Convert StiColor to String value

Parameters:

color -

Returns:

Formatted color

getFontHeightCorrection

public static double getFontHeightCorrection(String font)

renderFont

public void renderFont(StiHtmlTableCell cell,
 StiFont font)
                throws IOException

Render font

Parameters:

cell - StiHtmlTableCell

font - StiFont

Throws:

IOException

renderTextHorAlignment

public void renderTextHorAlignment(StiHtmlTableCell cell,
 StiTextOptions textOptions,
 StiTextHorAlignment textHorAlignment)
                            throws IOException

Render text horizontal alignmeng

Parameters:

cell - StiHtmlTableCell

style - StiCellStyle

Throws:

IOException

renderVertAlignment

public void renderVertAlignment(StiHtmlTableCell cell,
 StiVertAlignment textVertAlignment,
 StiTextOptions textOptions,
 boolean allowHtmlTags)
                         throws IOException

Render vertical alignment

Parameters:

cell - StiHtmlTableCell

textVertAlignment - StiVertAlignment

Throws:

IOException

renderTextAngle

public void renderTextAngle(StiTextOptions textOptions)
                     throws IOException

Render text angle

Parameters:

textOptions - StiTextOptions

Throws:

IOException

renderTextDirection

public void renderTextDirection(StiHtmlTableCell cell,
 StiTextOptions textOptions)
                         throws IOException

Render text direction

Parameters:

cell - StiHtmlTableCell

textOptions - StiTextOptions

Throws:

IOException

renderBackColor

public void renderBackColor(StiHtmlTableCell cell,
 StiColor color)
                     throws IOException

Render backward color

Parameters:

cell - StiHtmlTableCell

color - StiColor

Throws:

IOException

renderTextColor

public void renderTextColor(StiHtmlTableCell cell,
 StiColor color)
                     throws IOException

Render text color

Parameters:

cell - StiHtmlTableCell

color - StiColor

Throws:

IOException

renderBorder

public void renderBorder(StiComponent comp)
                  throws IOException

Render StiComponent border

Parameters:

comp - StiComponent

Throws:

IOException

renderBorder

public void renderBorder(StiBorder border)
                  throws IOException

Render border

Parameters:

border - StiBorder

Throws:

IOException

renderBorder

public void renderBorder(StiHtmlTableCell cell,
 StiBorderSide border,
 String side)
                  throws IOException

Render border

Parameters:

cell - StiHtmlTableCell

border - StiBorderSide

side -

Throws:

IOException

renderPosition

public String renderPosition(StiComponent comp,
 boolean returnSize,
 boolean asImage)
                      throws IOException

Render StiComponent position

Parameters:

comp - StiComponent

Throws:

IOException

renderImage

public void renderImage(StiComponent comp)
                 throws IOException

Render StiComponent image

Parameters:

comp - StiComponent

Throws:

IOException

renderImage

public void renderImage(StiComponent component,
 String imageURL)
                 throws IOException

Render image

Parameters:

imageURL -

exportImage - IStiExportImage

Throws:

IOException

renderImage

public void renderImage(BufferedImage image,
 StiComponent component,
 String imageURL,
 double zoom,
 int margin)
                 throws IOException

Render BufferedImage

Parameters:

image - BufferedImage

imageURL -

zoom -

Throws:

IOException

renderPage

public void renderPage(StiPagesCollection pages,
 boolean useBookmarksTree,
 int bookmarkWidth,
 StiPage page,
 boolean writePageBreak)
                throws IOException

Render pages

Parameters:

pages - StiPagesCollection of rendered pages

useBookmarksTree -

bookmarkWidth -

Throws:

IOException

renderStartDoc

public void renderStartDoc(StiHtmlTableRender render,
 boolean asTable,
 boolean useBookmarks,
 boolean exportBookmarksOnly,
 Hashtable<String,String> cssStyles,
 StiPagesCollection pages,
 Charset charset)
                    throws IOException

Render start document

Parameters:

render - StiHtmlTableRender

asTable -

useBookmarks -

exportBookmarksOnly -

cssStyles -

pages -

charset -

Throws:

IOException

renderBookmarkScript

public void renderBookmarkScript()
                          throws IOException

Render bookmark script

Throws:

IOException

getGuid

public String getGuid(StiComponent comp)

renderEndDoc

public void renderEndDoc()
                  throws IOException

Render end doucment

Throws:

IOException

prepareTextForHtml

public String prepareTextForHtml(String text,
 boolean processWhiteSpaces)

prepareTextForHtml

public String prepareTextForHtml(String text,
 boolean processWhiteSpaces,
 boolean isJustify)

convertTextWithHtmlTagsToHtmlText

public static String convertTextWithHtmlTagsToHtmlText(StiText stiText,
 String text,
 double zoom)

Convert html text to html

Parameters:

stiText - StiText

text -

Returns:

Converted html

getFile

public byte[] getFile(String filePath)

Convert file to byte array

Parameters:

filePath -

Returns:

Byte array of image

prepareChartData

public String prepareChartData(StiHtmlTextWriter writer,
 StiChart chart,
 double width,
 double height)
                        throws ParserConfigurationException,
IOException,
TransformerException

Throws:

ParserConfigurationException

IOException

TransformerException

prepareGaugeData

public String prepareGaugeData(StiHtmlTextWriter writer,
 StiGauge gauge,
 double width,
 double height)
                        throws ParserConfigurationException,
IOException,
TransformerException

Throws:

ParserConfigurationException

IOException

TransformerException

prepareMapData

public String prepareMapData(StiHtmlTextWriter writer,
 StiMap map,
 double width,
 double height)
                      throws Exception

Throws:

Exception

getChartScript

public String getChartScript()
                      throws IOException

Throws:

IOException

clear

public void clear()

Clear

export

public void export(StiReport report,
 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

exportHtmlWithoutEvents

public void exportHtmlWithoutEvents(StiReport report,
 OutputStream stream,
 StiHtmlExportSettings settings)
                             throws StiException

Throws:

StiException

exportHtml

public void exportHtml(StiReport report,
 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:

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 Hashtable<Object,Object> getInteractionComponents()

Returns:

the interactionComponents

setInteractionComponents

public void setInteractionComponents(Hashtable<Object,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 ArrayList<StiCellStyle> getStyles()

Returns:

the styles

setStyles

public void setStyles(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 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