planetstack/core/static/log4javascript-1.4.6/docs/manual_lite.html

   1 <?xml version="1.0"?>\r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">\r
   4         <head>\r
   5                 <title>log4javascript 1.4 Lite manual</title>\r
   6                 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />\r
   7                 <meta name="author" content="Tim Down - tim@log4javascript.org" />\r
   8                 <meta name="description" content="log4javascript, a logging framework for JavaScript based on log4j" />\r
   9                 <meta name="robots" content="all" />\r
  10                 <link rel="stylesheet" type="text/css" media="screen,print" href="../main.css" title="Default" />\r
  11         </head>\r
  12         <body>\r
  13                 <div id="container" class="nonav">\r
  14                         <div id="header">\r
  15                                 <h1><a href="index.html">log4javascript</a></h1>\r
  16                         </div>\r
  17                         <div id="content">\r
  18                                 <div id="nav">\r
  19                                         <a class="navitem" href="../index.html">home</a>\r
  20                                         | <a class="navitem" href="http://sourceforge.net/projects/log4javascript" target="_blank" title="Download (opens in new window)">download</a>\r
  21                                         | <a class="navitem" href="index.html">docs</a>\r
  22                                         | <a class="navitem" href="quickstart.html">quick start</a>\r
  23                                         | <a class="navitem" href="../demos/index.html">demos</a>\r
  24                                         | <a class="navitem" href="http://log4javascript.org" target="_blank">website</a>\r
  25                                         | <a class="navitem" href="http://www.timdown.co.uk" target="_blank">timdown.co.uk</a>\r
  26                                 </div>\r
  27                                 <h1>log4javascript 1.4 Lite manual</h1>\r
  28                                 <h2>Contents</h2>\r
  29                                 <ul>\r
  30                                         <li><a href="#intro">Introduction</a></li>\r
  31                                         <li><a href="#log4javascript">log4javascript static properties/methods</a></li>\r
  32                                         <li><a href="#levels">Levels</a></li>\r
  33                                         <li><a href="#loggers">Loggers</a></li>\r
  34                                         <li><a href="#enabling">Enabling / disabling log4javascript Lite</a></li>\r
  35                                 </ul>\r
  36                                 <div id="intro">\r
  37                                         <h2>Introduction</h2>\r
  38                                         <p>\r
  39                                                 log4javascript Lite is designed to be a basic, lightweight, cross-browser logging tool. It\r
  40                                                 provides functions to log messages of different severity to a pop-up window using the exactly\r
  41                                                 the same syntax as log4javascript. It is designed for situations when the key requirement is just\r
  42                                                 to display logging messages without needing all the features of the standard version of\r
  43                                                 log4javascript. \r
  44                                         </p>\r
  45                                         <p>\r
  46                                                 Below is the complete list of functions and properties available in log4javascript Lite.\r
  47                                                 They make up a small subset of those provided by the standard version of\r
  48                                                 log4javascript. Each function is <strong>named and called identically to the equivalent\r
  49                                                 function in log4javascript</strong>. Please refer to the\r
  50                                                 <a href="manual.html">log4javascript manual</a> for a detailed explanation\r
  51                                                 of all the concepts alluded to in this document.\r
  52                                         </p>\r
  53                                         <p class="linktotop">\r
  54                                                 <a href="#container">Top</a>\r
  55                                         </p>\r
  56                                 </div>\r
  57                                 <div id="log4javascript">\r
  58                                         <h2>log4javascript static properties/methods</h2>\r
  59                                         <h4>Properties</h4>\r
  60                                         <ul class="propertieslist">\r
  61                                                 <li class="property">\r
  62                                                         <div class="name">version</div>\r
  63                                                         <div class="summary">\r
  64                                                                 The version number of your copy of log4javascript.\r
  65                                                         </div>\r
  66                                                 </li>\r
  67                                                 <li class="property">\r
  68                                                         <div class="name">edition</div>\r
  69                                                         <div class="summary">\r
  70                                                                 The edition of your copy of log4javascript ("log4javascript_lite" in this case").\r
  71                                                         </div>\r
  72                                                 </li>\r
  73                                         </ul>\r
  74                                         <h4>Methods</h4>\r
  75                                         <ul class="propertieslist">\r
  76                                                 <li class="method">\r
  77                                                         <div class="name">getDefaultLogger</div>\r
  78                                                         <div class="methodsignature"><code>Logger <strong>getDefaultLogger</strong>()</code></div>\r
  79                                                         <div class="summary">\r
  80                                                                 Returns the default and only logger (apart from the null logger). The default logger\r
  81                                                                 logs to a simple pop-up window.\r
  82                                                         </div>\r
  83                                                 </li>\r
  84                                                 <li class="method">\r
  85                                                         <div class="name">getNullLogger</div>\r
  86                                                         <div class="methodsignature"><code>Logger <strong>getNullLogger</strong>()</code></div>\r
  87                                                         <div class="summary">\r
  88                                                                 Returns an empty logger. Useful for disabling all logging.\r
  89                                                         </div>\r
  90                                                 </li>\r
  91                                                 <li class="method">\r
  92                                                         <div class="name">setEnabled</div>\r
  93                                                         <div class="methodsignature"><code>void <strong>setEnabled</strong>(Boolean <em>enabled</em>)</code></div>\r
  94                                                         <div class="paramsheading">Parameters:</div>\r
  95                                                         <ul class="params">\r
  96                                                                 <li class="param">\r
  97                                                                         <code class="paramname">enabled</code>\r
  98                                                                 </li>\r
  99                                                         </ul>\r
 100                                                         <div class="summary">\r
 101                                                                 Enables or disables all logging, depending on <code>enabled</code>.\r
 102                                                         </div>\r
 103                                                 </li>\r
 104                                                 <li class="method">\r
 105                                                         <div class="name">isEnabled</div>\r
 106                                                         <div class="methodsignature"><code>Boolean <strong>isEnabled</strong>()</code></div>\r
 107                                                         <div class="summary">\r
 108                                                                 Returns true or false depending on whether logging is enabled.\r
 109                                                         </div>\r
 110                                                 </li>\r
 111                                                 <li class="method">\r
 112                                                         <div class="name">setShowStackTraces</div>\r
 113                                                         <div class="methodsignature"><code>void <strong>setShowStackTraces</strong>(Boolean <em>show</em>)</code></div>\r
 114                                                         <div class="paramsheading">Parameters:</div>\r
 115                                                         <ul class="params">\r
 116                                                                 <li class="param">\r
 117                                                                         <code class="paramname">show</code>\r
 118                                                                 </li>\r
 119                                                         </ul>\r
 120                                                         <div class="summary">\r
 121                                                                 Enables or disables displaying of error stack traces, depending on <code>show</code>.\r
 122                                                                 By default, stack traces are not displayed. (Only works in Firefox)\r
 123                                                         </div>\r
 124                                                 </li>\r
 125                                         </ul>\r
 126                                         <p class="linktotop">\r
 127                                                 <a href="#container">Top</a>\r
 128                                         </p>\r
 129                                 </div>\r
 130                                 <div id="levels">\r
 131                                         <h2>Levels</h2>\r
 132                                         <p>\r
 133                                                 Levels are available as static properties of the <code>log4javascript.Level</code>\r
 134                                                 object. In ascending order of severity:\r
 135                                         </p>\r
 136                                         <ol>\r
 137                                                 <li><code>log4javascript.Level.ALL</code></li>\r
 138                                                 <li><code>log4javascript.Level.TRACE</code></li>\r
 139                                                 <li><code>log4javascript.Level.DEBUG</code></li>\r
 140                                                 <li><code>log4javascript.Level.INFO</code></li>\r
 141                                                 <li><code>log4javascript.Level.WARN</code></li>\r
 142                                                 <li><code>log4javascript.Level.ERROR</code></li>\r
 143                                                 <li><code>log4javascript.Level.FATAL</code></li>\r
 144                                                 <li><code>log4javascript.Level.NONE</code></li>\r
 145                                         </ol>\r
 146                                         <p class="linktotop">\r
 147                                                 <a href="#container">Top</a>\r
 148                                         </p>\r
 149                                 </div>\r
 150                                 <div id="loggers">\r
 151                                         <h2>Loggers</h2>\r
 152                                         <p>\r
 153                                                 There are only two loggers in log4javascript Lite: the default logger obtained\r
 154                                                 by calling <code>log4javascript.getDefaultLogger()</code> and the empty logger\r
 155                                                 returned by <code>log4javascript.getNullLogger()</code>.\r
 156                                         </p>\r
 157                                         <h4>Logger methods</h4>\r
 158                                         <ul class="propertieslist">\r
 159                                                 <li class="method">\r
 160                                                         <div class="name">setLevel</div>\r
 161                                                         <div class="methodsignature"><code>void <strong>setLevel</strong>(Level <em>level</em>)</code></div>\r
 162                                                         <div class="paramsheading">Parameters:</div>\r
 163                                                         <ul class="params">\r
 164                                                                 <li class="param">\r
 165                                                                         <code class="paramname">level</code>\r
 166                                                                 </li>\r
 167                                                         </ul>\r
 168                                                         <div class="summary">\r
 169                                                                 Sets the level. Log messages of a lower level than <code>level</code> will not be logged.\r
 170                                                                 Default value is <code>ALL</code> (unlike in log4javascript, where the default level is\r
 171                                                                 <code>DEBUG</code>).\r
 172                                                         </div>\r
 173                                                 </li>\r
 174                                                 <li class="method">\r
 175                                                         <div class="name">getLevel</div>\r
 176                                                         <div class="methodsignature"><code>Level <strong>getLevel</strong>()</code></div>\r
 177                                                         <div class="summary">\r
 178                                                                 Returns the level for this logger.\r
 179                                                         </div>\r
 180                                                 </li>\r
 181                                                 <li class="method">\r
 182                                                         <div class="name">trace</div>\r
 183                                                         <div class="methodsignature"><code>void <strong>trace</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>\r
 184                                                         <div class="paramsheading">Parameters:</div>\r
 185                                                         <ul class="params">\r
 186                                                                 <li class="param">\r
 187                                                                         <code class="paramname">message1[, message2...]</code>\r
 188                                                                 </li>\r
 189                                                                 <li class="param">\r
 190                                                                         <code class="paramname">exception</code>\r
 191                                                                         [<em>optional</em>]\r
 192                                                                 </li>\r
 193                                                         </ul>\r
 194                                                         <div class="summary">\r
 195                                                                 Logs one or more messages and optionally an error at level <code>TRACE</code>.\r
 196                                                         </div>\r
 197                                                 </li>\r
 198                                                 <li class="method">\r
 199                                                         <div class="name">debug</div>\r
 200                                                         <div class="methodsignature"><code>void <strong>debug</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>\r
 201                                                         <div class="paramsheading">Parameters:</div>\r
 202                                                         <ul class="params">\r
 203                                                                 <li class="param">\r
 204                                                                         <code class="paramname">message1[, message2...]</code>\r
 205                                                                 </li>\r
 206                                                                 <li class="param">\r
 207                                                                         <code class="paramname">exception</code>\r
 208                                                                         [<em>optional</em>]\r
 209                                                                 </li>\r
 210                                                         </ul>\r
 211                                                         <div class="summary">\r
 212                                                                 Logs one or more messages and optionally an error at level <code>DEBUG</code>.\r
 213                                                         </div>\r
 214                                                 </li>\r
 215                                                 <li class="method">\r
 216                                                         <div class="name">info</div>\r
 217                                                         <div class="methodsignature"><code>void <strong>info</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>\r
 218                                                         <div class="paramsheading">Parameters:</div>\r
 219                                                         <ul class="params">\r
 220                                                                 <li class="param">\r
 221                                                                         <code class="paramname">message1[, message2...]</code>\r
 222                                                                 </li>\r
 223                                                                 <li class="param">\r
 224                                                                         <code class="paramname">exception</code>\r
 225                                                                         [<em>optional</em>]\r
 226                                                                 </li>\r
 227                                                         </ul>\r
 228                                                         <div class="summary">\r
 229                                                                 Logs one or more messages and optionally an error at level <code>INFO</code>.\r
 230                                                         </div>\r
 231                                                 </li>\r
 232                                                 <li class="method">\r
 233                                                         <div class="name">warn</div>\r
 234                                                         <div class="methodsignature"><code>void <strong>warn</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>\r
 235                                                         <div class="paramsheading">Parameters:</div>\r
 236                                                         <ul class="params">\r
 237                                                                 <li class="param">\r
 238                                                                         <code class="paramname">message1[, message2...]</code>\r
 239                                                                 </li>\r
 240                                                                 <li class="param">\r
 241                                                                         <code class="paramname">exception</code>\r
 242                                                                         [<em>optional</em>]\r
 243                                                                 </li>\r
 244                                                         </ul>\r
 245                                                         <div class="summary">\r
 246                                                                 Logs one or more messages and optionally an error at level <code>WARN</code>.\r
 247                                                         </div>\r
 248                                                 </li>\r
 249                                                 <li class="method">\r
 250                                                         <div class="name">error</div>\r
 251                                                         <div class="methodsignature"><code>void <strong>error</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>\r
 252                                                         <div class="paramsheading">Parameters:</div>\r
 253                                                         <ul class="params">\r
 254                                                                 <li class="param">\r
 255                                                                         <code class="paramname">message1[, message2...]</code>\r
 256                                                                 </li>\r
 257                                                                 <li class="param">\r
 258                                                                         <code class="paramname">exception</code>\r
 259                                                                         [<em>optional</em>]\r
 260                                                                 </li>\r
 261                                                         </ul>\r
 262                                                         <div class="summary">\r
 263                                                                 Logs one or more messages and optionally an error at level <code>ERROR</code>.\r
 264                                                         </div>\r
 265                                                 </li>\r
 266                                                 <li class="method">\r
 267                                                         <div class="name">fatal</div>\r
 268                                                         <div class="methodsignature"><code>void <strong>fatal</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>\r
 269                                                         <div class="paramsheading">Parameters:</div>\r
 270                                                         <ul class="params">\r
 271                                                                 <li class="param">\r
 272                                                                         <code class="paramname">message1[, message2...]</code>\r
 273                                                                 </li>\r
 274                                                                 <li class="param">\r
 275                                                                         <code class="paramname">exception</code>\r
 276                                                                         [<em>optional</em>]\r
 277                                                                 </li>\r
 278                                                         </ul>\r
 279                                                         <div class="summary">\r
 280                                                                 Logs one or more messages and optionally an error at level <code>FATAL</code>.\r
 281                                                         </div>\r
 282                                                 </li>\r
 283                                                 <li class="method">\r
 284                                                         <div class="name">isEnabledFor</div>\r
 285                                                         <div class="methodsignature"><code>Boolean <strong>isEnabledFor</strong>(Level <em>level</em>, Error <em>exception</em>)</code></div>\r
 286                                                         <div class="paramsheading">Parameters:</div>\r
 287                                                         <ul class="params">\r
 288                                                                 <li class="param">\r
 289                                                                         <code class="paramname">level</code>\r
 290                                                                 </li>\r
 291                                                         </ul>\r
 292                                                         <div class="summary">\r
 293                                                                 Returns whether the logger is enabled for the specified level. \r
 294                                                         </div>\r
 295                                                 </li>\r
 296                                                 <li class="method">\r
 297                                                         <div class="name">isTraceEnabled</div>\r
 298                                                         <div class="methodsignature"><code>Boolean <strong>isTraceEnabled</strong>()</code></div>\r
 299                                                         <div class="summary">\r
 300                                                                 Returns whether the logger is enabled for <code>TRACE</code> messages.\r
 301                                                         </div>\r
 302                                                 </li>\r
 303                                                 <li class="method">\r
 304                                                         <div class="name">isDebugEnabled</div>\r
 305                                                         <div class="methodsignature"><code>Boolean <strong>isDebugEnabled</strong>()</code></div>\r
 306                                                         <div class="summary">\r
 307                                                                 Returns whether the logger is enabled for <code>DEBUG</code> messages.\r
 308                                                         </div>\r
 309                                                 </li>\r
 310                                                 <li class="method">\r
 311                                                         <div class="name">isInfoEnabled</div>\r
 312                                                         <div class="methodsignature"><code>Boolean <strong>isInfoEnabled</strong>()</code></div>\r
 313                                                         <div class="summary">\r
 314                                                                 Returns whether the logger is enabled for <code>INFO</code> messages.\r
 315                                                         </div>\r
 316                                                 </li>\r
 317                                                 <li class="method">\r
 318                                                         <div class="name">isWarnEnabled</div>\r
 319                                                         <div class="methodsignature"><code>Boolean <strong>isWarnEnabled</strong>()</code></div>\r
 320                                                         <div class="summary">\r
 321                                                                 Returns whether the logger is enabled for <code>WARN</code> messages.\r
 322                                                         </div>\r
 323                                                 </li>\r
 324                                                 <li class="method">\r
 325                                                         <div class="name">isErrorEnabled</div>\r
 326                                                         <div class="methodsignature"><code>Boolean <strong>isErrorEnabled</strong>()</code></div>\r
 327                                                         <div class="summary">\r
 328                                                                 Returns whether the logger is enabled for <code>ERROR</code> messages.\r
 329                                                         </div>\r
 330                                                 </li>\r
 331                                                 <li class="method">\r
 332                                                         <div class="name">isFatalEnabled</div>\r
 333                                                         <div class="methodsignature"><code>Boolean <strong>isFatalEnabled</strong>()</code></div>\r
 334                                                         <div class="summary">\r
 335                                                                 Returns whether the logger is enabled for <code>FATAL</code> messages.\r
 336                                                         </div>\r
 337                                                 </li>\r
 338                                         </ul>\r
 339                                         <p class="linktotop">\r
 340                                                 <a href="#container">Top</a>\r
 341                                         </p>\r
 342                                 </div>\r
 343                                 <div id="enabling">\r
 344                                         <h2>Enabling / disabling log4javascript Lite</h2>\r
 345                                         <p>\r
 346                                                 All logging can be enabled or disabled in log4javascript Lite in a number of ways:\r
 347                                         </p>\r
 348                                         <ul>\r
 349                                                 <li>\r
 350                                                         At any time, you can call\r
 351                                                         <code>log4javascript.setEnabled(<em>enabled</em>)</code>. This will\r
 352                                                         enable or disable all logging, depending on whether <code>enabled</code>\r
 353                                                         is set to <code>true</code> or <code>false</code>.\r
 354                                                 </li>\r
 355                                                 <li>\r
 356                                                         Assign your logger object a value of <code>log4javascript.getNullLogger()</code>.\r
 357                                                 </li>\r
 358                                                 <li>\r
 359                                                         Replace your copy of log4javascript_lite.js with stubs/log4javascript_lite.js, provided in the\r
 360                                                         distribution. This file has a stub version of each of the functions and methods\r
 361                                                         in the log4javascript Lite API and can simply be dropped in in place of the main file.\r
 362                                                 </li>\r
 363                                         </ul>\r
 364                                         <p class="linktotop">\r
 365                                                 <a href="#container">Top</a>\r
 366                                         </p>\r
 367                                 </div>\r
 368                         </div>\r
 369                         <div id="footer">\r
 370                                 <span class="externallinkinfo">\r
 371                                         <strong>NB.</strong> All external links open in a new window.\r
 372                                 </span>\r
 373                                 Written by Tim Down. <a href="mailto:tim@log4javascript.org">tim@log4javascript.org</a>\r
 374                                 <br />\r
 375                                 log4javascript is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html"\r
 376                                         title="Apache License, Version 2.0 (opens in new window)" target="_blank">Apache License,\r
 377                                         Version 2.0</a>\r
 378 \r
 379                         </div>\r
 380                 </div>\r
 381 \r
 382         </body>\r
 383 </html>\r