Event.Facade.html revision 4fcbec6145d16637205990699912fb90f6a3807c
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: event Event.Facade (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>event&nbsp; <span class="subtitle">3.00PR1</span></h3>
<p>
<a href="/index.html">Yahoo! UI Library</a>
&gt; <a href="/module_event.html">event</a>
&gt; Event.Facade
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>Event.Facade</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
Wraps a DOM event, properties requiring browser abstraction are
fixed here. Provids a security layer when required.
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="">
<h4><a name="property_button">button</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The button that was pushed.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_charCode">charCode</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The charCode for key events. Same as keyCode
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_currentTarget">currentTarget</a>
<code>- Node</code>
</h4>
<div class="detail">
<div class="description">
Node reference for the element that the listener was attached to.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_details">details</a>
<code>- Array</code>
</h4>
<div class="detail">
<div class="description">
The event details. Currently supported for Custom
Events only, where it contains the arguments that
were passed to fire().
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_keyCode">keyCode</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The keyCode for key events. Uses charCode if keyCode is not available
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_pageX">pageX</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The X location of the event on the page (including scroll)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_pageY">pageY</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The Y location of the event on the page (including scroll)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_relatedTarget">relatedTarget</a>
<code>- Node</code>
</h4>
<div class="detail">
<div class="description">
Node reference to the relatedTarget
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_target">target</a>
<code>- Node</code>
</h4>
<div class="detail">
<div class="description">
Node reference for the targeted element
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_time">time</a>
<code>- Date</code>
</h4>
<div class="detail">
<div class="description">
Timestamp for the event
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_which">which</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The button that was pushed. Same as button.
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="">
<h4>
<a name="method_halt">halt</a></h4>
<div class="detail">
<code>
void
<strong>halt</strong>
(
immediate
)
</code>
<div class="description">
Stops the event propagation and prevents the default
event behavior.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>immediate &lt;boolean&gt;</code>
if true additional listeners
on the current target will not be executed
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_preventDefault">preventDefault</a></h4>
<div class="detail">
<code>
void
<strong>preventDefault</strong>
(
)
</code>
<div class="description">
Prevents the event's default behavior
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_stopImmediatePropagation">stopImmediatePropagation</a></h4>
<div class="detail">
<code>
void
<strong>stopImmediatePropagation</strong>
(
)
</code>
<div class="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>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_stopPropagation">stopPropagation</a></h4>
<div class="detail">
<code>
void
<strong>stopPropagation</strong>
(
)
</code>
<div class="description">
Stops the propagation to the next bubble target
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html">anim</a></li>
<li class=""><a href="module_attribute.html">attribute</a></li>
<li class=""><a href="module_base.html">base</a></li>
<li class=""><a href="module_dd.html">dd</a></li>
<li class=""><a href="module_dd-plugin.html">dd-plugin</a></li>
<li class=""><a href="module_dump.html">dump</a></li>
<li class="selected"><a href="module_event.html">event</a></li>
<li class=""><a href="module_io.html">io</a></li>
<li class=""><a href="module_node.html">node</a></li>
<li class=""><a href="module_oop.html">oop</a></li>
<li class=""><a href="module_queue.html">queue</a></li>
<li class=""><a href="module_substitute.html">substitute</a></li>
<li class=""><a href="module_yui.html">yui</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="Do.html">Do</a></li>
<li class=""><a href="Do.AlterArgs.html">Do.AlterArgs</a></li>
<li class=""><a href="Do.AlterReturn.html">Do.AlterReturn</a></li>
<li class=""><a href="Do.Error.html">Do.Error</a></li>
<li class=""><a href="Do.Method.html">Do.Method</a></li>
<li class=""><a href="Event.html">Event</a></li>
<li class=""><a href="Event.Custom.html">Event.Custom</a></li>
<li class="selected"><a href="Event.Facade.html">Event.Facade</a></li>
<li class=""><a href="Event.Handle.html">Event.Handle</a></li>
<li class=""><a href="Event.Subscriber.html">Event.Subscriber</a></li>
<li class=""><a href="Event.Target.html">Event.Target</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="event-custom.js.html">event-custom.js</a></li>
<li class=""><a href="event-do.js.html">event-do.js</a></li>
<li class=""><a href="event-dom.js.html">event-dom.js</a></li>
<li class=""><a href="event-facade.js.html">event-facade.js</a></li>
<li class=""><a href="event-ready.js.html">event-ready.js</a></li>
<li class=""><a href="event-target.js.html">event-target.js</a></li>
<li class=""><a href="event.js.html">event.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_button">button</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_charCode">charCode</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_currentTarget">currentTarget</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_details">details</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_keyCode">keyCode</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_pageX">pageX</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_pageY">pageY</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_relatedTarget">relatedTarget</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_target">target</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_time">time</a>
<!--<code>&lt;int&gt;</code>-->
</li>
<li class=""><a href="#property_which">which</a>
<!--<code>&lt;int&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><!--<code>void</code>-->
<a href="#method_halt">halt</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_preventDefault">preventDefault</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_stopImmediatePropagation">stopImmediatePropagation</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_stopPropagation">stopPropagation</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>