docs/output/Ext.util.ClickRepeater.js

   1 Ext.data.JsonP.Ext_util_ClickRepeater({
   2   "tagname": "class",
   3   "name": "Ext.util.ClickRepeater",
   4   "doc": "<p>A wrapper class which can be applied to any element. Fires a \"click\" event while the\nmouse is pressed. The interval between firings may be specified in the config but\ndefaults to 20 milliseconds.</p>\n\n<p>Optionally, a CSS class may be applied to the element during the time it is pressed.</p>\n",
   5   "extends": "Ext.util.Observable",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "accelerate",
  21       "member": "Ext.util.ClickRepeater",
  22       "type": "Boolean",
  23       "doc": "<p>True if autorepeating should start slowly and accelerate.\n\"interval\" and \"delay\" are ignored.</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
  26       "linenr": 70,
  27       "html_filename": "ClickRepeater.html",
  28       "href": "ClickRepeater.html#Ext-util-ClickRepeater-cfg-accelerate"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "delay",
  33       "member": "Ext.util.ClickRepeater",
  34       "type": "Number",
  35       "doc": "<p>The initial delay before the repeating event begins firing.\nSimilar to an autorepeat key delay.</p>\n",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
  38       "linenr": 80,
  39       "html_filename": "ClickRepeater.html",
  40       "href": "ClickRepeater.html#Ext-util-ClickRepeater-cfg-delay"
  41     },
  42     {
  43       "tagname": "cfg",
  44       "name": "el",
  45       "member": "Ext.util.ClickRepeater",
  46       "type": "Mixed",
  47       "doc": "<p>The element to act as a button.</p>\n",
  48       "private": false,
  49       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
  50       "linenr": 62,
  51       "html_filename": "ClickRepeater.html",
  52       "href": "ClickRepeater.html#Ext-util-ClickRepeater-cfg-el"
  53     },
  54     {
  55       "tagname": "cfg",
  56       "name": "interval",
  57       "member": "Ext.util.ClickRepeater",
  58       "type": "Number",
  59       "doc": "<p>The interval between firings of the \"click\" event. Default 20 ms.</p>\n",
  60       "private": false,
  61       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
  62       "linenr": 75,
  63       "html_filename": "ClickRepeater.html",
  64       "href": "ClickRepeater.html#Ext-util-ClickRepeater-cfg-interval"
  65     },
  66     {
  67       "tagname": "cfg",
  68       "name": "listeners",
  69       "member": "Ext.util.Observable",
  70       "type": "Object",
  71       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.util.ClickRepeater-method-addListener\" rel=\"Ext.util.ClickRepeater-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
  72       "private": false,
  73       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  74       "linenr": 103,
  75       "html_filename": "Observable.html",
  76       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  77       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
  78     },
  79     {
  80       "tagname": "cfg",
  81       "name": "pressedCls",
  82       "member": "Ext.util.ClickRepeater",
  83       "type": "String",
  84       "doc": "<p>A CSS class name to be applied to the element while pressed.</p>\n",
  85       "private": false,
  86       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
  87       "linenr": 66,
  88       "html_filename": "ClickRepeater.html",
  89       "href": "ClickRepeater.html#Ext-util-ClickRepeater-cfg-pressedCls"
  90     },
  91     {
  92       "tagname": "cfg",
  93       "name": "preventDefault",
  94       "member": "Ext.util.ClickRepeater",
  95       "type": "Boolean",
  96       "doc": "<p>True to prevent the default click event</p>\n",
  97       "private": false,
  98       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
  99       "linenr": 86,
 100       "html_filename": "ClickRepeater.html",
 101       "href": "ClickRepeater.html#Ext-util-ClickRepeater-cfg-preventDefault"
 102     },
 103     {
 104       "tagname": "cfg",
 105       "name": "stopDefault",
 106       "member": "Ext.util.ClickRepeater",
 107       "type": "Boolean",
 108       "doc": "<p>True to stop the default click event</p>\n",
 109       "private": false,
 110       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 111       "linenr": 90,
 112       "html_filename": "ClickRepeater.html",
 113       "href": "ClickRepeater.html#Ext-util-ClickRepeater-cfg-stopDefault"
 114     }
 115   ],
 116   "method": [
 117     {
 118       "tagname": "method",
 119       "name": "ClickRepeater",
 120       "member": "Ext.util.ClickRepeater",
 121       "doc": "\n",
 122       "params": [
 123         {
 124           "type": "Mixed",
 125           "name": "el",
 126           "doc": "<p>The element to listen on</p>\n",
 127           "optional": false
 128         },
 129         {
 130           "type": "Object",
 131           "name": "config",
 132           "doc": "\n",
 133           "optional": false
 134         }
 135       ],
 136       "return": {
 137         "type": "void",
 138         "doc": "\n"
 139       },
 140       "private": false,
 141       "static": false,
 142       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 143       "linenr": 1,
 144       "html_filename": "ClickRepeater.html",
 145       "href": "ClickRepeater.html#Ext-util-ClickRepeater-method-constructor",
 146       "shortDoc": "\n"
 147     },
 148     {
 149       "tagname": "method",
 150       "name": "addEvents",
 151       "member": "Ext.util.Observable",
 152       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
 153       "params": [
 154         {
 155           "type": "Object/String",
 156           "name": "o",
 157           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
 158           "optional": false
 159         },
 160         {
 161           "type": "String",
 162           "name": "",
 163           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
 164           "optional": false
 165         }
 166       ],
 167       "return": {
 168         "type": "void",
 169         "doc": "\n"
 170       },
 171       "private": false,
 172       "static": false,
 173       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 174       "linenr": 452,
 175       "html_filename": "Observable.html",
 176       "href": "Observable.html#Ext-util-Observable-method-addEvents",
 177       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
 178     },
 179     {
 180       "tagname": "method",
 181       "name": "addListener",
 182       "member": "Ext.util.Observable",
 183       "doc": "<p>Appends an event handler to this object.</p>\n",
 184       "params": [
 185         {
 186           "type": "String",
 187           "name": "eventName",
 188           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
 189           "optional": false
 190         },
 191         {
 192           "type": "Function",
 193           "name": "handler",
 194           "doc": "<p>The method the event invokes.</p>\n",
 195           "optional": false
 196         },
 197         {
 198           "type": "Object",
 199           "name": "scope",
 200           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
 201           "optional": true
 202         },
 203         {
 204           "type": "Object",
 205           "name": "options",
 206           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
 207           "optional": true
 208         }
 209       ],
 210       "return": {
 211         "type": "void",
 212         "doc": "\n"
 213       },
 214       "private": false,
 215       "static": false,
 216       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 217       "linenr": 271,
 218       "html_filename": "Observable.html",
 219       "href": "Observable.html#Ext-util-Observable-method-addListener",
 220       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 221     },
 222     {
 223       "tagname": "method",
 224       "name": "addManagedListener",
 225       "member": "Ext.util.Observable",
 226       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 227       "params": [
 228         {
 229           "type": "Observable/Element",
 230           "name": "item",
 231           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 232           "optional": false
 233         },
 234         {
 235           "type": "Object/String",
 236           "name": "ename",
 237           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 238           "optional": false
 239         },
 240         {
 241           "type": "Function",
 242           "name": "fn",
 243           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 244           "optional": false
 245         },
 246         {
 247           "type": "Object",
 248           "name": "scope",
 249           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
 250           "optional": false
 251         },
 252         {
 253           "type": "Object",
 254           "name": "opt",
 255           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
 256           "optional": false
 257         }
 258       ],
 259       "return": {
 260         "type": "void",
 261         "doc": "\n"
 262       },
 263       "private": false,
 264       "static": false,
 265       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 266       "linenr": 155,
 267       "html_filename": "Observable.html",
 268       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 269       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 270     },
 271     {
 272       "tagname": "method",
 273       "name": "capture",
 274       "member": "Ext.util.Observable",
 275       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
 276       "params": [
 277         {
 278           "type": "Observable",
 279           "name": "o",
 280           "doc": "<p>The Observable to capture events from.</p>\n",
 281           "optional": false
 282         },
 283         {
 284           "type": "Function",
 285           "name": "fn",
 286           "doc": "<p>The function to call when an event is fired.</p>\n",
 287           "optional": false
 288         },
 289         {
 290           "type": "Object",
 291           "name": "scope",
 292           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 293           "optional": true
 294         }
 295       ],
 296       "return": {
 297         "type": "void",
 298         "doc": "\n"
 299       },
 300       "private": false,
 301       "static": true,
 302       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 303       "linenr": 55,
 304       "html_filename": "Observable.html",
 305       "href": "Observable.html#Ext-util-Observable-method-capture",
 306       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 307     },
 308     {
 309       "tagname": "method",
 310       "name": "clearListeners",
 311       "member": "Ext.util.Observable",
 312       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 313       "params": [
 314
 315       ],
 316       "return": {
 317         "type": "void",
 318         "doc": "\n"
 319       },
 320       "private": false,
 321       "static": false,
 322       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 323       "linenr": 383,
 324       "html_filename": "Observable.html",
 325       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 326       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 327     },
 328     {
 329       "tagname": "method",
 330       "name": "clearManagedListeners",
 331       "member": "Ext.util.Observable",
 332       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 333       "params": [
 334
 335       ],
 336       "return": {
 337         "type": "void",
 338         "doc": "\n"
 339       },
 340       "private": false,
 341       "static": false,
 342       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 343       "linenr": 412,
 344       "html_filename": "Observable.html",
 345       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 346       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 347     },
 348     {
 349       "tagname": "method",
 350       "name": "disable",
 351       "member": "Ext.util.ClickRepeater",
 352       "doc": "<p>Disables the repeater and stops events from firing.</p>\n",
 353       "params": [
 354         {
 355           "type": "Object",
 356           "name": "force",
 357           "doc": "\n",
 358           "optional": false
 359         }
 360       ],
 361       "return": {
 362         "type": "void",
 363         "doc": "\n"
 364       },
 365       "private": false,
 366       "static": false,
 367       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 368       "linenr": 113,
 369       "html_filename": "ClickRepeater.html",
 370       "href": "ClickRepeater.html#Ext-util-ClickRepeater-method-disable",
 371       "shortDoc": "<p>Disables the repeater and stops events from firing.</p>\n"
 372     },
 373     {
 374       "tagname": "method",
 375       "name": "enable",
 376       "member": "Ext.util.ClickRepeater",
 377       "doc": "<p>Enables the repeater and allows events to fire.</p>\n",
 378       "params": [
 379
 380       ],
 381       "return": {
 382         "type": "void",
 383         "doc": "\n"
 384       },
 385       "private": false,
 386       "static": false,
 387       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 388       "linenr": 97,
 389       "html_filename": "ClickRepeater.html",
 390       "href": "ClickRepeater.html#Ext-util-ClickRepeater-method-enable",
 391       "shortDoc": "<p>Enables the repeater and allows events to fire.</p>\n"
 392     },
 393     {
 394       "tagname": "method",
 395       "name": "enableBubble",
 396       "member": "Ext.util.Observable",
 397       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
 398       "params": [
 399         {
 400           "type": "String/Array",
 401           "name": "events",
 402           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 403           "optional": false
 404         }
 405       ],
 406       "return": {
 407         "type": "void",
 408         "doc": "\n"
 409       },
 410       "private": false,
 411       "static": false,
 412       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 413       "linenr": 554,
 414       "html_filename": "Observable.html",
 415       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 416       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 417     },
 418     {
 419       "tagname": "method",
 420       "name": "fireEvent",
 421       "member": "Ext.util.Observable",
 422       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.util.ClickRepeater-method-enableBubble\" rel=\"Ext.util.ClickRepeater-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 423       "params": [
 424         {
 425           "type": "String",
 426           "name": "eventName",
 427           "doc": "<p>The name of the event to fire.</p>\n",
 428           "optional": false
 429         },
 430         {
 431           "type": "Object...",
 432           "name": "args",
 433           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 434           "optional": false
 435         }
 436       ],
 437       "return": {
 438         "type": "Boolean",
 439         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 440       },
 441       "private": false,
 442       "static": false,
 443       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 444       "linenr": 232,
 445       "html_filename": "Observable.html",
 446       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 447       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
 448     },
 449     {
 450       "tagname": "method",
 451       "name": "hasListener",
 452       "member": "Ext.util.Observable",
 453       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 454       "params": [
 455         {
 456           "type": "String",
 457           "name": "eventName",
 458           "doc": "<p>The name of the event to check for</p>\n",
 459           "optional": false
 460         }
 461       ],
 462       "return": {
 463         "type": "Boolean",
 464         "doc": "<p>True if the event is being listened for, else false</p>\n"
 465       },
 466       "private": false,
 467       "static": false,
 468       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 469       "linenr": 480,
 470       "html_filename": "Observable.html",
 471       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 472       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 473     },
 474     {
 475       "tagname": "method",
 476       "name": "observe",
 477       "member": "Ext.util.Observable",
 478       "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
 479       "params": [
 480         {
 481           "type": "Function",
 482           "name": "c",
 483           "doc": "<p>The class constructor to make observable.</p>\n",
 484           "optional": false
 485         },
 486         {
 487           "type": "Object",
 488           "name": "listeners",
 489           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.util.ClickRepeater-method-addListener\" rel=\"Ext.util.ClickRepeater-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 490           "optional": false
 491         }
 492       ],
 493       "return": {
 494         "type": "void",
 495         "doc": "\n"
 496       },
 497       "private": false,
 498       "static": true,
 499       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 500       "linenr": 69,
 501       "html_filename": "Observable.html",
 502       "href": "Observable.html#Ext-util-Observable-method-observe",
 503       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 504     },
 505     {
 506       "tagname": "method",
 507       "name": "on",
 508       "member": "Ext.util.Observable",
 509       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.util.ClickRepeater-method-addListener\" rel=\"Ext.util.ClickRepeater-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 510       "params": [
 511         {
 512           "type": "String",
 513           "name": "eventName",
 514           "doc": "<p>The type of event to listen for</p>\n",
 515           "optional": false
 516         },
 517         {
 518           "type": "Function",
 519           "name": "handler",
 520           "doc": "<p>The method the event invokes</p>\n",
 521           "optional": false
 522         },
 523         {
 524           "type": "Object",
 525           "name": "scope",
 526           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
 527           "optional": true
 528         },
 529         {
 530           "type": "Object",
 531           "name": "options",
 532           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 533           "optional": true
 534         }
 535       ],
 536       "return": {
 537         "type": "void",
 538         "doc": "\n"
 539       },
 540       "private": false,
 541       "static": false,
 542       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 543       "linenr": 616,
 544       "html_filename": "Observable.html",
 545       "href": "Observable.html#Ext-util-Observable-method-on",
 546       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.util.ClickRepeater-method-addListener\" rel=\"Ext.util.ClickRepeater-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 547     },
 548     {
 549       "tagname": "method",
 550       "name": "relayEvents",
 551       "member": "Ext.util.Observable",
 552       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 553       "params": [
 554         {
 555           "type": "Object",
 556           "name": "origin",
 557           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 558           "optional": false
 559         },
 560         {
 561           "type": "Array",
 562           "name": "events",
 563           "doc": "<p>Array of event names to relay.</p>\n",
 564           "optional": false
 565         },
 566         {
 567           "type": "Object",
 568           "name": "prefix",
 569           "doc": "\n",
 570           "optional": false
 571         }
 572       ],
 573       "return": {
 574         "type": "void",
 575         "doc": "\n"
 576       },
 577       "private": false,
 578       "static": false,
 579       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 580       "linenr": 520,
 581       "html_filename": "Observable.html",
 582       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 583       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 584     },
 585     {
 586       "tagname": "method",
 587       "name": "releaseCapture",
 588       "member": "Ext.util.Observable",
 589       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 590       "params": [
 591         {
 592           "type": "Observable",
 593           "name": "o",
 594           "doc": "<p>The Observable to release</p>\n",
 595           "optional": false
 596         }
 597       ],
 598       "return": {
 599         "type": "void",
 600         "doc": "\n"
 601       },
 602       "private": false,
 603       "static": true,
 604       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 605       "linenr": 46,
 606       "html_filename": "Observable.html",
 607       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 608       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 609     },
 610     {
 611       "tagname": "method",
 612       "name": "removeListener",
 613       "member": "Ext.util.Observable",
 614       "doc": "<p>Removes an event handler.</p>\n",
 615       "params": [
 616         {
 617           "type": "String",
 618           "name": "eventName",
 619           "doc": "<p>The type of event the handler was associated with.</p>\n",
 620           "optional": false
 621         },
 622         {
 623           "type": "Function",
 624           "name": "handler",
 625           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.util.ClickRepeater-method-addListener\" rel=\"Ext.util.ClickRepeater-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 626           "optional": false
 627         },
 628         {
 629           "type": "Object",
 630           "name": "scope",
 631           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 632           "optional": true
 633         }
 634       ],
 635       "return": {
 636         "type": "void",
 637         "doc": "\n"
 638       },
 639       "private": false,
 640       "static": false,
 641       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 642       "linenr": 352,
 643       "html_filename": "Observable.html",
 644       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 645       "shortDoc": "<p>Removes an event handler.</p>\n"
 646     },
 647     {
 648       "tagname": "method",
 649       "name": "removeManagedListener",
 650       "member": "Ext.util.Observable",
 651       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.util.ClickRepeater--mon\" rel=\"Ext.util.ClickRepeater--mon\" class=\"docClass\">mon</a> method.</p>\n",
 652       "params": [
 653         {
 654           "type": "Observable|Element",
 655           "name": "item",
 656           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 657           "optional": false
 658         },
 659         {
 660           "type": "Object|String",
 661           "name": "ename",
 662           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 663           "optional": false
 664         },
 665         {
 666           "type": "Function",
 667           "name": "fn",
 668           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 669           "optional": false
 670         },
 671         {
 672           "type": "Object",
 673           "name": "scope",
 674           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
 675           "optional": false
 676         }
 677       ],
 678       "return": {
 679         "type": "void",
 680         "doc": "\n"
 681       },
 682       "private": false,
 683       "static": false,
 684       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 685       "linenr": 196,
 686       "html_filename": "Observable.html",
 687       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 688       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.util.ClickRepeater--mon\" rel=\"Ext.util.ClickRepeater--mon\" class=\"docClass\">mon</a> method.</p>\n"
 689     },
 690     {
 691       "tagname": "method",
 692       "name": "resumeEvents",
 693       "member": "Ext.util.Observable",
 694       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.util.ClickRepeater-method-suspendEvents\" rel=\"Ext.util.ClickRepeater-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
 695       "params": [
 696
 697       ],
 698       "return": {
 699         "type": "void",
 700         "doc": "\n"
 701       },
 702       "private": false,
 703       "static": false,
 704       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 705       "linenr": 502,
 706       "html_filename": "Observable.html",
 707       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 708       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 709     },
 710     {
 711       "tagname": "method",
 712       "name": "setDisabled",
 713       "member": "Ext.util.ClickRepeater",
 714       "doc": "<p>Convenience function for setting disabled/enabled by boolean.</p>\n",
 715       "params": [
 716         {
 717           "type": "Boolean",
 718           "name": "disabled",
 719           "doc": "\n",
 720           "optional": false
 721         }
 722       ],
 723       "return": {
 724         "type": "void",
 725         "doc": "\n"
 726       },
 727       "private": false,
 728       "static": false,
 729       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 730       "linenr": 128,
 731       "html_filename": "ClickRepeater.html",
 732       "href": "ClickRepeater.html#Ext-util-ClickRepeater-method-setDisabled",
 733       "shortDoc": "<p>Convenience function for setting disabled/enabled by boolean.</p>\n"
 734     },
 735     {
 736       "tagname": "method",
 737       "name": "suspendEvents",
 738       "member": "Ext.util.Observable",
 739       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.util.ClickRepeater-method-resumeEvents\" rel=\"Ext.util.ClickRepeater-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 740       "params": [
 741         {
 742           "type": "Boolean",
 743           "name": "queueSuspended",
 744           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.util.ClickRepeater-method-resumeEvents\" rel=\"Ext.util.ClickRepeater-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 745           "optional": false
 746         }
 747       ],
 748       "return": {
 749         "type": "void",
 750         "doc": "\n"
 751       },
 752       "private": false,
 753       "static": false,
 754       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 755       "linenr": 490,
 756       "html_filename": "Observable.html",
 757       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 758       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.util.ClickRepeater-method-resumeEvents\" rel=\"Ext.util.ClickRepeater-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 759     },
 760     {
 761       "tagname": "method",
 762       "name": "un",
 763       "member": "Ext.util.Observable",
 764       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.util.ClickRepeater-method-removeListener\" rel=\"Ext.util.ClickRepeater-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 765       "params": [
 766         {
 767           "type": "String",
 768           "name": "eventName",
 769           "doc": "<p>The type of event the handler was associated with.</p>\n",
 770           "optional": false
 771         },
 772         {
 773           "type": "Function",
 774           "name": "handler",
 775           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.util.ClickRepeater-method-addListener\" rel=\"Ext.util.ClickRepeater-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 776           "optional": false
 777         },
 778         {
 779           "type": "Object",
 780           "name": "scope",
 781           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 782           "optional": true
 783         }
 784       ],
 785       "return": {
 786         "type": "void",
 787         "doc": "\n"
 788       },
 789       "private": false,
 790       "static": false,
 791       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 792       "linenr": 608,
 793       "html_filename": "Observable.html",
 794       "href": "Observable.html#Ext-util-Observable-method-un",
 795       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.util.ClickRepeater-method-removeListener\" rel=\"Ext.util.ClickRepeater-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 796     }
 797   ],
 798   "property": [
 799
 800   ],
 801   "event": [
 802     {
 803       "tagname": "event",
 804       "name": "click",
 805       "member": "Ext.util.ClickRepeater",
 806       "doc": "<p>Fires on a specified interval during the time the element is pressed.</p>\n",
 807       "params": [
 808         {
 809           "type": "Ext.util.ClickRepeater",
 810           "name": "this",
 811           "doc": "\n",
 812           "optional": false
 813         },
 814         {
 815           "type": "Ext.EventObject",
 816           "name": "e",
 817           "doc": "\n",
 818           "optional": false
 819         }
 820       ],
 821       "private": false,
 822       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 823       "linenr": 33,
 824       "html_filename": "ClickRepeater.html",
 825       "href": "ClickRepeater.html#Ext-util-ClickRepeater-event-click",
 826       "shortDoc": "<p>Fires on a specified interval during the time the element is pressed.</p>\n"
 827     },
 828     {
 829       "tagname": "event",
 830       "name": "mousedown",
 831       "member": "Ext.util.ClickRepeater",
 832       "doc": "<p>Fires when the mouse button is depressed.</p>\n",
 833       "params": [
 834         {
 835           "type": "Ext.util.ClickRepeater",
 836           "name": "this",
 837           "doc": "\n",
 838           "optional": false
 839         },
 840         {
 841           "type": "Ext.EventObject",
 842           "name": "e",
 843           "doc": "\n",
 844           "optional": false
 845         }
 846       ],
 847       "private": false,
 848       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 849       "linenr": 26,
 850       "html_filename": "ClickRepeater.html",
 851       "href": "ClickRepeater.html#Ext-util-ClickRepeater-event-mousedown",
 852       "shortDoc": "<p>Fires when the mouse button is depressed.</p>\n"
 853     },
 854     {
 855       "tagname": "event",
 856       "name": "mouseup",
 857       "member": "Ext.util.ClickRepeater",
 858       "doc": "<p>Fires when the mouse key is released.</p>\n",
 859       "params": [
 860         {
 861           "type": "Ext.util.ClickRepeater",
 862           "name": "this",
 863           "doc": "\n",
 864           "optional": false
 865         },
 866         {
 867           "type": "Ext.EventObject",
 868           "name": "e",
 869           "doc": "\n",
 870           "optional": false
 871         }
 872       ],
 873       "private": false,
 874       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 875       "linenr": 40,
 876       "html_filename": "ClickRepeater.html",
 877       "href": "ClickRepeater.html#Ext-util-ClickRepeater-event-mouseup",
 878       "shortDoc": "<p>Fires when the mouse key is released.</p>\n"
 879     }
 880   ],
 881   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ClickRepeater.js",
 882   "linenr": 1,
 883   "html_filename": "ClickRepeater.html",
 884   "href": "ClickRepeater.html#Ext-util-ClickRepeater",
 885   "cssVar": [
 886
 887   ],
 888   "cssMixin": [
 889
 890   ],
 891   "component": false,
 892   "superclasses": [
 893     "Ext.util.Observable"
 894   ],
 895   "subclasses": [
 896
 897   ],
 898   "mixedInto": [
 899
 900   ],
 901   "allMixins": [
 902
 903   ]
 904 });