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 -
Method Summary
Modifier and TypeMethodDescriptionProvides the value for theborder-collapse
CSS property to be applied to the table generated for the report.Returns a String value specifying the unit to use when measuring lengths or font size.The zoom ratio used for the export.Configuration setting that determines the exporter to produce accessible HTML.Indicates whether page margins should be ignored when the report is exported using a grid-based exporterDetermines whether design element UUIDs are included in the HTML output asdata-eluuid
attributes oftd
elements.Returns a boolean value specifying whether the blank lines, that sometimes appear between rows, should be deleted.Returns a boolean value specifying whether the report background should be white.Returns a boolean value specifying whether the export engine should use force wrapping by breaking words (CSSword-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
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 interfaceHtmlReportConfiguration
- See Also:
-
setRemoveEmptySpaceBetweenRows
-
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 interfaceHtmlReportConfiguration
- See Also:
-
setWhitePageBackground
-
isWrapBreakWord
Description copied from interface:HtmlReportConfiguration
Returns a boolean value specifying whether the export engine should use force wrapping by breaking words (CSSword-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 interfaceHtmlReportConfiguration
- See Also:
-
setWrapBreakWord
-
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 interfaceHtmlReportConfiguration
- See Also:
-
setSizeUnit
-
getBorderCollapseValue
Description copied from interface:HtmlReportConfiguration
Provides the value for theborder-collapse
CSS property to be applied to the table generated for the report.- Specified by:
getBorderCollapseValue
in interfaceHtmlReportConfiguration
- See Also:
-
setBorderCollapse
-
isIgnorePageMargins
Description copied from interface:HtmlReportConfiguration
Indicates whether page margins should be ignored when the report is exported using a grid-based exporterIf set to
true
, any page in the document will be exported without taking into account its margins.- Specified by:
isIgnorePageMargins
in interfaceHtmlReportConfiguration
- See Also:
-
setIgnorePageMargins
-
isAccessibleHtml
Description copied from interface:HtmlReportConfiguration
Configuration setting that determines the exporter to produce accessible HTML.- Specified by:
isAccessibleHtml
in interfaceHtmlReportConfiguration
- See Also:
-
setAccessibleHtml
-
getZoomRatio
Description copied from interface:HtmlReportConfiguration
The zoom ratio used for the export. The default value is 1.- Specified by:
getZoomRatio
in interfaceHtmlReportConfiguration
-
setZoomRatio
-
isIgnoreHyperlink
- Specified by:
isIgnoreHyperlink
in interfaceHtmlReportConfiguration
- See Also:
-
setIgnoreHyperlink
-
isEmbedImage
- Specified by:
isEmbedImage
in interfaceHtmlReportConfiguration
- See Also:
-
setEmbedImage
-
isEmbeddedSvgUseFonts
- Specified by:
isEmbeddedSvgUseFonts
in interfaceHtmlReportConfiguration
- See Also:
-
setEmbeddedSvgUseFonts
-
isConvertSvgToImage
- Specified by:
isConvertSvgToImage
in interfaceHtmlReportConfiguration
- See Also:
-
setConvertSvgToImage
-
isUseBackgroundImageToAlign
- Specified by:
isUseBackgroundImageToAlign
in interfaceHtmlReportConfiguration
- See Also:
-
setUseBackgroundImageToAlign
-
isIncludeElementUUID
Description copied from interface:HtmlReportConfiguration
Determines whether design element UUIDs are included in the HTML output asdata-eluuid
attributes oftd
elements.- Specified by:
isIncludeElementUUID
in interfaceHtmlReportConfiguration
- See Also:
-
setIncludeElementUUID
-