- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.EventObject-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.EventObject-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.EventObject-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.EventObject"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.EventObject</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/EventManager.js" target="_blank">EventManager.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">EventObject</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- EventObject exposes the Yahoo! UI Event functionality directly on the object
-passed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code
-Example:
-<pre><code>function handleClick(e){ <i>// e is not a standard event object, it is a Ext.EventObject</i>
- e.preventDefault();
- <b>var</b> target = e.getTarget();
- ...
- }
- <b>var</b> myDiv = Ext.get(<em>"myDiv"</em>);
- myDiv.on(<em>"click"</em>, handleClick);
- <i>//or</i>
- Ext.EventManager.on(<em>"myDiv"</em>, <em>'click'</em>, handleClick);
- Ext.EventManager.addListener(<em>"myDiv"</em>, <em>'click'</em>, handleClick);</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i> </div>
-
- <div class="hr"></div>
- <a id="Ext.EventObject-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-A"></a>\r
- <b>A</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-ALT"></a>\r
- <b>ALT</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-B"></a>\r
- <b>B</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-BACKSPACE"></a>\r
- <b>BACKSPACE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-C"></a>\r
- <b>C</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-CAPS_LOCK"></a>\r
- <b>CAPS_LOCK</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-CONTEXT_MENU"></a>\r
- <b>CONTEXT_MENU</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-CTRL"></a>\r
- <b>CTRL</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-D"></a>\r
- <b>D</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-DELETE"></a>\r
- <b>DELETE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-DOWN"></a>\r
- <b>DOWN</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-E"></a>\r
- <b>E</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-EIGHT"></a>\r
- <b>EIGHT</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-END"></a>\r
- <b>END</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-ENTER"></a>\r
- <b>ENTER</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-ESC"></a>\r
- <b>ESC</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F"></a>\r
- <b>F</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F1"></a>\r
- <b>F1</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F10"></a>\r
- <b>F10</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F11"></a>\r
- <b>F11</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F12"></a>\r
- <b>F12</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F2"></a>\r
- <b>F2</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F3"></a>\r
- <b>F3</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F4"></a>\r
- <b>F4</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F5"></a>\r
- <b>F5</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F6"></a>\r
- <b>F6</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F7"></a>\r
- <b>F7</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F8"></a>\r
- <b>F8</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-F9"></a>\r
- <b>F9</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-FIVE"></a>\r
- <b>FIVE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-FOUR"></a>\r
- <b>FOUR</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-G"></a>\r
- <b>G</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-H"></a>\r
- <b>H</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-HOME"></a>\r
- <b>HOME</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-I"></a>\r
- <b>I</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-INSERT"></a>\r
- <b>INSERT</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-J"></a>\r
- <b>J</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-K"></a>\r
- <b>K</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-L"></a>\r
- <b>L</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-LEFT"></a>\r
- <b>LEFT</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-M"></a>\r
- <b>M</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-N"></a>\r
- <b>N</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NINE"></a>\r
- <b>NINE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_CENTER"></a>\r
- <b>NUM_CENTER</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_DIVISION"></a>\r
- <b>NUM_DIVISION</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_EIGHT"></a>\r
- <b>NUM_EIGHT</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_FIVE"></a>\r
- <b>NUM_FIVE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_FOUR"></a>\r
- <b>NUM_FOUR</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_MINUS"></a>\r
- <b>NUM_MINUS</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_MULTIPLY"></a>\r
- <b>NUM_MULTIPLY</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_NINE"></a>\r
- <b>NUM_NINE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_ONE"></a>\r
- <b>NUM_ONE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_PERIOD"></a>\r
- <b>NUM_PERIOD</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_PLUS"></a>\r
- <b>NUM_PLUS</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_SEVEN"></a>\r
- <b>NUM_SEVEN</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_SIX"></a>\r
- <b>NUM_SIX</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_THREE"></a>\r
- <b>NUM_THREE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_TWO"></a>\r
- <b>NUM_TWO</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-NUM_ZERO"></a>\r
- <b>NUM_ZERO</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-O"></a>\r
- <b>O</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-ONE"></a>\r
- <b>ONE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-P"></a>\r
- <b>P</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-PAGE_DOWN"></a>\r
- <b>PAGE_DOWN</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-PAGE_UP"></a>\r
- <b>PAGE_UP</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-PAUSE"></a>\r
- <b>PAUSE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-PRINT_SCREEN"></a>\r
- <b>PRINT_SCREEN</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-Q"></a>\r
- <b>Q</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-R"></a>\r
- <b>R</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-RETURN"></a>\r
- <b>RETURN</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-RIGHT"></a>\r
- <b>RIGHT</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-S"></a>\r
- <b>S</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-SEVEN"></a>\r
- <b>SEVEN</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-SHIFT"></a>\r
- <b>SHIFT</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-SIX"></a>\r
- <b>SIX</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-SPACE"></a>\r
- <b>SPACE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-T"></a>\r
- <b>T</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-TAB"></a>\r
- <b>TAB</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-THREE"></a>\r
- <b>THREE</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-TWO"></a>\r
- <b>TWO</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-U"></a>\r
- <b>U</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-UP"></a>\r
- <b>UP</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-V"></a>\r
- <b>V</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-W"></a>\r
- <b>W</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-X"></a>\r
- <b>X</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-Y"></a>\r
- <b>Y</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-Z"></a>\r
- <b>Z</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-ZERO"></a>\r
- <b>ZERO</b> : Number <div class="mdesc">\r
- Key constant </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-altKey"></a>\r
- <b>altKey</b> : Object <div class="mdesc">\r
- True if the alt key was down during the event </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-browserEvent"></a>\r
- <b>browserEvent</b> : Object <div class="mdesc">\r
- The normal browser event </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-button"></a>\r
- <b>button</b> : Object <div class="mdesc">\r
- The button pressed in a mouse event </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-ctrlKey"></a>\r
- <b>ctrlKey</b> : Object <div class="mdesc">\r
- True if the control key was down during the event </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-shiftKey"></a>\r
- <b>shiftKey</b> : Object <div class="mdesc">\r
- True if the shift key was down during the event </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- </table>
- <a id="Ext.EventObject-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getCharCode"></a>\r
- <b>getCharCode</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the character code for the event.</div>\r
- <div class="long">\r
- Gets the character code for the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getKey"></a>\r
- <b>getKey</b>() : Number <div class="mdesc">\r
- <div class="short">Returns a normalized keyCode for the event.</div>\r
- <div class="long">\r
- Returns a normalized keyCode for the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The key code</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getPageX"></a>\r
- <b>getPageX</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the x coordinate of the event.</div>\r
- <div class="long">\r
- Gets the x coordinate of the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getPageY"></a>\r
- <b>getPageY</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the y coordinate of the event.</div>\r
- <div class="long">\r
- Gets the y coordinate of the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getRelatedTarget"></a>\r
- <b>getRelatedTarget</b>() : HTMLElement <div class="mdesc">\r
- <div class="short">Gets the related target.</div>\r
- <div class="long">\r
- Gets the related target. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getTarget"></a>\r
- <b>getTarget</b>( <span class="optional" title="Optional">[<code>String selector</code>]</span>, <span class="optional" title="Optional">[<code>Number/Mixed maxDepth</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span> ) : HTMLelement <div class="mdesc">\r
- <div class="short">Gets the target for the event.</div>\r
- <div class="long">\r
- Gets the target for the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">(optional) A simple selector to filter the target or look for an ancestor of the target</div></li><li><code>maxDepth</code> : Number/Mixed<div class="sub-desc">(optional) The max depth to\r
- search as a number or element (defaults to 10 || document.body)</div></li><li><code>returnEl</code> : Boolean<div class="sub-desc">(optional) True to return a Ext.Element object instead of DOM node</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLelement</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getTime"></a>\r
- <b>getTime</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the time of the event.</div>\r
- <div class="long">\r
- Gets the time of the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getWheelDelta"></a>\r
- <b>getWheelDelta</b>() : Number <div class="mdesc">\r
- <div class="short">Normalizes mouse wheel delta across browsers</div>\r
- <div class="long">\r
- Normalizes mouse wheel delta across browsers <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The delta</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-getXY"></a>\r
- <b>getXY</b>() : Array <div class="mdesc">\r
- <div class="short">Gets the page coordinates of the event.</div>\r
- <div class="long">\r
- Gets the page coordinates of the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">The xy values like [x, y]</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-hasModifier"></a>\r
- <b>hasModifier</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the control, meta, shift or alt key was pressed during this event.</div>\r
- <div class="long">\r
- Returns true if the control, meta, shift or alt key was pressed during this event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-preventDefault"></a>\r
- <b>preventDefault</b>() : void <div class="mdesc">\r
- <div class="short">Prevents the browsers default handling of the event.</div>\r
- <div class="long">\r
- Prevents the browsers default handling of the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-stopEvent"></a>\r
- <b>stopEvent</b>() : void <div class="mdesc">\r
- <div class="short">Stop the event (preventDefault and stopPropagation)</div>\r
- <div class="long">\r
- Stop the event (preventDefault and stopPropagation) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-stopPropagation"></a>\r
- <b>stopPropagation</b>() : void <div class="mdesc">\r
- <div class="short">Cancels bubbling of the event.</div>\r
- <div class="long">\r
- Cancels bubbling of the event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventObject-within"></a>\r
- <b>within</b>( <code>Mixed el</code>, <span class="optional" title="Optional">[<code>Boolean related</code>]</span>, <code>Boolean allowEl</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the target of this event is a child of el. Unless the allowEl parameter is set, it will return false...</div>\r
- <div class="long">\r
- Returns true if the target of this event is a child of el. Unless the allowEl parameter is set, it will return false if if the target is el.
-Example usage:<pre><code><i>// Handle click on any child of an element</i>
-Ext.getBody().on(<em>'click'</em>, <b>function</b>(e){
- <b>if</b>(e.within(<em>'some-el'</em>)){
- alert(<em>'Clicked on a child of some-el!'</em>);
- }
-});
-
-<i>// Handle click directly on an element, ignoring clicks on child nodes</i>
-Ext.getBody().on(<em>'click'</em>, <b>function</b>(e,t){
- <b>if</b>((t.id == <em>'some-el'</em>) && !e.within(t, true)){
- alert(<em>'Clicked directly on some-el!'</em>);
- }
-});</code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The id, DOM element or Ext.Element to check</div></li><li><code>related</code> : Boolean<div class="sub-desc">(optional) true to test if the related target is within el instead of the target</div></li><li><code>allowEl</code> : Boolean<div class="sub-desc">{optional} true to also check if the passed element is the target or related target</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventObject</td>\r
- </tr>\r
- </table>
- <a id="Ext.EventObject-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/EventManager.html#cls-Ext.EventObject">Ext.EventObject</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">EventManager.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/EventManager.html#cls-Ext.EventObject">EventObject</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Just as <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> wraps around a native DOM node, Ext.EventObject\r
+wraps the browser's native event-object normalizing cross-browser differences,\r
+such as which mouse button is clicked, keys pressed, mechanisms to stop\r
+event-propagation along with a method to prevent default actions from taking place.\r
+<p>For example:</p>\r
+<pre><code><b>function</b> handleClick(e, t){ <i>// e is not a standard event object, it is a Ext.EventObject\r</i>
+ e.preventDefault();\r
+ <b>var</b> target = e.getTarget(); <i>// same as t (the target HTMLElement)\r</i>
+ ...\r
+}\r
+<b>var</b> myDiv = <a href="output/Ext.html#Ext-get" ext:member="get" ext:cls="Ext">Ext.get</a>(<em>"myDiv"</em>); <i>// get reference to an <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a>\r</i>
+myDiv.on( <i>// <em>'on'</em> is shorthand <b>for</b> addListener\r</i>
+ <em>"click"</em>, <i>// perform an action on click of myDiv\r</i>
+ handleClick <i>// reference to the action handler\r</i>
+);\r
+<i>// other methods to <b>do</b> the same:\r</i>
+Ext.EventManager.on(<em>"myDiv"</em>, <em>'click'</em>, handleClick);\r
+Ext.EventManager.addListener(<em>"myDiv"</em>, <em>'click'</em>, handleClick);</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.EventObject-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.EventObject-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getCharCode"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getCharCode">getCharCode</a></b>()\r
+ :\r
+ Number<div class="mdesc"><div class="short">Gets the character code for the event.</div><div class="long">Gets the character code for the event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getKey"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getKey">getKey</a></b>()\r
+ :\r
+ Number<div class="mdesc"><div class="short">Returns a normalized keyCode for the event.</div><div class="long">Returns a normalized keyCode for the event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The key code</div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getPageX"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getPageX">getPageX</a></b>()\r
+ :\r
+ Number<div class="mdesc"><div class="short">Gets the x coordinate of the event.</div><div class="long">Gets the x coordinate of the event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getPageY"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getPageY">getPageY</a></b>()\r
+ :\r
+ Number<div class="mdesc"><div class="short">Gets the y coordinate of the event.</div><div class="long">Gets the y coordinate of the event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getRelatedTarget"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getRelatedTarget">getRelatedTarget</a></b>()\r
+ :\r
+ HTMLElement<div class="mdesc"><div class="short">Gets the related target.</div><div class="long">Gets the related target.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>HTMLElement</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getTarget"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getTarget">getTarget</a></b>( <span title="Optional" class="optional">[<code>String selector</code>]</span>, <span title="Optional" class="optional">[<code>Number/Mixed maxDepth</code>]</span>, <span title="Optional" class="optional">[<code>Boolean returnEl</code>]</span> )\r
+ :\r
+ HTMLelement<div class="mdesc"><div class="short">Gets the target for the event.</div><div class="long">Gets the target for the event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String<div class="sub-desc">(optional) A simple selector to filter the target or look for an ancestor of the target</div></li><li><code>maxDepth</code> : Number/Mixed<div class="sub-desc">(optional) The max depth to\r
+ search as a number or element (defaults to 10 || document.body)</div></li><li><code>returnEl</code> : Boolean<div class="sub-desc">(optional) True to return a Ext.Element object instead of DOM node</div></li></ul><strong>Returns:</strong><ul><li><code>HTMLelement</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getWheelDelta"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getWheelDelta">getWheelDelta</a></b>()\r
+ :\r
+ Number<div class="mdesc"><div class="short">Normalizes mouse wheel delta across browsers</div><div class="long">Normalizes mouse wheel delta across browsers<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The delta</div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-getXY"></a><b><a href="source/EventManager.html#method-Ext.EventObject-getXY">getXY</a></b>()\r
+ :\r
+ Array<div class="mdesc"><div class="short">Gets the page coordinates of the event.</div><div class="long">Gets the page coordinates of the event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The xy values like [x, y]</div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-preventDefault"></a><b><a href="source/EventManager.html#method-Ext.EventObject-preventDefault">preventDefault</a></b>()\r
+ :\r
+ void<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 class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-stopEvent"></a><b><a href="source/EventManager.html#method-Ext.EventObject-stopEvent">stopEvent</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Stop the event (preventDefault and stopPropagation)</div><div class="long">Stop the event (preventDefault and stopPropagation)<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-stopPropagation"></a><b><a href="source/EventManager.html#method-Ext.EventObject-stopPropagation">stopPropagation</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Cancels bubbling of the event.</div><div class="long">Cancels bubbling of the event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventObject</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventObject-within"></a><b><a href="source/EventManager.html#method-Ext.EventObject-within">within</a></b>( <code>Mixed el</code>, <span title="Optional" class="optional">[<code>Boolean related</code>]</span>, <code>Boolean allowEl</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the target of this event is a child of el. Unless the allowEl parameter is set, it will return false...</div><div class="long">Returns true if the target of this event is a child of el. Unless the allowEl parameter is set, it will return false if if the target is el.\r
+Example usage:<pre><code><i>// Handle click on any child of an element\r</i>
+ Ext.getBody().on(<em>'click'</em>, <b>function</b>(e){\r
+ <b>if</b>(e.within(<em>'some-el'</em>)){\r
+ alert(<em>'Clicked on a child of some-el!'</em>);\r
+ }\r
+ });\r
+\r
+ <i>// Handle click directly on an element, ignoring clicks on child nodes\r</i>
+ Ext.getBody().on(<em>'click'</em>, <b>function</b>(e,t){\r
+ <b>if</b>((t.id == <em>'some-el'</em>) && !e.within(t, true)){\r
+ alert(<em>'Clicked directly on some-el!'</em>);\r
+ }\r
+ });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : Mixed<div class="sub-desc">The id, DOM element or Ext.Element to check</div></li><li><code>related</code> : Boolean<div class="sub-desc">(optional) true to test if the related target is within el instead of the target</div></li><li><code>allowEl</code> : Boolean<div class="sub-desc">{optional} true to also check if the passed element is the target or related target</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">EventObject</td></tr></tbody></table><a id="Ext.EventObject-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff