Event.Subscriber.html revision 4fcbec6145d16637205990699912fb90f6a3807c
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: event Event.Subscriber (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>event&nbsp; <span class="subtitle">3.00PR1</span></h3>
<p>
<a href="/index.html">Yahoo! UI Library</a>
&gt; <a href="/module_event.html">event</a>
&gt; Event.Subscriber
</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" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>Event.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 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>Event.Subscriber</strong>
<code>
(
fn
,
obj
,
args
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>fn
&lt;Function&gt;
</code>
The wrapped function to execute
</dd>
<dd>
<code>obj
&lt;Object&gt;
</code>
An object to be passed along when the event fires
</dd>
<dd>
<code>args
&lt;Array&gt;
</code>
subscribe() additional arguments
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="">
<h4><a name="property_args">args</a>
<code>- Array</code>
</h4>
<div class="detail">
<div class="description">
Optional additional arguments supplied to subscribe(). If present,
these will be appended to the arguments supplied to fire()
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_fn">fn</a>
<code>- Function</code>
</h4>
<div class="detail">
<div class="description">
The callback that will be execute when the event fires
This is wrapped by Y.bind if obj was supplied.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_id">id</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Unique subscriber id
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_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 />
</div>
<div class="">
<h4><a name="property_wrappedFn">wrappedFn</a>
<code>- Function</code>
</h4>
<div class="detail">
<div class="description">
}
fn bound to obj with additional arguments applied via Y.bind
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="">
<h4>
<a name="method_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 &lt;Function&gt;</code>
the function to execute
</dd>
<dd>
<code>obj &lt;Object&gt;</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 />
</div>
<div class="">
<h4>
<a name="method_notify">notify</a></h4>
<div class="detail">
<code>
void
<strong>notify</strong>
(
defaultContext
,
args
)
</code>
<div class="description">
Executes the subscriber.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>defaultContext &lt;object&gt;</code>
The execution context if not overridden
by the subscriber
</dd>
<dd>
<code>args &lt;Array&gt;</code>
Arguments array for the subscriber
</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>
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>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html">anim</a></li>
<li class=""><a href="module_attribute.html">attribute</a></li>
<li class=""><a href="module_base.html">base</a></li>
<li class=""><a href="module_dd.html">dd</a></li>
<li class=""><a href="module_dd-plugin.html">dd-plugin</a></li>
<li class=""><a href="module_dump.html">dump</a></li>
<li class="selected"><a href="module_event.html">event</a></li>
<li class=""><a href="module_io.html">io</a></li>
<li class=""><a href="module_node.html">node</a></li>
<li class=""><a href="module_oop.html">oop</a></li>
<li class=""><a href="module_queue.html">queue</a></li>
<li class=""><a href="module_substitute.html">substitute</a></li>
<li class=""><a href="module_yui.html">yui</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="Do.html">Do</a></li>
<li class=""><a href="Do.AlterArgs.html">Do.AlterArgs</a></li>
<li class=""><a href="Do.AlterReturn.html">Do.AlterReturn</a></li>
<li class=""><a href="Do.Error.html">Do.Error</a></li>
<li class=""><a href="Do.Method.html">Do.Method</a></li>
<li class=""><a href="Event.html">Event</a></li>
<li class=""><a href="Event.Custom.html">Event.Custom</a></li>
<li class=""><a href="Event.Facade.html">Event.Facade</a></li>
<li class=""><a href="Event.Handle.html">Event.Handle</a></li>
<li class="selected"><a href="Event.Subscriber.html">Event.Subscriber</a></li>
<li class=""><a href="Event.Target.html">Event.Target</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="event-custom.js.html">event-custom.js</a></li>
<li class=""><a href="event-do.js.html">event-do.js</a></li>
<li class=""><a href="event-dom.js.html">event-dom.js</a></li>
<li class=""><a href="event-facade.js.html">event-facade.js</a></li>
<li class=""><a href="event-ready.js.html">event-ready.js</a></li>
<li class=""><a href="event-target.js.html">event-target.js</a></li>
<li class=""><a href="event.js.html">event.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_args">args</a>
<!--<code>&lt;Function&gt;</code>-->
</li>
<li class=""><a href="#property_fn">fn</a>
<!--<code>&lt;Function&gt;</code>-->
</li>
<li class=""><a href="#property_id">id</a>
<!--<code>&lt;Function&gt;</code>-->
</li>
<li class=""><a href="#property_obj">obj</a>
<!--<code>&lt;Function&gt;</code>-->
</li>
<li class=""><a href="#property_wrappedFn">wrappedFn</a>
<!--<code>&lt;Function&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><!--<code>boolean</code>-->
<a href="#method_contains">contains</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_notify">notify</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_toString">toString</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>