Package net.sf.jasperreports.export
Interface HtmlReportConfiguration
-
- All Superinterfaces:
CommonExportConfiguration
,ReportExportConfiguration
- All Known Implementing Classes:
SimpleHtmlReportConfiguration
public interface HtmlReportConfiguration extends ReportExportConfiguration
Interface containing settings used by the HTML exporters.- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
- See Also:
HtmlExporter
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROPERTY_ACCESSIBLE
Property that provides a default value for theisAccessibleHtml()
exporter configuration setting.static String
PROPERTY_BORDER_COLLAPSE
Property that provides the default value for thegetBorderCollapseValue()
export configuration setting.static String
PROPERTY_CONVERT_SVG_TO_IMAGE
Property that provides a default for theisConvertSvgToImage()
export configuration flag.static String
PROPERTY_EMBED_IMAGE
Property that provides a default for theisEmbedImage()
export configuration flag.static String
PROPERTY_EMBEDDED_SVG_USE_FONTS
Property that provides a default for theisEmbeddedSvgUseFonts()
export configuration flag.static String
PROPERTY_FORCE_HTML_EMBED_IMAGE
static String
PROPERTY_IGNORE_HYPERLINK
Property that provides a default for theisIgnoreHyperlink()
export configuration flag.static String
PROPERTY_INCLUDE_ELEMENT_UUID
Boolean property that provides a default for theisIncludeElementUUID()
flag.static String
PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Property whose value is used as default state of theisRemoveEmptySpaceBetweenRows()
export configuration flag.static String
PROPERTY_SIZE_UNIT
Property whose value is used as default for thegetSizeUnit()
export configuration setting.static String
PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN
Property that provides a default for theisUseBackgroundImageToAlign()
export configuration flag.static String
PROPERTY_WHITE_PAGE_BACKGROUND
Property whose value is used as default state of theisWhitePageBackground()
export configuration flag.static String
PROPERTY_WRAP_BREAK_WORD
Property whose value is used as default state of theisWrapBreakWord()
export configuration flag.-
Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration
PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS
-
Fields inherited from interface net.sf.jasperreports.export.ReportExportConfiguration
PROPERTY_IGNORE_PAGE_MARGINS
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static void
forceEmbedImage(JRPropertiesUtil properties, JRPropertiesHolder source, JRPropertiesHolder target)
HtmlBorderCollapseEnum
getBorderCollapseValue()
Provides the value for theborder-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 exporterBoolean
isIncludeElementUUID()
Determines whether design element UUIDs are included in the HTML output asdata-eluuid
attributes oftd
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 (CSSword-wrap: break-word
).-
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
-
-
-
-
Field Detail
-
PROPERTY_WHITE_PAGE_BACKGROUND
static final String PROPERTY_WHITE_PAGE_BACKGROUND
Property whose value is used as default state of theisWhitePageBackground()
export configuration flag. This property is set by default (true
).- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
static final String PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Property whose value is used as default state of theisRemoveEmptySpaceBetweenRows()
export configuration flag. This property is by default not set (false
).- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_WRAP_BREAK_WORD
static final String PROPERTY_WRAP_BREAK_WORD
Property whose value is used as default state of theisWrapBreakWord()
export configuration flag. This property is by default not set (false
).- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_SIZE_UNIT
static final String PROPERTY_SIZE_UNIT
Property whose value is used as default for thegetSizeUnit()
export configuration setting.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_BORDER_COLLAPSE
static final String PROPERTY_BORDER_COLLAPSE
Property that provides the default value for thegetBorderCollapseValue()
export configuration setting.The property can be set globally and at report level. It defaults to
collapse
.- See Also:
- Constant Field Values
-
PROPERTY_ACCESSIBLE
static final String PROPERTY_ACCESSIBLE
Property that provides a default value for theisAccessibleHtml()
exporter configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_IGNORE_HYPERLINK
static final String PROPERTY_IGNORE_HYPERLINK
Property that provides a default for theisIgnoreHyperlink()
export configuration flag.- See Also:
- Constant Field Values
-
PROPERTY_EMBED_IMAGE
static final String PROPERTY_EMBED_IMAGE
Property that provides a default for theisEmbedImage()
export configuration flag.- See Also:
- Constant Field Values
-
PROPERTY_EMBEDDED_SVG_USE_FONTS
static final String PROPERTY_EMBEDDED_SVG_USE_FONTS
Property that provides a default for theisEmbeddedSvgUseFonts()
export configuration flag.- See Also:
- Constant Field Values
-
PROPERTY_FORCE_HTML_EMBED_IMAGE
static final String PROPERTY_FORCE_HTML_EMBED_IMAGE
- See Also:
- Constant Field Values
-
PROPERTY_CONVERT_SVG_TO_IMAGE
static final String PROPERTY_CONVERT_SVG_TO_IMAGE
Property that provides a default for theisConvertSvgToImage()
export configuration flag.- See Also:
- Constant Field Values
-
PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN
static final String PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN
Property that provides a default for theisUseBackgroundImageToAlign()
export configuration flag.- See Also:
- Constant Field Values
-
PROPERTY_INCLUDE_ELEMENT_UUID
static final String PROPERTY_INCLUDE_ELEMENT_UUID
Boolean property that provides a default for theisIncludeElementUUID()
flag. It only applies to text elements with numeric values.- See Also:
- Constant Field Values
-
-
Method Detail
-
isRemoveEmptySpaceBetweenRows
Boolean isRemoveEmptySpaceBetweenRows()
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.- See Also:
PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
-
isWhitePageBackground
Boolean isWhitePageBackground()
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.- See Also:
PROPERTY_WHITE_PAGE_BACKGROUND
-
isWrapBreakWord
Boolean isWrapBreakWord()
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.- See Also:
PROPERTY_WRAP_BREAK_WORD
-
getSizeUnit
HtmlSizeUnitEnum getSizeUnit()
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.- See Also:
PROPERTY_SIZE_UNIT
-
getBorderCollapseValue
HtmlBorderCollapseEnum getBorderCollapseValue()
Provides the value for theborder-collapse
CSS property to be applied to the table generated for the report.- See Also:
PROPERTY_BORDER_COLLAPSE
-
isIgnorePageMargins
Boolean isIgnorePageMargins()
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.
-
isAccessibleHtml
Boolean isAccessibleHtml()
Configuration setting that determines the exporter to produce accessible HTML.- See Also:
PROPERTY_ACCESSIBLE
-
getZoomRatio
Float getZoomRatio()
The zoom ratio used for the export. The default value is 1.
-
isIgnoreHyperlink
Boolean isIgnoreHyperlink()
- See Also:
PROPERTY_IGNORE_HYPERLINK
-
isEmbedImage
Boolean isEmbedImage()
- See Also:
PROPERTY_EMBED_IMAGE
-
isEmbeddedSvgUseFonts
Boolean isEmbeddedSvgUseFonts()
- See Also:
PROPERTY_EMBEDDED_SVG_USE_FONTS
-
isConvertSvgToImage
Boolean isConvertSvgToImage()
- See Also:
PROPERTY_CONVERT_SVG_TO_IMAGE
-
isUseBackgroundImageToAlign
Boolean isUseBackgroundImageToAlign()
- See Also:
PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN
-
isIncludeElementUUID
Boolean isIncludeElementUUID()
Determines whether design element UUIDs are included in the HTML output asdata-eluuid
attributes oftd
elements.
-
forceEmbedImage
static void forceEmbedImage(JRPropertiesUtil properties, JRPropertiesHolder source, JRPropertiesHolder target)
-
-