<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: HTMLLayout Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1_h_t_m_l_layout.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>HTMLLayout Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::HTMLLayout" --><!-- doxytag: inherits="log4cxx::Layout" -->
<p>This layout outputs events in a HTML table.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1_layout.html">log4cxx::Layout</a>.</p>
<p><a href="classlog4cxx_1_1_h_t_m_l_layout-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a46d8801a3e45a55b344f5290c6ee91eb">HTMLLayout</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a3a5a676600b808a7a742c5610346380c">setLocationInfo</a> (bool locationInfoFlag)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>LocationInfo</b> option takes a boolean value. <a href="#a3a5a676600b808a7a742c5610346380c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#ad70ffd01a630335c8e0465b04f360db4">getLocationInfo</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current value of the <b>LocationInfo</b> option. <a href="#ad70ffd01a630335c8e0465b04f360db4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a39b664891c1c6bf640eed588be1c2265">setTitle</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &title1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>Title</b> option takes a String value. <a href="#a39b664891c1c6bf640eed588be1c2265"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a64093828760efbdd6ddeb94feccfdef1">getTitle</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current value of the <b>Title</b> option. <a href="#a64093828760efbdd6ddeb94feccfdef1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a8d61ef61f2aaf3923ef0a16fc6728dc7">getContentType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the content type output by this layout, i.e "text/html". <a href="#a8d61ef61f2aaf3923ef0a16fc6728dc7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#abe1aa95ede9cc9d0609905154129c0ba">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">No options to activate. <a href="#abe1aa95ede9cc9d0609905154129c0ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#aee5023c29cca9dc68164b22a01cb7c6e">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set options. <a href="#aee5023c29cca9dc68164b22a01cb7c6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a79cba5d2db27cc6537de868018b72d9c">format</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &output, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implement this method to create your own layout format. <a href="#a79cba5d2db27cc6537de868018b72d9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a396a9f379b832d1b9df431303b0cb93e">appendHeader</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &output, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append appropriate HTML headers. <a href="#a396a9f379b832d1b9df431303b0cb93e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a273cfddfaa1950d22bd104feafb604b3">appendFooter</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &output, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append the appropriate HTML footers. <a href="#a273cfddfaa1950d22bd104feafb604b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a5796c8d5c4ed8ceae2cb9ebb1db75518">ignoresThrowable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The HTML layout handles the throwable contained in logging events. <a href="#a5796c8d5c4ed8ceae2cb9ebb1db75518"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This layout outputs events in a HTML table. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a46d8801a3e45a55b344f5290c6ee91eb"></a><!-- doxytag: member="log4cxx::HTMLLayout::HTMLLayout" ref="a46d8801a3e45a55b344f5290c6ee91eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html">HTMLLayout</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abe1aa95ede9cc9d0609905154129c0ba"></a><!-- doxytag: member="log4cxx::HTMLLayout::activateOptions" ref="abe1aa95ede9cc9d0609905154129c0ba" args="(log4cxx::helpers::Pool &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void activateOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>No options to activate. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#af04d4bfbd66b46083b1aa042fdafbb06">OptionHandler</a>.</p>
</div>
</div>
<a class="anchor" id="a273cfddfaa1950d22bd104feafb604b3"></a><!-- doxytag: member="log4cxx::HTMLLayout::appendFooter" ref="a273cfddfaa1950d22bd104feafb604b3" args="(LogString &output, log4cxx::helpers::Pool &pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void appendFooter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append the appropriate HTML footers. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_layout.html#ae8f7d8f894b39b251cada7674bdfe8d2">Layout</a>.</p>
</div>
</div>
<a class="anchor" id="a396a9f379b832d1b9df431303b0cb93e"></a><!-- doxytag: member="log4cxx::HTMLLayout::appendHeader" ref="a396a9f379b832d1b9df431303b0cb93e" args="(LogString &output, log4cxx::helpers::Pool &pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void appendHeader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append appropriate HTML headers. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_layout.html#ad1b07d688e39f3a8d71acec8f6d7b878">Layout</a>.</p>
</div>
</div>
<a class="anchor" id="a79cba5d2db27cc6537de868018b72d9c"></a><!-- doxytag: member="log4cxx::HTMLLayout::format" ref="a79cba5d2db27cc6537de868018b72d9c" args="(LogString &output, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void format </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implement this method to create your own layout format. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1_layout.html#aefcaf353e4b45b21fc47b7e25410f8ff">Layout</a>.</p>
</div>
</div>
<a class="anchor" id="a8d61ef61f2aaf3923ef0a16fc6728dc7"></a><!-- doxytag: member="log4cxx::HTMLLayout::getContentType" ref="a8d61ef61f2aaf3923ef0a16fc6728dc7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getContentType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the content type output by this layout, i.e "text/html". </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_layout.html#a8d61ef61f2aaf3923ef0a16fc6728dc7">Layout</a>.</p>
</div>
</div>
<a class="anchor" id="ad70ffd01a630335c8e0465b04f360db4"></a><!-- doxytag: member="log4cxx::HTMLLayout::getLocationInfo" ref="ad70ffd01a630335c8e0465b04f360db4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getLocationInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current value of the <b>LocationInfo</b> option. </p>
</div>
</div>
<a class="anchor" id="a64093828760efbdd6ddeb94feccfdef1"></a><!-- doxytag: member="log4cxx::HTMLLayout::getTitle" ref="a64093828760efbdd6ddeb94feccfdef1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getTitle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current value of the <b>Title</b> option. </p>
</div>
</div>
<a class="anchor" id="a5796c8d5c4ed8ceae2cb9ebb1db75518"></a><!-- doxytag: member="log4cxx::HTMLLayout::ignoresThrowable" ref="a5796c8d5c4ed8ceae2cb9ebb1db75518" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ignoresThrowable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The HTML layout handles the throwable contained in logging events. </p>
<p>Hence, this method return <code>false</code>. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1_layout.html#a7d46cce1553abd1ecb65fe6c5761fbd2">Layout</a>.</p>
</div>
</div>
<a class="anchor" id="a3a5a676600b808a7a742c5610346380c"></a><!-- doxytag: member="log4cxx::HTMLLayout::setLocationInfo" ref="a3a5a676600b808a7a742c5610346380c" args="(bool locationInfoFlag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setLocationInfo </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>locationInfoFlag</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b>LocationInfo</b> option takes a boolean value. </p>
<p>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.</p>
<p>If you are embedding this layout within an <a class="el" href="classlog4cxx_1_1net_1_1_s_m_t_p_appender.html">SMTPAppender</a> then make sure to set the <b>LocationInfo</b> option of that appender as well. </p>
</div>
</div>
<a class="anchor" id="aee5023c29cca9dc68164b22a01cb7c6e"></a><!-- doxytag: member="log4cxx::HTMLLayout::setOption" ref="aee5023c29cca9dc68164b22a01cb7c6e" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setOption </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set options. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">OptionHandler</a>.</p>
</div>
</div>
<a class="anchor" id="a39b664891c1c6bf640eed588be1c2265"></a><!-- doxytag: member="log4cxx::HTMLLayout::setTitle" ref="a39b664891c1c6bf640eed588be1c2265" args="(const LogString &title1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setTitle </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>title1</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b>Title</b> option takes a String value. </p>
<p>This option sets the document title of the generated HTML document. </p>
<p>Defaults to 'Log4cxx Log Messages'. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="htmllayout_8h.html">htmllayout.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html">HTMLLayout</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
