git.roojs.org Git - roojs1/blob - docs/symbols/Roo.EventManager.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.EventManager</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.EventManager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.EventManager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.EventManager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.EventManager-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.EventManager
  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">EventManager</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides <br/>several useful events directly.<br/>See {<b>link</b> Roo.EventObject} for more details on normalized event objects.
  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.EventManager';">[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.EventManager.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.EventManager-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.EventManager-props"></a>
 118
 119
 120
 121
 122
 123
 124
 125       <table cellspacing="0" class="member-table">
 126       <caption>Public Properties </caption>
 127         <tr>
 128             <th class="sig-header" colspan="2">Property</th>
 129             <th class="sig-header">Description</th>
 130             <th class="msource-header">Defined By</th>
 131         </tr>
 132
 133
 134
 135
 136
 137
 138
 139
 140           <tr class="property-row config-row-alt0 notInherited">
 141             <td class="micon">
 142                 <a class="exi" href="#expand">&nbsp;</a>
 143             </td>
 144             <td class="sig">
 145                <a id="Roo.EventManager-prop-ieDeferSrc" name=".ieDeferSrc"></a>
 146                <div class="fixedFont">
 147                     <span class="attributes">Roo.EventManager.</span><b  class="itemname">ieDeferSrc</b> :
 148                      <span type="etype"></span>
 149                      </div>
 150             </td>
 151             <td class="sig">
 152                 <div class="mdesc">
 153
 154
 155                    <div class="short">
 156                         Url used for onDocumentReady with using SSL (defaults to Roo.SSL_SECURE_URL)
 157
 158
 159
 160                    </div>
 161
 162                     <div class="long">
 163
 164                         Url used for onDocumentReady with using SSL (defaults to Roo.SSL_SECURE_URL)
 165
 166                 </div>
 167                 </div>
 168             </td>
 169
 170             <td class="msource">
 171             Roo.EventManager
 172             </td>
 173
 174           </tr>
 175
 176
 177
 178
 179           <tr class="property-row config-row-alt1 notInherited">
 180             <td class="micon">
 181                 <a class="exi" href="#expand">&nbsp;</a>
 182             </td>
 183             <td class="sig">
 184                <a id="Roo.EventManager-prop-textResizeInterval" name=".textResizeInterval"></a>
 185                <div class="fixedFont">
 186                     <span class="attributes">Roo.EventManager.</span><b  class="itemname">textResizeInterval</b> :
 187                      <span type="etype"></span>
 188                      </div>
 189             </td>
 190             <td class="sig">
 191                 <div class="mdesc">
 192
 193
 194                    <div class="short">
 195                         The frequency, in milliseconds, to check for text resize events (defaults to 50)
 196
 197
 198
 199                    </div>
 200
 201                     <div class="long">
 202
 203                         The frequency, in milliseconds, to check for text resize events (defaults to 50)
 204
 205                 </div>
 206                 </div>
 207             </td>
 208
 209             <td class="msource">
 210             Roo.EventManager
 211             </td>
 212
 213           </tr>
 214
 215
 216
 217
 218
 219         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 220         <tr class="property-row alt">
 221
 222         -->
 223
 224     </table>
 225
 226
 227   <!-- ============================== methods summary / details ======================== -->
 228
 229
 230   <a id="Roo.EventManager-methods"></a>
 231         <!-- constructor?? -->
 232
 233         <!-- static's first
 234
 235
 236         -->
 237
 238         <!-- then dynamics first -->
 239
 240
 241
 242
 243
 244
 245       <table cellspacing="0" class="member-table">
 246       <caption>Public Methods</caption>
 247         <tr>
 248             <th class="sig-header" colspan="2">Method</th>
 249             <th class="msource-header">Defined By</th>
 250
 251         </tr>
 252
 253
 254
 255
 256
 257
 258
 259           <tr class="method-row config-row-alt0 expandable notInherited">
 260             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 261
 262
 263             <td class="sig">
 264                 <a id="Roo.EventManager-method-addListener"   name=".addListener"></a>
 265                 <div class="fixedFont">
 266                         <span class="attributes">Roo.EventManager.</span><b class="itemname">addListener</b>
 267
 268                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>element</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 269
 270
 271
 272                 </div>
 273                 <div class="mdesc">
 274
 275                    <div class="short">Appends an event handler to an element (shorthand for addListener)</div>
 276
 277
 278
 279                     <div class="long">
 280
 281                                 Appends an event handler to an element (shorthand for addListener)
 282
 283
 284
 285
 286
 287
 288                                 <dl class="detailList">
 289                                 <dt class="heading">Parameters:</dt>
 290
 291                                         <dt>
 292                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>element</b>
 293
 294                                         </dt>
 295                                         <dd>The html element or id to assign the</dd>
 296
 297                                         <dt>
 298                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 299
 300                                         </dt>
 301                                         <dd>The type of event to listen for</dd>
 302
 303                                         <dt>
 304                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 305
 306                                         </dt>
 307                                         <dd>The method the event invokes</dd>
 308
 309                                         <dt>
 310                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 311
 312                                         </dt>
 313                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 314
 315                                         <dt>
 316                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 317
 318                                         </dt>
 319                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li><br/><li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li><br/><li>preventDefault {Boolean} True to prevent the default action</li><br/><li>stopPropagation {Boolean} True to prevent event propagation</li><br/><li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;"><br/>Code:<pre><code><br/>el.on('click', this.onClick, this, {<br/>    single: true,<br/>    delay: 100,<br/>    stopEvent : true,<br/>    forumId: 4<br/>});</code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><p><br/>Code:<pre><code><br/>el.on({<br/>    'click' : {<br/>        fn: this.onClick<br/>        scope: this,<br/>        delay: 100<br/>    },<br/>    'mouseover' : {<br/>        fn: this.onMouseOver<br/>        scope: this<br/>    },<br/>    'mouseout' : {<br/>        fn: this.onMouseOut<br/>        scope: this<br/>    }<br/>});</code></pre><br/><p><br/>Or a shorthand syntax:<br><br/>Code:<pre><code><br/>el.on({<br/>    'click' : this.onClick,<br/>    'mouseover' : this.onMouseOver,<br/>    'mouseout' : this.onMouseOut<br/>    scope: this<br/>});</code></pre></dd>
 320
 321                                 </dl>
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333                     </div>
 334                 </div>
 335
 336             </td>
 337             <td class="msource">
 338
 339                         Roo.EventManager
 340                 &nbsp;
 341             </td>
 342         </tr>
 343
 344
 345           <tr class="method-row config-row-alt1 expandable notInherited">
 346             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 347
 348
 349             <td class="sig">
 350                 <a id="Roo.EventManager-method-on"   name=".on"></a>
 351                 <div class="fixedFont">
 352                         <span class="attributes">Roo.EventManager.</span><b class="itemname">on</b>
 353
 354                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>element</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 355
 356
 357
 358                 </div>
 359                 <div class="mdesc">
 360
 361                    <div class="short">Appends an event handler to an element (shorthand for addListener)</div>
 362
 363
 364
 365                     <div class="long">
 366
 367                                 Appends an event handler to an element (shorthand for addListener)
 368
 369
 370
 371
 372
 373
 374                                 <dl class="detailList">
 375                                 <dt class="heading">Parameters:</dt>
 376
 377                                         <dt>
 378                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>element</b>
 379
 380                                         </dt>
 381                                         <dd>The html element or id to assign the</dd>
 382
 383                                         <dt>
 384                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 385
 386                                         </dt>
 387                                         <dd>The type of event to listen for</dd>
 388
 389                                         <dt>
 390                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 391
 392                                         </dt>
 393                                         <dd>The method the event invokes</dd>
 394
 395                                         <dt>
 396                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 397
 398                                         </dt>
 399                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 400
 401                                         <dt>
 402                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 403
 404                                         </dt>
 405                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li><br/><li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li><br/><li>preventDefault {Boolean} True to prevent the default action</li><br/><li>stopPropagation {Boolean} True to prevent event propagation</li><br/><li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;"><br/>Code:<pre><code><br/>el.on('click', this.onClick, this, {<br/>    single: true,<br/>    delay: 100,<br/>    stopEvent : true,<br/>    forumId: 4<br/>});</code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><p><br/>Code:<pre><code><br/>el.on({<br/>    'click' : {<br/>        fn: this.onClick<br/>        scope: this,<br/>        delay: 100<br/>    },<br/>    'mouseover' : {<br/>        fn: this.onMouseOver<br/>        scope: this<br/>    },<br/>    'mouseout' : {<br/>        fn: this.onMouseOut<br/>        scope: this<br/>    }<br/>});</code></pre><br/><p><br/>Or a shorthand syntax:<br><br/>Code:<pre><code><br/>el.on({<br/>    'click' : this.onClick,<br/>    'mouseover' : this.onMouseOver,<br/>    'mouseout' : this.onMouseOut<br/>    scope: this<br/>});</code></pre></dd>
 406
 407                                 </dl>
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419                     </div>
 420                 </div>
 421
 422             </td>
 423             <td class="msource">
 424
 425                         Roo.EventManager
 426                 &nbsp;
 427             </td>
 428         </tr>
 429
 430
 431           <tr class="method-row config-row-alt0 expandable notInherited">
 432             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 433
 434
 435             <td class="sig">
 436                 <a id="Roo.EventManager-method-onDocumentReady"   name=".onDocumentReady"></a>
 437                 <div class="fixedFont">
 438                         <span class="attributes">Roo.EventManager.</span><b class="itemname">onDocumentReady</b>
 439
 440                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, boolean <B><i>options</i></B>)
 441
 442
 443
 444                 </div>
 445                 <div class="mdesc">
 446
 447                    <div class="short">Fires when the document is ready (before onload and before images are loaded).</div>
 448
 449
 450
 451                     <div class="long">
 452
 453                                 Fires when the document is ready (before onload and before images are loaded). Can be <br/>accessed shorthanded Roo.onReady().
 454
 455
 456
 457
 458
 459
 460                                 <dl class="detailList">
 461                                 <dt class="heading">Parameters:</dt>
 462
 463                                         <dt>
 464                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 465
 466                                         </dt>
 467                                         <dd>The method the event invokes</dd>
 468
 469                                         <dt>
 470                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 471
 472                                         </dt>
 473                                         <dd>An  object that becomes the scope of the handler</dd>
 474
 475                                         <dt>
 476                                                 <span class="fixedFont">boolean</span>  <b>options</b>
 477
 478                                         </dt>
 479                                         <dd></dd>
 480
 481                                 </dl>
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493                     </div>
 494                 </div>
 495
 496             </td>
 497             <td class="msource">
 498
 499                         Roo.EventManager
 500                 &nbsp;
 501             </td>
 502         </tr>
 503
 504
 505           <tr class="method-row config-row-alt1 expandable notInherited">
 506             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 507
 508
 509             <td class="sig">
 510                 <a id="Roo.EventManager-method-onTextResize"   name=".onTextResize"></a>
 511                 <div class="fixedFont">
 512                         <span class="attributes">Roo.EventManager.</span><b class="itemname">onTextResize</b>
 513
 514                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, boolean <B><i>options</i></B>)
 515
 516
 517
 518                 </div>
 519                 <div class="mdesc">
 520
 521                    <div class="short">Fires when the user changes the active text size.</div>
 522
 523
 524
 525                     <div class="long">
 526
 527                                 Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.
 528
 529
 530
 531
 532
 533
 534                                 <dl class="detailList">
 535                                 <dt class="heading">Parameters:</dt>
 536
 537                                         <dt>
 538                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 539
 540                                         </dt>
 541                                         <dd>The method the event invokes</dd>
 542
 543                                         <dt>
 544                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 545
 546                                         </dt>
 547                                         <dd>An object that becomes the scope of the handler</dd>
 548
 549                                         <dt>
 550                                                 <span class="fixedFont">boolean</span>  <b>options</b>
 551
 552                                         </dt>
 553                                         <dd></dd>
 554
 555                                 </dl>
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567                     </div>
 568                 </div>
 569
 570             </td>
 571             <td class="msource">
 572
 573                         Roo.EventManager
 574                 &nbsp;
 575             </td>
 576         </tr>
 577
 578
 579           <tr class="method-row config-row-alt0 expandable notInherited">
 580             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 581
 582
 583             <td class="sig">
 584                 <a id="Roo.EventManager-method-onWindowResize"   name=".onWindowResize"></a>
 585                 <div class="fixedFont">
 586                         <span class="attributes">Roo.EventManager.</span><b class="itemname">onWindowResize</b>
 587
 588                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, boolean <B><i>options</i></B>)
 589
 590
 591
 592                 </div>
 593                 <div class="mdesc">
 594
 595                    <div class="short">Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.</div>
 596
 597
 598
 599                     <div class="long">
 600
 601                                 Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.
 602
 603
 604
 605
 606
 607
 608                                 <dl class="detailList">
 609                                 <dt class="heading">Parameters:</dt>
 610
 611                                         <dt>
 612                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 613
 614                                         </dt>
 615                                         <dd>The method the event invokes</dd>
 616
 617                                         <dt>
 618                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 619
 620                                         </dt>
 621                                         <dd>An object that becomes the scope of the handler</dd>
 622
 623                                         <dt>
 624                                                 <span class="fixedFont">boolean</span>  <b>options</b>
 625
 626                                         </dt>
 627                                         <dd></dd>
 628
 629                                 </dl>
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641                     </div>
 642                 </div>
 643
 644             </td>
 645             <td class="msource">
 646
 647                         Roo.EventManager
 648                 &nbsp;
 649             </td>
 650         </tr>
 651
 652
 653           <tr class="method-row config-row-alt1 expandable notInherited">
 654             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 655
 656
 657             <td class="sig">
 658                 <a id="Roo.EventManager-method-removeListener"   name=".removeListener"></a>
 659                 <div class="fixedFont">
 660                         <span class="attributes">Roo.EventManager.</span><b class="itemname">removeListener</b>
 661
 662                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>element</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>)
 663
 664
 665                                          :
 666
 667
 668                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 669
 670
 671
 672
 673
 674                 </div>
 675                 <div class="mdesc">
 676
 677                    <div class="short">Removes an event handler</div>
 678
 679
 680
 681                     <div class="long">
 682
 683                                 Removes an event handler
 684
 685
 686
 687
 688
 689
 690                                 <dl class="detailList">
 691                                 <dt class="heading">Parameters:</dt>
 692
 693                                         <dt>
 694                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>element</b>
 695
 696                                         </dt>
 697                                         <dd>The id or html element to remove the <br/>                            event from</dd>
 698
 699                                         <dt>
 700                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 701
 702                                         </dt>
 703                                         <dd>The type of event</dd>
 704
 705                                         <dt>
 706                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 707
 708                                         </dt>
 709                                         <dd></dd>
 710
 711                                 </dl>
 712
 713
 714
 715
 716
 717                                 <dl class="detailList">
 718                                 <dt class="heading">Returns:</dt>
 719
 720                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if a listener was actually removed</dd>
 721
 722                                 </dl>
 723
 724
 725
 726
 727
 728
 729
 730                     </div>
 731                 </div>
 732
 733             </td>
 734             <td class="msource">
 735
 736                         Roo.EventManager
 737                 &nbsp;
 738             </td>
 739         </tr>
 740
 741
 742           <tr class="method-row config-row-alt0 expandable notInherited">
 743             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 744
 745
 746             <td class="sig">
 747                 <a id="Roo.EventManager-method-removeResizeListener"   name=".removeResizeListener"></a>
 748                 <div class="fixedFont">
 749                         <span class="attributes">Roo.EventManager.</span><b class="itemname">removeResizeListener</b>
 750
 751                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
 752
 753
 754
 755                 </div>
 756                 <div class="mdesc">
 757
 758                    <div class="short">Removes the passed window resize listener.</div>
 759
 760
 761
 762                     <div class="long">
 763
 764                                 Removes the passed window resize listener.
 765
 766
 767
 768
 769
 770
 771                                 <dl class="detailList">
 772                                 <dt class="heading">Parameters:</dt>
 773
 774                                         <dt>
 775                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 776
 777                                         </dt>
 778                                         <dd>The method the event invokes</dd>
 779
 780                                         <dt>
 781                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 782
 783                                         </dt>
 784                                         <dd>The scope of handler</dd>
 785
 786                                 </dl>
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798                     </div>
 799                 </div>
 800
 801             </td>
 802             <td class="msource">
 803
 804                         Roo.EventManager
 805                 &nbsp;
 806             </td>
 807         </tr>
 808
 809
 810           <tr class="method-row config-row-alt1 expandable notInherited">
 811             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 812
 813
 814             <td class="sig">
 815                 <a id="Roo.EventManager-method-wrap"   name=".wrap"></a>
 816                 <div class="fixedFont">
 817                         <span class="attributes">Roo.EventManager.</span><b class="itemname">wrap</b>
 818
 819                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, boolean <B><i>override</i></B>)
 820
 821
 822                                          :
 823
 824
 825                                                 <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
 826
 827
 828
 829
 830
 831                 </div>
 832                 <div class="mdesc">
 833
 834                    <div class="short">This is no longer needed and is deprecated.</div>
 835
 836
 837
 838                     <div class="long">
 839
 840                                 This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event<br/>object with a Roo.EventObject
 841
 842
 843
 844
 845
 846
 847                                 <dl class="detailList">
 848                                 <dt class="heading">Parameters:</dt>
 849
 850                                         <dt>
 851                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 852
 853                                         </dt>
 854                                         <dd>The method the event invokes</dd>
 855
 856                                         <dt>
 857                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 858
 859                                         </dt>
 860                                         <dd>An object that becomes the scope of the handler</dd>
 861
 862                                         <dt>
 863                                                 <span class="fixedFont">boolean</span>  <b>override</b>
 864
 865                                         </dt>
 866                                         <dd>If true, the obj passed in becomes<br/>                            the execution scope of the listener</dd>
 867
 868                                 </dl>
 869
 870
 871
 872
 873
 874                                 <dl class="detailList">
 875                                 <dt class="heading">Returns:</dt>
 876
 877                                         <dd><span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  The wrapped function</dd>
 878
 879                                 </dl>
 880
 881
 882
 883
 884
 885
 886
 887                     </div>
 888                 </div>
 889
 890             </td>
 891             <td class="msource">
 892
 893                         Roo.EventManager
 894                 &nbsp;
 895             </td>
 896         </tr>
 897
 898
 899     </table>
 900
 901
 902   <!-- ============================== events summary / details ======================== -->
 903
 904
 905   <a id="Roo.EventManager-events"></a>
 906
 907
 908
 909
 910
 911      <table cellspacing="0" class="member-table">
 912       <caption class="Empty">Events - Has None</caption>
 913      </table>
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923 <!-- ============================== footer ================================= -->
 924                 <div class="fineprint" style="clear:both">
 925
 926                         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)
 927                         Based on
 928                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 929                 </div>
 930         </body>
 931 </html>