com.stimulsoft.report.export.settings

Class StiHtmlExportSettings

java.lang.Object

com.stimulsoft.report.export.settings.StiExportSettings

com.stimulsoft.report.export.settings.StiPageRangeExportSettings

com.stimulsoft.report.export.settings.StiHtmlExportSettings

public class StiHtmlExportSettings
extends StiPageRangeExportSettings

HTML format export settings Copyright Stimulsoft

Constructor Summary

Constructors

Constructor and Description
StiHtmlExportSettings()
StiHtmlExportSettings(StiExportSettings settings)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBookmarksTreeWidth() Gets defaullt width of bookmarks tree.
StiHtmlChartType	getChartType() type of the chart in the exported html file.
java.nio.charset.Charset	getEncoding() Gets encoding of html file.
StiHtmlExportBookmarksMode	getExportBookmarksMode() Gets export mode of bookmarks tree.
StiExportFormat	getExportFormat() Export format
StiHtmlExportMode	getExportMode() Gets mode of html file creation.
StiHtmlExportQuality	getExportQuality() Gets quality of html file.
StiImageFormat	getImageFormat() Gets image format for exported images.
float	getImageQuality() Gets image quality of images which will be exported to result file.
float	getImageResolution() Gets image resolution of images which will be exported to result file.
java.lang.String	getOpenLinksTarget() a target to open links from the exported report.
StiHorAlignment	getPageHorAlignment() The horizontal alignment of pages.
double	getZoom() Gets zoom factor of exported file.
boolean	isAddPageBreaks() Gets value which indicates that special page breaks marker will be added to result html file.
boolean	isRemoveEmptySpaceAtBottom()
boolean	isUseStylesTable() Gets value which indicates that table styles will be used in result html file.
boolean	isUseWatermarkMargins()
void	setAddPageBreaks(boolean addPageBreaks) Sets value which indicates that special page breaks marker will be added to result html file.
void	setBookmarksTreeWidth(int bookmarksTreeWidth) Sets defaullt width of bookmarks tree.
void	setChartType(StiHtmlChartType chartType) type of the chart in the exported html file.
void	setEncoding(java.nio.charset.Charset encoding) Sets encoding of html file.
void	setExportBookmarksMode(StiHtmlExportBookmarksMode exportBookmarksMode) Sets export mode of bookmarks tree.
void	setExportMode(StiHtmlExportMode exportMode) Sets mode of html file creation.
void	setExportQuality(StiHtmlExportQuality exportQuality) Sets quality of html file.
void	setImageFormat(StiImageFormat imageFormat) Sets image format for exported images
void	setImageQuality(float imageQuality) Sets image quality of images which will be exported to result file.
void	setImageResolution(float imageResolution) Sets image resolution of images which will be exported to result file.
void	setOpenLinksTarget(java.lang.String openLinksTarget) a target to open links from the exported report.
void	setPageHorAlignment(StiHorAlignment pageHorAlignment) The horizontal alignment of pages.
void	setRemoveEmptySpaceAtBottom(boolean removeEmptySpaceAtBottom)
void	setUseStylesTable(boolean useStylesTable) Sets value which indicates that table styles will be used in result html file.
void	setUseWatermarkMargins(boolean useWatermarkMargins)
void	setZoom(double zoom) Sets zoom factor of exported file.

Methods inherited from class com.stimulsoft.report.export.settings.StiPageRangeExportSettings

getPageRange, isOpenAfterExport, isSendEmail, setExportFormat, setOpenAfterExport, setPageRange, setSendEmail

Methods inherited from class java.lang.Object

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

Constructor Detail

StiHtmlExportSettings

public StiHtmlExportSettings()

StiHtmlExportSettings

public StiHtmlExportSettings(StiExportSettings settings)

Method Detail

isUseWatermarkMargins

public boolean isUseWatermarkMargins()

Returns:

the useWatermarkMargins

setUseWatermarkMargins

public void setUseWatermarkMargins(boolean useWatermarkMargins)

Parameters:

useWatermarkMargins - the useWatermarkMargins to set

getExportFormat

public StiExportFormat getExportFormat()

Export format

Overrides:

getExportFormat in class StiPageRangeExportSettings

Returns:

the exportFormat

getImageQuality

public float getImageQuality()

Gets image quality of images which will be exported to result file.

Returns:

the imageQuality

setImageQuality

public void setImageQuality(float imageQuality)

Sets image quality of images which will be exported to result file.

Parameters:

imageQuality - the imageQuality to set

getImageResolution

public float getImageResolution()

Gets image resolution of images which will be exported to result file.

Returns:

the imageResolution

setImageResolution

public void setImageResolution(float imageResolution)

Sets image resolution of images which will be exported to result file.

Parameters:

imageResolution - the imageResolution to set

getZoom

public double getZoom()

Gets zoom factor of exported file.

Returns:

the zoom

setZoom

public void setZoom(double zoom)

Sets zoom factor of exported file.

Parameters:

zoom - the zoom to set

getImageFormat

public StiImageFormat getImageFormat()

Gets image format for exported images.

Returns:

the imageFormat

setImageFormat

public void setImageFormat(StiImageFormat imageFormat)

Sets image format for exported images. *

Parameters:

imageFormat - the imageFormat to set

getExportMode

public StiHtmlExportMode getExportMode()

Gets mode of html file creation.

Returns:

the exportMode

setExportMode

public void setExportMode(StiHtmlExportMode exportMode)

Sets mode of html file creation.

Parameters:

exportMode - the exportMode to set

getExportQuality

public StiHtmlExportQuality getExportQuality()

Gets quality of html file.

Returns:

the exportQuality

setExportQuality

public void setExportQuality(StiHtmlExportQuality exportQuality)

Sets quality of html file.

Parameters:

exportQuality - the exportQuality to set

getEncoding

public java.nio.charset.Charset getEncoding()

Gets encoding of html file.

Returns:

the encoding

setEncoding

public void setEncoding(java.nio.charset.Charset encoding)

Sets encoding of html file.

Parameters:

encoding - the encoding to set

isAddPageBreaks

public boolean isAddPageBreaks()

Gets value which indicates that special page breaks marker will be added to result html file.

Returns:

the addPageBreaks

setAddPageBreaks

public void setAddPageBreaks(boolean addPageBreaks)

Sets value which indicates that special page breaks marker will be added to result html file.

Parameters:

addPageBreaks - the addPageBreaks to set

getBookmarksTreeWidth

public int getBookmarksTreeWidth()

Gets defaullt width of bookmarks tree.

Returns:

the bookmarksTreeWidth

setBookmarksTreeWidth

public void setBookmarksTreeWidth(int bookmarksTreeWidth)

Sets defaullt width of bookmarks tree.

Parameters:

bookmarksTreeWidth - the bookmarksTreeWidth to set

getExportBookmarksMode

public StiHtmlExportBookmarksMode getExportBookmarksMode()

Gets export mode of bookmarks tree.

Returns:

the exportBookmarksMode

setExportBookmarksMode

public void setExportBookmarksMode(StiHtmlExportBookmarksMode exportBookmarksMode)

Sets export mode of bookmarks tree.

Parameters:

exportBookmarksMode - the exportBookmarksMode to set

isUseStylesTable

public boolean isUseStylesTable()

Gets value which indicates that table styles will be used in result html file.

Returns:

the useStylesTable

setUseStylesTable

public void setUseStylesTable(boolean useStylesTable)

Sets value which indicates that table styles will be used in result html file.

Parameters:

useStylesTable - the useStylesTable to set

isRemoveEmptySpaceAtBottom

public boolean isRemoveEmptySpaceAtBottom()

Returns:

the removeEmptySpaceAtBottom

setRemoveEmptySpaceAtBottom

public void setRemoveEmptySpaceAtBottom(boolean removeEmptySpaceAtBottom)

Parameters:

removeEmptySpaceAtBottom - the removeEmptySpaceAtBottom to set

getPageHorAlignment

public StiHorAlignment getPageHorAlignment()

The horizontal alignment of pages.

Returns:

the pageHorAlignment

setPageHorAlignment

public void setPageHorAlignment(StiHorAlignment pageHorAlignment)

The horizontal alignment of pages.

Parameters:

pageHorAlignment - the pageHorAlignment to set

getOpenLinksTarget

public java.lang.String getOpenLinksTarget()

a target to open links from the exported report.

Returns:

the openLinksTarget

setOpenLinksTarget

public void setOpenLinksTarget(java.lang.String openLinksTarget)

a target to open links from the exported report.

Parameters:

openLinksTarget - the openLinksTarget to set

getChartType

public StiHtmlChartType getChartType()

type of the chart in the exported html file. HTML5 export mode is not supported.

Returns:

the chartType

setChartType

public void setChartType(StiHtmlChartType chartType)

type of the chart in the exported html file. HTML5 export mode is not supported.

Parameters:

chartType - the chartType to set