webgui/www/extras/yui/docs/YAHOO.widget.LogReader.html
2008-03-25 16:13:25 +00:00

2876 lines
141 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.LogReader (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>Logger Widget&nbsp; <span class="subtitle">2.5.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_logger.html">logger</a>
&gt; YAHOO.widget.LogReader
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.LogReader</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
The LogReader class provides UI to read messages logged to YAHOO.widget.Logger.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.LogReader</strong>
<code>
(
elContainer
,
oConfigs
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer
&lt;HTMLElement&gt;
</code>
(optional) DOM element reference of an existing DIV.
</dd>
<dd>
<code>elContainer
&lt;String&gt;
</code>
(optional) String ID of an existing DIV.
</dd>
<dd>
<code>oConfigs
&lt;Object&gt;
</code>
(optional) Object literal of configuration params.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property__btnClear">_btnClear</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Clear button element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__btnCollapse">_btnCollapse</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader collapse button element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__btnPause">_btnPause</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader pause button element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__buffer">_buffer</a>
<code>- private Object[]</code>
</h4>
<div class="detail">
<div class="description">
Buffer of log message objects for batch output.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__categoryFilters">_categoryFilters</a>
<code>- private String[]</code>
</h4>
<div class="detail">
<div class="description">
Array of filters for log message categories.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__consoleMsgCount">_consoleMsgCount</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Number of log messages output to console.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elBtns">_elBtns</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader buttons container element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elCategoryFilters">_elCategoryFilters</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Container element for LogReader category filter checkboxes.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elCollapse">_elCollapse</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader collapse element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elConsole">_elConsole</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader console element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elContainer">_elContainer</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader container element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elDefaultContainer">_elDefaultContainer</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
A class member shared by all LogReaders if a container needs to be
created during instantiation. Will be null if a container element never needs to
be created on the fly, such as when the implementer passes in their own element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elFt">_elFt</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader footer element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elHd">_elHd</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader header element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elSourceFilters">_elSourceFilters</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Container element for LogReader source filter checkboxes.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__filterCheckboxes">_filterCheckboxes</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
Hash of filters and their related checkbox elements.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__lastTime">_lastTime</a>
<code>- private Date</code>
</h4>
<div class="detail">
<div class="description">
Date of last output log message.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__memberName">_memberName</a>
<code>- private static Number</code>
</h4>
<div class="detail">
<div class="description">
Internal class member to index multiple LogReader instances.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__sName">_sName</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
Name of LogReader instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__sourceFilters">_sourceFilters</a>
<code>- private String[]</code>
</h4>
<div class="detail">
<div class="description">
Array of filters for log message sources.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__timeout">_timeout</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Batched output timeout ID.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__title">_title</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
LogReader title header element.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_BASIC_TEMPLATE">BASIC_TEMPLATE</a>
<code>- static object</code>
</h4>
<div class="detail">
<div class="description">
Template used for innerHTML of compact entry output.
</div>
</div>
<div class="default">
Default Value: "<p><span class='{category}'>{label}</span>{totalTime}ms (+{elapsedTime}) {localTime}: {sourceAndDetail}: {message}</p>"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_bottom">bottom</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Public member to access CSS bottom position of the LogReader container.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_draggable">draggable</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Enables draggable LogReader if DragDrop Utility is present.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="property_ENTRY_TEMPLATE">ENTRY_TEMPLATE</a>
<code>- static {HTMLElement}</code>
</h4>
<div class="detail">
<div class="description">
Node template for the log entries
</div>
</div>
<div class="default">
Default Value: PRE.yui-log-entry element
</div>
<hr />
</div>
<div class="">
<h4><a name="property_entryFormat">entryFormat</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Custom output format for log messages. Defaults to null, which falls
back to verboseOutput param deciding between LogReader.VERBOSE_TEMPLATE
and LogReader.BASIC_TEMPLATE. Use bracketed place holders to mark where
message info should go. Available place holder names include:
<ul>
<li>category</li>
<li>label</li>
<li>sourceAndDetail</li>
<li>message</li>
<li>localTime</li>
<li>elapsedTime</li>
<li>totalTime</li>
</ul>
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="property_fontSize">fontSize</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Public member to access CSS font size of the LogReader container.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_footerEnabled">footerEnabled</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Whether or not the footer UI is enabled for the LogReader.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="property_height">height</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Public member to access CSS height of the LogReader container.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_isCollapsed">isCollapsed</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True when LogReader is in a collapsed state, false otherwise.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="property_isPaused">isPaused</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True when LogReader is in a paused state, false otherwise.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="property_left">left</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Public member to access CSS left position of the LogReader container.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_logReaderEnabled">logReaderEnabled</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Whether or not LogReader is enabled to output log messages.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="property_newestOnTop">newestOnTop</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Whether or not newest message is printed on top.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_outputBuffer">outputBuffer</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Output timeout buffer in milliseconds.
</div>
</div>
<div class="default">
Default Value: 100
</div>
<hr />
</div>
<div class="">
<h4><a name="property_right">right</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Public member to access CSS right position of the LogReader container.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_thresholdMax">thresholdMax</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Maximum number of messages a LogReader console will display.
</div>
</div>
<div class="default">
Default Value: 500
</div>
<hr />
</div>
<div class="">
<h4><a name="property_thresholdMin">thresholdMin</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
When a LogReader console reaches its thresholdMax, it will clear out messages
and print out the latest thresholdMin number of messages.
</div>
</div>
<div class="default">
Default Value: 100
</div>
<hr />
</div>
<div class="">
<h4><a name="property_top">top</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Public member to access CSS top position of the LogReader container.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_VERBOSE_TEMPLATE">VERBOSE_TEMPLATE</a>
<code>- static object</code>
</h4>
<div class="detail">
<div class="description">
Template used for innerHTML of verbose entry output.
</div>
</div>
<div class="default">
Default Value: "<span class='{category}'>{label}</span>{totalTime}ms (+{elapsedTime}) {localTime}:</p><p>{sourceAndDetail}</p><p>{message}</p>"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_verboseOutput">verboseOutput</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Whether or not output is verbose (more readable). Setting to true will make
output more compact (less readable).
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="property_width">width</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Public member to access CSS width of the LogReader container.
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method__createCategoryCheckbox">_createCategoryCheckbox</a></h4>
<div class="detail">
<code>
private
void
<strong>_createCategoryCheckbox</strong>
(
sCategory
)
</code>
<div class="description">
Creates the UI for a category filter in the LogReader footer element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sCategory &lt;String&gt;</code>
Category name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__createSourceCheckbox">_createSourceCheckbox</a></h4>
<div class="detail">
<code>
private
void
<strong>_createSourceCheckbox</strong>
(
sSource
)
</code>
<div class="description">
Creates a checkbox in the LogReader footer element to filter by source.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sSource &lt;String&gt;</code>
Source name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__filterLogs">_filterLogs</a></h4>
<div class="detail">
<code>
private
void
<strong>_filterLogs</strong>
(
)
</code>
<div class="description">
Reprints all log messages in the stack through filters.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initCategories">_initCategories</a></h4>
<div class="detail">
<code>
private
void
<strong>_initCategories</strong>
(
)
</code>
<div class="description">
Initializes category filters.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initConsoleEl">_initConsoleEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initConsoleEl</strong>
(
)
</code>
<div class="description">
Initializes the console element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initContainerEl">_initContainerEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initContainerEl</strong>
(
elContainer
)
</code>
<div class="description">
Initializes the primary container element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer &lt;HTMLElement&gt;</code>
Container element by reference or string ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initDragDrop">_initDragDrop</a></h4>
<div class="detail">
<code>
private
void
<strong>_initDragDrop</strong>
(
)
</code>
<div class="description">
Initializes Drag and Drop on the header element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initFooterEl">_initFooterEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initFooterEl</strong>
(
)
</code>
<div class="description">
Initializes the footer element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initHeaderEl">_initHeaderEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initHeaderEl</strong>
(
)
</code>
<div class="description">
Initializes the header element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initSources">_initSources</a></h4>
<div class="detail">
<code>
private
void
<strong>_initSources</strong>
(
)
</code>
<div class="description">
Initializes source filters.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onCategoryCreate">_onCategoryCreate</a></h4>
<div class="detail">
<code>
private
void
<strong>_onCategoryCreate</strong>
(
sType
,
aArgs
,
oSelf
)
</code>
<div class="description">
Handles Logger's categoryCreateEvent.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sType &lt;String&gt;</code>
The event.
</dd>
<dd>
<code>aArgs &lt;Object[]&gt;</code>
Data passed from event firer.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onCheckCategory">_onCheckCategory</a></h4>
<div class="detail">
<code>
private
void
<strong>_onCheckCategory</strong>
(
v
,
oSelf
)
</code>
<div class="description">
Handles check events on the category filter checkboxes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>v &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onCheckSource">_onCheckSource</a></h4>
<div class="detail">
<code>
private
void
<strong>_onCheckSource</strong>
(
v
,
oSelf
)
</code>
<div class="description">
Handles check events on the category filter checkboxes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>v &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onClickClearBtn">_onClickClearBtn</a></h4>
<div class="detail">
<code>
private
void
<strong>_onClickClearBtn</strong>
(
v
,
oSelf
)
</code>
<div class="description">
Handles click events on the clear button.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>v &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onClickCollapseBtn">_onClickCollapseBtn</a></h4>
<div class="detail">
<code>
private
void
<strong>_onClickCollapseBtn</strong>
(
v
,
oSelf
)
</code>
<div class="description">
Handles click events on the collapse button.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>v &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onClickPauseBtn">_onClickPauseBtn</a></h4>
<div class="detail">
<code>
private
void
<strong>_onClickPauseBtn</strong>
(
v
,
oSelf
)
</code>
<div class="description">
Handles click events on the pause button.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>v &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onNewLog">_onNewLog</a></h4>
<div class="detail">
<code>
private
void
<strong>_onNewLog</strong>
(
sType
,
aArgs
,
oSelf
)
</code>
<div class="description">
Handles Logger's newLogEvent.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sType &lt;String&gt;</code>
The event.
</dd>
<dd>
<code>aArgs &lt;Object[]&gt;</code>
Data passed from event firer.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onReset">_onReset</a></h4>
<div class="detail">
<code>
private
void
<strong>_onReset</strong>
(
sType
,
aArgs
,
oSelf
)
</code>
<div class="description">
Handles Logger's resetEvent.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sType &lt;String&gt;</code>
The event.
</dd>
<dd>
<code>aArgs &lt;Object[]&gt;</code>
Data passed from event firer.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onSourceCreate">_onSourceCreate</a></h4>
<div class="detail">
<code>
private
void
<strong>_onSourceCreate</strong>
(
sType
,
aArgs
,
oSelf
)
</code>
<div class="description">
Handles Logger's sourceCreateEvent.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sType &lt;String&gt;</code>
The event.
</dd>
<dd>
<code>aArgs &lt;Object[]&gt;</code>
Data passed from event firer.
</dd>
<dd>
<code>oSelf &lt;Object&gt;</code>
The LogReader instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__printBuffer">_printBuffer</a></h4>
<div class="detail">
<code>
private
void
<strong>_printBuffer</strong>
(
)
</code>
<div class="description">
Sends buffer of log messages to output and clears buffer.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__printToConsole">_printToConsole</a></h4>
<div class="detail">
<code>
private
void
<strong>_printToConsole</strong>
(
aEntries
)
</code>
<div class="description">
Cycles through an array of log messages, and outputs each one to the console
if its category has not been filtered out.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aEntries &lt;Object[]&gt;</code>
Array of LogMsg objects to output to console.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clearConsole">clearConsole</a></h4>
<div class="detail">
<code>
void
<strong>clearConsole</strong>
(
)
</code>
<div class="description">
Does not delete any log messages, but clears all printed log messages from
the console. Log messages will be printed out again if user re-filters. The
static method YAHOO.widget.Logger.reset() should be called in order to
actually delete log messages.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_collapse">collapse</a></h4>
<div class="detail">
<code>
void
<strong>collapse</strong>
(
)
</code>
<div class="description">
Collapses UI of LogReader. Logging functionality is not disrupted.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_expand">expand</a></h4>
<div class="detail">
<code>
void
<strong>expand</strong>
(
)
</code>
<div class="description">
Expands UI of LogReader. Logging functionality is not disrupted.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getCategories">getCategories</a></h4>
<div class="detail">
<code>
String[]
<strong>getCategories</strong>
(
)
</code>
<div class="description">
Returns array of enabled categories.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String[]
</code></dt>
<dd>Array of enabled categories.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getCheckbox">getCheckbox</a></h4>
<div class="detail">
<code>
Array
<strong>getCheckbox</strong>
(
Category
)
</code>
<div class="description">
Returns related checkbox element for given filter (i.e., category or source).
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Category &lt;String&gt;</code>
or source name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>Array of all filter checkboxes.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getLastTime">getLastTime</a></h4>
<div class="detail">
<code>
Date
<strong>getLastTime</strong>
(
)
</code>
<div class="description">
Gets timestamp of the last log.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Date
</code></dt>
<dd>Timestamp of the last log.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSources">getSources</a></h4>
<div class="detail">
<code>
Array
<strong>getSources</strong>
(
)
</code>
<div class="description">
Returns array of enabled sources.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>Array of enabled sources.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hide">hide</a></h4>
<div class="detail">
<code>
void
<strong>hide</strong>
(
)
</code>
<div class="description">
Hides UI of LogReader. Logging functionality is not disrupted.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hideCategory">hideCategory</a></h4>
<div class="detail">
<code>
void
<strong>hideCategory</strong>
(
Category
)
</code>
<div class="description">
Hides log messages associated with given category.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Category &lt;String&gt;</code>
name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hideSource">hideSource</a></h4>
<div class="detail">
<code>
void
<strong>hideSource</strong>
(
Source
)
</code>
<div class="description">
Hides log messages associated with given source.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Source &lt;String&gt;</code>
name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_html2Text">html2Text</a></h4>
<div class="detail">
<code>
private
void
<strong>html2Text</strong>
(
sHtml
)
</code>
<div class="description">
Converts input chars "<", ">", and "&" to HTML entities.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sHtml &lt;String&gt;</code>
String to convert.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_pause">pause</a></h4>
<div class="detail">
<code>
void
<strong>pause</strong>
(
)
</code>
<div class="description">
Pauses output of log messages. While paused, log messages are not lost, but
get saved to a buffer and then output upon resume of LogReader.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_resume">resume</a></h4>
<div class="detail">
<code>
void
<strong>resume</strong>
(
)
</code>
<div class="description">
Resumes output of log messages, including outputting any log messages that
have been saved to buffer while paused.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setTitle">setTitle</a></h4>
<div class="detail">
<code>
void
<strong>setTitle</strong>
(
sTitle
)
</code>
<div class="description">
Updates title to given string.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sTitle &lt;String&gt;</code>
New title.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_show">show</a></h4>
<div class="detail">
<code>
void
<strong>show</strong>
(
)
</code>
<div class="description">
Shows UI of LogReader. Logging functionality is not disrupted.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_showCategory">showCategory</a></h4>
<div class="detail">
<code>
void
<strong>showCategory</strong>
(
Category
)
</code>
<div class="description">
Shows log messages associated with given category.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Category &lt;String&gt;</code>
name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_showSource">showSource</a></h4>
<div class="detail">
<code>
void
<strong>showSource</strong>
(
Source
)
</code>
<div class="description">
Shows log messages associated with given source.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Source &lt;String&gt;</code>
name.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Public accessor to the unique name of the LogReader instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique name of the LogReader instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
</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_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</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_cookie.html">cookie</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_editor.html">editor</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_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</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_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</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_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</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="selected"><a href="YAHOO.widget.LogReader.html">YAHOO.widget.LogReader</a></li>
<li class=""><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 class="private"><a href="#property__btnClear">_btnClear</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__btnCollapse">_btnCollapse</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__btnPause">_btnPause</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__buffer">_buffer</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__categoryFilters">_categoryFilters</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__consoleMsgCount">_consoleMsgCount</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elBtns">_elBtns</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elCategoryFilters">_elCategoryFilters</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elCollapse">_elCollapse</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elConsole">_elConsole</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elContainer">_elContainer</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elDefaultContainer">_elDefaultContainer</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elFt">_elFt</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elHd">_elHd</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__elSourceFilters">_elSourceFilters</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__filterCheckboxes">_filterCheckboxes</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__lastTime">_lastTime</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__memberName">_memberName</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__sName">_sName</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__sourceFilters">_sourceFilters</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__timeout">_timeout</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__title">_title</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_BASIC_TEMPLATE">BASIC_TEMPLATE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_bottom">bottom</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_draggable">draggable</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_ENTRY_TEMPLATE">ENTRY_TEMPLATE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_entryFormat">entryFormat</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_fontSize">fontSize</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_footerEnabled">footerEnabled</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_height">height</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_isCollapsed">isCollapsed</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_isPaused">isPaused</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_left">left</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_logReaderEnabled">logReaderEnabled</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_newestOnTop">newestOnTop</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_outputBuffer">outputBuffer</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_right">right</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_thresholdMax">thresholdMax</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_thresholdMin">thresholdMin</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_top">top</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_VERBOSE_TEMPLATE">VERBOSE_TEMPLATE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_verboseOutput">verboseOutput</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_width">width</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#method__createCategoryCheckbox">_createCategoryCheckbox</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__createSourceCheckbox">_createSourceCheckbox</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__filterLogs">_filterLogs</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initCategories">_initCategories</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initConsoleEl">_initConsoleEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initContainerEl">_initContainerEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initDragDrop">_initDragDrop</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initFooterEl">_initFooterEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initHeaderEl">_initHeaderEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initSources">_initSources</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onCategoryCreate">_onCategoryCreate</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onCheckCategory">_onCheckCategory</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onCheckSource">_onCheckSource</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onClickClearBtn">_onClickClearBtn</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onClickCollapseBtn">_onClickCollapseBtn</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onClickPauseBtn">_onClickPauseBtn</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onNewLog">_onNewLog</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onReset">_onReset</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onSourceCreate">_onSourceCreate</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__printBuffer">_printBuffer</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__printToConsole">_printToConsole</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clearConsole">clearConsole</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_collapse">collapse</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_expand">expand</a>
</li>
<li class=""><!--<code>String[]</code>-->
<a href="#method_getCategories">getCategories</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_getCheckbox">getCheckbox</a>
</li>
<li class=""><!--<code>Date</code>-->
<a href="#method_getLastTime">getLastTime</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_getSources">getSources</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_hide">hide</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_hideCategory">hideCategory</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_hideSource">hideSource</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_html2Text">html2Text</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_pause">pause</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_resume">resume</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setTitle">setTitle</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_show">show</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_showCategory">showCategory</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_showSource">showSource</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_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>