git.roojs.org Git - roojs1/blob - docs/symbols/Roo.util.ClickRepeater.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.util.ClickRepeater</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.util.ClickRepeater-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.util.ClickRepeater-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.util.ClickRepeater-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.util.ClickRepeater-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                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.util.ClickRepeater
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.util.ClickRepeater
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.util</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_util_ClickRepeater.js.html">Roo/util/ClickRepeater.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">ClickRepeater</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A wrapper class which can be applied to any element. Fires a "click" event while the<br/>mouse is pressed. The interval between firings may be specified in the config but<br/>defaults to 10 milliseconds.<br/><br/>Optionally, a CSS class may be applied to the element during the time it is pressed.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.util.ClickRepeater';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.util" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.util.ClickRepeater.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.util.ClickRepeater-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.util.ClickRepeater-cfg-accelerate" name=".accelerate"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">accelerate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">True if autorepeating should start slowly and accelerate.</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">True if autorepeating should start slowly and accelerate.<br/>          "interval" and "delay" are ignored. "immediate" is honored.</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.util.ClickRepeater
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.util.ClickRepeater-cfg-delay" name=".delay"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">delay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">The initial delay before the repeating event begins firing.</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">The initial delay before the repeating event begins firing.<br/>Similar to an autorepeat key delay.</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.util.ClickRepeater
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.util.ClickRepeater-cfg-el" name=".el"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">el</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">The element to act as a button.</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">The element to act as a button.</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.util.ClickRepeater
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.util.ClickRepeater-cfg-interval" name=".interval"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">interval</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">The interval between firings of the "click" event.</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">The interval between firings of the "click" event. Default 10 ms.</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.util.ClickRepeater
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre></div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 281                         <a id="Roo.util.ClickRepeater-cfg-pressClass" name=".pressClass"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">pressClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">A CSS class name to be applied to the element while pressed.</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">A CSS class name to be applied to the element while pressed.</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.util.ClickRepeater
 302
 303                     </td>
 304                 </tr>
 305
 306
 307                 <tr class="config-row expandable config-row-alt0 notInherited">
 308                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309                     <td class="sig">
 310
 311                         <a id="Roo.util.ClickRepeater-cfg-preventDefault" name=".preventDefault"></a>
 312                         <div class="fixedFont">
 313                                 <b  class="itemname">preventDefault</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 314
 315
 316                         </div>
 317
 318                         <div class="mdesc">
 319                             <div class="short">True to prevent the default click event</div>
 320                         </div>
 321
 322                         <div class="mdesc">
 323                             <div class="long">True to prevent the default click event</div>
 324                         </div>
 325
 326
 327
 328                     </td>
 329                     <td class="msource">
 330
 331                         Roo.util.ClickRepeater
 332
 333                     </td>
 334                 </tr>
 335
 336
 337                 <tr class="config-row expandable config-row-alt1 notInherited">
 338                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 339                     <td class="sig">
 340
 341                         <a id="Roo.util.ClickRepeater-cfg-stopDefault" name=".stopDefault"></a>
 342                         <div class="fixedFont">
 343                                 <b  class="itemname">stopDefault</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 344
 345
 346                         </div>
 347
 348                         <div class="mdesc">
 349                             <div class="short">True to stop the default click event</div>
 350                         </div>
 351
 352                         <div class="mdesc">
 353                             <div class="long">True to stop the default click event</div>
 354                         </div>
 355
 356
 357
 358                     </td>
 359                     <td class="msource">
 360
 361                         Roo.util.ClickRepeater
 362
 363                     </td>
 364                 </tr>
 365
 366
 367     </table>
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377   <!-- ============================== public properties ==================== -->
 378
 379
 380
 381     <a id="Roo.util.ClickRepeater-props"></a>
 382
 383
 384
 385
 386
 387      <table cellspacing="0" class="member-table">
 388       <caption class="Empty">Public Properties - Has None</caption>
 389      </table>
 390
 391
 392
 393
 394   <!-- ============================== methods summary / details ======================== -->
 395
 396
 397   <a id="Roo.util.ClickRepeater-methods"></a>
 398         <!-- constructor?? -->
 399
 400         <!-- static's first
 401
 402
 403         -->
 404
 405         <!-- then dynamics first -->
 406
 407
 408
 409
 410
 411
 412       <table cellspacing="0" class="member-table">
 413       <caption>Public Methods</caption>
 414         <tr>
 415             <th class="sig-header" colspan="2">Method</th>
 416             <th class="msource-header">Defined By</th>
 417
 418         </tr>
 419
 420
 421
 422
 423
 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.util-method-ClickRepeater"   name=".ClickRepeater"></a>
 432                 <div class="fixedFont">
 433                         <span class="attributes">new <B>Roo.util.</B></span><b class="itemname">ClickRepeater</b>
 434
 435                                  (<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:Object">Object</a> <B><i>config</i></B>)
 436
 437
 438
 439                 </div>
 440                 <div class="mdesc">
 441
 442
 443                         <div class="short">Create a new Roo.util.ClickRepeater</div>
 444
 445
 446                     <div class="long">
 447
 448
 449
 450                                 Create a new Roo.util.ClickRepeater
 451
 452
 453                                 <dl class="detailList">
 454                                 <dt class="heading">Parameters:</dt>
 455
 456                                         <dt>
 457                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
 458
 459                                         </dt>
 460                                         <dd>The element to listen on</dd>
 461
 462                                         <dt>
 463                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 464
 465                                         </dt>
 466                                         <dd></dd>
 467
 468                                 </dl>
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480                     </div>
 481                 </div>
 482
 483             </td>
 484             <td class="msource">
 485                 &nbsp;
 486             </td>
 487         </tr>
 488
 489
 490           <tr class="method-row config-row-alt1 expandable">
 491             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 492
 493
 494             <td class="sig">
 495                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 496                 <div class="fixedFont">
 497                         <span class="attributes"></span><b class="itemname">addEvents</b>
 498
 499                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 500
 501
 502
 503                 </div>
 504                 <div class="mdesc">
 505
 506                    <div class="short">Used to define events on this Observable</div>
 507
 508
 509
 510                     <div class="long">
 511
 512                                 Used to define events on this Observable
 513
 514
 515
 516
 517
 518
 519                                 <dl class="detailList">
 520                                 <dt class="heading">Parameters:</dt>
 521
 522                                         <dt>
 523                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
 524
 525                                         </dt>
 526                                         <dd>The object with the events defined</dd>
 527
 528                                 </dl>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540                     </div>
 541                 </div>
 542
 543             </td>
 544             <td class="msource">
 545
 546                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 547                 &nbsp;
 548             </td>
 549         </tr>
 550
 551
 552           <tr class="method-row config-row-alt0 expandable">
 553             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 554
 555
 556             <td class="sig">
 557                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 558                 <div class="fixedFont">
 559                         <span class="attributes"></span><b class="itemname">addListener</b>
 560
 561                                  (<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>)
 562
 563
 564
 565                 </div>
 566                 <div class="mdesc">
 567
 568                    <div class="short">Appends an event handler to this component</div>
 569
 570
 571
 572                     <div class="long">
 573
 574                                 Appends an event handler to this component
 575
 576
 577
 578
 579
 580
 581                                 <dl class="detailList">
 582                                 <dt class="heading">Parameters:</dt>
 583
 584                                         <dt>
 585                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 586
 587                                         </dt>
 588                                         <dd>The type of event to listen for</dd>
 589
 590                                         <dt>
 591                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 592
 593                                         </dt>
 594                                         <dd>The method the event invokes</dd>
 595
 596                                         <dt>
 597                                                 <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>
 598
 599                                         </dt>
 600                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 601
 602                                         <dt>
 603                                                 <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>
 604
 605                                         </dt>
 606                                         <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>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)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<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/><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/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
 607
 608                                 </dl>
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620                     </div>
 621                 </div>
 622
 623             </td>
 624             <td class="msource">
 625
 626                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 627                 &nbsp;
 628             </td>
 629         </tr>
 630
 631
 632           <tr class="method-row config-row-alt1 expandable">
 633             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 634
 635
 636             <td class="sig">
 637                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 638                 <div class="fixedFont">
 639                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 640
 641                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
 642
 643
 644                                          :
 645
 646
 647                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 648
 649
 650
 651
 652
 653                 </div>
 654                 <div class="mdesc">
 655
 656                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 657
 658
 659
 660                     <div class="long">
 661
 662                                 Fires the specified event with the passed parameters (minus the event name).
 663
 664
 665
 666
 667
 668
 669                                 <dl class="detailList">
 670                                 <dt class="heading">Parameters:</dt>
 671
 672                                         <dt>
 673                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 674
 675                                         </dt>
 676                                         <dd></dd>
 677
 678                                         <dt>
 679                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
 680
 681                                         </dt>
 682                                         <dd>Variable number of parameters are passed to handlers</dd>
 683
 684                                 </dl>
 685
 686
 687
 688
 689
 690                                 <dl class="detailList">
 691                                 <dt class="heading">Returns:</dt>
 692
 693                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
 694
 695                                 </dl>
 696
 697
 698
 699
 700
 701
 702
 703                     </div>
 704                 </div>
 705
 706             </td>
 707             <td class="msource">
 708
 709                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 710                 &nbsp;
 711             </td>
 712         </tr>
 713
 714
 715           <tr class="method-row config-row-alt0 expandable">
 716             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 717
 718
 719             <td class="sig">
 720                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 721                 <div class="fixedFont">
 722                         <span class="attributes"></span><b class="itemname">hasListener</b>
 723
 724                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 725
 726
 727                                          :
 728
 729
 730                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 731
 732
 733
 734
 735
 736                 </div>
 737                 <div class="mdesc">
 738
 739                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 740
 741
 742
 743                     <div class="long">
 744
 745                                 Checks to see if this object has any listeners for a specified event
 746
 747
 748
 749
 750
 751
 752                                 <dl class="detailList">
 753                                 <dt class="heading">Parameters:</dt>
 754
 755                                         <dt>
 756                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 757
 758                                         </dt>
 759                                         <dd>The name of the event to check for</dd>
 760
 761                                 </dl>
 762
 763
 764
 765
 766
 767                                 <dl class="detailList">
 768                                 <dt class="heading">Returns:</dt>
 769
 770                                         <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 the event is being listened for, else false</dd>
 771
 772                                 </dl>
 773
 774
 775
 776
 777
 778
 779
 780                     </div>
 781                 </div>
 782
 783             </td>
 784             <td class="msource">
 785
 786                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 787                 &nbsp;
 788             </td>
 789         </tr>
 790
 791
 792           <tr class="method-row config-row-alt1 expandable">
 793             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 794
 795
 796             <td class="sig">
 797                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 798                 <div class="fixedFont">
 799                         <span class="attributes"></span><b class="itemname">on</b>
 800
 801                                  (<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>)
 802
 803
 804
 805                 </div>
 806                 <div class="mdesc">
 807
 808                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 809
 810
 811
 812                     <div class="long">
 813
 814                                 Appends an event handler to this element (shorthand for addListener)
 815
 816
 817
 818
 819
 820
 821                                 <dl class="detailList">
 822                                 <dt class="heading">Parameters:</dt>
 823
 824                                         <dt>
 825                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 826
 827                                         </dt>
 828                                         <dd>The type of event to listen for</dd>
 829
 830                                         <dt>
 831                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 832
 833                                         </dt>
 834                                         <dd>The method the event invokes</dd>
 835
 836                                         <dt>
 837                                                 <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>
 838
 839                                         </dt>
 840                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 841
 842                                         <dt>
 843                                                 <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>
 844
 845                                         </dt>
 846                                         <dd>(optional)</dd>
 847
 848                                 </dl>
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860                     </div>
 861                 </div>
 862
 863             </td>
 864             <td class="msource">
 865
 866                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 867                 &nbsp;
 868             </td>
 869         </tr>
 870
 871
 872           <tr class="method-row config-row-alt0 expandable">
 873             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 874
 875
 876             <td class="sig">
 877                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
 878                 <div class="fixedFont">
 879                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
 880
 881                                  ()
 882
 883
 884
 885                 </div>
 886                 <div class="mdesc">
 887
 888                    <div class="short">Removes all listeners for this object</div>
 889
 890
 891
 892                     <div class="long">
 893
 894                                 Removes all listeners for this object
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911                     </div>
 912                 </div>
 913
 914             </td>
 915             <td class="msource">
 916
 917                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 918                 &nbsp;
 919             </td>
 920         </tr>
 921
 922
 923           <tr class="method-row config-row-alt1 expandable">
 924             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 925
 926
 927             <td class="sig">
 928                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
 929                 <div class="fixedFont">
 930                         <span class="attributes"></span><b class="itemname">removeListener</b>
 931
 932                                  (<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>)
 933
 934
 935
 936                 </div>
 937                 <div class="mdesc">
 938
 939                    <div class="short">Removes a listener</div>
 940
 941
 942
 943                     <div class="long">
 944
 945                                 Removes a listener
 946
 947
 948
 949
 950
 951
 952                                 <dl class="detailList">
 953                                 <dt class="heading">Parameters:</dt>
 954
 955                                         <dt>
 956                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 957
 958                                         </dt>
 959                                         <dd>The type of event to listen for</dd>
 960
 961                                         <dt>
 962                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 963
 964                                         </dt>
 965                                         <dd>The handler to remove</dd>
 966
 967                                         <dt>
 968                                                 <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>
 969
 970                                         </dt>
 971                                         <dd>(optional) The scope (this object) for the handler</dd>
 972
 973                                 </dl>
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985                     </div>
 986                 </div>
 987
 988             </td>
 989             <td class="msource">
 990
 991                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 992                 &nbsp;
 993             </td>
 994         </tr>
 995
 996
 997           <tr class="method-row config-row-alt0 expandable">
 998             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 999
1000
1001             <td class="sig">
1002                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1003                 <div class="fixedFont">
1004                         <span class="attributes"></span><b class="itemname">un</b>
1005
1006                                  (<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>)
1007
1008
1009
1010                 </div>
1011                 <div class="mdesc">
1012
1013                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1014
1015
1016
1017                     <div class="long">
1018
1019                                 Removes a listener (shorthand for removeListener)
1020
1021
1022
1023
1024
1025
1026                                 <dl class="detailList">
1027                                 <dt class="heading">Parameters:</dt>
1028
1029                                         <dt>
1030                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1031
1032                                         </dt>
1033                                         <dd>The type of event to listen for</dd>
1034
1035                                         <dt>
1036                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1037
1038                                         </dt>
1039                                         <dd>The handler to remove</dd>
1040
1041                                         <dt>
1042                                                 <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>
1043
1044                                         </dt>
1045                                         <dd>(optional) The scope (this object) for the handler</dd>
1046
1047                                 </dl>
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059                     </div>
1060                 </div>
1061
1062             </td>
1063             <td class="msource">
1064
1065                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1066                 &nbsp;
1067             </td>
1068         </tr>
1069
1070
1071     </table>
1072
1073
1074   <!-- ============================== events summary / details ======================== -->
1075
1076
1077   <a id="Roo.util.ClickRepeater-events"></a>
1078
1079
1080
1081
1082
1083
1084
1085
1086       <table cellspacing="0" class="member-table">
1087                 <caption>Events</caption>
1088               <thead>
1089                 <tr>
1090                     <th class="sig-header" colspan="2">Event</th>
1091                     <th class="msource-header">Defined By</th>
1092
1093                 </tr>
1094               </thead>
1095
1096
1097
1098
1099
1100           <tr class="method-row expandable config-row-alt0 notInherited">
1101             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1102
1103             <td class="sig">
1104                 <a id="Roo.util.ClickRepeater-event-*click"></a>
1105
1106                <div class="fixedFont">
1107                 <b class="itemname">click</b> (<a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a> <B><i>this</i></B>)
1108
1109                 </div>
1110
1111                 <div class="mdesc">
1112
1113                    <div class="short">Fires on a specified interval during the time the element is pressed.
1114
1115                 </div>
1116
1117                     <div class="long">
1118
1119                         Fires on a specified interval during the time the element is pressed.
1120
1121
1122
1123
1124
1125                                 <dl class="detailList">
1126                                 <dt class="heading">Parameters:</dt>
1127
1128                                         <dt>
1129                                                 <span class="fixedFont"><a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a></span> <b>this</b>
1130
1131                                         </dt>
1132                                         <dd></dd>
1133
1134                                 </dl>
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146                     </div>
1147                 </div>
1148
1149             </td>
1150             <td class="msource">
1151                 Roo.util.ClickRepeater
1152             </td>
1153         </tr>
1154
1155           <tr class="method-row expandable config-row-alt1 notInherited">
1156             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1157
1158             <td class="sig">
1159                 <a id="Roo.util.ClickRepeater-event-*mousedown"></a>
1160
1161                <div class="fixedFont">
1162                 <b class="itemname">mousedown</b> (<a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a> <B><i>this</i></B>)
1163
1164                 </div>
1165
1166                 <div class="mdesc">
1167
1168                    <div class="short">Fires when the mouse button is depressed.
1169
1170                 </div>
1171
1172                     <div class="long">
1173
1174                         Fires when the mouse button is depressed.
1175
1176
1177
1178
1179
1180                                 <dl class="detailList">
1181                                 <dt class="heading">Parameters:</dt>
1182
1183                                         <dt>
1184                                                 <span class="fixedFont"><a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a></span> <b>this</b>
1185
1186                                         </dt>
1187                                         <dd></dd>
1188
1189                                 </dl>
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201                     </div>
1202                 </div>
1203
1204             </td>
1205             <td class="msource">
1206                 Roo.util.ClickRepeater
1207             </td>
1208         </tr>
1209
1210           <tr class="method-row expandable config-row-alt0 notInherited">
1211             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1212
1213             <td class="sig">
1214                 <a id="Roo.util.ClickRepeater-event-*mouseup"></a>
1215
1216                <div class="fixedFont">
1217                 <b class="itemname">mouseup</b> (<a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a> <B><i>this</i></B>)
1218
1219                 </div>
1220
1221                 <div class="mdesc">
1222
1223                    <div class="short">Fires when the mouse key is released.
1224
1225                 </div>
1226
1227                     <div class="long">
1228
1229                         Fires when the mouse key is released.
1230
1231
1232
1233
1234
1235                                 <dl class="detailList">
1236                                 <dt class="heading">Parameters:</dt>
1237
1238                                         <dt>
1239                                                 <span class="fixedFont"><a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a></span> <b>this</b>
1240
1241                                         </dt>
1242                                         <dd></dd>
1243
1244                                 </dl>
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256                     </div>
1257                 </div>
1258
1259             </td>
1260             <td class="msource">
1261                 Roo.util.ClickRepeater
1262             </td>
1263         </tr>
1264
1265
1266     </table>
1267
1268
1269
1270
1271
1272 <!-- ============================== footer ================================= -->
1273                 <div class="fineprint" style="clear:both">
1274
1275                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:09 GMT+0800 (HKT)
1276                         Based on
1277                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1278                 </div>
1279         </body>
1280 </html>