org.opencms.report

类 CmsHtmlReport

java.lang.Object

org.opencms.report.A_CmsReport

org.opencms.report.CmsHtmlReport

所有已实现的接口:

I_CmsReport

直接已知子类:

CmsPrintStreamReport

public class CmsHtmlReport
extends A_CmsReport

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

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
protected static java.lang.String	LINEBREAK Constant for a HTML linebreak with added "real" line break.
protected static java.lang.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.

从接口继承的字段 org.opencms.report.I_CmsReport

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

构造器概要

构造器

构造器和说明
CmsHtmlReport(java.util.Locale locale, java.lang.String siteRoot) Constructs a new report using the provided locale for the output language.
CmsHtmlReport(java.util.Locale locale, java.lang.String siteRoot, boolean writeHtml, boolean isTransient) Constructs a new report using the provided locale for the output language.

方法概要

方法

限定符和类型	方法和说明
protected java.lang.String	getLineBreak() Returns the correct line break notation depending on the output style of this report.
java.lang.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(java.lang.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(java.lang.Throwable t) Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.

从类继承的方法 org.opencms.report.A_CmsReport

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

从类继承的方法 java.lang.Object

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

字段详细资料

LINEBREAK

protected static final java.lang.String LINEBREAK

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

另请参阅:

常量字段值

LINEBREAK_TRADITIONAL

protected static final java.lang.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.

另请参阅:

常量字段值

构造器详细资料

CmsHtmlReport

public CmsHtmlReport(java.util.Locale locale,
             java.lang.String siteRoot)

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

参数:

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(java.util.Locale locale,
             java.lang.String siteRoot,
             boolean writeHtml,
             boolean isTransient)

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

参数:

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

方法详细资料

getReportUpdate

public java.lang.String getReportUpdate()

从接口复制的说明: 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.

返回:

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

另请参阅:

I_CmsReport.getReportUpdate()

isWriteHtml

public boolean isWriteHtml()

Returns if the report writes html or javascript code.

返回:

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

print

public void print(java.lang.String value,
         int format)

从类复制的说明: 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.

指定者:

print 在类中 A_CmsReport

参数:

value - the message container to add

format - the formatting to use for the output

另请参阅:

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

println

public void println()

从接口复制的说明: I_CmsReport

Adds a line break to the report.

另请参阅:

I_CmsReport.println()

println

public void println(java.lang.Throwable t)

从接口复制的说明: 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.

参数:

t - the exception to add

另请参阅:

I_CmsReport.println(java.lang.Throwable)

getLineBreak

protected java.lang.String getLineBreak()

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

返回:

the correct line break notation