org.apache.log4j

Class HTMLLayout

public class HTMLLayout extends Layout

This layout outputs events in a HTML table.

Author: Ceki Gülcü

Field Summary
protected intBUF_SIZE
static StringLOCATION_INFO_OPTION
A string constant used in naming the option for setting the the location information flag.
protected intMAX_CAPACITY
static StringTITLE_OPTION
A string constant used in naming the option for setting the the HTML document title.
Method Summary
voidactivateOptions()
No options to activate.
Stringformat(LoggingEvent event)
StringgetContentType()
Returns the content type output by this layout, i.e "text/html".
StringgetFooter()
Returns the appropriate HTML footers.
StringgetHeader()
Returns appropriate HTML headers.
booleangetLocationInfo()
Returns the current value of the LocationInfo option.
StringgetTitle()
Returns the current value of the Title option.
booleanignoresThrowable()
The HTML layout handles the throwable contained in logging events.
voidsetLocationInfo(boolean flag)
The LocationInfo option takes a boolean value.
voidsetTitle(String title)
The Title option takes a String value.

Field Detail

BUF_SIZE

protected final int BUF_SIZE

LOCATION_INFO_OPTION

public static final String 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.

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.

Method Detail

activateOptions

public void activateOptions()
No options to activate.

format

public String format(LoggingEvent event)

getContentType

public String getContentType()
Returns the content type output by this layout, i.e "text/html".

getFooter

public String getFooter()
Returns the appropriate HTML footers.

getHeader

public String getHeader()
Returns appropriate HTML headers.

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.

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 {@link org.apache.log4j.net.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.