--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.EventObject</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.EventObject-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.EventObject-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.EventObject-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.EventObject-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.EventObject
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_EventManager.js.html">Roo/EventManager.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">EventObject</td></tr>
+
+
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ EventObject exposes the Yahoo! UI Event functionality directly on the object<br/>passed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code <br/>Example:<br/><pre><code><br/> function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject<br/> e.preventDefault();<br/> var target = e.getTarget();<br/> ...<br/> }<br/> var myDiv = Roo.get("myDiv");<br/> myDiv.on("click", handleClick);<br/> //or<br/> Roo.EventManager.on("myDiv", 'click', handleClick);<br/> Roo.EventManager.addListener("myDiv", 'click', handleClick);<br/> </code></pre>
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.EventObject';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.EventObject.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.EventObject-configs"></a>
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Config Options - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.EventObject-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.EventObject-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getCharCode" name=".getCharCode"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getCharCode</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the key code for the event.</div>
+
+
+
+ <div class="long">
+
+ Gets the key code for the event.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getKey" name=".getKey"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getKey</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns a normalized keyCode for the event.</div>
+
+
+
+ <div class="long">
+
+ Returns a normalized keyCode for the event.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The key code</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getPageX" name=".getPageX"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getPageX</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the x coordinate of the event.</div>
+
+
+
+ <div class="long">
+
+ Gets the x coordinate of the event.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getPageY" name=".getPageY"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getPageY</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the y coordinate of the event.</div>
+
+
+
+ <div class="long">
+
+ Gets the y coordinate of the event.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getRelatedTarget" name=".getRelatedTarget"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getRelatedTarget</b>
+
+ ()
+
+
+ :
+
+
+ <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the related target.</div>
+
+
+
+ <div class="long">
+
+ Gets the related target.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getTarget" name=".getTarget"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getTarget</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>selector</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/HTMLElement/Element <B><i>maxDepth</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>returnEl</i></B>)
+
+
+ :
+
+
+ HTMLelement
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the target for the event.</div>
+
+
+
+ <div class="long">
+
+ Gets the target for the event.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>selector</b>
+
+ </dt>
+ <dd>(optional) A simple selector to filter the target or look for an ancestor of the target</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/HTMLElement/Element</span> <b>maxDepth</b>
+
+ </dt>
+ <dd>(optional) The max depth to<br/> search as a number or element (defaults to 10 || document.body)</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>returnEl</b>
+
+ </dt>
+ <dd>(optional) True to return a Roo.Element object instead of DOM node</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">HTMLelement</span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getTime" name=".getTime"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getTime</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the time of the event.</div>
+
+
+
+ <div class="long">
+
+ Gets the time of the event.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getWheelDelta" name=".getWheelDelta"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getWheelDelta</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Normalizes mouse wheel delta across browsers</div>
+
+
+
+ <div class="long">
+
+ Normalizes mouse wheel delta across browsers
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The delta</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-getXY" name=".getXY"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">getXY</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the page coordinates of the event.</div>
+
+
+
+ <div class="long">
+
+ Gets the page coordinates of the event.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> The xy values like [x, y]</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-hasModifier" name=".hasModifier"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">hasModifier</b>
+
+ ()
+
+
+ :
+
+
+ <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns true if the control, meta, shift or alt key was pressed during this event.</div>
+
+
+
+ <div class="long">
+
+ Returns true if the control, meta, shift or alt key was pressed during this event.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-preventDefault" name=".preventDefault"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">preventDefault</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Prevents the browsers default handling of the event.</div>
+
+
+
+ <div class="long">
+
+ Prevents the browsers default handling of the event.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-stopEvent" name=".stopEvent"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">stopEvent</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Stop the event (preventDefault and stopPropagation)</div>
+
+
+
+ <div class="long">
+
+ Stop the event (preventDefault and stopPropagation)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-stopPropagation" name=".stopPropagation"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">stopPropagation</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Cancels bubbling of the event.</div>
+
+
+
+ <div class="long">
+
+ Cancels bubbling of the event.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.EventObject-method-within" name=".within"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.EventObject.</span><b class="itemname">within</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>related</i></B>)
+
+
+ :
+
+
+ <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns true if the target of this event equals el or is a child of el</div>
+
+
+
+ <div class="long">
+
+ Returns true if the target of this event equals el or is a child of el
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>related</b>
+
+ </dt>
+ <dd>(optional) true to test if the related target is within el instead of the target</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.EventObject
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.EventObject-events"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Events - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>
projects / roojs1 / blobdiff