|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.report.A_CmsReport
org.opencms.report.CmsHtmlReport
HTML report output to be used for import / export / publish operations in the entire OpenCms system.
Field Summary |
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 | |
|
CmsHtmlReport(java.util.Locale locale,
java.lang.String siteRoot)
Constructs a new report using the provided locale for the output language. |
protected |
CmsHtmlReport(java.util.Locale locale,
java.lang.String siteRoot,
boolean writeHtml)
Constructs a new report using the provided locale for the output language. |
Method Summary | |
protected java.lang.String |
getLineBreak()
Returns the corrent linebreak 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. |
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. |
Methods inherited from class org.opencms.report.A_CmsReport |
addError, addWarning, formatRuntime, getErrors, getLocale, getMessages, getRuntime, getSiteRoot, getWarnings, hasError, hasWarning, init, print, print, print, println, println, println, println, printMessageWithParam, printMessageWithParam, removeSiteRoot, resetRuntime |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CmsHtmlReport(java.util.Locale locale, java.lang.String siteRoot)
locale
- the locale to use for the output languagesiteRoot
- the site root of the user who started this report (may be null
)protected CmsHtmlReport(java.util.Locale locale, java.lang.String siteRoot, boolean writeHtml)
locale
- the locale to use for the output languagesiteRoot
- the site root of the user who started this report (may be null
)writeHtml
- if true
, this report should generate HTML instead of JavaScript outputMethod Detail |
public java.lang.String getReportUpdate()
I_CmsReport
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.
I_CmsReport.getReportUpdate()
public void print(java.lang.String value, int format)
A_CmsReport
Use the contants starting with FORMAT
from this interface
to indicate which formatting to use.
print
in class A_CmsReport
value
- the message container to addformat
- the formatting to use for the outputA_CmsReport.print(java.lang.String, int)
public void println()
I_CmsReport
I_CmsReport.println()
public void println(java.lang.Throwable t)
I_CmsReport
The exception will be stored and the output will later be processed in a special way.
t
- the exception to addI_CmsReport.println(java.lang.Throwable)
protected java.lang.String getLineBreak()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |