upgraded yui to 2.2.2 and yui-ext to 1.0.1a
This commit is contained in:
JT Smith
parent
4d9af2c691
commit
547ced6500
1992 changed files with 645731 additions and 0 deletions
406
www/extras/yui/docs/YAHOO.util.Subscriber.html
Normal file
406
www/extras/yui/docs/YAHOO.util.Subscriber.html
Normal file
|
|
@ -0,0 +1,406 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>API: event YAHOO.util.Subscriber (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>Event Utility <span class="subtitle">2.2.2</span></h3>
|
||||
<p>
|
||||
<a href="./index.html">Yahoo! UI Library</a>
|
||||
> <a href="./module_event.html">event</a>
|
||||
> YAHOO.util.Subscriber
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="bd">
|
||||
<div id="yui-main">
|
||||
<div class="yui-b">
|
||||
|
||||
|
||||
<h2>
|
||||
|
||||
|
||||
|
||||
|
||||
Class <b>YAHOO.util.Subscriber</b>
|
||||
<span class="extends">
|
||||
</span>
|
||||
|
||||
<span class="extends">
|
||||
</span>
|
||||
|
||||
</code>
|
||||
</h2>
|
||||
<!-- class tree goes here -->
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="summary description">
|
||||
Stores the subscriber information to be used when the event fires.
|
||||
</div>
|
||||
|
||||
<div class="section constructor details">
|
||||
<h3><a name="constructor_detail">Constructor</a></h3>
|
||||
<div class="content">
|
||||
<div class="detail">
|
||||
<strong>YAHOO.util.Subscriber</strong>
|
||||
<code>
|
||||
(
|
||||
|
||||
|
||||
|
||||
fn
|
||||
|
||||
,
|
||||
obj
|
||||
|
||||
,
|
||||
override
|
||||
)
|
||||
</code>
|
||||
<div class="description">
|
||||
<dl>
|
||||
<dt>Parameters:</dt>
|
||||
<dd>
|
||||
<code>fn
|
||||
<Function>
|
||||
</code>
|
||||
The function to execute
|
||||
</dd>
|
||||
<dd>
|
||||
<code>obj
|
||||
<Object>
|
||||
</code>
|
||||
An object to be passed along when the event fires
|
||||
</dd>
|
||||
<dd>
|
||||
<code>override
|
||||
<boolean>
|
||||
</code>
|
||||
If true, the obj passed in becomes the execution
|
||||
scope of the listener
|
||||
</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="fn">fn</a>
|
||||
<code>- function</code>
|
||||
</h4>
|
||||
<div class="detail">
|
||||
<div class="description">
|
||||
The callback that will be execute when the event fires
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
<h4><a name="obj">obj</a>
|
||||
<code>- object</code>
|
||||
</h4>
|
||||
<div class="detail">
|
||||
<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>
|
||||
<code>- boolean|object</code>
|
||||
</h4>
|
||||
<div class="detail">
|
||||
<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. If override is an object, that
|
||||
object becomes the scope.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="section method details">
|
||||
<h3><a name="methodDetails">Methods</a></h3>
|
||||
<div class="content">
|
||||
<h4>
|
||||
<a name="contains">contains</a></h4>
|
||||
<div class="detail">
|
||||
<code>
|
||||
|
||||
|
||||
|
||||
boolean
|
||||
<strong>contains</strong>
|
||||
(
|
||||
|
||||
|
||||
fn
|
||||
|
||||
|
||||
,
|
||||
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.
|
||||
</div>
|
||||
|
||||
<div class="description">
|
||||
|
||||
<dl>
|
||||
<dt>Parameters:</dt>
|
||||
<dd>
|
||||
<code>fn <Function></code>
|
||||
the function to execute
|
||||
</dd>
|
||||
<dd>
|
||||
<code>obj <Object></code>
|
||||
an object to be passed along when the event fires
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl>
|
||||
<dt>Returns:
|
||||
<code>
|
||||
boolean
|
||||
</code></dt>
|
||||
<dd>true if the supplied arguments match this
|
||||
subscriber's signature.</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<hr />
|
||||
<h4>
|
||||
<a name="getScope">getScope</a></h4>
|
||||
<div class="detail">
|
||||
<code>
|
||||
|
||||
|
||||
|
||||
void
|
||||
<strong>getScope</strong>
|
||||
(
|
||||
|
||||
|
||||
defaultScope
|
||||
|
||||
|
||||
)
|
||||
</code>
|
||||
|
||||
<div class="description">
|
||||
Returns the execution scope for this listener. If override was set to true
|
||||
the custom obj will be the scope. If override is an object, that is the
|
||||
scope, otherwise the default scope will be used.
|
||||
</div>
|
||||
|
||||
<div class="description">
|
||||
|
||||
<dl>
|
||||
<dt>Parameters:</dt>
|
||||
<dd>
|
||||
<code>defaultScope <Object></code>
|
||||
the scope to use if this listener does not
|
||||
override it.
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
void
|
||||
<strong>toString</strong>
|
||||
(
|
||||
)
|
||||
</code>
|
||||
|
||||
<div class="description">
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description">
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>Returns:
|
||||
<code>
|
||||
void
|
||||
</code></dt>
|
||||
<dd></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="selected"><a href="module_event.html">event</a></li>
|
||||
|
||||
<li class=""><a href="module_history.html">history</a></li>
|
||||
|
||||
<li class=""><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.util.CustomEvent.html">YAHOO.util.CustomEvent</a></li>
|
||||
<li class=""><a href="YAHOO.util.Event.html">YAHOO.util.Event</a></li>
|
||||
<li class=""><a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a></li>
|
||||
<li class="selected"><a href="YAHOO.util.Subscriber.html">YAHOO.util.Subscriber</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="module">
|
||||
<h4>Files</h4>
|
||||
<ul class="content">
|
||||
<li class=""><a href="CustomEvent.js.html">CustomEvent.js</a></li>
|
||||
<li class=""><a href="Event.js.html">Event.js</a></li>
|
||||
<li class=""><a href="EventProvider.js.html">EventProvider.js</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="module">
|
||||
<h4>Properties</h4>
|
||||
<ul class="content">
|
||||
<li><a href="#fn">fn</a>
|
||||
<!--<code><boolean|object></code>-->
|
||||
</li>
|
||||
<li><a href="#obj">obj</a>
|
||||
<!--<code><boolean|object></code>-->
|
||||
</li>
|
||||
<li><a href="#override">override</a>
|
||||
<!--<code><boolean|object></code>-->
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="module">
|
||||
<h4>Methods</h4>
|
||||
<ul class="content">
|
||||
<li><!--<code>boolean</code>-->
|
||||
<a href="#contains">contains</a>
|
||||
</li>
|
||||
<li><!--<code>void</code>-->
|
||||
<a href="#getScope">getScope</a>
|
||||
</li>
|
||||
<li><!--<code>void</code>-->
|
||||
<a href="#toString">toString</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="ft">
|
||||
<hr />
|
||||
Copyright © 2007 Yahoo! Inc. All rights reserved.
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue