yui/docs/LogWriter.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4         <title>API: logger  LogWriter   (YUI Library)</title>
   5         <link rel="stylesheet" type="text/css" href="assets/api.css">
   6 </head>
   7
   8 <body id="yahoo-com">
   9 <div id="doc3" class="yui-t2">
  10
  11         <div id="hd">
  12         <h1>Yahoo! UI Library</h1>
  13         <h3>Logger Widget&nbsp; <span class="subtitle">2.2.0</span></h3>
  14         <p>
  15         <a href="./index.html">Yahoo! UI Library</a>
  16             &gt; <a href="./module_logger.html">logger</a>
  17                  &gt; LogWriter
  18
  19             </p>
  20         </div>
  21
  22         <div id="bd">
  23                 <div id="yui-main">
  24                         <div class="yui-b">
  25
  26
  27                     <h2>
  28
  29
  30
  31
  32                             Class <b>LogWriter</b>
  33                         <span class="extends">
  34                         </span>
  35
  36                         <span class="extends">
  37                         </span>
  38
  39                         </code>
  40                     </h2>
  41                     <!-- class tree goes here -->
  42
  43
  44
  45
  46                     <div class="summary description">
  47                         The LogWriter class provides a mechanism to log messages through
  48 YAHOO.widget.Logger from a named source.
  49                     </div>
  50
  51                         <div class="section constructor details">
  52                         <h3><a name="constructor_detail">Constructor</a></h3>
  53                         <div class="content">
  54                             <div class="detail">
  55                                 <strong>LogWriter</strong>
  56                                 <code>
  57                                     (
  58
  59
  60
  61                                                 sSource
  62                                     )
  63                                 </code>
  64                                 <div class="description">
  65                                         <dl>
  66                                             <dt>Parameters:</dt>
  67                                                 <dd>
  68                                                     <code>sSource
  69                                                     &lt;String&gt;
  70                                                     </code>
  71                                                       Source of LogWriter instance.
  72                                                 </dd>
  73                                         </dl>
  74
  75
  76                                 </div>
  77                             </div>
  78                         </div>
  79                     </div>
  80
  81                         <div class="section field details">
  82                             <h3><a name="field_detail">Properties</a></h3>
  83                             <div class="content">
  84                                     <h4><a name="_source">_source</a>
  85                                         <code>- private String</code>
  86                                     </h4>
  87                                     <div class="detail">
  88                                         <div class="description">
  89                                             Source of the LogWriter instance.
  90                                         </div>
  91                                     </div>
  92
  93
  94
  95
  96                                     <hr />
  97
  98
  99                             </div>
 100                         </div>
 101
 102
 103                         <div class="section method details">
 104                             <h3><a name="methodDetails">Methods</a></h3>
 105                             <div class="content">
 106                                     <h4>
 107                                         <a name="getSource">getSource</a></h4>
 108                                     <div class="detail">
 109                                         <code>
 110
 111
 112
 113                                         String
 114                                             <strong>getSource</strong>
 115                                            (
 116                                             )
 117                                         </code>
 118
 119                                         <div class="description">
 120                                             Public accessor to get the source name.
 121                                         </div>
 122
 123                                         <div class="description">
 124
 125
 126                                                 <dl>
 127                                                     <dt>Returns:
 128                                                     <code>
 129                                                         String
 130                                                     </code></dt>
 131                                                     <dd>The LogWriter source.</dd>
 132                                                 </dl>
 133
 134                                         </div>
 135
 136                                     </div>
 137                                     <hr />
 138                                     <h4>
 139                                         <a name="log">log</a></h4>
 140                                     <div class="detail">
 141                                         <code>
 142
 143
 144
 145                                         void
 146                                             <strong>log</strong>
 147                                            (
 148
 149
 150                                                          sMsg
 151
 152
 153                                                         ,
 154                                                          sCategory
 155
 156
 157                                             )
 158                                         </code>
 159
 160                                         <div class="description">
 161                                             Logs a message attached to the source of the LogWriter.
 162                                         </div>
 163
 164                                         <div class="description">
 165
 166                                                 <dl>
 167                                                     <dt>Parameters:</dt>
 168                                                         <dd>
 169                                                             <code>sMsg &lt;String&gt;</code>
 170                                                               The log message.
 171                                                         </dd>
 172                                                         <dd>
 173                                                             <code>sCategory &lt;String&gt;</code>
 174                                                               Category name.
 175                                                         </dd>
 176                                                 </dl>
 177
 178                                                 <dl>
 179                                                     <dt>Returns:
 180                                                     <code>
 181                                                         void
 182                                                     </code></dt>
 183                                                     <dd></dd>
 184                                                 </dl>
 185
 186                                         </div>
 187
 188                                     </div>
 189                                     <hr />
 190                                     <h4>
 191                                         <a name="setSource">setSource</a></h4>
 192                                     <div class="detail">
 193                                         <code>
 194
 195
 196
 197                                         void
 198                                             <strong>setSource</strong>
 199                                            (
 200
 201
 202                                                          sSource
 203
 204
 205                                             )
 206                                         </code>
 207
 208                                         <div class="description">
 209                                             Public accessor to set the source name.
 210                                         </div>
 211
 212                                         <div class="description">
 213
 214                                                 <dl>
 215                                                     <dt>Parameters:</dt>
 216                                                         <dd>
 217                                                             <code>sSource &lt;String&gt;</code>
 218                                                               Source of LogWriter instance.
 219                                                         </dd>
 220                                                 </dl>
 221
 222                                                 <dl>
 223                                                     <dt>Returns:
 224                                                     <code>
 225                                                         void
 226                                                     </code></dt>
 227                                                     <dd></dd>
 228                                                 </dl>
 229
 230                                         </div>
 231
 232                                     </div>
 233                                     <hr />
 234                                     <h4>
 235                                         <a name="toString">toString</a></h4>
 236                                     <div class="detail">
 237                                         <code>
 238
 239
 240
 241                                         String
 242                                             <strong>toString</strong>
 243                                            (
 244                                             )
 245                                         </code>
 246
 247                                         <div class="description">
 248                                             Public accessor to the unique name of the LogWriter instance.
 249                                         </div>
 250
 251                                         <div class="description">
 252
 253
 254                                                 <dl>
 255                                                     <dt>Returns:
 256                                                     <code>
 257                                                         String
 258                                                     </code></dt>
 259                                                     <dd>Unique name of the LogWriter instance.</dd>
 260                                                 </dl>
 261
 262                                         </div>
 263
 264                                     </div>
 265                                     <hr />
 266                             </div>
 267                         </div>
 268
 269
 270
 271
 272
 273
 274
 275                         </div>
 276                 </div>
 277                 <div class="yui-b">
 278             <div class="nav">
 279
 280                     <div class="module">
 281                         <h4>Modules</h4>
 282                         <ul class="content">
 283
 284                                 <li class=""><a href="module_animation.html">animation</a></li>
 285
 286                                 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
 287
 288                                 <li class=""><a href="module_button.html">button</a></li>
 289
 290                                 <li class=""><a href="module_calendar.html">calendar</a></li>
 291
 292                                 <li class=""><a href="module_connection.html">connection</a></li>
 293
 294                                 <li class=""><a href="module_container.html">container</a></li>
 295
 296                                 <li class=""><a href="module_datasource.html">datasource</a></li>
 297
 298                                 <li class=""><a href="module_datatable.html">datatable</a></li>
 299
 300                                 <li class=""><a href="module_dom.html">dom</a></li>
 301
 302                                 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
 303
 304                                 <li class=""><a href="module_element.html">element</a></li>
 305
 306                                 <li class=""><a href="module_event.html">event</a></li>
 307
 308                                 <li class=""><a href="module_history.html">history</a></li>
 309
 310                                 <li class="selected"><a href="module_logger.html">logger</a></li>
 311
 312                                 <li class=""><a href="module_menu.html">menu</a></li>
 313
 314                                 <li class=""><a href="module_slider.html">slider</a></li>
 315
 316                                 <li class=""><a href="module_tabview.html">tabview</a></li>
 317
 318                                 <li class=""><a href="module_treeview.html">treeview</a></li>
 319
 320                                 <li class=""><a href="module_yahoo.html">yahoo</a></li>
 321                         </ul>
 322                     </div>
 323
 324                     <div class="module">
 325                         <h4>Classes</h4>
 326                         <ul class="content">
 327                                 <li class=""><a href="LogMsg.html">LogMsg</a></li>
 328                                 <li class=""><a href="LogReader.html">LogReader</a></li>
 329                                 <li class="selected"><a href="LogWriter.html">LogWriter</a></li>
 330                                 <li class=""><a href="YAHOO.widget.Logger.html">YAHOO.widget.Logger</a></li>
 331                         </ul>
 332                     </div>
 333
 334                     <div class="module">
 335                         <h4>Files</h4>
 336                         <ul class="content">
 337                                 <li class=""><a href="Logger.js.html">Logger.js</a></li>
 338                                 <li class=""><a href="LogMsg.js.html">LogMsg.js</a></li>
 339                                 <li class=""><a href="LogReader.js.html">LogReader.js</a></li>
 340                                 <li class=""><a href="LogWriter.js.html">LogWriter.js</a></li>
 341                         </ul>
 342                     </div>
 343
 344                     <div class="module">
 345                         <h4>Properties</h4>
 346                         <ul class="content">
 347                                 <li><a href="#_source">_source</a>
 348                                         <!--<code>&lt;String&gt;</code>-->
 349                                 </li>
 350                         </ul>
 351                     </div>
 352
 353                     <div class="module">
 354                         <h4>Methods</h4>
 355                         <ul class="content">
 356                                 <li><!--<code>String</code>-->
 357                                 <a href="#getSource">getSource</a>
 358                                 </li>
 359                                 <li><!--<code>void</code>-->
 360                                 <a href="#log">log</a>
 361                                 </li>
 362                                 <li><!--<code>void</code>-->
 363                                 <a href="#setSource">setSource</a>
 364                                 </li>
 365                                 <li><!--<code>String</code>-->
 366                                 <a href="#toString">toString</a>
 367                                 </li>
 368                         </ul>
 369                     </div>
 370
 371
 372
 373             </div>
 374                 </div>
 375         </div>
 376         <div id="ft">
 377         <hr />
 378         Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
 379         </div>
 380 </div>
 381 </body>
 382 </html>