log4cxx::HTMLLayout Class Reference

This layout outputs events in a HTML table. More...

#include <htmllayout.h>

Inheritance diagram for log4cxx::HTMLLayout:

Public Member Functions
void	setLocationInfo (bool locationInfoFlag)
	The LocationInfo option takes a boolean value. More...
bool	getLocationInfo () const
	Returns the current value of the LocationInfo option.
void	setTitle (const LogString &title1)
	The Title option takes a String value. More...
const LogString &	getTitle () const
	Returns the current value of the Title option.
virtual LogString	getContentType () const
	Returns the content type output by this layout, i.e "text/html".
virtual void	activateOptions (log4cxx::helpers::Pool &)
	No options to activate.
virtual void	setOption (const LogString &option, const LogString &value)
	Set options.
virtual void	format (LogString &output, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) const
	Implement this method to create your own layout format.
virtual void	appendHeader (LogString &output, log4cxx::helpers::Pool &pool)
	Append appropriate HTML headers.
virtual void	appendFooter (LogString &output, log4cxx::helpers::Pool &pool)
	Append the appropriate HTML footers.
virtual bool	ignoresThrowable () const
	The HTML layout handles the throwable contained in logging events. More...
Public Member Functions inherited from log4cxx::Layout
void	addRef () const
void	releaseRef () const
Public Member Functions inherited from log4cxx::helpers::Object
virtual bool	instanceof (const Class &clazz) const =0
virtual const void *	cast (const Class &clazz) const =0

Additional Inherited Members
Protected Attributes inherited from log4cxx::helpers::ObjectImpl
unsigned int volatile	ref

Detailed Description

This layout outputs events in a HTML table.

Member Function Documentation

ignoresThrowable()

virtual bool log4cxx::HTMLLayout::ignoresThrowable ( ) const

inlinevirtual

The HTML layout handles the throwable contained in logging events.

Hence, this method return false.

Implements log4cxx::Layout.

setLocationInfo()

void log4cxx::HTMLLayout::setLocationInfo ( bool  locationInfoFlag )

inline

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()

void log4cxx::HTMLLayout::setTitle ( const LogString &  title1 )

inline

The Title option takes a String value.

This option sets the document title of the generated HTML document.

Defaults to 'Log4cxx Log Messages'.

---

The documentation for this class was generated from the following file:

• htmllayout.h