<!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 DOMEventFacade (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 <span class="subtitle">3.0.0b1</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_event.html" title="event">event</a>
> DOMEventFacade
<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">DOMEventFacade</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
Wraps a DOM event, properties requiring browser abstraction are
fixed here. Provids a security layer when required.
</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_button">
<h4><a name="property_button" property="yui:name">button</a>
- <code><span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The button that was pushed.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_charCode">
<h4><a name="property_charCode" property="yui:name">charCode</a>
- <code><span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The charCode for key events. Same as keyCode
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_currentTarget">
<h4><a name="property_currentTarget" property="yui:name">currentTarget</a>
- <code><span property="yui:type">Node</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Node reference for the element that the listener was attached to.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_keyCode">
<h4><a name="property_keyCode" property="yui:name">keyCode</a>
- <code><span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The keyCode for key events. Uses charCode if keyCode is not available
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_pageX">
<h4><a name="property_pageX" property="yui:name">pageX</a>
- <code><span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The X location of the event on the page (including scroll)
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_pageY">
<h4><a name="property_pageY" property="yui:name">pageY</a>
- <code><span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The Y location of the event on the page (including scroll)
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_relatedTarget">
<h4><a name="property_relatedTarget" property="yui:name">relatedTarget</a>
- <code><span property="yui:type">Node</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Node reference to the relatedTarget
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_target">
<h4><a name="property_target" property="yui:name">target</a>
- <code><span property="yui:type">Node</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Node reference for the targeted element
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_webkitKeymap">
<h4><a name="property_webkitKeymap" property="yui:name">webkitKeymap</a>
- <code>private <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
webkit key remapping required for Safari < 3.1
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_which">
<h4><a name="property_which" property="yui:name">which</a>
- <code><span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The button that was pushed. Same as button.
</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="" rel="yui:method" resource="#method_halt">
<h4>
<a name="method_halt">halt</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">halt</strong>
(
immediate
)
</code>
<div class="description" property="yui:description">
Stops the event propagation and prevents the default
event behavior.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">immediate</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> if true additional listeners
on the current target will not be executed</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_preventDefault">
<h4>
<a name="method_preventDefault">preventDefault</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">preventDefault</strong>
(
)
</code>
<div class="description" property="yui:description">
Prevents the event's default behavior
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_resolve">
<h4>
<a name="method_resolve">resolve</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">resolve</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns a wrapped node. Intended to be used on event targets,
so it will return the node's parent if the target is a text
node
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_stopImmediatePropagation">
<h4>
<a name="method_stopImmediatePropagation">stopImmediatePropagation</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">stopImmediatePropagation</strong>
(
)
</code>
<div class="description" property="yui:description">
Stops the propagation to the next bubble target and
prevents any additional listeners from being exectued
on the current target.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_stopPropagation">
<h4>
<a name="method_stopPropagation">stopPropagation</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">stopPropagation</strong>
(
)
</code>
<div class="description" property="yui:description">
Stops the propagation to the next bubble target
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
</div>
<div rel="yui:attributes" resource="#configattributes">
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class="selected"><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.html" title="queue">queue</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="DOMEventFacade.html" title="DOMEventFacade">DOMEventFacade</a></li>
<li class=""><a href="Event.html" title="Event">Event</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="available.js.html" title="available.js">available.js</a></li>
<li class=""><a href="delegate.js.html" title="delegate.js">delegate.js</a></li>
<li class=""><a href="event-dom.js.html" title="event-dom.js">event-dom.js</a></li>
<li class=""><a href="event-facade-dom.js.html" title="event-facade-dom.js">event-facade-dom.js</a></li>
<li class=""><a href="event-ready-base.js.html" title="event-ready-base.js">event-ready-base.js</a></li>
<li class=""><a href="event-ready.js.html" title="event-ready.js">event-ready.js</a></li>
<li class=""><a href="focusblur.js.html" title="focusblur.js">focusblur.js</a></li>
<li class=""><a href="key.js.html" title="key.js">key.js</a></li>
<li class=""><a href="mouseentermouseleave.js.html" title="mouseentermouseleave.js">mouseentermouseleave.js</a></li>
<li class=""><a href="resize-window.js.html" title="resize-window.js">resize-window.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_button" title="button">button</a></li>
<li class=""><a href="#property_charCode" title="charCode">charCode</a></li>
<li class=""><a href="#property_currentTarget" title="currentTarget">currentTarget</a></li>
<li class=""><a href="#property_keyCode" title="keyCode">keyCode</a></li>
<li class=""><a href="#property_pageX" title="pageX">pageX</a></li>
<li class=""><a href="#property_pageY" title="pageY">pageY</a></li>
<li class=""><a href="#property_relatedTarget" title="relatedTarget">relatedTarget</a></li>
<li class=""><a href="#property_target" title="target">target</a></li>
<li class="private"><a href="#property_webkitKeymap" title="webkitKeymap">webkitKeymap</a></li>
<li class=""><a href="#property_which" title="which">which</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><a href="#method_halt" title="halt">halt</a></li>
<li class=""><a href="#method_preventDefault" title="preventDefault">preventDefault</a></li>
<li class="private"><a href="#method_resolve" title="resolve">resolve</a></li>
<li class=""><a href="#method_stopImmediatePropagation" title="stopImmediatePropagation">stopImmediatePropagation</a></li>
<li class=""><a href="#method_stopPropagation" title="stopPropagation">stopPropagation</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": "Event", "name": "attach", "url": "Event.html#method_attach", "type": "method"}, {"access": "private", "host": "Event", "name": "_avail", "url": "Event.html#property__avail", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "button", "url": "DOMEventFacade.html#property_button", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "charCode", "url": "DOMEventFacade.html#property_charCode", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "currentTarget", "url": "DOMEventFacade.html#property_currentTarget", "type": "property"}, {"access": "", "host": "Event", "name": "detach", "url": "Event.html#method_detach", "type": "method"}, {"access": "", "host": "Event", "name": "DOMReady", "url": "Event.html#property_DOMReady", "type": "property"}, {"access": "private", "host": "Event", "name": "_dri", "url": "Event.html#property__dri", "type": "property"}, {"access": "private", "host": "Event", "name": "_el_events", "url": "Event.html#property__el_events", "type": "property"}, {"access": "", "host": "Event", "name": "generateId", "url": "Event.html#method_generateId", "type": "method"}, {"access": "", "host": "Event", "name": "getEvent", "url": "Event.html#method_getEvent", "type": "method"}, {"access": "", "host": "Event", "name": "getListeners", "url": "Event.html#method_getListeners", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "halt", "url": "DOMEventFacade.html#method_halt", "type": "method"}, {"access": "private", "host": "Event", "name": "_interval", "url": "Event.html#property__interval", "type": "property"}, {"access": "private", "host": "Event", "name": "_isValidCollection", "url": "Event.html#method__isValidCollection", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "keyCode", "url": "DOMEventFacade.html#property_keyCode", "type": "property"}, {"access": "", "host": "Event", "name": "lastError", "url": "Event.html#property_lastError", "type": "property"}, {"access": "private", "host": "Event", "name": "_load", "url": "Event.html#method__load", "type": "method"}, {"access": "private", "host": "Event", "name": "_loadComplete", "url": "Event.html#property__loadComplete", "type": "property"}, {"access": "private", "host": "Event", "name": "nativeAdd", "url": "Event.html#method_nativeAdd", "type": "method"}, {"access": "private", "host": "Event", "name": "nativeRemove", "url": "Event.html#method_nativeRemove", "type": "method"}, {"access": "", "host": "Event", "name": "onAvailable", "url": "Event.html#method_onAvailable", "type": "method"}, {"access": "", "host": "Event", "name": "onContentReady", "url": "Event.html#method_onContentReady", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "pageX", "url": "DOMEventFacade.html#property_pageX", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "pageY", "url": "DOMEventFacade.html#property_pageY", "type": "property"}, {"access": "private", "host": "Event", "name": "_poll", "url": "Event.html#method__poll", "type": "method"}, {"access": "", "host": "Event", "name": "POLL_INTERVAL", "url": "Event.html#property_POLL_INTERVAL", "type": "property"}, {"access": "", "host": "Event", "name": "POLL_RETRYS", "url": "Event.html#property_POLL_RETRYS", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "preventDefault", "url": "DOMEventFacade.html#method_preventDefault", "type": "method"}, {"access": "", "host": "Event", "name": "purgeElement", "url": "Event.html#method_purgeElement", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "relatedTarget", "url": "DOMEventFacade.html#property_relatedTarget", "type": "property"}, {"access": "private", "host": "DOMEventFacade", "name": "resolve", "url": "DOMEventFacade.html#method_resolve", "type": "method"}, {"access": "private", "host": "Event", "name": "_retryCount", "url": "Event.html#property__retryCount", "type": "property"}, {"access": "private", "host": "Event", "name": "startInterval", "url": "Event.html#method_startInterval", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "stopImmediatePropagation", "url": "DOMEventFacade.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "stopPropagation", "url": "DOMEventFacade.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "target", "url": "DOMEventFacade.html#property_target", "type": "property"}, {"access": "private", "host": "Event", "name": "_unload", "url": "Event.html#method__unload", "type": "method"}, {"access": "private", "host": "DOMEventFacade", "name": "webkitKeymap", "url": "DOMEventFacade.html#property_webkitKeymap", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "which", "url": "DOMEventFacade.html#property_which", "type": "property"}, {"access": "private", "host": "Event", "name": "_wrappers", "url": "Event.html#property__wrappers", "type": "property"}];
</script>
</body>
</html>