webgui/www/extras/yui/docs/YAHOO.widget.LogWriter.html
2007-07-05 04:23:55 +00:00

382 lines
16 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: logger YAHOO.widget.LogWriter (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1>Yahoo! UI Library</h1>
<h3>Logger Widget&nbsp; <span class="subtitle">2.2.2</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_logger.html">logger</a>
&gt; YAHOO.widget.LogWriter
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<h2>
Class <b>YAHOO.widget.LogWriter</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
The LogWriter class provides a mechanism to log messages through
YAHOO.widget.Logger from a named source.
</div>
<div class="section constructor details">
<h3><a name="constructor_detail">Constructor</a></h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.LogWriter</strong>
<code>
(
sSource
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sSource
&lt;String&gt;
</code>
Source of LogWriter instance.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3><a name="field_detail">Properties</a></h3>
<div class="content">
<h4><a name="_source">_source</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
Source of the LogWriter instance.
</div>
</div>
<hr />
</div>
</div>
<div class="section method details">
<h3><a name="methodDetails">Methods</a></h3>
<div class="content">
<h4>
<a name="getSource">getSource</a></h4>
<div class="detail">
<code>
String
<strong>getSource</strong>
(
)
</code>
<div class="description">
Public accessor to get the source name.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>The LogWriter source.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="log">log</a></h4>
<div class="detail">
<code>
void
<strong>log</strong>
(
sMsg
,
sCategory
)
</code>
<div class="description">
Logs a message attached to the source of the LogWriter.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sMsg &lt;String&gt;</code>
The log message.
</dd>
<dd>
<code>sCategory &lt;String&gt;</code>
Category name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="setSource">setSource</a></h4>
<div class="detail">
<code>
void
<strong>setSource</strong>
(
sSource
)
</code>
<div class="description">
Public accessor to set the source name.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sSource &lt;String&gt;</code>
Source of LogWriter instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Public accessor to the unique name of the LogWriter instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique name of the LogWriter instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class="selected"><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.widget.Logger.html">YAHOO.widget.Logger</a></li>
<li class=""><a href="YAHOO.widget.LogMsg.html">YAHOO.widget.LogMsg</a></li>
<li class=""><a href="YAHOO.widget.LogReader.html">YAHOO.widget.LogReader</a></li>
<li class="selected"><a href="YAHOO.widget.LogWriter.html">YAHOO.widget.LogWriter</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Logger.js.html">Logger.js</a></li>
<li class=""><a href="LogMsg.js.html">LogMsg.js</a></li>
<li class=""><a href="LogReader.js.html">LogReader.js</a></li>
<li class=""><a href="LogWriter.js.html">LogWriter.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li><a href="#_source">_source</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li><!--<code>String</code>-->
<a href="#getSource">getSource</a>
</li>
<li><!--<code>void</code>-->
<a href="#log">log</a>
</li>
<li><!--<code>void</code>-->
<a href="#setSource">setSource</a>
</li>
<li><!--<code>String</code>-->
<a href="#toString">toString</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>