1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.EventObject</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.EventObject-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.EventObject-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.EventObject-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.EventObject-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_EventManager.js.html">Roo/EventManager.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">EventObject</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 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>
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.EventObject';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.EventObject.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.EventObject-configs"></a>
98 <table cellspacing="0" class="member-table">
99 <caption class="Empty">Config Options - Has None</caption>
113 <!-- ============================== public properties ==================== -->
117 <a id="Roo.EventObject-props"></a>
123 <table cellspacing="0" class="member-table">
124 <caption class="Empty">Public Properties - Has None</caption>
130 <!-- ============================== methods summary / details ======================== -->
133 <a id="Roo.EventObject-methods"></a>
134 <!-- constructor?? -->
141 <!-- then dynamics first -->
148 <table cellspacing="0" class="member-table">
149 <caption>Public Methods</caption>
151 <th class="sig-header" colspan="2">Method</th>
152 <th class="msource-header">Defined By</th>
162 <tr class="method-row config-row-alt0 expandable notInherited">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
167 <a id="Roo.EventObject-method-getCharCode" name=".getCharCode"></a>
168 <div class="fixedFont">
169 <span class="attributes">Roo.EventObject.</span><b class="itemname">getCharCode</b>
177 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
186 <div class="short">Gets the key code for the event.</div>
192 Gets the key code for the event.
203 <dl class="detailList">
204 <dt class="heading">Returns:</dt>
206 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
228 <tr class="method-row config-row-alt1 expandable notInherited">
229 <td class="micon"><a class="exi" href="#expand"> </a></td>
233 <a id="Roo.EventObject-method-getKey" name=".getKey"></a>
234 <div class="fixedFont">
235 <span class="attributes">Roo.EventObject.</span><b class="itemname">getKey</b>
243 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
252 <div class="short">Returns a normalized keyCode for the event.</div>
258 Returns a normalized keyCode for the event.
269 <dl class="detailList">
270 <dt class="heading">Returns:</dt>
272 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The key code</dd>
294 <tr class="method-row config-row-alt0 expandable notInherited">
295 <td class="micon"><a class="exi" href="#expand"> </a></td>
299 <a id="Roo.EventObject-method-getPageX" name=".getPageX"></a>
300 <div class="fixedFont">
301 <span class="attributes">Roo.EventObject.</span><b class="itemname">getPageX</b>
309 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
318 <div class="short">Gets the x coordinate of the event.</div>
324 Gets the x coordinate of the event.
335 <dl class="detailList">
336 <dt class="heading">Returns:</dt>
338 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
360 <tr class="method-row config-row-alt1 expandable notInherited">
361 <td class="micon"><a class="exi" href="#expand"> </a></td>
365 <a id="Roo.EventObject-method-getPageY" name=".getPageY"></a>
366 <div class="fixedFont">
367 <span class="attributes">Roo.EventObject.</span><b class="itemname">getPageY</b>
375 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
384 <div class="short">Gets the y coordinate of the event.</div>
390 Gets the y coordinate of the event.
401 <dl class="detailList">
402 <dt class="heading">Returns:</dt>
404 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
426 <tr class="method-row config-row-alt0 expandable notInherited">
427 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.EventObject-method-getRelatedTarget" name=".getRelatedTarget"></a>
432 <div class="fixedFont">
433 <span class="attributes">Roo.EventObject.</span><b class="itemname">getRelatedTarget</b>
441 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
450 <div class="short">Gets the related target.</div>
456 Gets the related target.
467 <dl class="detailList">
468 <dt class="heading">Returns:</dt>
470 <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> </dd>
492 <tr class="method-row config-row-alt1 expandable notInherited">
493 <td class="micon"><a class="exi" href="#expand"> </a></td>
497 <a id="Roo.EventObject-method-getTarget" name=".getTarget"></a>
498 <div class="fixedFont">
499 <span class="attributes">Roo.EventObject.</span><b class="itemname">getTarget</b>
501 (<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>)
516 <div class="short">Gets the target for the event.</div>
522 Gets the target for the event.
529 <dl class="detailList">
530 <dt class="heading">Parameters:</dt>
533 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>selector</b>
536 <dd>(optional) A simple selector to filter the target or look for an ancestor of the target</dd>
539 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/HTMLElement/Element</span> <b>maxDepth</b>
542 <dd>(optional) The max depth to<br/> search as a number or element (defaults to 10 || document.body)</dd>
545 <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>
548 <dd>(optional) True to return a Roo.Element object instead of DOM node</dd>
556 <dl class="detailList">
557 <dt class="heading">Returns:</dt>
559 <dd><span class="fixedFont">HTMLelement</span> </dd>
581 <tr class="method-row config-row-alt0 expandable notInherited">
582 <td class="micon"><a class="exi" href="#expand"> </a></td>
586 <a id="Roo.EventObject-method-getTime" name=".getTime"></a>
587 <div class="fixedFont">
588 <span class="attributes">Roo.EventObject.</span><b class="itemname">getTime</b>
596 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
605 <div class="short">Gets the time of the event.</div>
611 Gets the time of the event.
622 <dl class="detailList">
623 <dt class="heading">Returns:</dt>
625 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
647 <tr class="method-row config-row-alt1 expandable notInherited">
648 <td class="micon"><a class="exi" href="#expand"> </a></td>
652 <a id="Roo.EventObject-method-getWheelDelta" name=".getWheelDelta"></a>
653 <div class="fixedFont">
654 <span class="attributes">Roo.EventObject.</span><b class="itemname">getWheelDelta</b>
662 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
671 <div class="short">Normalizes mouse wheel delta across browsers</div>
677 Normalizes mouse wheel delta across browsers
688 <dl class="detailList">
689 <dt class="heading">Returns:</dt>
691 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The delta</dd>
713 <tr class="method-row config-row-alt0 expandable notInherited">
714 <td class="micon"><a class="exi" href="#expand"> </a></td>
718 <a id="Roo.EventObject-method-getXY" name=".getXY"></a>
719 <div class="fixedFont">
720 <span class="attributes">Roo.EventObject.</span><b class="itemname">getXY</b>
728 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
737 <div class="short">Gets the page coordinates of the event.</div>
743 Gets the page coordinates of the event.
754 <dl class="detailList">
755 <dt class="heading">Returns:</dt>
757 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> The xy values like [x, y]</dd>
779 <tr class="method-row config-row-alt1 expandable notInherited">
780 <td class="micon"><a class="exi" href="#expand"> </a></td>
784 <a id="Roo.EventObject-method-hasModifier" name=".hasModifier"></a>
785 <div class="fixedFont">
786 <span class="attributes">Roo.EventObject.</span><b class="itemname">hasModifier</b>
794 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
803 <div class="short">Returns true if the control, meta, shift or alt key was pressed during this event.</div>
809 Returns true if the control, meta, shift or alt key was pressed during this event.
820 <dl class="detailList">
821 <dt class="heading">Returns:</dt>
823 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
845 <tr class="method-row config-row-alt0 expandable notInherited">
846 <td class="micon"><a class="exi" href="#expand"> </a></td>
850 <a id="Roo.EventObject-method-preventDefault" name=".preventDefault"></a>
851 <div class="fixedFont">
852 <span class="attributes">Roo.EventObject.</span><b class="itemname">preventDefault</b>
861 <div class="short">Prevents the browsers default handling of the event.</div>
867 Prevents the browsers default handling of the event.
896 <tr class="method-row config-row-alt1 expandable notInherited">
897 <td class="micon"><a class="exi" href="#expand"> </a></td>
901 <a id="Roo.EventObject-method-stopEvent" name=".stopEvent"></a>
902 <div class="fixedFont">
903 <span class="attributes">Roo.EventObject.</span><b class="itemname">stopEvent</b>
912 <div class="short">Stop the event (preventDefault and stopPropagation)</div>
918 Stop the event (preventDefault and stopPropagation)
947 <tr class="method-row config-row-alt0 expandable notInherited">
948 <td class="micon"><a class="exi" href="#expand"> </a></td>
952 <a id="Roo.EventObject-method-stopPropagation" name=".stopPropagation"></a>
953 <div class="fixedFont">
954 <span class="attributes">Roo.EventObject.</span><b class="itemname">stopPropagation</b>
963 <div class="short">Cancels bubbling of the event.</div>
969 Cancels bubbling of the event.
998 <tr class="method-row config-row-alt1 expandable notInherited">
999 <td class="micon"><a class="exi" href="#expand"> </a></td>
1003 <a id="Roo.EventObject-method-within" name=".within"></a>
1004 <div class="fixedFont">
1005 <span class="attributes">Roo.EventObject.</span><b class="itemname">within</b>
1007 (<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>)
1013 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1022 <div class="short">Returns true if the target of this event equals el or is a child of el</div>
1028 Returns true if the target of this event equals el or is a child of el
1035 <dl class="detailList">
1036 <dt class="heading">Parameters:</dt>
1039 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1045 <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>
1048 <dd>(optional) true to test if the related target is within el instead of the target</dd>
1056 <dl class="detailList">
1057 <dt class="heading">Returns:</dt>
1059 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1073 <td class="msource">
1084 <!-- ============================== events summary / details ======================== -->
1087 <a id="Roo.EventObject-events"></a>
1093 <table cellspacing="0" class="member-table">
1094 <caption class="Empty">Events - Has None</caption>
1105 <!-- ============================== footer ================================= -->
1106 <div class="fineprint" style="clear:both">
1108 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Nov 10 2017 11:27:46 GMT+0800 (HKT)
1110 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>