Package net.sf.jasperreports.export

Interface HtmlExporterConfiguration

All Superinterfaces:

CommonExportConfiguration, ExporterConfiguration

All Known Implementing Classes:

SimpleHtmlExporterConfiguration

public interface HtmlExporterConfiguration
extends ExporterConfiguration

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_BETWEEN_PAGES_HTML	Property that provides the default value for the getBetweenPagesHtml() export configuration setting.
static String	PROPERTY_FLUSH_OUTPUT	Property that provides the default value for the isFlushOutput() export configuration setting.
static String	PROPERTY_HTML_FOOTER	Property that provides the default value for the getHtmlFooter() export configuration setting.
static String	PROPERTY_HTML_HEADER	Property that provides the default value for the getHtmlHeader() export configuration setting.

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

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Method Summary

Modifier and Type	Method	Description
String	getBetweenPagesHtml()	Returns a string representing HTML code that will be inserted between pages of the generated report.
String	getHtmlFooter()	Returns a string representing HTML code that will be inserted after the generated report.
String	getHtmlHeader()	Returns a string representing HTML code that will be inserted in front of the generated report.
Boolean	isFlushOutput()	A flag that determines whether the HTML exporter should flush the output stream after writing the HTML content to it.

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

isOverrideHints

Field Detail

PROPERTY_FLUSH_OUTPUT

static final String PROPERTY_FLUSH_OUTPUT

Property that provides the default value for the isFlushOutput() export configuration setting.

The property can be set at report level or globally. By default, the HTML exporter performs a flush on the output stream after export.

See Also:

Constant Field Values

PROPERTY_HTML_HEADER

static final String PROPERTY_HTML_HEADER

Property that provides the default value for the getHtmlHeader() export configuration setting.

See Also:

Constant Field Values

PROPERTY_HTML_FOOTER

static final String PROPERTY_HTML_FOOTER

Property that provides the default value for the getHtmlFooter() export configuration setting.

See Also:

Constant Field Values

PROPERTY_BETWEEN_PAGES_HTML

static final String PROPERTY_BETWEEN_PAGES_HTML

Property that provides the default value for the getBetweenPagesHtml() export configuration setting.

See Also:

Constant Field Values

Method Detail

getHtmlHeader

String getHtmlHeader()

Returns a string representing HTML code that will be inserted in front of the generated report. The JasperReports engine places a piece of HTML code at the top of the page but users can define their own headers and stylesheet links.

getHtmlFooter

String getHtmlFooter()

Returns a string representing HTML code that will be inserted after the generated report. By default, JasperReports closes the usual HTML tags that were opened in getHtmlHeader(). If a custom HTML header was provided using getHtmlHeader(), it is recommended that a value for this setting is provided too, in order to ensure proper construction of HTML page.

getBetweenPagesHtml

String getBetweenPagesHtml()

Returns a string representing HTML code that will be inserted between pages of the generated report. By default, JasperReports separates pages by two empty lines, but this behavior can be overridden by this parameter.

isFlushOutput

Boolean isFlushOutput()

A flag that determines whether the HTML exporter should flush the output stream after writing the HTML content to it.

See Also:

PROPERTY_FLUSH_OUTPUT