org.apache.log4j
Class HTMLLayout
- OptionHandler
This layout outputs events in a HTML table.
void | activateOptions() - No options to activate.
|
String | format(LoggingEvent event)
|
String | getContentType() - Returns the content type output by this layout, i.e "text/html".
|
String | getFooter() - Returns the appropriate HTML footers.
|
String | getHeader() - Returns appropriate HTML headers.
|
boolean | getLocationInfo() - Returns the current value of the LocationInfo option.
|
String | getTitle() - Returns the current value of the Title option.
|
boolean | ignoresThrowable() - The HTML layout handles the throwable contained in logging
events.
|
void | setLocationInfo(boolean flag) - The LocationInfo option takes a boolean value.
|
void | setTitle(String title) - The Title option takes a String value.
|
BUF_SIZE
protected final int BUF_SIZE
LOCATION_INFO_OPTION
public static final String LOCATION_INFO_OPTION
Options are now handled using the JavaBeans paradigm.
This constant is not longer needed and will be removed in the
near term.
A string constant used in naming the option for setting the the
location information flag. Current value of this string
constant is
LocationInfo.
Note that all option keys are case sensitive.
MAX_CAPACITY
protected final int MAX_CAPACITY
TITLE_OPTION
public static final String TITLE_OPTION
A string constant used in naming the option for setting the the
HTML document title. Current value of this string
constant is Title.
getContentType
public String getContentType()
Returns the content type output by this layout, i.e "text/html".
- getContentType in interface Layout
getFooter
public String getFooter()
Returns the appropriate HTML footers.
- getFooter in interface Layout
getHeader
public String getHeader()
Returns appropriate HTML headers.
- getHeader in interface Layout
getLocationInfo
public boolean getLocationInfo()
Returns the current value of the LocationInfo option.
getTitle
public String getTitle()
Returns the current value of the Title option.
ignoresThrowable
public boolean ignoresThrowable()
The HTML layout handles the throwable contained in logging
events. Hence, this method return false
.
- ignoresThrowable in interface Layout
setLocationInfo
public void setLocationInfo(boolean flag)
The
LocationInfo option takes a boolean value. By
default, it is set to false which means there will be no location
information output by this layout. If the the option is set to
true, then the file name and line number of the statement
at the origin of the log statement will be output.
If you are embedding this layout within an
SMTPAppender
then make sure to set the
LocationInfo option of that appender as well.
setTitle
public void setTitle(String title)
The
Title option takes a String value. This option sets the
document title of the generated HTML document.
Defaults to 'Log4J Log Messages'.
Copyright 2000-2005 Apache Software Foundation.