Package org.opencms.report

Class CmsHtmlReport

java.lang.Object

org.opencms.report.A_CmsReport

org.opencms.report.CmsHtmlReport

All Implemented Interfaces:

I_CmsReport

Direct Known Subclasses:

CmsPrintStreamReport

public class CmsHtmlReport
extends A_CmsReport

HTML report output to be used for import / export / publish operations in the entire OpenCms system.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LINEBREAK	Constant for a HTML linebreak with added "real" line break.
static final String	LINEBREAK_TRADITIONAL	Constant for a HTML linebreak with added "real" line break- traditional style for report threads that still use XML templates for their output.

Fields inherited from interface org.opencms.report.I_CmsReport

FORMAT_DEFAULT, FORMAT_ERROR, FORMAT_HEADLINE, FORMAT_NOTE, FORMAT_OK, FORMAT_WARNING, REPORT_TYPE_EXTENDED, REPORT_TYPE_SIMPLE

Constructor Summary

Constructors

Constructor	Description
CmsHtmlReport(Locale locale, String siteRoot)	Constructs a new report using the provided locale for the output language.
CmsHtmlReport(Locale locale, String siteRoot, boolean writeHtml, boolean isTransient)	Constructs a new report using the provided locale for the output language.

Method Summary

Modifier and Type	Method	Description
protected String	getLineBreak()	Returns the correct line break notation depending on the output style of this report.
String	getReportUpdate()	Updates this report, this processes all new output added since the last call to this method.
boolean	isWriteHtml()	Returns if the report writes html or javascript code.
void	print(String value, int format)	Prints a String to the report, using the indicated formatting.
void	println()	Adds a line break to the report.
void	println(Throwable t)	Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp.

Methods inherited from class org.opencms.report.A_CmsReport

addError, addWarning, formatRuntime, getErrors, getLastEntryTime, getLocale, getMessages, getReportUpdate, getRuntime, getSiteRoot, getWarnings, hasError, hasWarning, init, print, print, print, println, println, println, println, printMessageWithParam, printMessageWithParam, removeSiteRoot, resetRuntime, setLastEntryTime

Methods inherited from class java.lang.Object

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

Field Details

LINEBREAK

public static final String LINEBREAK

Constant for a HTML linebreak with added "real" line break.

See Also:

• Constant Field Values

LINEBREAK_TRADITIONAL

public static final String LINEBREAK_TRADITIONAL

Constant for a HTML linebreak with added "real" line break- traditional style for report threads that still use XML templates for their output.

See Also:

• Constant Field Values

Constructor Details

CmsHtmlReport

public CmsHtmlReport(Locale locale,
 String siteRoot)

Constructs a new report using the provided locale for the output language.

Parameters:

locale - the locale to use for the output language

siteRoot - the site root of the user who started this report (may be null)

CmsHtmlReport

public CmsHtmlReport(Locale locale,
 String siteRoot,
 boolean writeHtml,
 boolean isTransient)

Constructs a new report using the provided locale for the output language.

Parameters:

locale - the locale to use for the output language

siteRoot - the site root of the user who started this report (may be null)

writeHtml - if true, this report should generate HTML instead of JavaScript output

isTransient - If set to true nothing is kept in memory

Method Details

getReportUpdate

public String getReportUpdate()

Description copied from interface: I_CmsReport

Updates this report, this processes all new output added since the last call to this method.

This is only required in case the output is written to a HTML page, if the shell output is used, this will just return an empty String.

Returns:

new elements that have been added to the report and not yet processed.

See Also:

• I_CmsReport.getReportUpdate()

isWriteHtml

public boolean isWriteHtml()

Returns if the report writes html or javascript code.

Returns:

true if the report writes html, and false if the report writes javascript code

print

public void print(String value,
 int format)

Description copied from class: A_CmsReport

Prints a String to the report, using the indicated formatting.

Use the constants starting with FORMAT from this interface to indicate which formatting to use.

Specified by:

print in class A_CmsReport

Parameters:

value - the message container to add

format - the formatting to use for the output

See Also:

• A_CmsReport.print(java.lang.String, int)

println

public void println()

Description copied from interface: I_CmsReport

Adds a line break to the report.

See Also:

• I_CmsReport.println()

println

public void println(Throwable t)

Description copied from interface: I_CmsReport

Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.

The exception will be stored and the output will later be processed in a special way.

Parameters:

t - the exception to add

See Also:

• I_CmsReport.println(java.lang.Throwable)

getLineBreak

protected String getLineBreak()

Returns the correct line break notation depending on the output style of this report.

Returns:

the correct line break notation