Package org.apache.log4j
Class HTMLLayout
java.lang.Object
org.apache.log4j.Layout
org.apache.log4j.HTMLLayout
- All Implemented Interfaces:
OptionHandler
This layout outputs events in a HTML table.
Appenders using this layout should have their encoding set to UTF-8 or
UTF-16, otherwise events containing non ASCII characters could result in
corrupted log files.
- Author:
- Ceki Gülcü
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final int
static final String
Deprecated.Options are now handled using the JavaBeans paradigm.protected final int
static final String
A string constant used in naming the option for setting the the HTML document title.Fields inherited from class org.apache.log4j.Layout
LINE_SEP, LINE_SEP_LEN
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
No options to activate.format
(LoggingEvent event) Implement this method to create your own layout format.Returns the content type output by this layout, i.e "text/html".Returns the appropriate HTML footers.Returns appropriate HTML headers.boolean
Returns the current value of the LocationInfo option.getTitle()
Returns the current value of the Title option.boolean
The HTML layout handles the throwable contained in logging events.void
setLocationInfo
(boolean flag) The LocationInfo option takes a boolean value.void
The Title option takes a String value.
-
Field Details
-
BUF_SIZE
protected final int BUF_SIZE- See Also:
-
MAX_CAPACITY
protected final int MAX_CAPACITY- See Also:
-
LOCATION_INFO_OPTION
Deprecated.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.
- See Also:
-
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.- See Also:
-
-
Constructor Details
-
HTMLLayout
public HTMLLayout()
-
-
Method Details
-
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. -
getLocationInfo
public boolean getLocationInfo()Returns the current value of the LocationInfo option. -
setTitle
The Title option takes a String value. This option sets the document title of the generated HTML document.Defaults to 'Log4J Log Messages'.
-
getTitle
Returns the current value of the Title option. -
getContentType
Returns the content type output by this layout, i.e "text/html".- Overrides:
getContentType
in classLayout
-
activateOptions
public void activateOptions()No options to activate. -
format
Description copied from class:Layout
Implement this method to create your own layout format. -
getHeader
Returns appropriate HTML headers. -
ignoresThrowable
public boolean ignoresThrowable()The HTML layout handles the throwable contained in logging events. Hence, this method returnfalse
.- Specified by:
ignoresThrowable
in classLayout
-