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