--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/cm/media/js/lib/yui/yui_3.0.0b1/api/CustomEvent.html Mon Nov 23 15:14:29 2009 +0100
@@ -0,0 +1,1447 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>API: event-custom CustomEvent (YUI Library)</title>
+
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
+ <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">
+ <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
+ <h3>event-custom <span class="subtitle">3.0.0b1</span></h3>
+ <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
+ > <a href="./module_event-custom.html" title="event-custom">event-custom</a>
+ > CustomEvent
+
+ <form onsubmit="return false">
+ <div id="propertysearch">
+ Search: <input autocomplete="off" id="searchinput" />
+ <div id="searchresults">
+
+ </div>
+ </div>
+ </form>
+ </div>
+
+ <div id="bd">
+ <div id="yui-main">
+ <div class="yui-b">
+ <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
+ <fieldset>
+ <legend>Filters</legend>
+ <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
+ <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
+ <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
+ </fieldset>
+ </form>
+
+ <h2>
+
+
+
+
+ Class <b property="yui:name">CustomEvent</b>
+ <span class="extends">
+ </span>
+
+ </h2>
+ <!-- class tree goes here -->
+
+
+
+
+ <div class="summary description" property="yui:description">
+ The CustomEvent class lets you define events for your application
+that can be subscribed to by one or more independent component.
+ </div>
+
+ <div class="section constructor details" rel="yui:constructor" resource="#constructor">
+ <h3 id="constructor">Constructor</h3>
+ <div class="content">
+ <div class="detail">
+ <strong property="yui:name">CustomEvent</strong>
+ <code>
+ (
+
+
+
+ type
+
+ ,
+ o
+ )
+ </code>
+ <div class="description">
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">type</span>
+ <<span property="yui:type">String</span>>
+ </code>
+ <span property="yui:description"> The type of event, which is passed to the callback
+when the event fires</span>
+ </dd>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">o</span>
+ <<span property="yui:type">object</span>>
+ </code>
+ <span property="yui:description"> configuration object</span>
+ </dd>
+ </dl>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div rel="yui:properties" resource="#properties">
+ <div class="section field details">
+ <h3 id="properties">Properties</h3>
+ <div class="content">
+ <div class="" rel="yui:property" resource="#property_afters">
+ <h4><a name="property_afters" property="yui:name">afters</a>
+ - <code><span property="yui:type">Subscriber{}</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ 'After' subscribers
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_broadcast">
+ <h4><a name="property_broadcast" property="yui:name">broadcast</a>
+ - <code><span property="yui:type">int</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ If 0, this event does not broadcast. If 1, the YUI instance is notified
+every time this event fires. If 2, the YUI instance and the YUI global
+(if event is enabled on the global) are notified every time this event
+fires.
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_bubbles">
+ <h4><a name="property_bubbles" property="yui:name">bubbles</a>
+ - <code><span property="yui:type">boolean</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Specifies whether or not a subscriber can stop the event propagation
+via stopPropagation(), stopImmediatePropagation(), or halt()
+ </div>
+ </div>
+
+
+ <div class="default" property="yui:defaultValue">
+ Default Value: true
+ </div>
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_context">
+ <h4><a name="property_context" property="yui:name">context</a>
+ - <code><span property="yui:type">object</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ The context the the event will fire from by default. Defaults to the YUI
+instance.
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_defaultFn">
+ <h4><a name="property_defaultFn" property="yui:name">defaultFn</a>
+ - <code><span property="yui:type">Function</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ The default function to execute after event listeners
+have fire, but only if the default action was not
+prevented.
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_emitFacade">
+ <h4><a name="property_emitFacade" property="yui:name">emitFacade</a>
+ - <code><span property="yui:type">boolean</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ If set to true, the custom event will deliver an EventFacade object
+that is similar to a DOM event object.
+ </div>
+ </div>
+
+
+ <div class="default" property="yui:defaultValue">
+ Default Value: false
+ </div>
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_fired">
+ <h4><a name="property_fired" property="yui:name">fired</a>
+ - <code><span property="yui:type">boolean</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ This event has fired if true
+ </div>
+ </div>
+
+
+ <div class="default" property="yui:defaultValue">
+ Default Value: false;
+ </div>
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_fireOnce">
+ <h4><a name="property_fireOnce" property="yui:name">fireOnce</a>
+ - <code><span property="yui:type">boolean</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ This event should only fire one time if true, and if
+it has fired, any new subscribers should be notified
+immediately.
+ </div>
+ </div>
+
+
+ <div class="default" property="yui:defaultValue">
+ Default Value: false;
+ </div>
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_host">
+ <h4><a name="property_host" property="yui:name">host</a>
+ - <code><span property="yui:type">EventTarget</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Specifies the host for this custom event. This is used
+to enable event bubbling
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_preventable">
+ <h4><a name="property_preventable" property="yui:name">preventable</a>
+ - <code><span property="yui:type">boolean</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Specifies whether or not this event's default function
+can be cancelled by a subscriber by executing preventDefault()
+on the event facade
+ </div>
+ </div>
+
+
+ <div class="default" property="yui:defaultValue">
+ Default Value: true
+ </div>
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_prevented">
+ <h4><a name="property_prevented" property="yui:name">prevented</a>
+ - <code><span property="yui:type">int</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Flag for preventDefault that is modified during fire().
+if it is not 0, the default behavior for this event
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_preventedFn">
+ <h4><a name="property_preventedFn" property="yui:name">preventedFn</a>
+ - <code><span property="yui:type">Function</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ The function to execute if a subscriber calls
+preventDefault
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_signature">
+ <h4><a name="property_signature" property="yui:name">signature</a>
+ - <code><span property="yui:type">int</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Supports multiple options for listener signatures in order to
+port YUI 2 apps.
+ </div>
+ </div>
+
+
+ <div class="default" property="yui:defaultValue">
+ Default Value: 9
+ </div>
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_silent">
+ <h4><a name="property_silent" property="yui:name">silent</a>
+ - <code><span property="yui:type">boolean</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ By default all custom events are logged in the debug build, set silent
+to true to disable debug outpu for this event.
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_stopped">
+ <h4><a name="property_stopped" property="yui:name">stopped</a>
+ - <code><span property="yui:type">int</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Flag for stopPropagation that is modified during fire()
+1 means to stop propagation to bubble targets. 2 means
+to also stop additional subscribers on this target.
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_stoppedFn">
+ <h4><a name="property_stoppedFn" property="yui:name">stoppedFn</a>
+ - <code><span property="yui:type">Function</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ The function to execute if a subscriber calls
+stopPropagation or stopImmediatePropagation
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_subscribers">
+ <h4><a name="property_subscribers" property="yui:name">subscribers</a>
+ - <code><span property="yui:type">Subscriber{}</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ The subscribers to this event
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_type">
+ <h4><a name="property_type" property="yui:name">type</a>
+ - <code><span property="yui:type">string</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ The type of event, returned to subscribers when the event fires
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ </div>
+ </div>
+
+ </div>
+
+ <div rel="yui:methods" resource="#methods">
+ <div class="section method details">
+ <h3 id="methods">Methods</h3>
+ <div class="content">
+ <div class="private" rel="yui:method" resource="#method__delete">
+ <h4>
+ <a name="method__delete">_delete</a></h4>
+ <div class="detail" >
+ <code>
+ private
+
+
+ void
+ <strong property="yui:name">_delete</strong>
+ (
+
+
+ subscriber
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">subscriber</span>
+ <<span property="yui:type">object</span>>
+ </code>
+ <span property="yui:description"> object</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="private" rel="yui:method" resource="#method__notify">
+ <h4>
+ <a name="method__notify">_notify</a></h4>
+ <div class="detail" >
+ <code>
+ private
+
+
+ void
+ <strong property="yui:name">_notify</strong>
+ (
+
+
+ s
+
+
+ ,
+ args
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Notify a single subscriber
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">s</span>
+ <<span property="yui:type">Subscriber</span>>
+ </code>
+ <span property="yui:description"> the subscriber</span>
+ </dd>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">args</span>
+ <<span property="yui:type">Array</span>>
+ </code>
+ <span property="yui:description"> the arguments array to apply to the listener</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_after">
+ <h4>
+ <a name="method_after">after</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ EventHandle|EventTarget
+ <strong property="yui:name">after</strong>
+ (
+
+
+ fn
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Listen for this event after the normal subscribers have been notified and
+the default behavior has been applied. If a normal subscriber prevents the
+default behavior, it also prevents after listeners from firing.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">fn</span>
+ <<span property="yui:type">Function</span>>
+ </code>
+ <span property="yui:description"> The function to execute</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ EventHandle|EventTarget
+ </code></dt>
+ <dd property="yui:returnInfo">unsubscribe handle or a
+chainable event target depending on the 'chain' config.</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_applyConfig">
+ <h4>
+ <a name="method_applyConfig">applyConfig</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ void
+ <strong property="yui:name">applyConfig</strong>
+ (
+
+
+ o
+
+
+ ,
+ force
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Apply configuration properties. Only applies the CONFIG whitelist
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">o</span>
+ <<span property="yui:type">object</span>>
+ </code>
+ <span property="yui:description"> hash of properties to apply</span>
+ </dd>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">force</span>
+ <<span property="yui:type">boolean</span>>
+ </code>
+ <span property="yui:description"> if true, properties that exist on the event
+will be overwritten.</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_detach">
+ <h4>
+ <a name="method_detach">detach</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ boolean|EventTarget
+ <strong property="yui:name">detach</strong>
+ (
+
+
+ fn
+
+
+ ,
+ context
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Detach listeners.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">fn</span>
+ <<span property="yui:type">Function</span>>
+ </code>
+ <span property="yui:description"> The subscribed function to remove, if not supplied
+all will be removed</span>
+ </dd>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">context</span>
+ <<span property="yui:type">Object</span>>
+ </code>
+ <span property="yui:description"> The context object passed to subscribe.</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ boolean|EventTarget
+ </code></dt>
+ <dd property="yui:returnInfo">returns a chainable event target
+or a boolean for legacy detach support.</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_detachAll">
+ <h4>
+ <a name="method_detachAll">detachAll</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ int
+ <strong property="yui:name">detachAll</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Removes all listeners
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ int
+ </code></dt>
+ <dd property="yui:returnInfo">The number of listeners unsubscribed</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_fire">
+ <h4>
+ <a name="method_fire">fire</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ boolean
+ <strong property="yui:name">fire</strong>
+ (
+
+
+ arguments
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Notifies the subscribers. The callback functions will be executed
+from the context specified when the event was created, and with the
+following parameters:
+<ul>
+<li>The type of event</li>
+<li>All of the arguments fire() was executed with as an array</li>
+<li>The custom object (if any) that was passed into the subscribe()
+method</li>
+</ul>
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">arguments</span>
+ <<span property="yui:type">Object*</span>>
+ </code>
+ <span property="yui:description"> an arbitrary set of parameters to pass to
+the handler.</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ boolean
+ </code></dt>
+ <dd property="yui:returnInfo">false if one of the subscribers returned false,
+true otherwise</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_halt">
+ <h4>
+ <a name="method_halt">halt</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ void
+ <strong property="yui:name">halt</strong>
+ (
+
+
+ immediate
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Stops the event propagation and prevents the default
+event behavior.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">immediate</span>
+ <<span property="yui:type">boolean</span>>
+ </code>
+ <span property="yui:description"> if true additional listeners
+on the current target will not be executed</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_log">
+ <h4>
+ <a name="method_log">log</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ void
+ <strong property="yui:name">log</strong>
+ (
+
+
+ msg
+
+
+ ,
+ cat
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Logger abstraction to centralize the application of the silent flag
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">msg</span>
+ <<span property="yui:type">string</span>>
+ </code>
+ <span property="yui:description"> message to log</span>
+ </dd>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">cat</span>
+ <<span property="yui:type">string</span>>
+ </code>
+ <span property="yui:description"> log category</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_on">
+ <h4>
+ <a name="method_on">on</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ EventHandle|EventTarget
+ <strong property="yui:name">on</strong>
+ (
+
+
+ fn
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Listen for this event
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">fn</span>
+ <<span property="yui:type">Function</span>>
+ </code>
+ <span property="yui:description"> The function to execute</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ EventHandle|EventTarget
+ </code></dt>
+ <dd property="yui:returnInfo">unsubscribe handle or a
+chainable event target depending on the 'chain' config.</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_preventDefault">
+ <h4>
+ <a name="method_preventDefault">preventDefault</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ void
+ <strong property="yui:name">preventDefault</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Prevents the execution of this event's defaultFn
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_stopImmediatePropagation">
+ <h4>
+ <a name="method_stopImmediatePropagation">stopImmediatePropagation</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ void
+ <strong property="yui:name">stopImmediatePropagation</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Stops propagation to bubble targets, and prevents any remaining
+subscribers on the current target from executing.
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_stopPropagation">
+ <h4>
+ <a name="method_stopPropagation">stopPropagation</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ void
+ <strong property="yui:name">stopPropagation</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Stop propagation to bubble targets
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class=" deprecated" rel="yui:method" resource="#method_subscribe">
+ <h4>
+ <a name="method_subscribe">subscribe</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ EventHandle|EventTarget
+ <strong property="yui:name">subscribe</strong>
+ (
+
+
+ fn
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Listen for this event
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">fn</span>
+ <<span property="yui:type">Function</span>>
+ </code>
+ <span property="yui:description"> The function to execute</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ EventHandle|EventTarget
+ </code></dt>
+ <dd property="yui:returnInfo">unsubscribe handle or a
+chainable event target depending on the 'chain' config.</dd>
+ </dl>
+
+
+
+ <div class="deprecated">
+ <strong>Deprecated</strong> use on
+ </div>
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_toString">
+ <h4>
+ <a name="method_toString">toString</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ void
+ <strong property="yui:name">toString</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ void
+ </code></dt>
+ <dd property="yui:returnInfo"></dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class=" deprecated" rel="yui:method" resource="#method_unsubscribe">
+ <h4>
+ <a name="method_unsubscribe">unsubscribe</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ boolean|EventTarget
+ <strong property="yui:name">unsubscribe</strong>
+ (
+
+
+ fn
+
+
+ ,
+ context
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Detach listeners.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">fn</span>
+ <<span property="yui:type">Function</span>>
+ </code>
+ <span property="yui:description"> The subscribed function to remove, if not supplied
+all will be removed</span>
+ </dd>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">context</span>
+ <<span property="yui:type">Object</span>>
+ </code>
+ <span property="yui:description"> The context object passed to subscribe.</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ boolean|EventTarget
+ </code></dt>
+ <dd property="yui:returnInfo">returns a chainable event target
+or a boolean for legacy detach support.</dd>
+ </dl>
+
+
+
+ <div class="deprecated">
+ <strong>Deprecated</strong> use detach
+ </div>
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class=" deprecated" rel="yui:method" resource="#method_unsubscribeAll">
+ <h4>
+ <a name="method_unsubscribeAll">unsubscribeAll</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ int
+ <strong property="yui:name">unsubscribeAll</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Removes all listeners
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ int
+ </code></dt>
+ <dd property="yui:returnInfo">The number of listeners unsubscribed</dd>
+ </dl>
+
+
+
+ <div class="deprecated">
+ <strong>Deprecated</strong> use detachAll
+ </div>
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ </div>
+ </div>
+
+ </div>
+
+ <div rel="yui:events" resource="#events">
+
+
+ </div>
+
+ <div rel="yui:attributes" resource="#configattributes">
+
+ </div>
+
+ </div>
+ </div>
+ <div class="yui-b">
+ <div class="nav">
+
+ <div id="moduleList" class="module">
+ <h4>Modules</h4>
+ <ul class="content">
+ <li class=""><a href="module_anim.html" title="anim">anim</a></li>
+ <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
+ <li class=""><a href="module_base.html" title="base">base</a></li>
+ <li class=""><a href="module_cache.html" title="cache">cache</a></li>
+ <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
+ <li class=""><a href="module_collection.html" title="collection">collection</a></li>
+ <li class=""><a href="module_console.html" title="console">console</a></li>
+ <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
+ <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
+ <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
+ <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
+ <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
+ <li class=""><a href="module_dd.html" title="dd">dd</a></li>
+ <li class=""><a href="module_dom.html" title="dom">dom</a></li>
+ <li class=""><a href="module_dump.html" title="dump">dump</a></li>
+ <li class=""><a href="module_event.html" title="event">event</a></li>
+ <li class="selected"><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
+ <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
+ <li class=""><a href="module_history.html" title="history">history</a></li>
+ <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
+ <li class=""><a href="module_io.html" title="io">io</a></li>
+ <li class=""><a href="module_json.html" title="json">json</a></li>
+ <li class=""><a href="module_node.html" title="node">node</a></li>
+ <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
+ <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
+ <li class=""><a href="module_oop.html" title="oop">oop</a></li>
+ <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
+ <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
+ <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
+ <li class=""><a href="module_queue.html" title="queue">queue</a></li>
+ <li class=""><a href="module_slider.html" title="slider">slider</a></li>
+ <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
+ <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
+ <li class=""><a href="module_test.html" title="test">test</a></li>
+ <li class=""><a href="module_widget.html" title="widget">widget</a></li>
+ <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
+ <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
+ <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
+ <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
+ <li class=""><a href="module_yui.html" title="yui">yui</a></li>
+ </ul>
+ </div>
+
+ <div id="classList" class="module">
+ <h4>Classes</h4>
+ <ul class="content">
+ <li class="selected"><a href="CustomEvent.html" title="CustomEvent">CustomEvent</a></li>
+ <li class=""><a href="Do.html" title="Do">Do</a></li>
+ <li class=""><a href="Do.AlterArgs.html" title="Do.AlterArgs">Do.AlterArgs</a></li>
+ <li class=""><a href="Do.AlterReturn.html" title="Do.AlterReturn">Do.AlterReturn</a></li>
+ <li class=""><a href="Do.Error.html" title="Do.Error">Do.Error</a></li>
+ <li class=""><a href="Do.Halt.html" title="Do.Halt">Do.Halt</a></li>
+ <li class=""><a href="Do.Method.html" title="Do.Method">Do.Method</a></li>
+ <li class=""><a href="Do.Prevent.html" title="Do.Prevent">Do.Prevent</a></li>
+ <li class=""><a href="EventFacade.html" title="EventFacade">EventFacade</a></li>
+ <li class=""><a href="EventHandle.html" title="EventHandle">EventHandle</a></li>
+ <li class=""><a href="EventTarget.html" title="EventTarget">EventTarget</a></li>
+ <li class=""><a href="Subscriber.html" title="Subscriber">Subscriber</a></li>
+ </ul>
+ </div>
+
+ <div id="fileList" class="module">
+ <h4>Files</h4>
+ <ul class="content">
+ <li class=""><a href="event-custom.js.html" title="event-custom.js">event-custom.js</a></li>
+ <li class=""><a href="event-do.js.html" title="event-do.js">event-do.js</a></li>
+ <li class=""><a href="event-facade.js.html" title="event-facade.js">event-facade.js</a></li>
+ <li class=""><a href="event-target.js.html" title="event-target.js">event-target.js</a></li>
+ <li class=""><a href="event.js.html" title="event.js">event.js</a></li>
+ </ul>
+ </div>
+
+ <div id="propertyList" class="module">
+ <h4>Properties</h4>
+ <ul class="content">
+ <li class=""><a href="#property_afters" title="afters">afters</a></li>
+ <li class=""><a href="#property_broadcast" title="broadcast">broadcast</a></li>
+ <li class=""><a href="#property_bubbles" title="bubbles">bubbles</a></li>
+ <li class=""><a href="#property_context" title="context">context</a></li>
+ <li class=""><a href="#property_defaultFn" title="defaultFn">defaultFn</a></li>
+ <li class=""><a href="#property_emitFacade" title="emitFacade">emitFacade</a></li>
+ <li class=""><a href="#property_fired" title="fired">fired</a></li>
+ <li class=""><a href="#property_fireOnce" title="fireOnce">fireOnce</a></li>
+ <li class=""><a href="#property_host" title="host">host</a></li>
+ <li class=""><a href="#property_preventable" title="preventable">preventable</a></li>
+ <li class=""><a href="#property_prevented" title="prevented">prevented</a></li>
+ <li class=""><a href="#property_preventedFn" title="preventedFn">preventedFn</a></li>
+ <li class=""><a href="#property_signature" title="signature">signature</a></li>
+ <li class=""><a href="#property_silent" title="silent">silent</a></li>
+ <li class=""><a href="#property_stopped" title="stopped">stopped</a></li>
+ <li class=""><a href="#property_stoppedFn" title="stoppedFn">stoppedFn</a></li>
+ <li class=""><a href="#property_subscribers" title="subscribers">subscribers</a></li>
+ <li class=""><a href="#property_type" title="type">type</a></li>
+ </ul>
+ </div>
+
+ <div id="methodsList" class="module">
+ <h4>Methods</h4>
+ <ul class="content">
+ <li class="private"><a href="#method__delete" title="_delete">_delete</a></li>
+ <li class="private"><a href="#method__notify" title="_notify">_notify</a></li>
+ <li class=""><a href="#method_after" title="after">after</a></li>
+ <li class=""><a href="#method_applyConfig" title="applyConfig">applyConfig</a></li>
+ <li class=""><a href="#method_detach" title="detach">detach</a></li>
+ <li class=""><a href="#method_detachAll" title="detachAll">detachAll</a></li>
+ <li class=""><a href="#method_fire" title="fire">fire</a></li>
+ <li class=""><a href="#method_halt" title="halt">halt</a></li>
+ <li class=""><a href="#method_log" title="log">log</a></li>
+ <li class=""><a href="#method_on" title="on">on</a></li>
+ <li class=""><a href="#method_preventDefault" title="preventDefault">preventDefault</a></li>
+ <li class=""><a href="#method_stopImmediatePropagation" title="stopImmediatePropagation">stopImmediatePropagation</a></li>
+ <li class=""><a href="#method_stopPropagation" title="stopPropagation">stopPropagation</a></li>
+ <li class=" deprecated"><a href="#method_subscribe" title="subscribe">subscribe</a></li>
+ <li class=""><a href="#method_toString" title="toString">toString</a></li>
+ <li class=" deprecated"><a href="#method_unsubscribe" title="unsubscribe">unsubscribe</a></li>
+ <li class=" deprecated"><a href="#method_unsubscribeAll" title="unsubscribeAll">unsubscribeAll</a></li>
+ </ul>
+ </div>
+
+
+
+ </div>
+ </div>
+ </div>
+ <div id="ft">
+ <hr />
+ Copyright © 2009 Yahoo! Inc. All rights reserved.
+ </div>
+</div>
+<script type="text/javascript">
+ ALL_YUI_PROPS = [{"access": "", "host": "EventTarget", "name": "addTarget", "url": "EventTarget.html#method_addTarget", "type": "method"}, {"access": "", "host": "EventTarget", "name": "after", "url": "EventTarget.html#method_after", "type": "method"}, {"access": "", "host": "Do", "name": "after", "url": "Do.html#method_after", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "after", "url": "CustomEvent.html#method_after", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "afters", "url": "CustomEvent.html#property_afters", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "applyConfig", "url": "CustomEvent.html#method_applyConfig", "type": "method"}, {"access": "", "host": "EventTarget", "name": "before", "url": "EventTarget.html#method_before", "type": "method"}, {"access": "", "host": "Do", "name": "before", "url": "Do.html#method_before", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "broadcast", "url": "CustomEvent.html#property_broadcast", "type": "property"}, {"access": "", "host": "EventTarget", "name": "bubble", "url": "EventTarget.html#method_bubble", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "bubbles", "url": "CustomEvent.html#property_bubbles", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "context", "url": "CustomEvent.html#property_context", "type": "property"}, {"access": "", "host": "EventFacade", "name": "currentTarget", "url": "EventFacade.html#property_currentTarget", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "defaultFn", "url": "CustomEvent.html#property_defaultFn", "type": "property"}, {"access": "", "host": "Do.Method", "name": "delete", "url": "Do.Method.html#method_delete", "type": "method"}, {"access": "private", "host": "CustomEvent", "name": "_delete", "url": "CustomEvent.html#method__delete", "type": "method"}, {"access": "", "host": "EventTarget", "name": "detach", "url": "EventTarget.html#method_detach", "type": "method"}, {"access": "", "host": "Do", "name": "detach", "url": "Do.html#method_detach", "type": "method"}, {"access": "", "host": "EventHandle", "name": "detach", "url": "EventHandle.html#method_detach", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "detach", "url": "CustomEvent.html#method_detach", "type": "method"}, {"access": "", "host": "EventTarget", "name": "detachAll", "url": "EventTarget.html#method_detachAll", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "detachAll", "url": "CustomEvent.html#method_detachAll", "type": "method"}, {"access": "", "host": "EventFacade", "name": "details", "url": "EventFacade.html#property_details", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "emitFacade", "url": "CustomEvent.html#property_emitFacade", "type": "property"}, {"access": "", "host": "EventHandle", "name": "evt", "url": "EventHandle.html#property_evt", "type": "property"}, {"access": "", "host": "Do.Method", "name": "exec", "url": "Do.Method.html#method_exec", "type": "method"}, {"access": "", "host": "EventTarget", "name": "fire", "url": "EventTarget.html#method_fire", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "fire", "url": "CustomEvent.html#method_fire", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "fired", "url": "CustomEvent.html#property_fired", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "fireOnce", "url": "CustomEvent.html#property_fireOnce", "type": "property"}, {"access": "", "host": "EventTarget", "name": "getEvent", "url": "EventTarget.html#method_getEvent", "type": "method"}, {"access": "private", "host": "EventTarget", "name": "_getType", "url": "EventTarget.html#method__getType", "type": "method"}, {"access": "", "host": "EventFacade", "name": "halt", "url": "EventFacade.html#method_halt", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "halt", "url": "CustomEvent.html#method_halt", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "host", "url": "CustomEvent.html#property_host", "type": "property"}, {"access": "private", "host": "Do", "name": "_inject", "url": "Do.html#method__inject", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "log", "url": "CustomEvent.html#method_log", "type": "method"}, {"access": "private", "host": "CustomEvent", "name": "_notify", "url": "CustomEvent.html#method__notify", "type": "method"}, {"access": "", "host": "Do", "name": "objs", "url": "Do.html#property_objs", "type": "property"}, {"access": "", "host": "EventTarget", "name": "on", "url": "EventTarget.html#method_on", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "on", "url": "CustomEvent.html#method_on", "type": "method"}, {"access": "private", "host": "EventTarget", "name": "_parseType", "url": "EventTarget.html#method__parseType", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "preventable", "url": "CustomEvent.html#property_preventable", "type": "property"}, {"access": "", "host": "EventFacade", "name": "preventDefault", "url": "EventFacade.html#method_preventDefault", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "preventDefault", "url": "CustomEvent.html#method_preventDefault", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "prevented", "url": "CustomEvent.html#property_prevented", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "preventedFn", "url": "CustomEvent.html#property_preventedFn", "type": "property"}, {"access": "", "host": "EventTarget", "name": "publish", "url": "EventTarget.html#method_publish", "type": "method"}, {"access": "", "host": "Do.Method", "name": "register", "url": "Do.Method.html#method_register", "type": "method"}, {"access": "", "host": "EventFacade", "name": "relatedTarget", "url": "EventFacade.html#property_relatedTarget", "type": "property"}, {"access": "", "host": "EventTarget", "name": "removeTarget", "url": "EventTarget.html#method_removeTarget", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "signature", "url": "CustomEvent.html#property_signature", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "silent", "url": "CustomEvent.html#property_silent", "type": "property"}, {"access": "", "host": "EventFacade", "name": "stopImmediatePropagation", "url": "EventFacade.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopImmediatePropagation", "url": "CustomEvent.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopped", "url": "CustomEvent.html#property_stopped", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "stoppedFn", "url": "CustomEvent.html#property_stoppedFn", "type": "property"}, {"access": "", "host": "EventFacade", "name": "stopPropagation", "url": "EventFacade.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopPropagation", "url": "CustomEvent.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "EventHandle", "name": "sub", "url": "EventHandle.html#property_sub", "type": "property"}, {"access": "", "host": "EventTarget", "name": "subscribe", "url": "EventTarget.html#method_subscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "subscribe", "url": "CustomEvent.html#method_subscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "subscribers", "url": "CustomEvent.html#property_subscribers", "type": "property"}, {"access": "", "host": "EventFacade", "name": "target", "url": "EventFacade.html#property_target", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "toString", "url": "CustomEvent.html#method_toString", "type": "method"}, {"access": "", "host": "EventFacade", "name": "type", "url": "EventFacade.html#property_type", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "type", "url": "CustomEvent.html#property_type", "type": "property"}, {"access": "", "host": "EventTarget", "name": "unsubscribe", "url": "EventTarget.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "unsubscribe", "url": "CustomEvent.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "EventTarget", "name": "unsubscribeAll", "url": "EventTarget.html#method_unsubscribeAll", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "unsubscribeAll", "url": "CustomEvent.html#method_unsubscribeAll", "type": "method"}];
+</script>
+</body>
+</html>