/lib/apache-log4j/site/apidocs/org/apache/log4j/HTMLLayout.html

https://bitbucket.org/arkban/somersault · HTML · 603 lines · 516 code · 63 blank · 24 comment · 0 complexity · a460416f0a0653f074d600890f3533f7 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0_16) -->
    6. 

  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <TITLE>
    8. 

  8. HTMLLayout (Apache Log4j 1.2.16 API)
    9. 

  9. </TITLE>
    10. 

  10. 

  11. <META NAME="date" CONTENT="2010-03-30">
    12. 

  12. 

  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
    14. 

  14. 

  15. <SCRIPT type="text/javascript">
    16. 

  16. function windowTitle()
    17. 

  17. {
    18. 

  18.     if (location.href.indexOf('is-external=true') == -1) {
    19. 

  19.         parent.document.title="HTMLLayout (Apache Log4j 1.2.16 API)";
    20. 

  20.     }
    21. 

  21. }
    22. 

  22. </SCRIPT>
    23. 

  23. <NOSCRIPT>
    24. 

  24. </NOSCRIPT>
    25. 

  25. 

  26. </HEAD>
    27. 

  27. 

  28. <BODY BGCOLOR="white" onload="windowTitle();">
    29. 

  29. <HR>
    30. 

  30. 

  31. 

  32. <!-- ========= START OF TOP NAVBAR ======= -->
    33. 

  33. <A NAME="navbar_top"><!-- --></A>
    34. 

  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    35. 

  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    36. 

  36. <TR>
    37. 

  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    38. 

  38. <A NAME="navbar_top_firstrow"><!-- --></A>
    39. 

  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    40. 

  40.   <TR ALIGN="center" VALIGN="top">
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HTMLLayout.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    47. 

  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    48. 

  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    49. 

  49.   </TR>
    50. 

  50. </TABLE>
    51. 

  51. </TD>
    52. 

  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    53. 

  53. </EM>
    54. 

  54. </TD>
    55. 

  55. </TR>
    56. 

  56. 

  57. <TR>
    58. 

  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    59. 

  59. &nbsp;<A HREF="../../../org/apache/log4j/Hierarchy.html" title="class in org.apache.log4j"><B>PREV CLASS</B></A>&nbsp;
    60. 

  60. &nbsp;<A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j"><B>NEXT CLASS</B></A></FONT></TD>
    61. 

  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    62. 

  62.   <A HREF="../../../index.html?org/apache/log4j/HTMLLayout.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    63. 

  63. &nbsp;<A HREF="HTMLLayout.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    64. 

  64. &nbsp;<SCRIPT type="text/javascript">
    65. 

  65.   <!--
    66. 

  66.   if(window==top) {
    67. 

  67.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
    68. 

  68.   }
    69. 

  69.   //-->
    70. 

  70. </SCRIPT>
    71. 

  71. <NOSCRIPT>
    72. 

  72.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    73. 

  73. </NOSCRIPT>
    74. 

  74. 

  75. 

  76. </FONT></TD>
    77. 

  77. </TR>
    78. 

  78. <TR>
    79. 

  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    80. 

  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    81. 

  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    82. 

  82. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    83. 

  83. </TR>
    84. 

  84. </TABLE>
    85. 

  85. <A NAME="skip-navbar_top"></A>
    86. 

  86. <!-- ========= END OF TOP NAVBAR ========= -->
    87. 

  87. 

  88. <HR>
    89. 

  89. <!-- ======== START OF CLASS DATA ======== -->
    90. 

  90. <H2>
    91. 

  91. <FONT SIZE="-1">
    92. 

  92. org.apache.log4j</FONT>
    93. 

  93. <BR>
    94. 

  94. Class HTMLLayout</H2>
    95. 

  95. <PRE>
    96. 

  96. <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
    97. 

  97.   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">org.apache.log4j.Layout</A>
    98. 

  98.       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.log4j.HTMLLayout</B>
    99. 

  99. </PRE>
    100. 

  100. <DL>
    101. 

  101. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../org/apache/log4j/spi/OptionHandler.html" title="interface in org.apache.log4j.spi">OptionHandler</A></DD>
    102. 

  102. </DL>
    103. 

  103. <HR>
    104. 

  104. <DL>
    105. 

  105. <DT><PRE>public class <B>HTMLLayout</B><DT>extends <A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></DL>
    106. 

  106. </PRE>
    107. 

  107. 

  108. <P>
    109. 

  109. This layout outputs events in a HTML table.
    110. 

  110. 

  111.  Appenders using this layout should have their encoding
    112. 

  112.  set to UTF-8 or UTF-16, otherwise events containing
    113. 

  113.  non ASCII characters could result in corrupted
    114. 

  114.  log files.
    115. 

  115. <P>
    116. 

  116. 

  117. <P>
    118. 

  118. <DL>
    119. 

  119. <DT><B>Author:</B></DT>
    120. 

  120.   <DD>Ceki G&uuml;lc&uuml;</DD>
    121. 

  121. </DL>
    122. 

  122. <HR>
    123. 

  123. 

  124. <P>
    125. 

  125. <!-- =========== FIELD SUMMARY =========== -->
    126. 

  126. 

  127. <A NAME="field_summary"><!-- --></A>
    128. 

  128. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    129. 

  129. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    130. 

  130. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    131. 

  131. <B>Field Summary</B></FONT></TH>
    132. 

  132. </TR>
    133. 

  133. <TR BGCOLOR="white" CLASS="TableRowColor">
    134. 

  134. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    135. 

  135. <CODE>protected &nbsp;int</CODE></FONT></TD>
    136. 

  136. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#BUF_SIZE">BUF_SIZE</A></B></CODE>
    137. 

  137. 

  138. <BR>
    139. 

  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    140. 

  140. </TR>
    141. 

  141. <TR BGCOLOR="white" CLASS="TableRowColor">
    142. 

  142. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    143. 

  143. <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    144. 

  144. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#LOCATION_INFO_OPTION">LOCATION_INFO_OPTION</A></B></CODE>
    145. 

  145. 

  146. <BR>
    147. 

  147. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Options are now handled using the JavaBeans paradigm.
    148. 

  148.      This constant is not longer needed and will be removed in the
    149. 

  149.      <em>near</em> term.</I></TD>
    150. 

  150. </TR>
    151. 

  151. <TR BGCOLOR="white" CLASS="TableRowColor">
    152. 

  152. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    153. 

  153. <CODE>protected &nbsp;int</CODE></FONT></TD>
    154. 

  154. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#MAX_CAPACITY">MAX_CAPACITY</A></B></CODE>
    155. 

  155. 

  156. <BR>
    157. 

  157. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    158. 

  158. </TR>
    159. 

  159. <TR BGCOLOR="white" CLASS="TableRowColor">
    160. 

  160. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    161. 

  161. <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    162. 

  162. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#TITLE_OPTION">TITLE_OPTION</A></B></CODE>
    163. 

  163. 

  164. <BR>
    165. 

  165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string constant used in naming the option for setting the the
    166. 

  166.      HTML document title.</TD>
    167. 

  167. </TR>
    168. 

  168. </TABLE>
    169. 

  169. &nbsp;<A NAME="fields_inherited_from_class_org.apache.log4j.Layout"><!-- --></A>
    170. 

  170. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    171. 

  171. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    172. 

  172. <TH ALIGN="left"><B>Fields inherited from class org.apache.log4j.<A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></B></TH>
    173. 

  173. </TR>
    174. 

  174. <TR BGCOLOR="white" CLASS="TableRowColor">
    175. 

  175. <TD><CODE><A HREF="../../../org/apache/log4j/Layout.html#LINE_SEP">LINE_SEP</A>, <A HREF="../../../org/apache/log4j/Layout.html#LINE_SEP_LEN">LINE_SEP_LEN</A></CODE></TD>
    176. 

  176. </TR>
    177. 

  177. </TABLE>
    178. 

  178. &nbsp;
    179. 

  179. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    180. 

  180. 

  181. <A NAME="constructor_summary"><!-- --></A>
    182. 

  182. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    183. 

  183. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    184. 

  184. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    185. 

  185. <B>Constructor Summary</B></FONT></TH>
    186. 

  186. </TR>
    187. 

  187. <TR BGCOLOR="white" CLASS="TableRowColor">
    188. 

  188. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#HTMLLayout()">HTMLLayout</A></B>()</CODE>
    189. 

  189. 

  190. <BR>
    191. 

  191. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    192. 

  192. </TR>
    193. 

  193. </TABLE>
    194. 

  194. &nbsp;
    195. 

  195. <!-- ========== METHOD SUMMARY =========== -->
    196. 

  196. 

  197. <A NAME="method_summary"><!-- --></A>
    198. 

  198. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    199. 

  199. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    200. 

  200. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    201. 

  201. <B>Method Summary</B></FONT></TH>
    202. 

  202. </TR>
    203. 

  203. <TR BGCOLOR="white" CLASS="TableRowColor">
    204. 

  204. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    205. 

  205. <CODE>&nbsp;void</CODE></FONT></TD>
    206. 

  206. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#activateOptions()">activateOptions</A></B>()</CODE>
    207. 

  207. 

  208. <BR>
    209. 

  209. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;No options to activate.</TD>
    210. 

  210. </TR>
    211. 

  211. <TR BGCOLOR="white" CLASS="TableRowColor">
    212. 

  212. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    213. 

  213. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    214. 

  214. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#format(org.apache.log4j.spi.LoggingEvent)">format</A></B>(<A HREF="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;event)</CODE>
    215. 

  215. 

  216. <BR>
    217. 

  217. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implement this method to create your own layout format.</TD>
    218. 

  218. </TR>
    219. 

  219. <TR BGCOLOR="white" CLASS="TableRowColor">
    220. 

  220. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    221. 

  221. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    222. 

  222. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#getContentType()">getContentType</A></B>()</CODE>
    223. 

  223. 

  224. <BR>
    225. 

  225. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the content type output by this layout, i.e "text/html".</TD>
    226. 

  226. </TR>
    227. 

  227. <TR BGCOLOR="white" CLASS="TableRowColor">
    228. 

  228. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    229. 

  229. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    230. 

  230. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#getFooter()">getFooter</A></B>()</CODE>
    231. 

  231. 

  232. <BR>
    233. 

  233. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the appropriate HTML footers.</TD>
    234. 

  234. </TR>
    235. 

  235. <TR BGCOLOR="white" CLASS="TableRowColor">
    236. 

  236. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    237. 

  237. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    238. 

  238. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#getHeader()">getHeader</A></B>()</CODE>
    239. 

  239. 

  240. <BR>
    241. 

  241. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns appropriate HTML headers.</TD>
    242. 

  242. </TR>
    243. 

  243. <TR BGCOLOR="white" CLASS="TableRowColor">
    244. 

  244. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    245. 

  245. <CODE>&nbsp;boolean</CODE></FONT></TD>
    246. 

  246. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#getLocationInfo()">getLocationInfo</A></B>()</CODE>
    247. 

  247. 

  248. <BR>
    249. 

  249. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current value of the <b>LocationInfo</b> option.</TD>
    250. 

  250. </TR>
    251. 

  251. <TR BGCOLOR="white" CLASS="TableRowColor">
    252. 

  252. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    253. 

  253. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    254. 

  254. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#getTitle()">getTitle</A></B>()</CODE>
    255. 

  255. 

  256. <BR>
    257. 

  257. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current value of the <b>Title</b> option.</TD>
    258. 

  258. </TR>
    259. 

  259. <TR BGCOLOR="white" CLASS="TableRowColor">
    260. 

  260. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    261. 

  261. <CODE>&nbsp;boolean</CODE></FONT></TD>
    262. 

  262. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#ignoresThrowable()">ignoresThrowable</A></B>()</CODE>
    263. 

  263. 

  264. <BR>
    265. 

  265. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The HTML layout handles the throwable contained in logging
    266. 

  266.      events.</TD>
    267. 

  267. </TR>
    268. 

  268. <TR BGCOLOR="white" CLASS="TableRowColor">
    269. 

  269. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    270. 

  270. <CODE>&nbsp;void</CODE></FONT></TD>
    271. 

  271. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#setLocationInfo(boolean)">setLocationInfo</A></B>(boolean&nbsp;flag)</CODE>
    272. 

  272. 

  273. <BR>
    274. 

  274. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <b>LocationInfo</b> option takes a boolean value.</TD>
    275. 

  275. </TR>
    276. 

  276. <TR BGCOLOR="white" CLASS="TableRowColor">
    277. 

  277. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    278. 

  278. <CODE>&nbsp;void</CODE></FONT></TD>
    279. 

  279. <TD><CODE><B><A HREF="../../../org/apache/log4j/HTMLLayout.html#setTitle(java.lang.String)">setTitle</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;title)</CODE>
    280. 

  280. 

  281. <BR>
    282. 

  282. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <b>Title</b> option takes a String value.</TD>
    283. 

  283. </TR>
    284. 

  284. </TABLE>
    285. 

  285. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    286. 

  286. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    287. 

  287. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    288. 

  288. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
    289. 

  289. </TR>
    290. 

  290. <TR BGCOLOR="white" CLASS="TableRowColor">
    291. 

  291. <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
    292. 

  292. </TR>
    293. 

  293. </TABLE>
    294. 

  294. &nbsp;
    295. 

  295. <P>
    296. 

  296. 

  297. <!-- ============ FIELD DETAIL =========== -->
    298. 

  298. 

  299. <A NAME="field_detail"><!-- --></A>
    300. 

  300. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    301. 

  301. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    302. 

  302. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    303. 

  303. <B>Field Detail</B></FONT></TH>
    304. 

  304. </TR>
    305. 

  305. </TABLE>
    306. 

  306. 

  307. <A NAME="BUF_SIZE"><!-- --></A><H3>
    308. 

  308. BUF_SIZE</H3>
    309. 

  309. <PRE>
    310. 

  310. protected final int <B>BUF_SIZE</B></PRE>
    311. 

  311. <DL>
    312. 

  312. <DL>
    313. 

  313. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.HTMLLayout.BUF_SIZE">Constant Field Values</A></DL>
    314. 

  314. </DL>
    315. 

  315. <HR>
    316. 

  316. 

  317. <A NAME="MAX_CAPACITY"><!-- --></A><H3>
    318. 

  318. MAX_CAPACITY</H3>
    319. 

  319. <PRE>
    320. 

  320. protected final int <B>MAX_CAPACITY</B></PRE>
    321. 

  321. <DL>
    322. 

  322. <DL>
    323. 

  323. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.HTMLLayout.MAX_CAPACITY">Constant Field Values</A></DL>
    324. 

  324. </DL>
    325. 

  325. <HR>
    326. 

  326. 

  327. <A NAME="LOCATION_INFO_OPTION"><!-- --></A><H3>
    328. 

  328. LOCATION_INFO_OPTION</H3>
    329. 

  329. <PRE>
    330. 

  330. public static final <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>LOCATION_INFO_OPTION</B></PRE>
    331. 

  331. <DL>
    332. 

  332. <DD><B>Deprecated.</B>&nbsp;<I>Options are now handled using the JavaBeans paradigm.
    333. 

  333.      This constant is not longer needed and will be removed in the
    334. 

  334.      <em>near</em> term.</I><DD>A string constant used in naming the option for setting the the
    335. 

  335.      location information flag.  Current value of this string
    336. 

  336.      constant is <b>LocationInfo</b>.
    337. 

  337. 

  338.      <p>Note that all option keys are case sensitive.
    339. 

  339. <P>
    340. 

  340. <DL>
    341. 

  341. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.HTMLLayout.LOCATION_INFO_OPTION">Constant Field Values</A></DL>
    342. 

  342. </DL>
    343. 

  343. <HR>
    344. 

  344. 

  345. <A NAME="TITLE_OPTION"><!-- --></A><H3>
    346. 

  346. TITLE_OPTION</H3>
    347. 

  347. <PRE>
    348. 

  348. public static final <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>TITLE_OPTION</B></PRE>
    349. 

  349. <DL>
    350. 

  350. <DD>A string constant used in naming the option for setting the the
    351. 

  351.      HTML document title.  Current value of this string
    352. 

  352.      constant is <b>Title</b>.
    353. 

  353. <P>
    354. 

  354. <DL>
    355. 

  355. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.HTMLLayout.TITLE_OPTION">Constant Field Values</A></DL>
    356. 

  356. </DL>
    357. 

  357. 

  358. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    359. 

  359. 

  360. <A NAME="constructor_detail"><!-- --></A>
    361. 

  361. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    362. 

  362. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    363. 

  363. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    364. 

  364. <B>Constructor Detail</B></FONT></TH>
    365. 

  365. </TR>
    366. 

  366. </TABLE>
    367. 

  367. 

  368. <A NAME="HTMLLayout()"><!-- --></A><H3>
    369. 

  369. HTMLLayout</H3>
    370. 

  370. <PRE>
    371. 

  371. public <B>HTMLLayout</B>()</PRE>
    372. 

  372. <DL>
    373. 

  373. </DL>
    374. 

  374. 

  375. <!-- ============ METHOD DETAIL ========== -->
    376. 

  376. 

  377. <A NAME="method_detail"><!-- --></A>
    378. 

  378. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    379. 

  379. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    380. 

  380. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    381. 

  381. <B>Method Detail</B></FONT></TH>
    382. 

  382. </TR>
    383. 

  383. </TABLE>
    384. 

  384. 

  385. <A NAME="setLocationInfo(boolean)"><!-- --></A><H3>
    386. 

  386. setLocationInfo</H3>
    387. 

  387. <PRE>
    388. 

  388. public void <B>setLocationInfo</B>(boolean&nbsp;flag)</PRE>
    389. 

  389. <DL>
    390. 

  390. <DD>The <b>LocationInfo</b> option takes a boolean value. By
    391. 

  391.      default, it is set to false which means there will be no location
    392. 

  392.      information output by this layout. If the the option is set to
    393. 

  393.      true, then the file name and line number of the statement
    394. 

  394.      at the origin of the log statement will be output.
    395. 

  395. 

  396.      <p>If you are embedding this layout within an <A HREF="../../../org/apache/log4j/net/SMTPAppender.html" title="class in org.apache.log4j.net"><CODE>SMTPAppender</CODE></A> then make sure to set the
    397. 

  397.      <b>LocationInfo</b> option of that appender as well.
    398. 

  398. <P>
    399. 

  399. <DD><DL>
    400. 

  400. </DL>
    401. 

  401. </DD>
    402. 

  402. </DL>
    403. 

  403. <HR>
    404. 

  404. 

  405. <A NAME="getLocationInfo()"><!-- --></A><H3>
    406. 

  406. getLocationInfo</H3>
    407. 

  407. <PRE>
    408. 

  408. public boolean <B>getLocationInfo</B>()</PRE>
    409. 

  409. <DL>
    410. 

  410. <DD>Returns the current value of the <b>LocationInfo</b> option.
    411. 

  411. <P>
    412. 

  412. <DD><DL>
    413. 

  413. </DL>
    414. 

  414. </DD>
    415. 

  415. </DL>
    416. 

  416. <HR>
    417. 

  417. 

  418. <A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
    419. 

  419. setTitle</H3>
    420. 

  420. <PRE>
    421. 

  421. public void <B>setTitle</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;title)</PRE>
    422. 

  422. <DL>
    423. 

  423. <DD>The <b>Title</b> option takes a String value. This option sets the
    424. 

  424.     document title of the generated HTML document.
    425. 

  425. 

  426.     <p>Defaults to 'Log4J Log Messages'.
    427. 

  427. <P>
    428. 

  428. <DD><DL>
    429. 

  429. </DL>
    430. 

  430. </DD>
    431. 

  431. </DL>
    432. 

  432. <HR>
    433. 

  433. 

  434. <A NAME="getTitle()"><!-- --></A><H3>
    435. 

  435. getTitle</H3>
    436. 

  436. <PRE>
    437. 

  437. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getTitle</B>()</PRE>
    438. 

  438. <DL>
    439. 

  439. <DD>Returns the current value of the <b>Title</b> option.
    440. 

  440. <P>
    441. 

  441. <DD><DL>
    442. 

  442. </DL>
    443. 

  443. </DD>
    444. 

  444. </DL>
    445. 

  445. <HR>
    446. 

  446. 

  447. <A NAME="getContentType()"><!-- --></A><H3>
    448. 

  448. getContentType</H3>
    449. 

  449. <PRE>
    450. 

  450. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getContentType</B>()</PRE>
    451. 

  451. <DL>
    452. 

  452. <DD>Returns the content type output by this layout, i.e "text/html".
    453. 

  453. <P>
    454. 

  454. <DD><DL>
    455. 

  455. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/apache/log4j/Layout.html#getContentType()">getContentType</A></CODE> in class <CODE><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></CODE></DL>
    456. 

  456. </DD>
    457. 

  457. <DD><DL>
    458. 

  458. </DL>
    459. 

  459. </DD>
    460. 

  460. </DL>
    461. 

  461. <HR>
    462. 

  462. 

  463. <A NAME="activateOptions()"><!-- --></A><H3>
    464. 

  464. activateOptions</H3>
    465. 

  465. <PRE>
    466. 

  466. public void <B>activateOptions</B>()</PRE>
    467. 

  467. <DL>
    468. 

  468. <DD>No options to activate.
    469. 

  469. <P>
    470. 

  470. <DD><DL>
    471. 

  471. </DL>
    472. 

  472. </DD>
    473. 

  473. </DL>
    474. 

  474. <HR>
    475. 

  475. 

  476. <A NAME="format(org.apache.log4j.spi.LoggingEvent)"><!-- --></A><H3>
    477. 

  477. format</H3>
    478. 

  478. <PRE>
    479. 

  479. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>format</B>(<A HREF="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;event)</PRE>
    480. 

  480. <DL>
    481. 

  481. <DD><B>Description copied from class: <CODE><A HREF="../../../org/apache/log4j/Layout.html#format(org.apache.log4j.spi.LoggingEvent)">Layout</A></CODE></B></DD>
    482. 

  482. <DD>Implement this method to create your own layout format.
    483. 

  483. <P>
    484. 

  484. <DD><DL>
    485. 

  485. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/log4j/Layout.html#format(org.apache.log4j.spi.LoggingEvent)">format</A></CODE> in class <CODE><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></CODE></DL>
    486. 

  486. </DD>
    487. 

  487. <DD><DL>
    488. 

  488. </DL>
    489. 

  489. </DD>
    490. 

  490. </DL>
    491. 

  491. <HR>
    492. 

  492. 

  493. <A NAME="getHeader()"><!-- --></A><H3>
    494. 

  494. getHeader</H3>
    495. 

  495. <PRE>
    496. 

  496. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getHeader</B>()</PRE>
    497. 

  497. <DL>
    498. 

  498. <DD>Returns appropriate HTML headers.
    499. 

  499. <P>
    500. 

  500. <DD><DL>
    501. 

  501. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/apache/log4j/Layout.html#getHeader()">getHeader</A></CODE> in class <CODE><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></CODE></DL>
    502. 

  502. </DD>
    503. 

  503. <DD><DL>
    504. 

  504. </DL>
    505. 

  505. </DD>
    506. 

  506. </DL>
    507. 

  507. <HR>
    508. 

  508. 

  509. <A NAME="getFooter()"><!-- --></A><H3>
    510. 

  510. getFooter</H3>
    511. 

  511. <PRE>
    512. 

  512. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getFooter</B>()</PRE>
    513. 

  513. <DL>
    514. 

  514. <DD>Returns the appropriate HTML footers.
    515. 

  515. <P>
    516. 

  516. <DD><DL>
    517. 

  517. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/apache/log4j/Layout.html#getFooter()">getFooter</A></CODE> in class <CODE><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></CODE></DL>
    518. 

  518. </DD>
    519. 

  519. <DD><DL>
    520. 

  520. </DL>
    521. 

  521. </DD>
    522. 

  522. </DL>
    523. 

  523. <HR>
    524. 

  524. 

  525. <A NAME="ignoresThrowable()"><!-- --></A><H3>
    526. 

  526. ignoresThrowable</H3>
    527. 

  527. <PRE>
    528. 

  528. public boolean <B>ignoresThrowable</B>()</PRE>
    529. 

  529. <DL>
    530. 

  530. <DD>The HTML layout handles the throwable contained in logging
    531. 

  531.      events. Hence, this method return <code>false</code>.
    532. 

  532. <P>
    533. 

  533. <DD><DL>
    534. 

  534. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/log4j/Layout.html#ignoresThrowable()">ignoresThrowable</A></CODE> in class <CODE><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></CODE></DL>
    535. 

  535. </DD>
    536. 

  536. <DD><DL>
    537. 

  537. </DL>
    538. 

  538. </DD>
    539. 

  539. </DL>
    540. 

  540. <!-- ========= END OF CLASS DATA ========= -->
    541. 

  541. <HR>
    542. 

  542. 

  543. 

  544. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    545. 

  545. <A NAME="navbar_bottom"><!-- --></A>
    546. 

  546. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    547. 

  547. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    548. 

  548. <TR>
    549. 

  549. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    550. 

  550. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    551. 

  551. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    552. 

  552.   <TR ALIGN="center" VALIGN="top">
    553. 

  553.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    554. 

  554.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    555. 

  555.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    556. 

  556.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HTMLLayout.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    557. 

  557.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    558. 

  558.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    559. 

  559.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    560. 

  560.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    561. 

  561.   </TR>
    562. 

  562. </TABLE>
    563. 

  563. </TD>
    564. 

  564. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    565. 

  565. </EM>
    566. 

  566. </TD>
    567. 

  567. </TR>
    568. 

  568. 

  569. <TR>
    570. 

  570. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    571. 

  571. &nbsp;<A HREF="../../../org/apache/log4j/Hierarchy.html" title="class in org.apache.log4j"><B>PREV CLASS</B></A>&nbsp;
    572. 

  572. &nbsp;<A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j"><B>NEXT CLASS</B></A></FONT></TD>
    573. 

  573. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    574. 

  574.   <A HREF="../../../index.html?org/apache/log4j/HTMLLayout.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    575. 

  575. &nbsp;<A HREF="HTMLLayout.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    576. 

  576. &nbsp;<SCRIPT type="text/javascript">
    577. 

  577.   <!--
    578. 

  578.   if(window==top) {
    579. 

  579.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
    580. 

  580.   }
    581. 

  581.   //-->
    582. 

  582. </SCRIPT>
    583. 

  583. <NOSCRIPT>
    584. 

  584.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    585. 

  585. </NOSCRIPT>
    586. 

  586. 

  587. 

  588. </FONT></TD>
    589. 

  589. </TR>
    590. 

  590. <TR>
    591. 

  591. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    592. 

  592.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    593. 

  593. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    594. 

  594. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    595. 

  595. </TR>
    596. 

  596. </TABLE>
    597. 

  597. <A NAME="skip-navbar_bottom"></A>
    598. 

  598. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    599. 

  599. 

  600. <HR>
    601. 

  601. Copyright &#169; 1999-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
    602. 

  602. </BODY>
    603. 

  603. </HTML>
    604.