<!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: yui YUI (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>yui <span class="subtitle">3.0.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_yui.html" title="yui">yui</a>
> YUI
<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">YUI</b>
<span class="extends">
</span>
<span class="extends" rel="yui:extends">
- uses
<span rel="extend" resource="EventTarget.html">
<a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>
</span>
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
The YUI global namespace object. If YUI is already defined, the
existing YUI object will not be overwritten so that defined
namespaces are preserved.
</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">YUI</strong>
<code>
(
o*
)
</code>
<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"> Up to five optional configuration objects. This object is stored
in YUI.config. See config for the list of supported properties.</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_Global">
<h4><a name="property_Global" property="yui:name">Global</a>
- <code><span property="yui:type">EventTarget</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Hosts YUI page level events. This is where events bubble to
when the broadcast config is set to 2. This property is
only available if the custom event module is loaded.
</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__init">
<h4>
<a name="method__init">_init</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_init</strong>
(
)
</code>
<div class="description" property="yui:description">
Initialize this YUI instance
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__setup">
<h4>
<a name="method__setup">_setup</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_setup</strong>
(
)
</code>
<div class="description" property="yui:description">
Finishes the instance setup. Attaches whatever modules were defined
when the yui modules was registered.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_add">
<h4>
<a name="method_add">add</a></h4>
<div class="detail" >
<code>
YUI
<strong property="yui:name">add</strong>
(
name
,
fn
,
version
,
details
)
</code>
<div class="description" property="yui:description">
Register a module
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">name</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> module name</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> entry point into the module that
is used to bind module to the YUI instance</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">version</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> version string</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">details</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional config data:
requires - features that should be present before loading
optional - optional features that should be present if load optional defined
use - features that should be attached automatically
skinnable -
rollup
omit - features that should not be loaded if this module is present</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
YUI
</code></dt>
<dd property="yui:returnInfo">the YUI instance</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>
<strong property="yui:name">after</strong>
(
type
,
fn
,
target
,
extra
,
context
,
args*
)
</code>
<div class="description" property="yui:description">
after() is a unified interface for subscribing to
most events exposed by YUI. This includes custom events,
DOM events, and AOP events. This works the same way as
the on() function, only it operates after any default
behavior for the event has executed. @see <code>on</code> for more
information.
</div>
<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">object</span>>
</code>
<span property="yui:description"> event type (this parameter does not apply for function events)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> the callback</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">target</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> a descriptor for the target (applies to custom events only).
For function events, this is the object that contains the function to
execute.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">extra</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n Extra information a particular event may need. These
will be documented with the event. In the case of function events, this
is the name of the function to execute on the host. In the case of
delegate listeners, this is the event delegation specification.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optionally change the value of 'this' in the callback</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args*</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to pass to the callback.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">the event target or a detach handle per 'chain' config</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_applyTo">
<h4>
<a name="method_applyTo">applyTo</a></h4>
<div class="detail" >
<code>
object
<strong property="yui:name">applyTo</strong>
(
id
,
method
,
args
)
</code>
<div class="description" property="yui:description">
Executes a method on a YUI instance with
the specified id if the specified method is whitelisted.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> the YUI instance id</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">method</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> the name of the method to exectute.
Ex: 'Object.keys'</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 to apply to the method</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
object
</code></dt>
<dd property="yui:returnInfo">the return value from the applied method or null</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_cached">
<h4>
<a name="method_cached">cached</a></h4>
<div class="detail" >
<code>
Function
<strong property="yui:name">cached</strong>
(
source
,
cache
,
refetch
)
</code>
<div class="description" property="yui:description">
Returns a wrapper for a function which caches the
return value of that function, keyed off of the combined
argument values.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">source</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the function to memoize</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">cache</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> an optional cache seed</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">refetch</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> if supplied, this value is tested against the cached
value. If the values are equal, the wrapped function is executed again.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Function
</code></dt>
<dd property="yui:returnInfo">the wrapped function</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_delegate">
<h4>
<a name="method_delegate">delegate</a></h4>
<div class="detail" >
<code>
EventHandle
<strong property="yui:name">delegate</strong>
(
type
,
fn
,
el
,
spec
,
context
,
args*
)
</code>
<div class="description" property="yui:description">
Sets up event delegation on a container element. The delegated event
will use a supplied selector to test if the target or one of the
descendants of the target match it. The supplied callback function
will only be executed if a match was encountered, and, in fact,
will be executed for each element that matches if you supply an
ambiguous selector.
The event object for the delegated event is supplied to the callback
function. It is modified slightly in order to support all properties
that may be needed for event delegation. 'currentTarget' is set to
the element that matched the delegation specifcation. 'container' is
set to the element that the listener is bound to (this normally would
be the 'currentTarget').
</div>
<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 event type to delegate</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the callback function to execute. This function
will be provided the event object for the delegated event.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
<<span property="yui:type">string|node</span>>
</code>
<span property="yui:description"> the element that is the delegation container</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">spec</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> a selector that must match the target of the
event.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional argument that specifies what 'this' refers to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args*</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to pass on to the callback function.
These arguments will be added after the event object.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
EventHandle
</code></dt>
<dd property="yui:returnInfo">the detach handle</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_error">
<h4>
<a name="method_error">error</a></h4>
<div class="detail" >
<code>
YUI
<strong property="yui:name">error</strong>
(
msg
,
e
)
</code>
<div class="description" property="yui:description">
Report an error. The reporting mechanism is controled by
the 'throwFail' configuration attribute. If throwFail is
not specified, the message is written to the Logger, otherwise
a JS error is thrown
</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"> the error message</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">e</span>
<<span property="yui:type">Error</span>>
</code>
<span property="yui:description"> Optional JS error that was caught. If supplied
and throwFail is specified, this error will be re-thrown.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
YUI
</code></dt>
<dd property="yui:returnInfo">this YUI instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_guid">
<h4>
<a name="method_guid">guid</a></h4>
<div class="detail" >
<code>
string
<strong property="yui:name">guid</strong>
(
pre
)
</code>
<div class="description" property="yui:description">
Generate an id that is unique among all YUI instances
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">pre</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> optional guid prefix</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
string
</code></dt>
<dd property="yui:returnInfo">the guid</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_later">
<h4>
<a name="method_later">later</a></h4>
<div class="detail" >
<code>
object
<strong property="yui:name">later</strong>
(
when
,
o
,
fn
,
data
,
periodic
)
</code>
<div class="description" property="yui:description">
Executes the supplied function in the context of the supplied
object 'when' milliseconds later. Executes the function a
single time unless periodic is set to true.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">when</span>
<<span property="yui:type">int</span>>
</code>
<span property="yui:description"> the number of milliseconds to wait until the fn
is executed.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> the context object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">Function|String</span>>
</code>
<span property="yui:description"> the function to execute or the name of
the method in the 'o' object to execute.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">data</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> [Array] data that is provided to the function. This accepts
either a single item or an array. If an array is provided, the
function is executed with one parameter for each array item. If
you need to pass a single array parameter, it needs to be wrapped in
an array [myarray].</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">periodic</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> if true, executes continuously at supplied
interval until canceled.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
object
</code></dt>
<dd property="yui:returnInfo">a timer object. Call the cancel() method on this object to
stop the timer.</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>
YUI
<strong property="yui:name">log</strong>
(
msg
,
cat
,
src
,
silent
)
</code>
<div class="description" property="yui:description">
If the 'debug' config is true, a 'yui:log' event will be
dispatched, which the Console widget and anything else
can consume. If the 'useBrowserConsole' config is true, it will
write to the browser console if available. YUI-specific log
messages will only be present in the -debug versions of the
JS files. The build system is supposed to remove log statements
from the raw and minified versions of the files.
</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"> The 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"> The log category for the message. Default
categories are "info", "warn", "error", time".
Custom categories can be used as well. (opt)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">src</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> The source of the the message (opt)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">silent</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> If true, the log event won't fire</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
YUI
</code></dt>
<dd property="yui:returnInfo">YUI instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_merge">
<h4>
<a name="method_merge">merge</a></h4>
<div class="detail" >
<code>
object
<strong property="yui:name">merge</strong>
(
arguments
)
</code>
<div class="description" property="yui:description">
Returns a new object containing all of the properties of
all the supplied objects. The properties from later objects
will overwrite those in earlier objects. Passing in a
single object will create a shallow copy of it. For a deep
copy, use clone.
</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"> the objects to merge</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
object
</code></dt>
<dd property="yui:returnInfo">the new merged object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_message">
<h4>
<a name="method_message">message</a></h4>
<div class="detail" >
<code>
YUI
<strong property="yui:name">message</strong>
(
msg
,
cat
,
src
,
silent
)
</code>
<div class="description" property="yui:description">
Write a system message. This message will be preserved in the
minified and raw versions of the YUI files, unlike log statements.
</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"> The 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"> The log category for the message. Default
categories are "info", "warn", "error", time".
Custom categories can be used as well. (opt)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">src</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> The source of the the message (opt)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">silent</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> If true, the log event won't fire</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
YUI
</code></dt>
<dd property="yui:returnInfo">YUI instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_mix">
<h4>
<a name="method_mix">mix</a></h4>
<div class="detail" >
<code>
object
<strong property="yui:name">mix</strong>
(
r
,
s
,
ov
,
wl
,
mode
,
merge
)
</code>
<div class="description" property="yui:description">
Applies the supplier's properties to the receiver. By default
all prototype and static propertes on the supplier are applied
to the corresponding spot on the receiver. By default all
properties are applied, and a property that is already on the
reciever will not be overwritten. The default behavior can
be modified by supplying the appropriate parameters.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">r</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> the object to receive the augmentation</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">s</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> the object that supplies the properties to augment</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">ov</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> if true, properties already on the receiver
will be overwritten if found on the supplier.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">wl</span>
<<span property="yui:type">string[]</span>>
</code>
<span property="yui:description"> a whitelist. If supplied, only properties in
this list will be applied to the receiver.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">mode</span>
<<span property="yui:type">int</span>>
</code>
<span property="yui:description"> what should be copies, and to where
default(0): object to object
1: prototype to prototype (old augment)
2: prototype to prototype and object props (new augment)
3: prototype to object
4: object to prototype</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">merge</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> merge objects instead of overwriting/ignoring
Used by Y.aggregate</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
object
</code></dt>
<dd property="yui:returnInfo">the augmented object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_namespace">
<h4>
<a name="method_namespace">namespace</a></h4>
<div class="detail" >
<code>
object
<strong property="yui:name">namespace</strong>
(
arguments
)
</code>
<div class="description" property="yui:description">
Returns the namespace specified and creates it if it doesn't exist
<pre>
YUI.namespace("property.package");
YUI.namespace("YAHOO.property.package");
</pre>
Either of the above would create YUI.property, then
YUI.property.package (YAHOO is scrubbed out, this is
to remain compatible with YUI2)
Be careful when naming packages. Reserved words may work in some browsers
and not others. For instance, the following will fail in Safari:
<pre>
YUI.namespace("really.long.nested.namespace");
</pre>
This fails because "long" is a future reserved word in ECMAScript
</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">string*</span>>
</code>
<span property="yui:description"> 1-n namespaces to create</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
object
</code></dt>
<dd property="yui:returnInfo">A reference to the last namespace object created</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Node.plug">
<h4>
<a name="method_Node.plug">Node.plug</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">Node.plug</strong>
(
plugin
,
config
)
</code>
<div class="description" property="yui:description">
Registers plugins to be instantiated at the class level (plugins
which should be plugged into every instance of Node by default).
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">plugin</span>
<<span property="yui:type">Function | Array</span>>
</code>
<span property="yui:description"> Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">config</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> (Optional) If plugin is the plugin class, the configuration for the plugin</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Node.unplug">
<h4>
<a name="method_Node.unplug">Node.unplug</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">Node.unplug</strong>
(
plugin
)
</code>
<div class="description" property="yui:description">
Unregisters any class level plugins which have been registered by the Node
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">plugin</span>
<<span property="yui:type">Function | Array</span>>
</code>
<span property="yui:description"> The plugin class, or an array of plugin classes</span>
</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>
<strong property="yui:name">on</strong>
(
type**
,
fn
,
target**
,
extra**
,
context
,
args*
)
</code>
<div class="description" property="yui:description">
<code>YUI</code>'s <code>on</code> method is a unified interface for subscribing to
most events exposed by YUI. This includes custom events, DOM events, and
function events. <code>detach</code> is also provided to remove listeners
serviced by this function.
The signature that <code>on</code> accepts varies depending on the type
of event being consumed. Refer to the specific methods that will
service a specific request for additional information about subscribing
to that type of event.
<ul>
<li>Custom events. These events are defined by various
modules in the library. This type of event is delegated to
<code>EventTarget</code>'s <code>on</code> method.
<ul>
<li>The type of the event</li>
<li>The callback to execute</li>
<li>An optional context object</li>
<li>0..n additional arguments to supply the callback.</li>
</ul>
Example:
<code>Y.on('domready', function() { // start work });</code>
</li>
<li>DOM events. These are moments reported by the browser related
to browser functionality and user interaction.
This type of event is delegated to <code>Event</code>'s
<code>attach</code> method.
<ul>
<li>The type of the event</li>
<li>The callback to execute</li>
<li>The specification for the Node(s) to attach the listener
to. This can be a selector, collections, or Node/Element
refereces.</li>
<li>An optional context object</li>
<li>0..n additional arguments to supply the callback.</li>
</ul>
Example:
<code>Y.on('click', function(e) { // something was clicked }, '#someelement');</code>
</li>
<li>Function events. These events can be used to react before or after a
function is executed. This type of event is delegated to <code>Event.Do</code>'s
<code>before</code> method.
<ul>
<li>The callback to execute</li>
<li>The object that has the function that will be listened for.</li>
<li>The name of the function to listen for.</li>
<li>An optional context object</li>
<li>0..n additional arguments to supply the callback.</li>
</ul>
Example <code>Y.on(function(arg1, arg2, etc) { // obj.methodname was executed }, obj 'methodname');</code>
</li>
</ul>
<code>on</code> corresponds to the moment before any default behavior of
the event. <code>after</code> works the same way, but these listeners
execute after the event's default behavior. <code>before</code> is an
alias for <code>on</code>.
</div>
<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">object</span>>
</code>
<span property="yui:description"> event type (this parameter does not apply for function events)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> the callback</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">target**</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> a descriptor for the target (applies to custom events only).
For function events, this is the object that contains the function to
execute.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">extra**</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n Extra information a particular event may need. These
will be documented with the event. In the case of function events, this
is the name of the function to execute on the host. In the case of
delegate listeners, this is the event delegation specification.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optionally change the value of 'this' in the callback</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args*</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to pass to the callback.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">the event target or a detach handle per 'chain' config</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_simulate">
<h4>
<a name="method_simulate">simulate</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">simulate</strong>
(
target
,
type
,
options
)
</code>
<div class="description" property="yui:description">
Simulates the event with the given name on a target.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">target</span>
<<span property="yui:type">HTMLElement</span>>
</code>
<span property="yui:description"> The DOM element that's the target of the event.</span>
</dd>
<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 to simulate (i.e., "click").</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">options</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> (Optional) Extra options to copy onto the event object.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_stamp">
<h4>
<a name="method_stamp">stamp</a></h4>
<div class="detail" >
<code>
string
<strong property="yui:name">stamp</strong>
(
o
,
readOnly
)
</code>
<div class="description" property="yui:description">
Returns a guid associated with an object. If the object
does not have one, a new one is created unless readOnly
is specified.
</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"> The object to stamp</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">readOnly</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> if true, a valid guid will only
be returned if the object has one assigned to it.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
string
</code></dt>
<dd property="yui:returnInfo">The object's guid or null</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_use">
<h4>
<a name="method_use">use</a></h4>
<div class="detail" >
<code>
YUI
<strong property="yui:name">use</strong>
(
modules*
,
*callback
)
</code>
<div class="description" property="yui:description">
Bind a module to a YUI instance
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">modules*</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> 1-n modules to bind (uses arguments array)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">*callback</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> callback function executed when
the instance has the required functionality. If included, it
must be the last parameter.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
YUI
</code></dt>
<dd property="yui:returnInfo">the YUI instance</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html">
<h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<span rel="yui:method" resource="EventTarget.html#method__getType">
<a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method__parseType">
<a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_addTarget">
<a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_after">
<a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_before">
<a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_bubble">
<a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_detach">
<a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_detachAll">
<a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_fire">
<a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_getEvent">
<a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_on">
<a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_publish">
<a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_removeTarget">
<a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_subscribe">
<a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_unsubscribe">
<a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span>
</span>
<span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll">
<a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a>
</span>
</code>
</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_available">
<h4>
<a name="event_available">available</a></h4>
<div class="detail">
<code>
<strong property="yui:name">available</strong>
(
type
,
fn
,
el
,
context
,
args*
)
</code>
<div class="description" property="yui:description">
Executes the callback as soon as the specified element
is detected in the DOM.
</div>
<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"> 'available'</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the callback function to execute.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
<<span property="yui:type">string|HTMLElement|collection</span>>
</code>
<span property="yui:description"> the element(s) to attach</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional argument that specifies what 'this' refers to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args*</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to pass on to the callback function.
These arguments will be added after the event object.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_blur">
<h4>
<a name="event_blur">blur</a></h4>
<div class="detail">
<code>
<strong property="yui:name">blur</strong>
(
type
,
fn
,
o
,
context
,
args
)
</code>
<div class="description" property="yui:description">
Adds a DOM blur listener. Uses the focusout event in IE,
DOMFocusOut for Opera and Webkit, and the capture phase for Gecko so that
the event propagates in a way that enables event delegation.
</div>
<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"> 'blur'</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the callback function to execute</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">string|HTMLElement|collection</span>>
</code>
<span property="yui:description"> the element(s) to bind</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional context object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to provide to the listener.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_contentready">
<h4>
<a name="event_contentready">contentready</a></h4>
<div class="detail">
<code>
<strong property="yui:name">contentready</strong>
(
type
,
fn
,
el
,
context
,
args*
)
</code>
<div class="description" property="yui:description">
Executes the callback as soon as the specified element
is detected in the DOM with a nextSibling property
(indicating that the element's children are available)
</div>
<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"> 'contentready'</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the callback function to execute.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
<<span property="yui:type">string|HTMLElement|collection</span>>
</code>
<span property="yui:description"> the element(s) to attach</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional argument that specifies what 'this' refers to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args*</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to pass on to the callback function.
These arguments will be added after the event object.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:event" resource="#event_delegate">
<h4>
<a name="event_delegate">delegate</a></h4>
<div class="detail">
<code>
<strong property="yui:name">delegate</strong>
(
type
,
fn
,
el
,
delegateType
,
spec
,
context
,
args*
)
</code>
<div class="description" property="yui:description">
Sets up event delegation on a container element. The delegated event
will use a supplied selector to test if the target or one of the
descendants of the target match it. The supplied callback function
will only be executed if a match was encountered, and, in fact,
will be executed for each element that matches if you supply an
ambiguous selector.
The event object for the delegated event is supplied to the callback
function. It is modified slightly in order to support all properties
that may be needed for event delegation. 'currentTarget' is set to
the element that matched the delegation specifcation. 'container' is
set to the element that the listener is bound to (this normally would
be the 'currentTarget').
</div>
<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"> 'delegate'</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the callback function to execute. This function
will be provided the event object for the delegated event.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
<<span property="yui:type">string|node</span>>
</code>
<span property="yui:description"> the element that is the delegation container</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">delegateType</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> the event type to delegate</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">spec</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> a selector that must match the target of the
event.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional argument that specifies what 'this' refers to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args*</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to pass on to the callback function.
These arguments will be added after the event object.</span>
</dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> use Y.delegate
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_focus">
<h4>
<a name="event_focus">focus</a></h4>
<div class="detail">
<code>
<strong property="yui:name">focus</strong>
(
type
,
fn
,
o
,
context
,
args
)
</code>
<div class="description" property="yui:description">
Adds a DOM focus listener. Uses the focusin event in IE,
DOMFocusIn for Opera and Webkit, and the capture phase for Gecko so that
the event propagates in a way that enables event delegation.
</div>
<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"> 'focus'</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the callback function to execute</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">string|HTMLElement|collection</span>>
</code>
<span property="yui:description"> the element(s) to bind</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional context object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to provide to the listener.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_key">
<h4>
<a name="event_key">key</a></h4>
<div class="detail">
<code>
<strong property="yui:name">key</strong>
(
type
,
fn
,
id
,
spec
,
o
,
args
)
</code>
<div class="description" property="yui:description">
Add a key listener. The listener will only be notified if the
keystroke detected meets the supplied specification. The
spec consists of the key event type, followed by a colon,
followed by zero or more comma separated key codes, followed
by zero or more modifiers delimited by a plus sign. Ex:
press:12,65+shift+ctrl
</div>
<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"> 'key'</span>
</dd>
<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>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
<<span property="yui:type">string|HTMLElement|collection</span>>
</code>
<span property="yui:description"> the element(s) to bind</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">spec</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> the keyCode and modifier specification</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional context object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to provide to the listener.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_mouseenter">
<h4>
<a name="event_mouseenter">mouseenter</a></h4>
<div class="detail">
<code>
<strong property="yui:name">mouseenter</strong>
(
type
,
fn
,
el
,
spec
)
</code>
<div class="description" property="yui:description">
Sets up a "mouseenter" listener—a listener that is called the first time
the user's mouse enters the specified element(s).
</div>
<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"> "mouseenter"</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> The method the event invokes.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
<<span property="yui:type">string|node</span>>
</code>
<span property="yui:description"> The element(s) to assign the listener to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">spec</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> Optional. String representing a selector that must
match the target of the event in order for the listener to be called.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_mouseleave">
<h4>
<a name="event_mouseleave">mouseleave</a></h4>
<div class="detail">
<code>
<strong property="yui:name">mouseleave</strong>
(
type
,
fn
,
el
,
spec
)
</code>
<div class="description" property="yui:description">
Sets up a "mouseleave" listener—a listener that is called the first time
the user's mouse leaves the specified element(s).
</div>
<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"> "mouseleave"</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> The method the event invokes.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
<<span property="yui:type">string|node</span>>
</code>
<span property="yui:description"> The element(s) to assign the listener to.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">spec</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> Optional. String representing a selector that must
match the target of the event in order for the listener to be called.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_mousewheel">
<h4>
<a name="event_mousewheel">mousewheel</a></h4>
<div class="detail">
<code>
<strong property="yui:name">mousewheel</strong>
(
type
,
fn
,
context
,
args
)
</code>
<div class="description" property="yui:description">
Mousewheel event. This listener is automatically attached to the
correct target, so one should not be supplied. Mouse wheel
direction and velocity is stored in the 'mouseDelta' field.
</div>
<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"> 'mousewheel'</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">fn</span>
<<span property="yui:type">function</span>>
</code>
<span property="yui:description"> the callback to execute</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">context</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> optional context object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> 0..n additional arguments to provide to the listener.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_windowresize">
<h4>
<a name="event_windowresize">windowresize</a></h4>
<div class="detail">
<code>
<strong property="yui:name">windowresize</strong>
(
)
</code>
<div class="description" property="yui:description">
Firefox fires the window resize event once when the resize action
finishes, other browsers fire the event periodically during the
resize. This code uses timeout logic to simulate the Firefox
behavior in other browsers.
</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_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</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=""><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-promote.html" title="queue-promote">queue-promote</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="selected"><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=""><a href="Array.html" title="Array">Array</a></li>
<li class=""><a href="config.html" title="config">config</a></li>
<li class=""><a href="Get.html" title="Get">Get</a></li>
<li class=""><a href="Lang.html" title="Lang">Lang</a></li>
<li class=""><a href="Object.html" title="Object">Object</a></li>
<li class=""><a href="Queue.html" title="Queue">Queue</a></li>
<li class=""><a href="UA.html" title="UA">UA</a></li>
<li class="selected"><a href="YUI.html" title="YUI">YUI</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="_module.js.html" title="_module.js">_module.js</a></li>
<li class=""><a href="get.js.html" title="get.js">get.js</a></li>
<li class=""><a href="queue-base.js.html" title="queue-base.js">queue-base.js</a></li>
<li class=""><a href="yui-array.js.html" title="yui-array.js">yui-array.js</a></li>
<li class=""><a href="yui-base.js.html" title="yui-base.js">yui-base.js</a></li>
<li class=""><a href="yui-core.js.html" title="yui-core.js">yui-core.js</a></li>
<li class=""><a href="yui-init.js.html" title="yui-init.js">yui-init.js</a></li>
<li class=""><a href="yui-lang.js.html" title="yui-lang.js">yui-lang.js</a></li>
<li class=""><a href="yui-later.js.html" title="yui-later.js">yui-later.js</a></li>
<li class=""><a href="yui-log.js.html" title="yui-log.js">yui-log.js</a></li>
<li class=""><a href="yui-object.js.html" title="yui-object.js">yui-object.js</a></li>
<li class=""><a href="yui-ua.js.html" title="yui-ua.js">yui-ua.js</a></li>
<li class=""><a href="yui.js.html" title="yui.js">yui.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_Global" title="Global">Global</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><a href="#method__init" title="_init">_init</a></li>
<li class="private"><a href="#method__setup" title="_setup">_setup</a></li>
<li class=""><a href="#method_add" title="add">add</a></li>
<li class=""><a href="#method_after" title="after">after</a></li>
<li class=""><a href="#method_applyTo" title="applyTo">applyTo</a></li>
<li class=""><a href="#method_cached" title="cached">cached</a></li>
<li class=""><a href="#method_delegate" title="delegate">delegate</a></li>
<li class=""><a href="#method_error" title="error">error</a></li>
<li class=""><a href="#method_guid" title="guid">guid</a></li>
<li class=""><a href="#method_later" title="later">later</a></li>
<li class=""><a href="#method_log" title="log">log</a></li>
<li class=""><a href="#method_merge" title="merge">merge</a></li>
<li class=""><a href="#method_message" title="message">message</a></li>
<li class=""><a href="#method_mix" title="mix">mix</a></li>
<li class=""><a href="#method_namespace" title="namespace">namespace</a></li>
<li class=""><a href="#method_Node.plug" title="Node.plug">Node.plug</a></li>
<li class=""><a href="#method_Node.unplug" title="Node.unplug">Node.unplug</a></li>
<li class=""><a href="#method_on" title="on">on</a></li>
<li class=""><a href="#method_simulate" title="simulate">simulate</a></li>
<li class=""><a href="#method_stamp" title="stamp">stamp</a></li>
<li class=""><a href="#method_use" title="use">use</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_available" title="available">available</a></li>
<li class=""><a href="#event_blur" title="blur">blur</a></li>
<li class=""><a href="#event_contentready" title="contentready">contentready</a></li>
<li class=" deprecated"><a href="#event_delegate" title="delegate">delegate</a></li>
<li class=""><a href="#event_focus" title="focus">focus</a></li>
<li class=""><a href="#event_key" title="key">key</a></li>
<li class=""><a href="#event_mouseenter" title="mouseenter">mouseenter</a></li>
<li class=""><a href="#event_mouseleave" title="mouseleave">mouseleave</a></li>
<li class=""><a href="#event_mousewheel" title="mousewheel">mousewheel</a></li>
<li class=""><a href="#event_windowresize" title="windowresize">windowresize</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": "Object", "name": "()", "url": "Object.html#method_()", "type": "method"}, {"access": "", "host": "YUI", "name": "add", "url": "YUI.html#method_add", "type": "method"}, {"access": "", "host": "YUI", "name": "after", "url": "YUI.html#method_after", "type": "method"}, {"access": "", "host": "YUI", "name": "applyTo", "url": "YUI.html#method_applyTo", "type": "method"}, {"access": "", "host": "YUI", "name": "available", "url": "YUI.html#event_available", "type": "event"}, {"access": "", "host": "YUI", "name": "blur", "url": "YUI.html#event_blur", "type": "event"}, {"access": "", "host": "YUI", "name": "cached", "url": "YUI.html#method_cached", "type": "method"}, {"access": "", "host": "YUI", "name": "contentready", "url": "YUI.html#event_contentready", "type": "event"}, {"access": "", "host": "YUI", "name": "delegate", "url": "YUI.html#method_delegate", "type": "method"}, {"access": "", "host": "YUI", "name": "delegate", "url": "YUI.html#event_delegate", "type": "event"}, {"access": "", "host": "Object", "name": "each", "url": "Object.html#method_each", "type": "method"}, {"access": "", "host": "YUI", "name": "error", "url": "YUI.html#method_error", "type": "method"}, {"access": "private", "host": "Object", "name": "_extract", "url": "Object.html#method__extract", "type": "method"}, {"access": "", "host": "YUI", "name": "focus", "url": "YUI.html#event_focus", "type": "event"}, {"access": "", "host": "Object", "name": "getValue", "url": "Object.html#method_getValue", "type": "method"}, {"access": "", "host": "YUI", "name": "Global", "url": "YUI.html#property_Global", "type": "property"}, {"access": "", "host": "YUI", "name": "guid", "url": "YUI.html#method_guid", "type": "method"}, {"access": "", "host": "Object", "name": "hasKey", "url": "Object.html#method_hasKey", "type": "method"}, {"access": "", "host": "Object", "name": "hasValue", "url": "Object.html#method_hasValue", "type": "method"}, {"access": "private", "host": "YUI", "name": "_init", "url": "YUI.html#method__init", "type": "method"}, {"access": "", "host": "YUI", "name": "key", "url": "YUI.html#event_key", "type": "event"}, {"access": "", "host": "Object", "name": "keys", "url": "Object.html#method_keys", "type": "method"}, {"access": "", "host": "YUI", "name": "later", "url": "YUI.html#method_later", "type": "method"}, {"access": "", "host": "YUI", "name": "log", "url": "YUI.html#method_log", "type": "method"}, {"access": "", "host": "YUI", "name": "merge", "url": "YUI.html#method_merge", "type": "method"}, {"access": "", "host": "YUI", "name": "message", "url": "YUI.html#method_message", "type": "method"}, {"access": "", "host": "YUI", "name": "mix", "url": "YUI.html#method_mix", "type": "method"}, {"access": "", "host": "YUI", "name": "mouseenter", "url": "YUI.html#event_mouseenter", "type": "event"}, {"access": "", "host": "YUI", "name": "mouseleave", "url": "YUI.html#event_mouseleave", "type": "event"}, {"access": "", "host": "YUI", "name": "mousewheel", "url": "YUI.html#event_mousewheel", "type": "event"}, {"access": "", "host": "YUI", "name": "namespace", "url": "YUI.html#method_namespace", "type": "method"}, {"access": "", "host": "YUI", "name": "Node.plug", "url": "YUI.html#method_Node.plug", "type": "method"}, {"access": "", "host": "YUI", "name": "Node.unplug", "url": "YUI.html#method_Node.unplug", "type": "method"}, {"access": "", "host": "YUI", "name": "on", "url": "YUI.html#method_on", "type": "method"}, {"access": "", "host": "Object", "name": "owns", "url": "Object.html#method_owns", "type": "method"}, {"access": "private", "host": "YUI", "name": "_setup", "url": "YUI.html#method__setup", "type": "method"}, {"access": "", "host": "Object", "name": "setValue", "url": "Object.html#method_setValue", "type": "method"}, {"access": "", "host": "YUI", "name": "simulate", "url": "YUI.html#method_simulate", "type": "method"}, {"access": "", "host": "Object", "name": "size", "url": "Object.html#method_size", "type": "method"}, {"access": "", "host": "YUI", "name": "stamp", "url": "YUI.html#method_stamp", "type": "method"}, {"access": "", "host": "YUI", "name": "use", "url": "YUI.html#method_use", "type": "method"}, {"access": "", "host": "Object", "name": "values", "url": "Object.html#method_values", "type": "method"}, {"access": "", "host": "YUI", "name": "windowresize", "url": "YUI.html#event_windowresize", "type": "event"}];
</script>
</body>
</html>