hazza/Phraseanet
1
0
Fork 0
mirror of https://github.com/alchemy-fr/Phraseanet.git synced 2025-10-13 21:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
901b42cce5139a61fafb9a981a68715b5dce7c04
Phraseanet/www/include/jslibs/yui2.8/docs/YAHOO.util.Event.html
Alchemy 339d23c06d initial import
2011-02-16 16:09:48 +01:00

3534 lines
212 KiB
HTML
Raw Blame History

<!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 YAHOO.util.Event (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 Utility&nbsp; <span class="subtitle">2.8.2r1</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
&gt; <a href="./module_event.html" title="event">event</a>
&gt; YAHOO.util.Event
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
&nbsp;
</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>
<code>static</code>
Class <b property="yui:name">YAHOO.util.Event</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
The event utility provides functions to add and remove event listeners,
event cleansing. It also tries to automatically remove listeners it
registers during the unload event.
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private" rel="yui:property" resource="#property__dri">
<h4><a name="property__dri" property="yui:name">_dri</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
document readystate poll handle
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__interval">
<h4><a name="property__interval" property="yui:name">_interval</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
poll handle
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__specialTypes">
<h4><a name="property__specialTypes" property="yui:name">_specialTypes</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Map of special event types
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_ADJ_SCOPE">
<h4><a name="property_ADJ_SCOPE" property="yui:name">ADJ_SCOPE</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Adjusted context, either the element we are registering the event
on or the custom object passed in by the listener, int constant
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_CAPTURE">
<h4><a name="property_CAPTURE" property="yui:name">CAPTURE</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The original capture parameter passed into addListener
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_counter">
<h4><a name="property_counter" property="yui:name">counter</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Counter for auto id generation
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_DOMReady">
<h4><a name="property_DOMReady" property="yui:name">DOMReady</a>
- <code>static <span property="yui:type">boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
True when the document is initially usable
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_EL">
<h4><a name="property_EL" property="yui:name">EL</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Element to bind, int constant
</div>
</div>
<hr />
</div>
<div class="private deprecated" rel="yui:property" resource="#property_elCache
DOM element cache">
<h4><a name="property_elCache
DOM element cache" property="yui:name">elCache
DOM element cache</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<div class="deprecated" property="yui:deprecated">
<strong>Deprecated:</strong> Elements are not cached due to issues that arise when
elements are removed and re-added
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_FN">
<h4><a name="property_FN" property="yui:name">FN</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Function to execute, int constant
</div>
</div>
<hr />
</div>
<div class="private deprecated" rel="yui:property" resource="#property_isIE">
<h4><a name="property_isIE" property="yui:name">isIE</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
IE detection
</div>
</div>
<div class="deprecated" property="yui:deprecated">
<strong>Deprecated:</strong> use YAHOO.env.ua.ie
</div>
<hr />
</div>
<div class="private deprecated" rel="yui:property" resource="#property_isSafari">
<h4><a name="property_isSafari" property="yui:name">isSafari</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Safari detection
</div>
</div>
<div class="deprecated" property="yui:deprecated">
<strong>Deprecated:</strong> use YAHOO.env.ua.webkit
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_lastError">
<h4><a name="property_lastError" property="yui:name">lastError</a>
- <code>static <span property="yui:type">Error</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
addListener/removeListener can throw errors in unexpected scenarios.
These errors are suppressed, the method returns false, and this property
is set
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_listeners">
<h4><a name="property_listeners" property="yui:name">listeners</a>
- <code>private static <span property="yui:type">array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Cache of wrapped listeners
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_loadComplete">
<h4><a name="property_loadComplete" property="yui:name">loadComplete</a>
- <code>private static <span property="yui:type">boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
True after the onload event has fired
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_OBJ">
<h4><a name="property_OBJ" property="yui:name">OBJ</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Object passed in by the user that will be returned as a
parameter to the callback, int constant. Specific to
unload listeners
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_onAvailStack">
<h4><a name="property_onAvailStack" property="yui:name">onAvailStack</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
onAvailable listeners
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_OVERRIDE">
<h4><a name="property_OVERRIDE" property="yui:name">OVERRIDE</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The original context parameter passed into addListener
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_POLL_INTERVAL">
<h4><a name="property_POLL_INTERVAL" property="yui:name">POLL_INTERVAL</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The poll interval in milliseconds
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_POLL_RETRYS">
<h4><a name="property_POLL_RETRYS" property="yui:name">POLL_RETRYS</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The number of times we should look for elements that are not
in the DOM at the time the event is requested after the document
has been loaded. The default is 500@amp;40 ms, so it will poll
for 20 seconds or until all outstanding handlers are bound
(whichever comes first).
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_retryCount">
<h4><a name="property_retryCount" property="yui:name">retryCount</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The number of times to poll after window.onload. This number is
increased if additional late-bound handlers are requested after
the page load.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_throwErrors">
<h4><a name="property_throwErrors" property="yui:name">throwErrors</a>
- <code><span property="yui:type">boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Errors thrown by subscribers of custom events are caught
and the error message is written to the debug console. If
this property is set to true, it will also re-throw the
error.
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: false
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_TYPE">
<h4><a name="property_TYPE" property="yui:name">TYPE</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Type of event, int constant
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_unloadListeners">
<h4><a name="property_unloadListeners" property="yui:name">unloadListeners</a>
- <code>private static <span property="yui:type">array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
User-defined unload function that will be fired before all events
are detached
</div>
</div>
<hr />
</div>
<div class="private deprecated" rel="yui:property" resource="#property_webkit">
<h4><a name="property_webkit" property="yui:name">webkit</a>
- <code>private static <span property="yui:type">string</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
webkit version
</div>
</div>
<div class="deprecated" property="yui:deprecated">
<strong>Deprecated:</strong> use YAHOO.env.ua.webkit
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_webkitKeymap">
<h4><a name="property_webkitKeymap" property="yui:name">webkitKeymap</a>
- <code>private static final <span property="yui:type">{int: int}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Normalized keycodes for webkit/safari
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_WFN">
<h4><a name="property_WFN" property="yui:name">WFN</a>
- <code>static final <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Function wrapped for context correction and cleanup, int constant
</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__addListener">
<h4>
<a name="method__addListener">_addListener</a></h4>
<div class="detail" >
<code>
private
static
Boolean
<strong property="yui:name">_addListener</strong>
(
el
,
sType
,
fn
,
obj
,
overrideContext
,
capture
)
</code>
<div class="description" property="yui:description">
Appends an event handler
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to assign the
listener to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The type of event to append</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method the event invokes</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> An arbitrary object that will be
passed as a parameter to the handler</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">Boolean|object</span>&gt;
</code>
<span property="yui:description"> If true, the obj passed in becomes
the execution context of the listener. If an
object, this object becomes the execution
context.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">capture</span>
&lt;<span property="yui:type">boolen</span>&gt;
</code>
<span property="yui:description"> capture or bubble phase</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">True if the action was successful or defered,
false if one or more of the elements
could not have the listener attached,
or if the operation throws an exception.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__createDelegate">
<h4>
<a name="method__createDelegate">_createDelegate</a></h4>
<div class="detail" >
<code>
private
static
Function
<strong property="yui:name">_createDelegate</strong>
(
fn
,
filter
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Creates a delegate function used to call event listeners specified
via the <code>YAHOO.util.Event.delegate</code> method.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method (event listener) to call.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">filter</span>
&lt;<span property="yui:type">Function|string</span>&gt;
</code>
<span property="yui:description"> Function or CSS selector used to
determine for what element(s) the event listener should be called.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> An arbitrary object that will be
passed as a parameter to the listener.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">Boolean|object</span>&gt;
</code>
<span property="yui:description"> If true, the value of the
obj parameter becomes the execution context
of the listener. If an object, this object
becomes the execution context.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Function
</code></dt>
<dd property="yui:returnInfo">Function that will call the event listener
specified by the <code>YAHOO.util.Event.delegate</code> method.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__createMouseDelegate">
<h4>
<a name="method__createMouseDelegate">_createMouseDelegate</a></h4>
<div class="detail" >
<code>
private
static
Function
<strong property="yui:name">_createMouseDelegate</strong>
(
fn
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Creates a delegate function used to call mouseover and mouseleave
event listeners specified via the
<code>YAHOO.util.Event.addListener</code>
or <code>YAHOO.util.Event.on</code> method.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method (event listener) to call</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> An arbitrary object that will be
passed as a parameter to the listener</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">Boolean|object</span>&gt;
</code>
<span property="yui:description"> If true, the value of the
obj parameter becomes the execution context
of the listener. If an object, this object
becomes the execution context.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Function
</code></dt>
<dd property="yui:returnInfo">Function that will call the event listener
specified by either the <code>YAHOO.util.Event.addListener</code>
or <code>YAHOO.util.Event.on</code> method.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__getCacheIndex">
<h4>
<a name="method__getCacheIndex">_getCacheIndex</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_getCacheIndex</strong>
(
)
</code>
<div class="description" property="yui:description">
Locating the saved event handler data by function ref
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__getScroll">
<h4>
<a name="method__getScroll">_getScroll</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_getScroll</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns the scrollTop and scrollLeft. Used to calculate the
pageX and pageY in Internet Explorer
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__getScrollLeft">
<h4>
<a name="method__getScrollLeft">_getScrollLeft</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_getScrollLeft</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns scrollLeft
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__getScrollTop">
<h4>
<a name="method__getScrollTop">_getScrollTop</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_getScrollTop</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns scrollTop
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__getType">
<h4>
<a name="method__getType">_getType</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_getType</strong>
(
sType
)
</code>
<div class="description" property="yui:description">
Checks to see if the type requested is a special type
(as defined by the _specialTypes hash), and (if so) returns
the special type name.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The type to look up</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__isValidCollection">
<h4>
<a name="method__isValidCollection">_isValidCollection</a></h4>
<div class="detail" >
<code>
private
static
boolean
<strong property="yui:name">_isValidCollection</strong>
(
o
)
</code>
<div class="description" property="yui:description">
We want to be able to use getElementsByTagName as a collection
to attach a group of events to. Unfortunately, different
browsers return different types of collections. This function
tests to determine if the object is array-like. It will also
fail if the object is an array, but is empty.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
&lt;<span property="yui:type">object</span>&gt;
</code>
<span property="yui:description"> the object to test</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
boolean
</code></dt>
<dd property="yui:returnInfo">true if the object is array-like and populated</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__load">
<h4>
<a name="method__load">_load</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_load</strong>
(
)
</code>
<div class="description" property="yui:description">
hook up any deferred listeners
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__ready">
<h4>
<a name="method__ready">_ready</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_ready</strong>
(
)
</code>
<div class="description" property="yui:description">
Fires the DOMReady event listeners the first time the document is
usable.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__simpleAdd">
<h4>
<a name="method__simpleAdd">_simpleAdd</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_simpleAdd</strong>
(
el
,
sType
,
fn
,
capture
)
</code>
<div class="description" property="yui:description">
Adds a DOM event directly without the caching, cleanup, context adj, etc
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> the element to bind the handler to</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">string</span>&gt;
</code>
<span property="yui:description"> the type of event handler</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">function</span>&gt;
</code>
<span property="yui:description"> the callback to invoke</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">capture</span>
&lt;<span property="yui:type">boolen</span>&gt;
</code>
<span property="yui:description"> capture or bubble phase</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__simpleRemove">
<h4>
<a name="method__simpleRemove">_simpleRemove</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_simpleRemove</strong>
(
el
,
sType
,
fn
,
capture
)
</code>
<div class="description" property="yui:description">
Basic remove listener
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> the element to bind the handler to</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">string</span>&gt;
</code>
<span property="yui:description"> the type of event handler</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">function</span>&gt;
</code>
<span property="yui:description"> the callback to invoke</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">capture</span>
&lt;<span property="yui:type">boolen</span>&gt;
</code>
<span property="yui:description"> capture or bubble phase</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__tryPreloadAttach">
<h4>
<a name="method__tryPreloadAttach">_tryPreloadAttach</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_tryPreloadAttach</strong>
(
)
</code>
<div class="description" property="yui:description">
Polling function that runs before the onload event fires,
attempting to attach to DOM Nodes as soon as they are
available
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__unload">
<h4>
<a name="method__unload">_unload</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_unload</strong>
(
)
</code>
<div class="description" property="yui:description">
Removes all listeners registered by pe.event. Called
automatically during the unload event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:method" resource="#method_addBlurListener">
<h4>
<a name="method_addBlurListener">addBlurListener</a></h4>
<div class="detail" >
<code>
static
Boolean
<strong property="yui:name">addBlurListener</strong>
(
el
,
fn
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Attaches a focusout event listener to the specified element for
the purpose of listening for the blur event on the element's
descendants.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to assign the
listener to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method the event invokes</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> An arbitrary object that will be
passed as a parameter to the handler</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">Boolean|object</span>&gt;
</code>
<span property="yui:description"> If true, the obj passed in becomes
the execution context of the listener. If an
object, this object becomes the execution
context.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">True if the action was successful or defered,
false if one or more of the elements
could not have the listener attached,
or if the operation throws an exception.</dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> use YAHOO.util.Event.on and specify "focusout" as the event type.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:method" resource="#method_addFocusListener">
<h4>
<a name="method_addFocusListener">addFocusListener</a></h4>
<div class="detail" >
<code>
static
Boolean
<strong property="yui:name">addFocusListener</strong>
(
el
,
fn
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Attaches a focusin event listener to the specified element for
the purpose of listening for the focus event on the element's
descendants.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to assign the
listener to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method the event invokes</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> An arbitrary object that will be
passed as a parameter to the handler</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">Boolean|object</span>&gt;
</code>
<span property="yui:description"> If true, the obj passed in becomes
the execution context of the listener. If an
object, this object becomes the execution
context.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">True if the action was successful or defered,
false if one or more of the elements
could not have the listener attached,
or if the operation throws an exception.</dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> use YAHOO.util.Event.on and specify "focusin" as the event type.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_addListener">
<h4>
<a name="method_addListener">addListener</a></h4>
<div class="detail" >
<code>
static
Boolean
<strong property="yui:name">addListener</strong>
(
el
,
sType
,
fn
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Appends an event handler
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to assign the
listener to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The type of event to append</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method the event invokes</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> An arbitrary object that will be
passed as a parameter to the handler</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">Boolean|object</span>&gt;
</code>
<span property="yui:description"> If true, the obj passed in becomes
the execution context of the listener. If an
object, this object becomes the execution
context.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">True if the action was successful or defered,
false if one or more of the elements
could not have the listener attached,
or if the operation throws an exception.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private deprecated" rel="yui:method" resource="#method_clearCache">
<h4>
<a name="method_clearCache">clearCache</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">clearCache</strong>
(
)
</code>
<div class="description" property="yui:description">
Clears the element cache
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Elements are not cached any longer
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_delegate">
<h4>
<a name="method_delegate">delegate</a></h4>
<div class="detail" >
<code>
static
Boolean
<strong property="yui:name">delegate</strong>
(
container
,
type
,
fn
,
filter
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Appends a delegated event listener. Delegated event listeners
receive three arguments by default: the DOM event, the element
specified by the filtering function or CSS selector, and the
container element (the element to which the event listener is
bound). (Note: Using the delegate method requires the event-delegate
module. Using CSS selectors as the filtering criteria for delegated
event listeners requires inclusion of the Selector Utility.)
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">container</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to assign the
listener to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">type</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The type of event listener to append</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method the event invokes</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">filter</span>
&lt;<span property="yui:type">Function|string</span>&gt;
</code>
<span property="yui:description"> Function or CSS selector used to
determine for what element(s) the event listener should be called.
When a function is specified, the function should return an
HTML element. Using a CSS Selector requires the inclusion of the
CSS Selector Utility.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> An arbitrary object that will be
passed as a parameter to the listener</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">Boolean|object</span>&gt;
</code>
<span property="yui:description"> If true, the value of the obj parameter becomes
the execution context of the listener. If an
object, this object becomes the execution
context.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">Returns true if the action was successful or defered,
false if one or more of the elements
could not have the listener attached,
or if the operation throws an exception.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_generateId">
<h4>
<a name="method_generateId">generateId</a></h4>
<div class="detail" >
<code>
static
string
<strong property="yui:name">generateId</strong>
(
el
)
</code>
<div class="description" property="yui:description">
Generates an unique ID for the element if it does not already
have one.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">object</span>&gt;
</code>
<span property="yui:description"> the element to create the id for</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
string
</code></dt>
<dd property="yui:returnInfo">the resulting id of the element</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getCharCode">
<h4>
<a name="method_getCharCode">getCharCode</a></h4>
<div class="detail" >
<code>
static
int
<strong property="yui:name">getCharCode</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Returns the charcode for an event
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
int
</code></dt>
<dd property="yui:returnInfo">the event's charCode</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private deprecated" rel="yui:method" resource="#method_getEl">
<h4>
<a name="method_getEl">getEl</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">getEl</strong>
(
)
</code>
<div class="description" property="yui:description">
We cache elements bound by id because when the unload event
fires, we can no longer use document.getElementById
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Elements are not cached any longer
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getEvent">
<h4>
<a name="method_getEvent">getEvent</a></h4>
<div class="detail" >
<code>
static
Event
<strong property="yui:name">getEvent</strong>
(
e
,
boundEl
)
</code>
<div class="description" property="yui:description">
Finds the event in the window object, the caller's arguments, or
in the arguments of another method in the callstack. This is
executed automatically for events registered through the event
manager, so the implementer should not normally need to execute
this function at all.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">e</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event parameter from the handler</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">boundEl</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> the element the listener is attached to</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Event
</code></dt>
<dd property="yui:returnInfo">the event</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getListeners">
<h4>
<a name="method_getListeners">getListeners</a></h4>
<div class="detail" >
<code>
static
Object
<strong property="yui:name">getListeners</strong>
(
el
,
sType
)
</code>
<div class="description" property="yui:description">
Returns all listeners attached to the given element via addListener.
Optionally, you can specify a specific type of event to return.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">HTMLElement|string</span>&gt;
</code>
<span property="yui:description"> the element or element id to inspect</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">string</span>&gt;
</code>
<span property="yui:description"> optional type of listener to return. If
left out, all listeners will be returned</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">the listener. Contains the following fields:
&nbsp;&nbsp;type: (string) the type of event
&nbsp;&nbsp;fn: (function) the callback supplied to addListener
&nbsp;&nbsp;obj: (object) the custom object supplied to addListener
&nbsp;&nbsp;adjust: (boolean|object) whether or not to adjust the default context
&nbsp;&nbsp;scope: (boolean) the derived context based on the adjust parameter
&nbsp;&nbsp;index: (int) its position in the Event util listener cache</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getPageX">
<h4>
<a name="method_getPageX">getPageX</a></h4>
<div class="detail" >
<code>
static
int
<strong property="yui:name">getPageX</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Returns the event's pageX
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
int
</code></dt>
<dd property="yui:returnInfo">the event's pageX</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getPageY">
<h4>
<a name="method_getPageY">getPageY</a></h4>
<div class="detail" >
<code>
static
int
<strong property="yui:name">getPageY</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Returns the event's pageY
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
int
</code></dt>
<dd property="yui:returnInfo">the event's pageY</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getRelatedTarget">
<h4>
<a name="method_getRelatedTarget">getRelatedTarget</a></h4>
<div class="detail" >
<code>
static
HTMLElement
<strong property="yui:name">getRelatedTarget</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Returns the event's related target
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
HTMLElement
</code></dt>
<dd property="yui:returnInfo">the event's relatedTarget</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getTarget">
<h4>
<a name="method_getTarget">getTarget</a></h4>
<div class="detail" >
<code>
static
HTMLElement
<strong property="yui:name">getTarget</strong>
(
ev
,
resolveTextNode
)
</code>
<div class="description" property="yui:description">
Returns the event's target element. Safari sometimes provides
a text node, and this is automatically resolved to the text
node's parent so that it behaves like other browsers.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">resolveTextNode</span>
&lt;<span property="yui:type">boolean</span>&gt;
</code>
<span property="yui:description"> when set to true the target's
parent will be returned if the target is a
text node. @deprecated, the text node is
now resolved automatically</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
HTMLElement
</code></dt>
<dd property="yui:returnInfo">the event's target</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getTime">
<h4>
<a name="method_getTime">getTime</a></h4>
<div class="detail" >
<code>
static
Date
<strong property="yui:name">getTime</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Returns the time of the event. If the time is not included, the
event is modified using the current time.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Date
</code></dt>
<dd property="yui:returnInfo">the time of the event</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getXY">
<h4>
<a name="method_getXY">getXY</a></h4>
<div class="detail" >
<code>
static
[x, y]
<strong property="yui:name">getXY</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Returns the pageX and pageY properties as an indexed array.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
[x, y]
</code></dt>
<dd property="yui:returnInfo">the pageX and pageY properties of the event</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>
static
void
<strong property="yui:name">on</strong>
(
)
</code>
<div class="description" property="yui:description">
YAHOO.util.Event.on is an alias for addListener
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onAvailable">
<h4>
<a name="method_onAvailable">onAvailable</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">onAvailable</strong>
(
id
,
fn
,
obj
,
overrideContext
,
checkContent
)
</code>
<div class="description" property="yui:description">
Executes the supplied callback when the item with the supplied
id is found. This is meant to be used to execute behavior as
soon as possible as the page loads. If you use this after the
initial page load it will poll for a fixed time for the element.
The number of times it will poll and the frequency are
configurable. By default it will poll for 10 seconds.
<p>The callback is executed with a single parameter:
the custom object parameter, if provided.</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">string||string[]</span>&gt;
</code>
<span property="yui:description"> the id of the element, or an array
of ids to look for.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">function</span>&gt;
</code>
<span property="yui:description"> what to execute when the element is found.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">object</span>&gt;
</code>
<span property="yui:description"> an optional object to be passed back as
a parameter to fn.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">boolean|object</span>&gt;
</code>
<span property="yui:description"> If set to true, fn will execute
in the context of obj, if set to an object it
will execute in the context of that object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">checkContent</span>
&lt;<span property="yui:type">boolean</span>&gt;
</code>
<span property="yui:description"> check child node readiness (onContentReady)</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:method" resource="#method_onBlur">
<h4>
<a name="method_onBlur">onBlur</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">onBlur</strong>
(
)
</code>
<div class="description" property="yui:description">
YAHOO.util.Event.onBlur is an alias for addBlurListener
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> use YAHOO.util.Event.on and specify "focusout" as the event type.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onContentReady">
<h4>
<a name="method_onContentReady">onContentReady</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">onContentReady</strong>
(
id
,
fn
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Works the same way as onAvailable, but additionally checks the
state of sibling elements to determine if the content of the
available element is safe to modify.
<p>The callback is executed with a single parameter:
the custom object parameter, if provided.</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">string</span>&gt;
</code>
<span property="yui:description"> the id of the element to look for.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">function</span>&gt;
</code>
<span property="yui:description"> what to execute when the element is ready.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">object</span>&gt;
</code>
<span property="yui:description"> an optional object to be passed back as
a parameter to fn.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">boolean|object</span>&gt;
</code>
<span property="yui:description"> If set to true, fn will execute
in the context of obj. If an object, fn will
exectute in the context of that object</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onDOMReady">
<h4>
<a name="method_onDOMReady">onDOMReady</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">onDOMReady</strong>
(
fn
,
obj
,
overrideContext
)
</code>
<div class="description" property="yui:description">
Executes the supplied callback when the DOM is first usable. This
will execute immediately if called after the DOMReady event has
fired. @todo the DOMContentReady event does not fire when the
script is dynamically injected into the page. This means the
DOMReady custom event will never fire in FireFox or Opera when the
library is injected. It _will_ fire in Safari, and the IE
implementation would allow for us to fire it if the defered script
is not available. We want this to behave the same in all browsers.
Is there a way to identify when the script has been injected
instead of included inline? Is there a way to know whether the
window onload event has fired without having had a listener attached
to it when it did so?
<p>The callback is a CustomEvent, so the signature is:</p>
<p>type &lt;string&gt;, args &lt;array&gt;, customobject &lt;object&gt;</p>
<p>For DOMReady events, there are no fire argments, so the
signature is:</p>
<p>"DOMReady", [], obj</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">function</span>&gt;
</code>
<span property="yui:description"> what to execute when the element is found.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">obj</span>
&lt;<span property="yui:type">object</span>&gt;
</code>
<span property="yui:description"> an optional object to be passed back as
a parameter to fn.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">overrideContext</span>
&lt;<span property="yui:type">boolean|object</span>&gt;
</code>
<span property="yui:description"> If set to true, fn will execute
in the context of obj, if set to an object it
will execute in the context of that object</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:method" resource="#method_onFocus">
<h4>
<a name="method_onFocus">onFocus</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">onFocus</strong>
(
)
</code>
<div class="description" property="yui:description">
YAHOO.util.Event.onFocus is an alias for addFocusListener
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> use YAHOO.util.Event.on and specify "focusin" as the event type.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_preventDefault">
<h4>
<a name="method_preventDefault">preventDefault</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">preventDefault</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Prevents the default behavior of the event
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_purgeElement">
<h4>
<a name="method_purgeElement">purgeElement</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">purgeElement</strong>
(
el
,
recurse
,
sType
)
</code>
<div class="description" property="yui:description">
Removes all listeners attached to the given element via addListener.
Optionally, the node's children can also be purged.
Optionally, you can specify a specific type of event to remove.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> the element to purge</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">recurse</span>
&lt;<span property="yui:type">boolean</span>&gt;
</code>
<span property="yui:description"> recursively purge this element's children
as well. Use with caution.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">string</span>&gt;
</code>
<span property="yui:description"> optional type of listener to purge. If
left out, all listeners will be removed</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private deprecated" rel="yui:method" resource="#method_regCE">
<h4>
<a name="method_regCE">regCE</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">regCE</strong>
(
)
</code>
<div class="description" property="yui:description">
Used by old versions of CustomEvent, restored for backwards
compatibility
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> still here for backwards compatibility
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:method" resource="#method_removeBlurListener">
<h4>
<a name="method_removeBlurListener">removeBlurListener</a></h4>
<div class="detail" >
<code>
static
boolean
<strong property="yui:name">removeBlurListener</strong>
(
el
,
fn
)
</code>
<div class="description" property="yui:description">
Removes a focusout event listener to the specified element for
the purpose of listening for the blur event on the element's
descendants.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to remove
the listener from.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> the method the event invokes. If fn is
undefined, then all event handlers for the type of event are
removed.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
boolean
</code></dt>
<dd property="yui:returnInfo">true if the unbind was successful, false
otherwise.</dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> use YAHOO.util.Event.removeListener and specify "focusout" as the event type.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_removeDelegate">
<h4>
<a name="method_removeDelegate">removeDelegate</a></h4>
<div class="detail" >
<code>
static
boolean
<strong property="yui:name">removeDelegate</strong>
(
container
,
type
,
fn
)
</code>
<div class="description" property="yui:description">
Removes a delegated event listener.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">container</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to remove
the listener from.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">type</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The type of event to remove.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> The method the event invokes. If fn is
undefined, then all event listeners for the type of event are
removed.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
boolean
</code></dt>
<dd property="yui:returnInfo">Returns true if the unbind was successful, false
otherwise.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:method" resource="#method_removeFocusListener">
<h4>
<a name="method_removeFocusListener">removeFocusListener</a></h4>
<div class="detail" >
<code>
static
boolean
<strong property="yui:name">removeFocusListener</strong>
(
el
,
fn
)
</code>
<div class="description" property="yui:description">
Removes a focusin event listener to the specified element for
the purpose of listening for the focus event on the element's
descendants.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to remove
the listener from.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> the method the event invokes. If fn is
undefined, then all event handlers for the type of event are
removed.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
boolean
</code></dt>
<dd property="yui:returnInfo">true if the unbind was successful, false
otherwise.</dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> use YAHOO.util.Event.removeListener and specify "focusin" as the event type.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_removeListener">
<h4>
<a name="method_removeListener">removeListener</a></h4>
<div class="detail" >
<code>
static
boolean
<strong property="yui:name">removeListener</strong>
(
el
,
sType
,
fn
)
</code>
<div class="description" property="yui:description">
Removes an event listener
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String|HTMLElement|Array|NodeList</span>&gt;
</code>
<span property="yui:description"> An id, an element
reference, or a collection of ids and/or elements to remove
the listener from.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sType</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> the type of event to remove.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
&lt;<span property="yui:type">Function</span>&gt;
</code>
<span property="yui:description"> the method the event invokes. If fn is
undefined, then all event handlers for the type of event are
removed.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
boolean
</code></dt>
<dd property="yui:returnInfo">true if the unbind was successful, false
otherwise.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_resolveTextNode">
<h4>
<a name="method_resolveTextNode">resolveTextNode</a></h4>
<div class="detail" >
<code>
static
HTMLElement
<strong property="yui:name">resolveTextNode</strong>
(
node
)
</code>
<div class="description" property="yui:description">
In some cases, some browsers will return a text node inside
the actual element that was targeted. This normalizes the
return value for getTarget and getRelatedTarget.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">node</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> node to resolve</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
HTMLElement
</code></dt>
<dd property="yui:returnInfo">the normized node</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_startInterval">
<h4>
<a name="method_startInterval">startInterval</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">startInterval</strong>
(
)
</code>
<div class="description" property="yui:description">
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_stopEvent">
<h4>
<a name="method_stopEvent">stopEvent</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">stopEvent</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Convenience method for stopPropagation + preventDefault
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</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>
static
void
<strong property="yui:name">stopPropagation</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Stops event propagation
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> the event</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="" rel="yui:event" resource="#event_DOMReadyEvent">
<h4>
<a name="event_DOMReadyEvent">DOMReadyEvent</a></h4>
<div class="detail">
<code>
<strong property="yui:name">DOMReadyEvent</strong>
(
)
</code>
<div class="description" property="yui:description">
Custom event the fires when the dom is initially usable
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
</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_animation.html" title="animation">animation</a></li>
<li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
<li class=""><a href="module_button.html" title="button">button</a></li>
<li class=""><a href="module_calendar.html" title="calendar">calendar</a></li>
<li class=""><a href="module_carousel.html" title="carousel">carousel</a></li>
<li class=""><a href="module_charts.html" title="charts">charts</a></li>
<li class=""><a href="module_colorpicker.html" title="colorpicker">colorpicker</a></li>
<li class=""><a href="module_connection.html" title="connection">connection</a></li>
<li class=""><a href="module_container.html" title="container">container</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
<li class=""><a href="module_datemath.html" title="datemath">datemath</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dragdrop.html" title="dragdrop">dragdrop</a></li>
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
<li class=""><a href="module_element.html" title="element">element</a></li>
<li class=""><a href="module_element-delegate.html" title="element-delegate">element-delegate</a></li>
<li class="selected"><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-delegate.html" title="event-delegate">event-delegate</a></li>
<li class=""><a href="module_event-mouseenter.html" title="event-mouseenter">event-mouseenter</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_get.html" title="get">get</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imagecropper.html" title="imagecropper">imagecropper</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_layout.html" title="layout">layout</a></li>
<li class=""><a href="module_logger.html" title="logger">logger</a></li>
<li class=""><a href="module_menu.html" title="menu">menu</a></li>
<li class=""><a href="module_paginator.html" title="paginator">paginator</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_profilerviewer.html" title="profilerviewer">profilerviewer</a></li>
<li class=""><a href="module_progressbar.html" title="progressbar">progressbar</a></li>
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
<li class=""><a href="module_selector.html" title="selector">selector</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_storage.html" title="Storage">Storage</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
<li class=""><a href="module_swfstore.html" title="swfstore">swfstore</a></li>
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
<li class=""><a href="module_treeview.html" title="treeview">treeview</a></li>
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
<li class=""><a href="module_yahoo.html" title="yahoo">yahoo</a></li>
<li class=""><a href="module_yuiloader.html" title="yuiloader">yuiloader</a></li>
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.util.CustomEvent.html" title="YAHOO.util.CustomEvent">YAHOO.util.CustomEvent</a></li>
<li class="selected"><a href="YAHOO.util.Event.html" title="YAHOO.util.Event">YAHOO.util.Event</a></li>
<li class=""><a href="YAHOO.util.EventProvider.html" title="YAHOO.util.EventProvider">YAHOO.util.EventProvider</a></li>
<li class=""><a href="YAHOO.util.KeyListener.html" title="YAHOO.util.KeyListener">YAHOO.util.KeyListener</a></li>
<li class=""><a href="YAHOO.util.Subscriber.html" title="YAHOO.util.Subscriber">YAHOO.util.Subscriber</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="CustomEvent.js.html" title="CustomEvent.js">CustomEvent.js</a></li>
<li class=""><a href="Event.js.html" title="Event.js">Event.js</a></li>
<li class=""><a href="EventProvider.js.html" title="EventProvider.js">EventProvider.js</a></li>
<li class=""><a href="KeyListener.js.html" title="KeyListener.js">KeyListener.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__dri" title="_dri">_dri</a></li>
<li class="private"><a href="#property__interval" title="_interval">_interval</a></li>
<li class="private"><a href="#property__specialTypes" title="_specialTypes">_specialTypes</a></li>
<li class=""><a href="#property_ADJ_SCOPE" title="ADJ_SCOPE">ADJ_SCOPE</a></li>
<li class=""><a href="#property_CAPTURE" title="CAPTURE">CAPTURE</a></li>
<li class="private"><a href="#property_counter" title="counter">counter</a></li>
<li class=""><a href="#property_DOMReady" title="DOMReady">DOMReady</a></li>
<li class=""><a href="#property_EL" title="EL">EL</a></li>
<li class="private deprecated"><a href="#property_elCache
DOM element cache" title="elCache
DOM element cache">elCache
DOM element cache</a></li>
<li class=""><a href="#property_FN" title="FN">FN</a></li>
<li class="private deprecated"><a href="#property_isIE" title="isIE">isIE</a></li>
<li class="private deprecated"><a href="#property_isSafari" title="isSafari">isSafari</a></li>
<li class=""><a href="#property_lastError" title="lastError">lastError</a></li>
<li class="private"><a href="#property_listeners" title="listeners">listeners</a></li>
<li class="private"><a href="#property_loadComplete" title="loadComplete">loadComplete</a></li>
<li class=""><a href="#property_OBJ" title="OBJ">OBJ</a></li>
<li class="private"><a href="#property_onAvailStack" title="onAvailStack">onAvailStack</a></li>
<li class=""><a href="#property_OVERRIDE" title="OVERRIDE">OVERRIDE</a></li>
<li class=""><a href="#property_POLL_INTERVAL" title="POLL_INTERVAL">POLL_INTERVAL</a></li>
<li class=""><a href="#property_POLL_RETRYS" title="POLL_RETRYS">POLL_RETRYS</a></li>
<li class="private"><a href="#property_retryCount" title="retryCount">retryCount</a></li>
<li class=""><a href="#property_throwErrors" title="throwErrors">throwErrors</a></li>
<li class=""><a href="#property_TYPE" title="TYPE">TYPE</a></li>
<li class="private"><a href="#property_unloadListeners" title="unloadListeners">unloadListeners</a></li>
<li class="private deprecated"><a href="#property_webkit" title="webkit">webkit</a></li>
<li class="private"><a href="#property_webkitKeymap" title="webkitKeymap">webkitKeymap</a></li>
<li class=""><a href="#property_WFN" title="WFN">WFN</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><a href="#method__addListener" title="_addListener">_addListener</a></li>
<li class="private"><a href="#method__createDelegate" title="_createDelegate">_createDelegate</a></li>
<li class="private"><a href="#method__createMouseDelegate" title="_createMouseDelegate">_createMouseDelegate</a></li>
<li class="private"><a href="#method__getCacheIndex" title="_getCacheIndex">_getCacheIndex</a></li>
<li class="private"><a href="#method__getScroll" title="_getScroll">_getScroll</a></li>
<li class="private"><a href="#method__getScrollLeft" title="_getScrollLeft">_getScrollLeft</a></li>
<li class="private"><a href="#method__getScrollTop" title="_getScrollTop">_getScrollTop</a></li>
<li class="private"><a href="#method__getType" title="_getType">_getType</a></li>
<li class="private"><a href="#method__isValidCollection" title="_isValidCollection">_isValidCollection</a></li>
<li class="private"><a href="#method__load" title="_load">_load</a></li>
<li class="private"><a href="#method__ready" title="_ready">_ready</a></li>
<li class="private"><a href="#method__simpleAdd" title="_simpleAdd">_simpleAdd</a></li>
<li class="private"><a href="#method__simpleRemove" title="_simpleRemove">_simpleRemove</a></li>
<li class="private"><a href="#method__tryPreloadAttach" title="_tryPreloadAttach">_tryPreloadAttach</a></li>
<li class="private"><a href="#method__unload" title="_unload">_unload</a></li>
<li class=" deprecated"><a href="#method_addBlurListener" title="addBlurListener">addBlurListener</a></li>
<li class=" deprecated"><a href="#method_addFocusListener" title="addFocusListener">addFocusListener</a></li>
<li class=""><a href="#method_addListener" title="addListener">addListener</a></li>
<li class="private deprecated"><a href="#method_clearCache" title="clearCache">clearCache</a></li>
<li class=""><a href="#method_delegate" title="delegate">delegate</a></li>
<li class=""><a href="#method_generateId" title="generateId">generateId</a></li>
<li class=""><a href="#method_getCharCode" title="getCharCode">getCharCode</a></li>
<li class="private deprecated"><a href="#method_getEl" title="getEl">getEl</a></li>
<li class=""><a href="#method_getEvent" title="getEvent">getEvent</a></li>
<li class=""><a href="#method_getListeners" title="getListeners">getListeners</a></li>
<li class=""><a href="#method_getPageX" title="getPageX">getPageX</a></li>
<li class=""><a href="#method_getPageY" title="getPageY">getPageY</a></li>
<li class=""><a href="#method_getRelatedTarget" title="getRelatedTarget">getRelatedTarget</a></li>
<li class=""><a href="#method_getTarget" title="getTarget">getTarget</a></li>
<li class=""><a href="#method_getTime" title="getTime">getTime</a></li>
<li class=""><a href="#method_getXY" title="getXY">getXY</a></li>
<li class=""><a href="#method_on" title="on">on</a></li>
<li class=""><a href="#method_onAvailable" title="onAvailable">onAvailable</a></li>
<li class=" deprecated"><a href="#method_onBlur" title="onBlur">onBlur</a></li>
<li class=""><a href="#method_onContentReady" title="onContentReady">onContentReady</a></li>
<li class=""><a href="#method_onDOMReady" title="onDOMReady">onDOMReady</a></li>
<li class=" deprecated"><a href="#method_onFocus" title="onFocus">onFocus</a></li>
<li class=""><a href="#method_preventDefault" title="preventDefault">preventDefault</a></li>
<li class=""><a href="#method_purgeElement" title="purgeElement">purgeElement</a></li>
<li class="private deprecated"><a href="#method_regCE" title="regCE">regCE</a></li>
<li class=" deprecated"><a href="#method_removeBlurListener" title="removeBlurListener">removeBlurListener</a></li>
<li class=""><a href="#method_removeDelegate" title="removeDelegate">removeDelegate</a></li>
<li class=" deprecated"><a href="#method_removeFocusListener" title="removeFocusListener">removeFocusListener</a></li>
<li class=""><a href="#method_removeListener" title="removeListener">removeListener</a></li>
<li class=""><a href="#method_resolveTextNode" title="resolveTextNode">resolveTextNode</a></li>
<li class="private"><a href="#method_startInterval" title="startInterval">startInterval</a></li>
<li class=""><a href="#method_stopEvent" title="stopEvent">stopEvent</a></li>
<li class=""><a href="#method_stopPropagation" title="stopPropagation">stopPropagation</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_DOMReadyEvent" title="DOMReadyEvent">DOMReadyEvent</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2010 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"access": "", "host": "YAHOO.util.Event", "name": "addBlurListener", "url": "YAHOO.util.Event.html#method_addBlurListener", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "addFocusListener", "url": "YAHOO.util.Event.html#method_addFocusListener", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_addListener", "url": "YAHOO.util.Event.html#method__addListener", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "addListener", "url": "YAHOO.util.Event.html#method_addListener", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "ADJ_SCOPE", "url": "YAHOO.util.Event.html#property_ADJ_SCOPE", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "CAPTURE", "url": "YAHOO.util.Event.html#property_CAPTURE", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "clearCache", "url": "YAHOO.util.Event.html#method_clearCache", "type": "method"}, {"access": "", "host": "YAHOO.util.Subscriber", "name": "contains", "url": "YAHOO.util.Subscriber.html#method_contains", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "counter", "url": "YAHOO.util.Event.html#property_counter", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_createDelegate", "url": "YAHOO.util.Event.html#method__createDelegate", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_createMouseDelegate", "url": "YAHOO.util.Event.html#method__createMouseDelegate", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "delegate", "url": "YAHOO.util.Event.html#method_delegate", "type": "method"}, {"access": "private", "host": "YAHOO.util.CustomEvent", "name": "_delete", "url": "YAHOO.util.CustomEvent.html#method__delete", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "DOMReady", "url": "YAHOO.util.Event.html#property_DOMReady", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "DOMReadyEvent", "url": "YAHOO.util.Event.html#event_DOMReadyEvent", "type": "event"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_dri", "url": "YAHOO.util.Event.html#property__dri", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "EL", "url": "YAHOO.util.Event.html#property_EL", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "elCache\nDOM element cache", "url": "YAHOO.util.Event.html#property_elCache\nDOM element cache", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "fire", "url": "YAHOO.util.CustomEvent.html#method_fire", "type": "method"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "fired", "url": "YAHOO.util.CustomEvent.html#property_fired", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "firedWith", "url": "YAHOO.util.CustomEvent.html#property_firedWith", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "fireOnce", "url": "YAHOO.util.CustomEvent.html#property_fireOnce", "type": "property"}, {"access": "", "host": "YAHOO.util.Subscriber", "name": "fn", "url": "YAHOO.util.Subscriber.html#property_fn", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "FN", "url": "YAHOO.util.Event.html#property_FN", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "generateId", "url": "YAHOO.util.Event.html#method_generateId", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_getCacheIndex", "url": "YAHOO.util.Event.html#method__getCacheIndex", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getCharCode", "url": "YAHOO.util.Event.html#method_getCharCode", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "getEl", "url": "YAHOO.util.Event.html#method_getEl", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getEvent", "url": "YAHOO.util.Event.html#method_getEvent", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getListeners", "url": "YAHOO.util.Event.html#method_getListeners", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getPageX", "url": "YAHOO.util.Event.html#method_getPageX", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getPageY", "url": "YAHOO.util.Event.html#method_getPageY", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getRelatedTarget", "url": "YAHOO.util.Event.html#method_getRelatedTarget", "type": "method"}, {"access": "", "host": "YAHOO.util.Subscriber", "name": "getScope", "url": "YAHOO.util.Subscriber.html#method_getScope", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_getScroll", "url": "YAHOO.util.Event.html#method__getScroll", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_getScrollLeft", "url": "YAHOO.util.Event.html#method__getScrollLeft", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_getScrollTop", "url": "YAHOO.util.Event.html#method__getScrollTop", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getTarget", "url": "YAHOO.util.Event.html#method_getTarget", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getTime", "url": "YAHOO.util.Event.html#method_getTime", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_getType", "url": "YAHOO.util.Event.html#method__getType", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "getXY", "url": "YAHOO.util.Event.html#method_getXY", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_interval", "url": "YAHOO.util.Event.html#property__interval", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "isIE", "url": "YAHOO.util.Event.html#property_isIE", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "isSafari", "url": "YAHOO.util.Event.html#property_isSafari", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_isValidCollection", "url": "YAHOO.util.Event.html#method__isValidCollection", "type": "method"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "lastError", "url": "YAHOO.util.CustomEvent.html#property_lastError", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "lastError", "url": "YAHOO.util.Event.html#property_lastError", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "listeners", "url": "YAHOO.util.Event.html#property_listeners", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_load", "url": "YAHOO.util.Event.html#method__load", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "loadComplete", "url": "YAHOO.util.Event.html#property_loadComplete", "type": "property"}, {"access": "", "host": "YAHOO.util.Subscriber", "name": "obj", "url": "YAHOO.util.Subscriber.html#property_obj", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "OBJ", "url": "YAHOO.util.Event.html#property_OBJ", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "on", "url": "YAHOO.util.Event.html#method_on", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "onAvailable", "url": "YAHOO.util.Event.html#method_onAvailable", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "onAvailStack", "url": "YAHOO.util.Event.html#property_onAvailStack", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "onBlur", "url": "YAHOO.util.Event.html#method_onBlur", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "onContentReady", "url": "YAHOO.util.Event.html#method_onContentReady", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "onDOMReady", "url": "YAHOO.util.Event.html#method_onDOMReady", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "onFocus", "url": "YAHOO.util.Event.html#method_onFocus", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "OVERRIDE", "url": "YAHOO.util.Event.html#property_OVERRIDE", "type": "property"}, {"access": "", "host": "YAHOO.util.Subscriber", "name": "overrideContext", "url": "YAHOO.util.Subscriber.html#property_overrideContext", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "POLL_INTERVAL", "url": "YAHOO.util.Event.html#property_POLL_INTERVAL", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "POLL_RETRYS", "url": "YAHOO.util.Event.html#property_POLL_RETRYS", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "preventDefault", "url": "YAHOO.util.Event.html#method_preventDefault", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "purgeElement", "url": "YAHOO.util.Event.html#method_purgeElement", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_ready", "url": "YAHOO.util.Event.html#method__ready", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "regCE", "url": "YAHOO.util.Event.html#method_regCE", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "removeBlurListener", "url": "YAHOO.util.Event.html#method_removeBlurListener", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "removeDelegate", "url": "YAHOO.util.Event.html#method_removeDelegate", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "removeFocusListener", "url": "YAHOO.util.Event.html#method_removeFocusListener", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "removeListener", "url": "YAHOO.util.Event.html#method_removeListener", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "resolveTextNode", "url": "YAHOO.util.Event.html#method_resolveTextNode", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "retryCount", "url": "YAHOO.util.Event.html#property_retryCount", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "scope", "url": "YAHOO.util.CustomEvent.html#property_scope", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "signature", "url": "YAHOO.util.CustomEvent.html#property_signature", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "silent", "url": "YAHOO.util.CustomEvent.html#property_silent", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_simpleAdd", "url": "YAHOO.util.Event.html#method__simpleAdd", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_simpleRemove", "url": "YAHOO.util.Event.html#method__simpleRemove", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_specialTypes", "url": "YAHOO.util.Event.html#property__specialTypes", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "startInterval", "url": "YAHOO.util.Event.html#method_startInterval", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "stopEvent", "url": "YAHOO.util.Event.html#method_stopEvent", "type": "method"}, {"access": "", "host": "YAHOO.util.Event", "name": "stopPropagation", "url": "YAHOO.util.Event.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "subscribe", "url": "YAHOO.util.CustomEvent.html#method_subscribe", "type": "method"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "subscribeEvent", "url": "YAHOO.util.CustomEvent.html#event_subscribeEvent", "type": "event"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "subscribers", "url": "YAHOO.util.CustomEvent.html#property_subscribers", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "throwErrors", "url": "YAHOO.util.Event.html#property_throwErrors", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "toString", "url": "YAHOO.util.CustomEvent.html#method_toString", "type": "method"}, {"access": "", "host": "YAHOO.util.Subscriber", "name": "toString", "url": "YAHOO.util.Subscriber.html#method_toString", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_tryPreloadAttach", "url": "YAHOO.util.Event.html#method__tryPreloadAttach", "type": "method"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "type", "url": "YAHOO.util.CustomEvent.html#property_type", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "TYPE", "url": "YAHOO.util.Event.html#property_TYPE", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "_unload", "url": "YAHOO.util.Event.html#method__unload", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "unloadListeners", "url": "YAHOO.util.Event.html#property_unloadListeners", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "unsubscribe", "url": "YAHOO.util.CustomEvent.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "unsubscribeAll", "url": "YAHOO.util.CustomEvent.html#method_unsubscribeAll", "type": "method"}, {"access": "private", "host": "YAHOO.util.Event", "name": "webkit", "url": "YAHOO.util.Event.html#property_webkit", "type": "property"}, {"access": "private", "host": "YAHOO.util.Event", "name": "webkitKeymap", "url": "YAHOO.util.Event.html#property_webkitKeymap", "type": "property"}, {"access": "", "host": "YAHOO.util.Event", "name": "WFN", "url": "YAHOO.util.Event.html#property_WFN", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "YAHOO.util.CustomEvent.FLAT", "url": "YAHOO.util.CustomEvent.html#property_YAHOO.util.CustomEvent.FLAT", "type": "property"}, {"access": "", "host": "YAHOO.util.CustomEvent", "name": "YAHOO.util.CustomEvent.LIST", "url": "YAHOO.util.CustomEvent.html#property_YAHOO.util.CustomEvent.LIST", "type": "property"}];
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink