4f68a0933c
fixed the resizable text area with IE problem fixed the ad space with IE problem merged the 7.2.0 and 7.1.4 change logs
464 lines
10 KiB
HTML
464 lines
10 KiB
HTML
|
|
|
|
<html>
|
|
|
|
<head>
|
|
|
|
<title>JavaScript Documentation - </title>
|
|
|
|
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
|
|
|
|
</head>
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
<div id="header">
|
|
|
|
<h1>JavaScript Documentation</h1>
|
|
|
|
<h3><a href="./index.html">Yui Event Utility</a></h3>
|
|
|
|
|
|
|
|
<div class="breadcrumbs">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="./index.html">Yui Event Utility</a>
|
|
|
|
>
|
|
|
|
<strong>YAHOO.util.Subscriber</strong>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div id="body">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="nav">
|
|
|
|
<div class="module resources">
|
|
|
|
<ul class="content">
|
|
|
|
<li><a href="overview-tree.html">Tree View</a></li>
|
|
|
|
<li><a href="index-all.html">Element Index</a></li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="module">
|
|
|
|
<h4><a href="./allclasses-noframe.html">Classes</a></h4>
|
|
|
|
<ul class="content">
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="YAHOO.util.html">
|
|
|
|
YAHOO.util</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="YAHOO.util.CustomEvent.html">
|
|
|
|
YAHOO.util.CustomEvent</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="YAHOO.util.Event.html">
|
|
|
|
YAHOO.util.Event</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="YAHOO.util.Subscriber.html">
|
|
|
|
YAHOO.util.Subscriber</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="module">
|
|
|
|
<h4><a href="./overview-summary.html">Files</a></h4>
|
|
|
|
<ul class="content">
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="overview-summary-CustomEvent.js.html">
|
|
|
|
CustomEvent.js</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="overview-summary-Event.js.html">
|
|
|
|
Event.js</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="pri">
|
|
|
|
<div class="main">
|
|
|
|
|
|
|
|
<h2>Class YAHOO.util.Subscriber</h2>
|
|
|
|
<pre>Object
|
|
|
|
|
+--<b>YAHOO.util.Subscriber</b>
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
<!-- Class definition -->
|
|
|
|
<div class="class-def">
|
|
|
|
<div class="class-name">
|
|
|
|
<span class="class-attribs">
|
|
|
|
|
|
|
|
</span>
|
|
|
|
<span class="class-type">class</span>
|
|
|
|
<b>YAHOO.util.Subscriber</b>
|
|
|
|
</div>
|
|
|
|
<div class="class-extends">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ======== QUICK LINKS ======== -->
|
|
|
|
<div class="quick-links">
|
|
|
|
<strong>Quick Links:</strong>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="#field_summary">Field Summary</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="#constructor_summary">Constructor Summary</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="#methodSummary">Method Summary</a> |
|
|
|
|
<a href="#methodDetails">Method Details</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<!-- ======== END QUICK LINKS ======== -->
|
|
|
|
|
|
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
|
|
<div class="section field summaries">
|
|
|
|
<h3><a name="field_summary">Field Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
|
|
|
|
<div class="content">
|
|
|
|
<table border="1" cellpadding="3" cellspacing="0">
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="flags">function</td>
|
|
|
|
<td class="spec">
|
|
|
|
<code>
|
|
|
|
<a href="#fn">fn</a>
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
The callback that will be execute when the event fires
|
|
|
|
</div>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="flags">object</td>
|
|
|
|
<td class="spec">
|
|
|
|
<code>
|
|
|
|
<a href="#obj">obj</a>
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
An optional custom object that will passed to the callback when
|
|
the event fires
|
|
|
|
</div>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="flags">boolean</td>
|
|
|
|
<td class="spec">
|
|
|
|
<code>
|
|
|
|
<a href="#override">override</a>
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
The default execution scope for the event listener is defined when the
|
|
event is created (usually the object which contains the event).
|
|
|
|
</div>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== END FIELD SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
|
|
|
<div class="section contructor summaries">
|
|
|
|
<h3><a name="constructor_summary">Constructor Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
|
|
|
|
<div class="content">
|
|
|
|
<code class="spec">
|
|
|
|
<a href="YAHOO.util.Subscriber.html#YAHOO.util.Subscriber()">YAHOO.util.Subscriber</a>
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
|
|
|
|
<div class="section method summaries">
|
|
|
|
<h3><a name="methodSummary">Method Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
|
|
|
|
<div class="content">
|
|
|
|
<table border="1" cellpadding="3" cellspacing="0">
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="flags">boolean</td>
|
|
|
|
<td class="spec">
|
|
|
|
<code>
|
|
|
|
<a href="#contains">contains</a>
|
|
|
|
(<Function> fn, <Object> obj)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
Returns true if the fn and obj match this objects properties.
|
|
|
|
</div>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="flags">Object</td>
|
|
|
|
<td class="spec">
|
|
|
|
<code>
|
|
|
|
<a href="#toString">toString</a>
|
|
|
|
()
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
|
|
|
|
|
|
|
<div class="section field details">
|
|
|
|
<h3><a name="field_detail">Field Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
|
|
|
|
<div class="content">
|
|
|
|
|
|
|
|
<h4><a name="fn">fn</a></h4>
|
|
|
|
<div class="detail">
|
|
|
|
<code>
|
|
|
|
function
|
|
|
|
|
|
|
|
<strong>fn</strong>
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
The callback that will be execute when the event fires
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
<h4><a name="obj">obj</a></h4>
|
|
|
|
<div class="detail">
|
|
|
|
<code>
|
|
|
|
object
|
|
|
|
|
|
|
|
<strong>obj</strong>
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
An optional custom object that will passed to the callback when
|
|
the event fires
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
<h4><a name="override">override</a></h4>
|
|
|
|
<div class="detail">
|
|
|
|
<code>
|
|
|
|
boolean
|
|
|
|
|
|
|
|
<strong>override</strong>
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
The default execution scope for the event listener is defined when the
|
|
event is created (usually the object which contains the event).
|
|
By setting override to true, the execution scope becomes the custom
|
|
object passed in by the subscriber
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- ============ FIELD DETAIL END =========== -->
|
|
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
|
|
|
|
|
|
|
<div class="section constructor details">
|
|
|
|
<h3><a name="constructor_detail">Constructor Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
|
|
|
|
<div class="content">
|
|
|
|
<h4><a name="YAHOO.util.Subscriber()">YAHOO.util.Subscriber</a></h4>
|
|
|
|
<div class="detail">
|
|
|
|
<code>
|
|
|
|
<strong>YAHOO.util.Subscriber</strong>
|
|
|
|
()
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
|
|
|
<dd>
|
|
|
|
<code>fn</code> -
|
|
|
|
The function to execute
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
<dd>
|
|
|
|
<code>obj</code> -
|
|
|
|
An object to be passed along when the event fires
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
<dd>
|
|
|
|
<code>bOverride</code> -
|
|
|
|
If true, the obj passed in becomes the execution scope of the listener
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============ METHOD DETAIL START ========== -->
|
|
|
|
|
|
|
|
<div class="section method details">
|
|
|
|
<h3><a name="methodDetails">Method Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
|
|
|
|
<div class="content">
|
|
|
|
|
|
|
|
<h4><a name="contains">contains</a></h4>
|
|
|
|
<div class="detail">
|
|
|
|
<code>
|
|
|
|
boolean
|
|
|
|
<strong>contains</strong>
|
|
|
|
(<Function> fn, <Object> obj)
|
|
|
|
</code>
|
|
|
|
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
Returns true if the fn and obj match this objects properties.
|
|
Used by the unsubscribe method to match the right subscriber.
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
|
|
|
<dd>
|
|
|
|
<code>fn</code> -
|
|
|
|
the function to execute
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
<dd>
|
|
|
|
<code>obj</code> -
|
|
|
|
an object to be passed along when the event fires
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
<dt>Returns:</dt>
|
|
|
|
<dd> true if the supplied arguments match this subscriber's signature.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
<h4><a name="toString">toString</a></h4>
|
|
|
|
<div class="detail">
|
|
|
|
<code>
|
|
|
|
Object
|
|
|
|
<strong>toString</strong>
|
|
|
|
()
|
|
|
|
</code>
|
|
|
|
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- ============ METHOD DETAIL END ========== -->
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
|
|
|
|
|
|
|
|
|
|
<div id="footer">
|
|
|
|
<hr />
|
|
|
|
Copyright © 2004 - 2006 Yahoo! Inc. All rights reserved.
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
</html>
|
|
|