net.sf.jasperreports.export.HtmlReportConfiguration Maven / Gradle / Ivy
Show all versions of jasperreports Show documentation
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.export;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.components.barbecue.BarbecueComponent;
import net.sf.jasperreports.components.barcode4j.Barcode4jComponent;
import net.sf.jasperreports.components.barcode4j.QRCodeComponent;
import net.sf.jasperreports.engine.JRPrintHyperlink;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRTextElement;
import net.sf.jasperreports.engine.export.HtmlExporter;
import net.sf.jasperreports.export.annotations.ExporterParameter;
import net.sf.jasperreports.export.annotations.ExporterProperty;
import net.sf.jasperreports.export.type.HtmlBorderCollapseEnum;
import net.sf.jasperreports.export.type.HtmlSizeUnitEnum;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Interface containing settings used by the HTML exporters.
*
* @see HtmlExporter
*
* @author Teodor Danciu ([email protected])
*/
public interface HtmlReportConfiguration extends ReportExportConfiguration
{
/**
* Property whose value is used as default state of the {@link #isWhitePageBackground()} export configuration flag.
*
* This property is set by default (true
).
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_TRUE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_2_0_1,
valueType = Boolean.class
)
public static final String PROPERTY_WHITE_PAGE_BACKGROUND = JRPropertiesUtil.PROPERTY_PREFIX + "export.html.white.page.background";
/**
* Property whose value is used as default state of the {@link #isRemoveEmptySpaceBetweenRows()} export configuration flag.
*
* This property is by default not set (false
).
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_2_0_1,
valueType = Boolean.class
)
public static final String PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS = JRPropertiesUtil.PROPERTY_PREFIX + "export.html.remove.emtpy.space.between.rows";
/**
* Property whose value is used as default state of the {@link #isWrapBreakWord()} export configuration flag.
*
* This property is by default not set (false
).
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_2_0_1,
valueType = Boolean.class
)
public static final String PROPERTY_WRAP_BREAK_WORD = JRPropertiesUtil.PROPERTY_PREFIX + "export.html.wrap.break.word";
/**
* Property whose value is used as default for the {@link #getSizeUnit()} export configuration setting.
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.PIXEL_UNIT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_2_0_1
)
public static final String PROPERTY_SIZE_UNIT = JRPropertiesUtil.PROPERTY_PREFIX + "export.html.size.unit";
/**
* Property that provides the default value for the {@link #getBorderCollapse()} export configuration setting.
*
* The property can be set globally and at report level. It defaults to collapse
.
*
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.COLLAPSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_5_0_4
)
public static final String PROPERTY_BORDER_COLLAPSE = JRPropertiesUtil.PROPERTY_PREFIX + "export.html.border.collapse";
/**
* Property that provides a default value for the {@link #isAccessibleHtml()} exporter configuration setting.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_3_7_5,
valueType = Boolean.class
)
public static final String PROPERTY_ACCESSIBLE = JRPropertiesUtil.PROPERTY_PREFIX + "export.html.accessible";
/**
* Property that provides a default for the {@link #isIgnoreHyperlink()} export configuration flag.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT, PropertyScope.HYPERLINK},
sinceVersion = PropertyConstants.VERSION_5_1_2,
valueType = Boolean.class
)
public static final String PROPERTY_IGNORE_HYPERLINK = HtmlExporter.HTML_EXPORTER_PROPERTIES_PREFIX + JRPrintHyperlink.PROPERTY_IGNORE_HYPERLINK_SUFFIX;
/**
* Property that provides a default for the {@link #isEmbedImage()} export configuration flag.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT, PropertyScope.IMAGE_ELEMENT},
sinceVersion = PropertyConstants.VERSION_6_2_1,
valueType = Boolean.class
)
public static final String PROPERTY_EMBED_IMAGE = HtmlExporter.HTML_EXPORTER_PROPERTIES_PREFIX + "embed.image";
/**
* Property that provides a default for the {@link #isEmbeddedSvgUseFonts()} export configuration flag.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT, PropertyScope.IMAGE_ELEMENT},
sinceVersion = PropertyConstants.VERSION_6_2_2,
valueType = Boolean.class
)
public static final String PROPERTY_EMBEDDED_SVG_USE_FONTS = HtmlExporter.HTML_EXPORTER_PROPERTIES_PREFIX + "embedded.svg.use.fonts";
/**
* Property that provides a default for the {@link #isConvertSvgToImage()} export configuration flag.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT,
PropertyScope.IMAGE_ELEMENT, PropertyScope.CHART_ELEMENT, PropertyScope.COMPONENT},
scopeQualifications = {Barcode4jComponent.COMPONENT_DESIGNATION, QRCodeComponent.COMPONENT_DESIGNATION,
BarbecueComponent.METADATA_KEY_QUALIFICATION},
sinceVersion = PropertyConstants.VERSION_6_3_0,
valueType = Boolean.class
)
public static final String PROPERTY_CONVERT_SVG_TO_IMAGE = HtmlExporter.HTML_EXPORTER_PROPERTIES_PREFIX + "convert.svg.to.image";
/**
* Property that provides a default for the {@link #isUseBackgroundImageToAlign()} export configuration flag.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_TRUE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT, PropertyScope.IMAGE_ELEMENT},
sinceVersion = PropertyConstants.VERSION_6_8_0,
valueType = Boolean.class
)
public static final String PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN = HtmlExporter.HTML_EXPORTER_PROPERTIES_PREFIX + "use.background.image.to.align";
/**
* 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 #PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRHtmlExporterParameter.class,
name="IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS"
)
@ExporterProperty(
value=PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS,
booleanDefault=false
)
public Boolean isRemoveEmptySpaceBetweenRows();
/**
* 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 #PROPERTY_WHITE_PAGE_BACKGROUND
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRHtmlExporterParameter.class,
name="IS_WHITE_PAGE_BACKGROUND"
)
@ExporterProperty(
value=PROPERTY_WHITE_PAGE_BACKGROUND,
booleanDefault=true
)
public Boolean isWhitePageBackground();
/**
* 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 {@link JRTextElement#PROPERTY_SAVE_LINE_BREAKS}
* property.
* @see #PROPERTY_WRAP_BREAK_WORD
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRHtmlExporterParameter.class,
name="IS_WRAP_BREAK_WORD"
)
@ExporterProperty(
value=PROPERTY_WRAP_BREAK_WORD,
booleanDefault=false
)
public Boolean isWrapBreakWord();
/**
* 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 #PROPERTY_SIZE_UNIT
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRHtmlExporterParameter.class,
name="SIZE_UNIT",
acceptNull=false
)
@ExporterProperty(PROPERTY_SIZE_UNIT)
public HtmlSizeUnitEnum getSizeUnit();
/**
* @deprecated Replaced by {@link #getBorderCollapseValue()}.
*/
public String getBorderCollapse();
/**
* Provides the value for the border-collapse
CSS property to be applied
* to the table generated for the report.
* @see #PROPERTY_BORDER_COLLAPSE
*/
@ExporterProperty(PROPERTY_BORDER_COLLAPSE)
public HtmlBorderCollapseEnum getBorderCollapseValue();
/**
* 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.
*
* @see ReportExportConfiguration#PROPERTY_IGNORE_PAGE_MARGINS
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.JRExporterParameter.class,
name="IGNORE_PAGE_MARGINS"
)
@ExporterProperty(
value=ReportExportConfiguration.PROPERTY_IGNORE_PAGE_MARGINS,
booleanDefault=false
)
public Boolean isIgnorePageMargins();
/**
* Configuration setting that determines the exporter to produce accessible HTML.
* @see HtmlReportConfiguration#PROPERTY_ACCESSIBLE
*/
@ExporterProperty(
value=PROPERTY_ACCESSIBLE,
booleanDefault=false
)
public Boolean isAccessibleHtml(); //FIXME this only worked in the ancient HTML exporter; if need to supported this again, look into history
/**
* The zoom ratio used for the export. The default value is 1.
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRHtmlExporterParameter.class,
name="ZOOM_RATIO"
)
public Float getZoomRatio();
/**
* @see #PROPERTY_IGNORE_HYPERLINK
*/
@ExporterProperty(
value=PROPERTY_IGNORE_HYPERLINK,
booleanDefault=false
)
public Boolean isIgnoreHyperlink();
/**
* @see #PROPERTY_EMBED_IMAGE
*/
@ExporterProperty(
value=PROPERTY_EMBED_IMAGE,
booleanDefault=false
)
public Boolean isEmbedImage();
/**
* @see #PROPERTY_EMBEDDED_SVG_USE_FONTS
*/
@ExporterProperty(
value=PROPERTY_EMBEDDED_SVG_USE_FONTS,
booleanDefault=false
)
public Boolean isEmbeddedSvgUseFonts();
/**
* @see #PROPERTY_CONVERT_SVG_TO_IMAGE
*/
@ExporterProperty(
value=PROPERTY_CONVERT_SVG_TO_IMAGE,
booleanDefault=false
)
public Boolean isConvertSvgToImage();
/**
* @see #PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN
*/
@ExporterProperty(
value=PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN,
booleanDefault=true
)
public Boolean isUseBackgroundImageToAlign();
}