git.roojs.org Git - roojs1/blob - docs/symbols/Roo.EventObject.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.EventObject</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.EventObject
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_EventManager.js.html">Roo/EventManager.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">EventObject</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  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>
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  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>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.EventObject.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.EventObject-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.EventObject-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.EventObject-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 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>
 170
 171                                  ()
 172
 173
 174                                          :
 175
 176
 177                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 178
 179
 180
 181
 182
 183                 </div>
 184                 <div class="mdesc">
 185
 186                    <div class="short">Gets the key code for the event.</div>
 187
 188
 189
 190                     <div class="long">
 191
 192                                 Gets the key code for the event.
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203                                 <dl class="detailList">
 204                                 <dt class="heading">Returns:</dt>
 205
 206                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
 207
 208                                 </dl>
 209
 210
 211
 212
 213
 214
 215
 216                     </div>
 217                 </div>
 218
 219             </td>
 220             <td class="msource">
 221
 222                         Roo.EventObject
 223                 &nbsp;
 224             </td>
 225         </tr>
 226
 227
 228           <tr class="method-row config-row-alt1 expandable notInherited">
 229             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 230
 231
 232             <td class="sig">
 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>
 236
 237                                  ()
 238
 239
 240                                          :
 241
 242
 243                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 244
 245
 246
 247
 248
 249                 </div>
 250                 <div class="mdesc">
 251
 252                    <div class="short">Returns a normalized keyCode for the event.</div>
 253
 254
 255
 256                     <div class="long">
 257
 258                                 Returns a normalized keyCode for the event.
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269                                 <dl class="detailList">
 270                                 <dt class="heading">Returns:</dt>
 271
 272                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The key code</dd>
 273
 274                                 </dl>
 275
 276
 277
 278
 279
 280
 281
 282                     </div>
 283                 </div>
 284
 285             </td>
 286             <td class="msource">
 287
 288                         Roo.EventObject
 289                 &nbsp;
 290             </td>
 291         </tr>
 292
 293
 294           <tr class="method-row config-row-alt0 expandable notInherited">
 295             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 296
 297
 298             <td class="sig">
 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>
 302
 303                                  ()
 304
 305
 306                                          :
 307
 308
 309                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 310
 311
 312
 313
 314
 315                 </div>
 316                 <div class="mdesc">
 317
 318                    <div class="short">Gets the x coordinate of the event.</div>
 319
 320
 321
 322                     <div class="long">
 323
 324                                 Gets the x coordinate of the event.
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335                                 <dl class="detailList">
 336                                 <dt class="heading">Returns:</dt>
 337
 338                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
 339
 340                                 </dl>
 341
 342
 343
 344
 345
 346
 347
 348                     </div>
 349                 </div>
 350
 351             </td>
 352             <td class="msource">
 353
 354                         Roo.EventObject
 355                 &nbsp;
 356             </td>
 357         </tr>
 358
 359
 360           <tr class="method-row config-row-alt1 expandable notInherited">
 361             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 362
 363
 364             <td class="sig">
 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>
 368
 369                                  ()
 370
 371
 372                                          :
 373
 374
 375                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 376
 377
 378
 379
 380
 381                 </div>
 382                 <div class="mdesc">
 383
 384                    <div class="short">Gets the y coordinate of the event.</div>
 385
 386
 387
 388                     <div class="long">
 389
 390                                 Gets the y coordinate of the event.
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401                                 <dl class="detailList">
 402                                 <dt class="heading">Returns:</dt>
 403
 404                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
 405
 406                                 </dl>
 407
 408
 409
 410
 411
 412
 413
 414                     </div>
 415                 </div>
 416
 417             </td>
 418             <td class="msource">
 419
 420                         Roo.EventObject
 421                 &nbsp;
 422             </td>
 423         </tr>
 424
 425
 426           <tr class="method-row config-row-alt0 expandable notInherited">
 427             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 428
 429
 430             <td class="sig">
 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>
 434
 435                                  ()
 436
 437
 438                                          :
 439
 440
 441                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
 442
 443
 444
 445
 446
 447                 </div>
 448                 <div class="mdesc">
 449
 450                    <div class="short">Gets the related target.</div>
 451
 452
 453
 454                     <div class="long">
 455
 456                                 Gets the related target.
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467                                 <dl class="detailList">
 468                                 <dt class="heading">Returns:</dt>
 469
 470                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  </dd>
 471
 472                                 </dl>
 473
 474
 475
 476
 477
 478
 479
 480                     </div>
 481                 </div>
 482
 483             </td>
 484             <td class="msource">
 485
 486                         Roo.EventObject
 487                 &nbsp;
 488             </td>
 489         </tr>
 490
 491
 492           <tr class="method-row config-row-alt1 expandable notInherited">
 493             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 494
 495
 496             <td class="sig">
 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>
 500
 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>)
 502
 503
 504                                          :
 505
 506
 507                                                 HTMLelement
 508
 509
 510
 511
 512
 513                 </div>
 514                 <div class="mdesc">
 515
 516                    <div class="short">Gets the target for the event.</div>
 517
 518
 519
 520                     <div class="long">
 521
 522                                 Gets the target for the event.
 523
 524
 525
 526
 527
 528
 529                                 <dl class="detailList">
 530                                 <dt class="heading">Parameters:</dt>
 531
 532                                         <dt>
 533                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>selector</b>
 534
 535                                         </dt>
 536                                         <dd>(optional) A simple selector to filter the target or look for an ancestor of the target</dd>
 537
 538                                         <dt>
 539                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/HTMLElement/Element</span>  <b>maxDepth</b>
 540
 541                                         </dt>
 542                                         <dd>(optional) The max depth to<br/>                search as a number or element (defaults to 10 || document.body)</dd>
 543
 544                                         <dt>
 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>
 546
 547                                         </dt>
 548                                         <dd>(optional) True to return a Roo.Element object instead of DOM node</dd>
 549
 550                                 </dl>
 551
 552
 553
 554
 555
 556                                 <dl class="detailList">
 557                                 <dt class="heading">Returns:</dt>
 558
 559                                         <dd><span class="fixedFont">HTMLelement</span>  </dd>
 560
 561                                 </dl>
 562
 563
 564
 565
 566
 567
 568
 569                     </div>
 570                 </div>
 571
 572             </td>
 573             <td class="msource">
 574
 575                         Roo.EventObject
 576                 &nbsp;
 577             </td>
 578         </tr>
 579
 580
 581           <tr class="method-row config-row-alt0 expandable notInherited">
 582             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 583
 584
 585             <td class="sig">
 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>
 589
 590                                  ()
 591
 592
 593                                          :
 594
 595
 596                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 597
 598
 599
 600
 601
 602                 </div>
 603                 <div class="mdesc">
 604
 605                    <div class="short">Gets the time of the event.</div>
 606
 607
 608
 609                     <div class="long">
 610
 611                                 Gets the time of the event.
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622                                 <dl class="detailList">
 623                                 <dt class="heading">Returns:</dt>
 624
 625                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
 626
 627                                 </dl>
 628
 629
 630
 631
 632
 633
 634
 635                     </div>
 636                 </div>
 637
 638             </td>
 639             <td class="msource">
 640
 641                         Roo.EventObject
 642                 &nbsp;
 643             </td>
 644         </tr>
 645
 646
 647           <tr class="method-row config-row-alt1 expandable notInherited">
 648             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 649
 650
 651             <td class="sig">
 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>
 655
 656                                  ()
 657
 658
 659                                          :
 660
 661
 662                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 663
 664
 665
 666
 667
 668                 </div>
 669                 <div class="mdesc">
 670
 671                    <div class="short">Normalizes mouse wheel delta across browsers</div>
 672
 673
 674
 675                     <div class="long">
 676
 677                                 Normalizes mouse wheel delta across browsers
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688                                 <dl class="detailList">
 689                                 <dt class="heading">Returns:</dt>
 690
 691                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The delta</dd>
 692
 693                                 </dl>
 694
 695
 696
 697
 698
 699
 700
 701                     </div>
 702                 </div>
 703
 704             </td>
 705             <td class="msource">
 706
 707                         Roo.EventObject
 708                 &nbsp;
 709             </td>
 710         </tr>
 711
 712
 713           <tr class="method-row config-row-alt0 expandable notInherited">
 714             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 715
 716
 717             <td class="sig">
 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>
 721
 722                                  ()
 723
 724
 725                                          :
 726
 727
 728                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 729
 730
 731
 732
 733
 734                 </div>
 735                 <div class="mdesc">
 736
 737                    <div class="short">Gets the page coordinates of the event.</div>
 738
 739
 740
 741                     <div class="long">
 742
 743                                 Gets the page coordinates of the event.
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754                                 <dl class="detailList">
 755                                 <dt class="heading">Returns:</dt>
 756
 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>
 758
 759                                 </dl>
 760
 761
 762
 763
 764
 765
 766
 767                     </div>
 768                 </div>
 769
 770             </td>
 771             <td class="msource">
 772
 773                         Roo.EventObject
 774                 &nbsp;
 775             </td>
 776         </tr>
 777
 778
 779           <tr class="method-row config-row-alt1 expandable notInherited">
 780             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 781
 782
 783             <td class="sig">
 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>
 787
 788                                  ()
 789
 790
 791                                          :
 792
 793
 794                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 795
 796
 797
 798
 799
 800                 </div>
 801                 <div class="mdesc">
 802
 803                    <div class="short">Returns true if the control, meta, shift or alt key was pressed during this event.</div>
 804
 805
 806
 807                     <div class="long">
 808
 809                                 Returns true if the control, meta, shift or alt key was pressed during this event.
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820                                 <dl class="detailList">
 821                                 <dt class="heading">Returns:</dt>
 822
 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>
 824
 825                                 </dl>
 826
 827
 828
 829
 830
 831
 832
 833                     </div>
 834                 </div>
 835
 836             </td>
 837             <td class="msource">
 838
 839                         Roo.EventObject
 840                 &nbsp;
 841             </td>
 842         </tr>
 843
 844
 845           <tr class="method-row config-row-alt0 expandable notInherited">
 846             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 847
 848
 849             <td class="sig">
 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>
 853
 854                                  ()
 855
 856
 857
 858                 </div>
 859                 <div class="mdesc">
 860
 861                    <div class="short">Prevents the browsers default handling of the event.</div>
 862
 863
 864
 865                     <div class="long">
 866
 867                                 Prevents the browsers default handling of the event.
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884                     </div>
 885                 </div>
 886
 887             </td>
 888             <td class="msource">
 889
 890                         Roo.EventObject
 891                 &nbsp;
 892             </td>
 893         </tr>
 894
 895
 896           <tr class="method-row config-row-alt1 expandable notInherited">
 897             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 898
 899
 900             <td class="sig">
 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>
 904
 905                                  ()
 906
 907
 908
 909                 </div>
 910                 <div class="mdesc">
 911
 912                    <div class="short">Stop the event (preventDefault and stopPropagation)</div>
 913
 914
 915
 916                     <div class="long">
 917
 918                                 Stop the event (preventDefault and stopPropagation)
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935                     </div>
 936                 </div>
 937
 938             </td>
 939             <td class="msource">
 940
 941                         Roo.EventObject
 942                 &nbsp;
 943             </td>
 944         </tr>
 945
 946
 947           <tr class="method-row config-row-alt0 expandable notInherited">
 948             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 949
 950
 951             <td class="sig">
 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>
 955
 956                                  ()
 957
 958
 959
 960                 </div>
 961                 <div class="mdesc">
 962
 963                    <div class="short">Cancels bubbling of the event.</div>
 964
 965
 966
 967                     <div class="long">
 968
 969                                 Cancels bubbling of the event.
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986                     </div>
 987                 </div>
 988
 989             </td>
 990             <td class="msource">
 991
 992                         Roo.EventObject
 993                 &nbsp;
 994             </td>
 995         </tr>
 996
 997
 998           <tr class="method-row config-row-alt1 expandable notInherited">
 999             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1000
1001
1002             <td class="sig">
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>
1006
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>)
1008
1009
1010                                          :
1011
1012
1013                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1014
1015
1016
1017
1018
1019                 </div>
1020                 <div class="mdesc">
1021
1022                    <div class="short">Returns true if the target of this event equals el or is a child of el</div>
1023
1024
1025
1026                     <div class="long">
1027
1028                                 Returns true if the target of this event equals el or is a child of el
1029
1030
1031
1032
1033
1034
1035                                 <dl class="detailList">
1036                                 <dt class="heading">Parameters:</dt>
1037
1038                                         <dt>
1039                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
1040
1041                                         </dt>
1042                                         <dd></dd>
1043
1044                                         <dt>
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>
1046
1047                                         </dt>
1048                                         <dd>(optional) true to test if the related target is within el instead of the target</dd>
1049
1050                                 </dl>
1051
1052
1053
1054
1055
1056                                 <dl class="detailList">
1057                                 <dt class="heading">Returns:</dt>
1058
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>
1060
1061                                 </dl>
1062
1063
1064
1065
1066
1067
1068
1069                     </div>
1070                 </div>
1071
1072             </td>
1073             <td class="msource">
1074
1075                         Roo.EventObject
1076                 &nbsp;
1077             </td>
1078         </tr>
1079
1080
1081     </table>
1082
1083
1084   <!-- ============================== events summary / details ======================== -->
1085
1086
1087   <a id="Roo.EventObject-events"></a>
1088
1089
1090
1091
1092
1093      <table cellspacing="0" class="member-table">
1094       <caption class="Empty">Events - Has None</caption>
1095      </table>
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105 <!-- ============================== footer ================================= -->
1106                 <div class="fineprint" style="clear:both">
1107
1108                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:06 GMT+0800 (HKT)
1109                         Based on
1110                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1111                 </div>
1112         </body>
1113 </html>