Package net.sf.jasperreports.export

Class SimpleHtmlReportConfiguration

java.lang.Object

net.sf.jasperreports.export.SimpleCommonExportConfiguration

net.sf.jasperreports.export.SimpleReportExportConfiguration

net.sf.jasperreports.export.SimpleHtmlReportConfiguration

All Implemented Interfaces:

CommonExportConfiguration, HtmlReportConfiguration, ReportExportConfiguration

public class SimpleHtmlReportConfiguration
extends SimpleReportExportConfiguration
implements HtmlReportConfiguration

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Fields inherited from interface net.sf.jasperreports.export.HtmlReportConfiguration

PROPERTY_ACCESSIBLE, PROPERTY_BORDER_COLLAPSE, PROPERTY_CONVERT_SVG_TO_IMAGE, PROPERTY_EMBED_IMAGE, PROPERTY_EMBEDDED_SVG_USE_FONTS, PROPERTY_FORCE_HTML_EMBED_IMAGE, PROPERTY_IGNORE_HYPERLINK, PROPERTY_INCLUDE_ELEMENT_UUID, PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS, PROPERTY_SIZE_UNIT, PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN, PROPERTY_WHITE_PAGE_BACKGROUND, PROPERTY_WRAP_BREAK_WORD

Fields inherited from interface net.sf.jasperreports.export.ReportExportConfiguration

PROPERTY_IGNORE_PAGE_MARGINS

Constructor Summary

Constructors

Constructor	Description
SimpleHtmlReportConfiguration()

Method Summary

Modifier and Type	Method	Description
HtmlBorderCollapseEnum	getBorderCollapseValue()	Provides the value for the border-collapse CSS property to be applied to the table generated for the report.
HtmlSizeUnitEnum	getSizeUnit()	Returns a String value specifying the unit to use when measuring lengths or font size.
Float	getZoomRatio()	The zoom ratio used for the export.
Boolean	isAccessibleHtml()	Configuration setting that determines the exporter to produce accessible HTML.
Boolean	isConvertSvgToImage()
Boolean	isEmbeddedSvgUseFonts()
Boolean	isEmbedImage()
Boolean	isIgnoreHyperlink()
Boolean	isIgnorePageMargins()	Indicates whether page margins should be ignored when the report is exported using a grid-based exporter
Boolean	isIncludeElementUUID()	Determines whether design element UUIDs are included in the HTML output as data-eluuid attributes of td elements.
Boolean	isRemoveEmptySpaceBetweenRows()	Returns a boolean value specifying whether the blank lines, that sometimes appear between rows, should be deleted.
Boolean	isUseBackgroundImageToAlign()
Boolean	isWhitePageBackground()	Returns a boolean value specifying whether the report background should be white.
Boolean	isWrapBreakWord()	Returns a boolean value specifying whether the export engine should use force wrapping by breaking words (CSS word-wrap: break-word).
void	setAccessibleHtml(Boolean accessibleHtml)
void	setBorderCollapse(HtmlBorderCollapseEnum borderCollapse)
void	setConvertSvgToImage(Boolean isConvertSvgToImage)
void	setEmbeddedSvgUseFonts(Boolean isEmbeddedSvgUseFonts)
void	setEmbedImage(Boolean isEmbedImage)
void	setIgnoreHyperlink(Boolean isIgnoreHyperlink)
void	setIgnorePageMargins(Boolean isIgnorePageMargins)
void	setIncludeElementUUID(Boolean includeElementUUID)
void	setRemoveEmptySpaceBetweenRows(Boolean isRemoveEmptySpaceBetweenRows)
void	setSizeUnit(HtmlSizeUnitEnum sizeUnit)
void	setUseBackgroundImageToAlign(Boolean isUseBackgroundImageToAlign)
void	setWhitePageBackground(Boolean isWhitePageBackground)
void	setWrapBreakWord(Boolean isWrapBreakWord)
void	setZoomRatio(Float zoomRatio)

Methods inherited from class net.sf.jasperreports.export.SimpleReportExportConfiguration

getEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndex, setEndPageIndex, setExporterFilter, setHyperlinkProducerFactory, setOffsetX, setOffsetY, setPageIndex, setProgressMonitor, setStartPageIndex

Methods inherited from class net.sf.jasperreports.export.SimpleCommonExportConfiguration

isOverrideHints, setOverrideHints

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

isOverrideHints

Methods inherited from interface net.sf.jasperreports.export.ReportExportConfiguration

getEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndex

Constructor Details

SimpleHtmlReportConfiguration

public SimpleHtmlReportConfiguration()

Method Details

isRemoveEmptySpaceBetweenRows

public Boolean isRemoveEmptySpaceBetweenRows()

Description copied from interface: HtmlReportConfiguration

Returns a boolean value specifying whether the blank lines, that sometimes appear between rows, should be deleted. Sometimes page break occurs before the entire page is filled with data (i.e. having a group with the isStartNewPage attribute set to true). All the remaining empty space could be removed by setting this parameter to true.

Specified by:

isRemoveEmptySpaceBetweenRows in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS

setRemoveEmptySpaceBetweenRows

public void setRemoveEmptySpaceBetweenRows(Boolean isRemoveEmptySpaceBetweenRows)

isWhitePageBackground

public Boolean isWhitePageBackground()

Description copied from interface: HtmlReportConfiguration

Returns a boolean value specifying whether the report background should be white. If this parameter is not set, the default background will appear, depending on the selected CSS styles.

Specified by:

isWhitePageBackground in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_WHITE_PAGE_BACKGROUND

setWhitePageBackground

public void setWhitePageBackground(Boolean isWhitePageBackground)

isWrapBreakWord

public Boolean isWrapBreakWord()

Description copied from interface: HtmlReportConfiguration

Returns a boolean value specifying whether the export engine should use force wrapping by breaking words (CSS word-wrap: break-word).

Note that this CSS property is not currently supported by all browsers. An alternative approach for forcing word breaks in HTML is to save the line breaks at fill time via the JRTextElement.PROPERTY_SAVE_LINE_BREAKS property.

Specified by:

isWrapBreakWord in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_WRAP_BREAK_WORD

setWrapBreakWord

public void setWrapBreakWord(Boolean isWrapBreakWord)

getSizeUnit

public HtmlSizeUnitEnum getSizeUnit()

Description copied from interface: HtmlReportConfiguration

Returns a String value specifying the unit to use when measuring lengths or font size. This can be one of the supported size units from the CSS specifications like "px" for pixels or "pt" for points. The default value is "px", meaning that lengths and font sizes are specified in pixels.

Specified by:

getSizeUnit in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_SIZE_UNIT

setSizeUnit

public void setSizeUnit(HtmlSizeUnitEnum sizeUnit)

getBorderCollapseValue

public HtmlBorderCollapseEnum getBorderCollapseValue()

Description copied from interface: HtmlReportConfiguration

Provides the value for the border-collapse CSS property to be applied to the table generated for the report.

Specified by:

getBorderCollapseValue in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_BORDER_COLLAPSE

setBorderCollapse

public void setBorderCollapse(HtmlBorderCollapseEnum borderCollapse)

isIgnorePageMargins

public Boolean isIgnorePageMargins()

Description copied from interface: HtmlReportConfiguration

Indicates whether page margins should be ignored when the report is exported using a grid-based exporter

If set to true, any page in the document will be exported without taking into account its margins.

Specified by:

isIgnorePageMargins in interface HtmlReportConfiguration

See Also:

• ReportExportConfiguration.PROPERTY_IGNORE_PAGE_MARGINS

setIgnorePageMargins

public void setIgnorePageMargins(Boolean isIgnorePageMargins)

isAccessibleHtml

public Boolean isAccessibleHtml()

Description copied from interface: HtmlReportConfiguration

Configuration setting that determines the exporter to produce accessible HTML.

Specified by:

isAccessibleHtml in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_ACCESSIBLE

setAccessibleHtml

public void setAccessibleHtml(Boolean accessibleHtml)

getZoomRatio

public Float getZoomRatio()

Description copied from interface: HtmlReportConfiguration

The zoom ratio used for the export. The default value is 1.

Specified by:

getZoomRatio in interface HtmlReportConfiguration

setZoomRatio

public void setZoomRatio(Float zoomRatio)

isIgnoreHyperlink

public Boolean isIgnoreHyperlink()

Specified by:

isIgnoreHyperlink in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_IGNORE_HYPERLINK

setIgnoreHyperlink

public void setIgnoreHyperlink(Boolean isIgnoreHyperlink)

isEmbedImage

public Boolean isEmbedImage()

Specified by:

isEmbedImage in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_EMBED_IMAGE

setEmbedImage

public void setEmbedImage(Boolean isEmbedImage)

isEmbeddedSvgUseFonts

public Boolean isEmbeddedSvgUseFonts()

Specified by:

isEmbeddedSvgUseFonts in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_EMBEDDED_SVG_USE_FONTS

setEmbeddedSvgUseFonts

public void setEmbeddedSvgUseFonts(Boolean isEmbeddedSvgUseFonts)

isConvertSvgToImage

public Boolean isConvertSvgToImage()

Specified by:

isConvertSvgToImage in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_CONVERT_SVG_TO_IMAGE

setConvertSvgToImage

public void setConvertSvgToImage(Boolean isConvertSvgToImage)

isUseBackgroundImageToAlign

public Boolean isUseBackgroundImageToAlign()

Specified by:

isUseBackgroundImageToAlign in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN

setUseBackgroundImageToAlign

public void setUseBackgroundImageToAlign(Boolean isUseBackgroundImageToAlign)

isIncludeElementUUID

public Boolean isIncludeElementUUID()

Description copied from interface: HtmlReportConfiguration

Determines whether design element UUIDs are included in the HTML output as data-eluuid attributes of td elements.

Specified by:

isIncludeElementUUID in interface HtmlReportConfiguration

See Also:

• HtmlReportConfiguration.PROPERTY_INCLUDE_ELEMENT_UUID
• JRIdentifiable.getUUID()

setIncludeElementUUID

public void setIncludeElementUUID(Boolean includeElementUUID)