docs/output/Ext.layout.container.boxOverflow.Scroller.js

   1 Ext.data.JsonP.Ext_layout_container_boxOverflow_Scroller({
   2   "tagname": "class",
   3   "name": "Ext.layout.container.boxOverflow.Scroller",
   4   "doc": "\n",
   5   "extends": "Ext.layout.container.boxOverflow.None",
   6   "mixins": [
   7     "Ext.util.Observable"
   8   ],
   9   "alternateClassNames": [
  10     "Ext.layout.boxOverflow.Scroller"
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": true,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "afterCtCls",
  21       "member": "Ext.layout.container.boxOverflow.Scroller",
  22       "type": "String",
  23       "doc": "<p>CSS class added to the afterCt element. This is the element that holds any special items such as scrollers,\nwhich must always be present at the rightmost edge of the Container</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
  26       "linenr": 55,
  27       "html_filename": "Scroller2.html",
  28       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-afterCtCls",
  29       "shortDoc": "CSS class added to the afterCt element. This is the element that holds any special items such as scrollers,\nwhich mus..."
  30     },
  31     {
  32       "tagname": "cfg",
  33       "name": "afterScrollerCls",
  34       "member": "Ext.layout.container.boxOverflow.Scroller",
  35       "type": "String",
  36       "doc": "<p>CSS class added to the right scroller element if enableScroll is used</p>\n",
  37       "private": false,
  38       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
  39       "linenr": 72,
  40       "html_filename": "Scroller2.html",
  41       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-afterScrollerCls"
  42     },
  43     {
  44       "tagname": "cfg",
  45       "name": "animateScroll",
  46       "member": "Ext.layout.container.boxOverflow.Scroller",
  47       "type": "Boolean",
  48       "doc": "<p>True to animate the scrolling of items within the layout (defaults to true, ignored if enableScroll is false)</p>\n",
  49       "private": false,
  50       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
  51       "linenr": 19,
  52       "html_filename": "Scroller2.html",
  53       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-animateScroll"
  54     },
  55     {
  56       "tagname": "cfg",
  57       "name": "beforeCtCls",
  58       "member": "Ext.layout.container.boxOverflow.Scroller",
  59       "type": "String",
  60       "doc": "<p>CSS class added to the beforeCt element. This is the element that holds any special items such as scrollers,\nwhich must always be present at the leftmost edge of the Container</p>\n",
  61       "private": false,
  62       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
  63       "linenr": 49,
  64       "html_filename": "Scroller2.html",
  65       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-beforeCtCls",
  66       "shortDoc": "CSS class added to the beforeCt element. This is the element that holds any special items such as scrollers,\nwhich mu..."
  67     },
  68     {
  69       "tagname": "cfg",
  70       "name": "beforeScrollerCls",
  71       "member": "Ext.layout.container.boxOverflow.Scroller",
  72       "type": "String",
  73       "doc": "<p>CSS class added to the left scroller element if enableScroll is used</p>\n",
  74       "private": false,
  75       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
  76       "linenr": 67,
  77       "html_filename": "Scroller2.html",
  78       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-beforeScrollerCls"
  79     },
  80     {
  81       "tagname": "cfg",
  82       "name": "listeners",
  83       "member": "Ext.util.Observable",
  84       "type": "Object",
  85       "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.layout.container.boxOverflow.Scroller-method-addListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-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",
  86       "private": false,
  87       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  88       "linenr": 103,
  89       "html_filename": "Observable.html",
  90       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  91       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
  92     },
  93     {
  94       "tagname": "cfg",
  95       "name": "scrollDuration",
  96       "member": "Ext.layout.container.boxOverflow.Scroller",
  97       "type": "Number",
  98       "doc": "<p>Number of milliseconds that each scroll animation lasts (defaults to 400)</p>\n",
  99       "private": false,
 100       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 101       "linenr": 43,
 102       "html_filename": "Scroller2.html",
 103       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-scrollDuration"
 104     },
 105     {
 106       "tagname": "cfg",
 107       "name": "scrollIncrement",
 108       "member": "Ext.layout.container.boxOverflow.Scroller",
 109       "type": "Number",
 110       "doc": "<p>The number of pixels to scroll by on scroller click (defaults to 24)</p>\n",
 111       "private": false,
 112       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 113       "linenr": 25,
 114       "html_filename": "Scroller2.html",
 115       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-scrollIncrement"
 116     },
 117     {
 118       "tagname": "cfg",
 119       "name": "scrollRepeatInterval",
 120       "member": "Ext.layout.container.boxOverflow.Scroller",
 121       "type": "Number",
 122       "doc": "<p>Number of milliseconds between each scroll while a scroller button is held down (defaults to 20)</p>\n",
 123       "private": false,
 124       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 125       "linenr": 37,
 126       "html_filename": "Scroller2.html",
 127       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-scrollRepeatInterval"
 128     },
 129     {
 130       "tagname": "cfg",
 131       "name": "scrollerCls",
 132       "member": "Ext.layout.container.boxOverflow.Scroller",
 133       "type": "String",
 134       "doc": "<p>CSS class added to both scroller elements if enableScroll is used</p>\n",
 135       "private": false,
 136       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 137       "linenr": 61,
 138       "html_filename": "Scroller2.html",
 139       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-scrollerCls"
 140     },
 141     {
 142       "tagname": "cfg",
 143       "name": "wheelIncrement",
 144       "member": "Ext.layout.container.boxOverflow.Scroller",
 145       "type": "Number",
 146       "doc": "<p>The number of pixels to increment on mouse wheel scrolling (defaults to <tt>3</tt>).</p>\n",
 147       "private": false,
 148       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 149       "linenr": 31,
 150       "html_filename": "Scroller2.html",
 151       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-cfg-wheelIncrement"
 152     }
 153   ],
 154   "method": [
 155     {
 156       "tagname": "method",
 157       "name": "addEvents",
 158       "member": "Ext.util.Observable",
 159       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
 160       "params": [
 161         {
 162           "type": "Object/String",
 163           "name": "o",
 164           "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",
 165           "optional": false
 166         },
 167         {
 168           "type": "String",
 169           "name": "",
 170           "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",
 171           "optional": false
 172         }
 173       ],
 174       "return": {
 175         "type": "void",
 176         "doc": "\n"
 177       },
 178       "private": false,
 179       "static": false,
 180       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 181       "linenr": 452,
 182       "html_filename": "Observable.html",
 183       "href": "Observable.html#Ext-util-Observable-method-addEvents",
 184       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
 185     },
 186     {
 187       "tagname": "method",
 188       "name": "addListener",
 189       "member": "Ext.util.Observable",
 190       "doc": "<p>Appends an event handler to this object.</p>\n",
 191       "params": [
 192         {
 193           "type": "String",
 194           "name": "eventName",
 195           "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",
 196           "optional": false
 197         },
 198         {
 199           "type": "Function",
 200           "name": "handler",
 201           "doc": "<p>The method the event invokes.</p>\n",
 202           "optional": false
 203         },
 204         {
 205           "type": "Object",
 206           "name": "scope",
 207           "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",
 208           "optional": true
 209         },
 210         {
 211           "type": "Object",
 212           "name": "options",
 213           "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",
 214           "optional": true
 215         }
 216       ],
 217       "return": {
 218         "type": "void",
 219         "doc": "\n"
 220       },
 221       "private": false,
 222       "static": false,
 223       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 224       "linenr": 271,
 225       "html_filename": "Observable.html",
 226       "href": "Observable.html#Ext-util-Observable-method-addListener",
 227       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 228     },
 229     {
 230       "tagname": "method",
 231       "name": "addManagedListener",
 232       "member": "Ext.util.Observable",
 233       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 234       "params": [
 235         {
 236           "type": "Observable/Element",
 237           "name": "item",
 238           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 239           "optional": false
 240         },
 241         {
 242           "type": "Object/String",
 243           "name": "ename",
 244           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 245           "optional": false
 246         },
 247         {
 248           "type": "Function",
 249           "name": "fn",
 250           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 251           "optional": false
 252         },
 253         {
 254           "type": "Object",
 255           "name": "scope",
 256           "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",
 257           "optional": false
 258         },
 259         {
 260           "type": "Object",
 261           "name": "opt",
 262           "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",
 263           "optional": false
 264         }
 265       ],
 266       "return": {
 267         "type": "void",
 268         "doc": "\n"
 269       },
 270       "private": false,
 271       "static": false,
 272       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 273       "linenr": 155,
 274       "html_filename": "Observable.html",
 275       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 276       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 277     },
 278     {
 279       "tagname": "method",
 280       "name": "capture",
 281       "member": "Ext.util.Observable",
 282       "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",
 283       "params": [
 284         {
 285           "type": "Observable",
 286           "name": "o",
 287           "doc": "<p>The Observable to capture events from.</p>\n",
 288           "optional": false
 289         },
 290         {
 291           "type": "Function",
 292           "name": "fn",
 293           "doc": "<p>The function to call when an event is fired.</p>\n",
 294           "optional": false
 295         },
 296         {
 297           "type": "Object",
 298           "name": "scope",
 299           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 300           "optional": true
 301         }
 302       ],
 303       "return": {
 304         "type": "void",
 305         "doc": "\n"
 306       },
 307       "private": false,
 308       "static": true,
 309       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 310       "linenr": 55,
 311       "html_filename": "Observable.html",
 312       "href": "Observable.html#Ext-util-Observable-method-capture",
 313       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 314     },
 315     {
 316       "tagname": "method",
 317       "name": "clearListeners",
 318       "member": "Ext.util.Observable",
 319       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 320       "params": [
 321
 322       ],
 323       "return": {
 324         "type": "void",
 325         "doc": "\n"
 326       },
 327       "private": false,
 328       "static": false,
 329       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 330       "linenr": 383,
 331       "html_filename": "Observable.html",
 332       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 333       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 334     },
 335     {
 336       "tagname": "method",
 337       "name": "clearManagedListeners",
 338       "member": "Ext.util.Observable",
 339       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 340       "params": [
 341
 342       ],
 343       "return": {
 344         "type": "void",
 345         "doc": "\n"
 346       },
 347       "private": false,
 348       "static": false,
 349       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 350       "linenr": 412,
 351       "html_filename": "Observable.html",
 352       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 353       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 354     },
 355     {
 356       "tagname": "method",
 357       "name": "enableBubble",
 358       "member": "Ext.util.Observable",
 359       "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",
 360       "params": [
 361         {
 362           "type": "String/Array",
 363           "name": "events",
 364           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 365           "optional": false
 366         }
 367       ],
 368       "return": {
 369         "type": "void",
 370         "doc": "\n"
 371       },
 372       "private": false,
 373       "static": false,
 374       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 375       "linenr": 554,
 376       "html_filename": "Observable.html",
 377       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 378       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 379     },
 380     {
 381       "tagname": "method",
 382       "name": "fireEvent",
 383       "member": "Ext.util.Observable",
 384       "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.layout.container.boxOverflow.Scroller-method-enableBubble\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 385       "params": [
 386         {
 387           "type": "String",
 388           "name": "eventName",
 389           "doc": "<p>The name of the event to fire.</p>\n",
 390           "optional": false
 391         },
 392         {
 393           "type": "Object...",
 394           "name": "args",
 395           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 396           "optional": false
 397         }
 398       ],
 399       "return": {
 400         "type": "Boolean",
 401         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 402       },
 403       "private": false,
 404       "static": false,
 405       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 406       "linenr": 232,
 407       "html_filename": "Observable.html",
 408       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 409       "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..."
 410     },
 411     {
 412       "tagname": "method",
 413       "name": "getScrollPosition",
 414       "member": "Ext.layout.container.boxOverflow.Scroller",
 415       "doc": "<p>Returns the current scroll position of the innerCt element</p>\n",
 416       "params": [
 417
 418       ],
 419       "return": {
 420         "type": "Number",
 421         "doc": "<p>The current scroll position</p>\n"
 422       },
 423       "private": false,
 424       "static": false,
 425       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 426       "linenr": 307,
 427       "html_filename": "Scroller2.html",
 428       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-method-getScrollPosition",
 429       "shortDoc": "<p>Returns the current scroll position of the innerCt element</p>\n"
 430     },
 431     {
 432       "tagname": "method",
 433       "name": "hasListener",
 434       "member": "Ext.util.Observable",
 435       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 436       "params": [
 437         {
 438           "type": "String",
 439           "name": "eventName",
 440           "doc": "<p>The name of the event to check for</p>\n",
 441           "optional": false
 442         }
 443       ],
 444       "return": {
 445         "type": "Boolean",
 446         "doc": "<p>True if the event is being listened for, else false</p>\n"
 447       },
 448       "private": false,
 449       "static": false,
 450       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 451       "linenr": 480,
 452       "html_filename": "Observable.html",
 453       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 454       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 455     },
 456     {
 457       "tagname": "method",
 458       "name": "observe",
 459       "member": "Ext.util.Observable",
 460       "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",
 461       "params": [
 462         {
 463           "type": "Function",
 464           "name": "c",
 465           "doc": "<p>The class constructor to make observable.</p>\n",
 466           "optional": false
 467         },
 468         {
 469           "type": "Object",
 470           "name": "listeners",
 471           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-addListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 472           "optional": false
 473         }
 474       ],
 475       "return": {
 476         "type": "void",
 477         "doc": "\n"
 478       },
 479       "private": false,
 480       "static": true,
 481       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 482       "linenr": 69,
 483       "html_filename": "Observable.html",
 484       "href": "Observable.html#Ext-util-Observable-method-observe",
 485       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 486     },
 487     {
 488       "tagname": "method",
 489       "name": "on",
 490       "member": "Ext.util.Observable",
 491       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-addListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 492       "params": [
 493         {
 494           "type": "String",
 495           "name": "eventName",
 496           "doc": "<p>The type of event to listen for</p>\n",
 497           "optional": false
 498         },
 499         {
 500           "type": "Function",
 501           "name": "handler",
 502           "doc": "<p>The method the event invokes</p>\n",
 503           "optional": false
 504         },
 505         {
 506           "type": "Object",
 507           "name": "scope",
 508           "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",
 509           "optional": true
 510         },
 511         {
 512           "type": "Object",
 513           "name": "options",
 514           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 515           "optional": true
 516         }
 517       ],
 518       "return": {
 519         "type": "void",
 520         "doc": "\n"
 521       },
 522       "private": false,
 523       "static": false,
 524       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 525       "linenr": 616,
 526       "html_filename": "Observable.html",
 527       "href": "Observable.html#Ext-util-Observable-method-on",
 528       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-addListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 529     },
 530     {
 531       "tagname": "method",
 532       "name": "relayEvents",
 533       "member": "Ext.util.Observable",
 534       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 535       "params": [
 536         {
 537           "type": "Object",
 538           "name": "origin",
 539           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 540           "optional": false
 541         },
 542         {
 543           "type": "Array",
 544           "name": "events",
 545           "doc": "<p>Array of event names to relay.</p>\n",
 546           "optional": false
 547         },
 548         {
 549           "type": "Object",
 550           "name": "prefix",
 551           "doc": "\n",
 552           "optional": false
 553         }
 554       ],
 555       "return": {
 556         "type": "void",
 557         "doc": "\n"
 558       },
 559       "private": false,
 560       "static": false,
 561       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 562       "linenr": 520,
 563       "html_filename": "Observable.html",
 564       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 565       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 566     },
 567     {
 568       "tagname": "method",
 569       "name": "releaseCapture",
 570       "member": "Ext.util.Observable",
 571       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 572       "params": [
 573         {
 574           "type": "Observable",
 575           "name": "o",
 576           "doc": "<p>The Observable to release</p>\n",
 577           "optional": false
 578         }
 579       ],
 580       "return": {
 581         "type": "void",
 582         "doc": "\n"
 583       },
 584       "private": false,
 585       "static": true,
 586       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 587       "linenr": 46,
 588       "html_filename": "Observable.html",
 589       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 590       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 591     },
 592     {
 593       "tagname": "method",
 594       "name": "removeListener",
 595       "member": "Ext.util.Observable",
 596       "doc": "<p>Removes an event handler.</p>\n",
 597       "params": [
 598         {
 599           "type": "String",
 600           "name": "eventName",
 601           "doc": "<p>The type of event the handler was associated with.</p>\n",
 602           "optional": false
 603         },
 604         {
 605           "type": "Function",
 606           "name": "handler",
 607           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-addListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 608           "optional": false
 609         },
 610         {
 611           "type": "Object",
 612           "name": "scope",
 613           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 614           "optional": true
 615         }
 616       ],
 617       "return": {
 618         "type": "void",
 619         "doc": "\n"
 620       },
 621       "private": false,
 622       "static": false,
 623       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 624       "linenr": 352,
 625       "html_filename": "Observable.html",
 626       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 627       "shortDoc": "<p>Removes an event handler.</p>\n"
 628     },
 629     {
 630       "tagname": "method",
 631       "name": "removeManagedListener",
 632       "member": "Ext.util.Observable",
 633       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller--mon\" rel=\"Ext.layout.container.boxOverflow.Scroller--mon\" class=\"docClass\">mon</a> method.</p>\n",
 634       "params": [
 635         {
 636           "type": "Observable|Element",
 637           "name": "item",
 638           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 639           "optional": false
 640         },
 641         {
 642           "type": "Object|String",
 643           "name": "ename",
 644           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 645           "optional": false
 646         },
 647         {
 648           "type": "Function",
 649           "name": "fn",
 650           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 651           "optional": false
 652         },
 653         {
 654           "type": "Object",
 655           "name": "scope",
 656           "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",
 657           "optional": false
 658         }
 659       ],
 660       "return": {
 661         "type": "void",
 662         "doc": "\n"
 663       },
 664       "private": false,
 665       "static": false,
 666       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 667       "linenr": 196,
 668       "html_filename": "Observable.html",
 669       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 670       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller--mon\" rel=\"Ext.layout.container.boxOverflow.Scroller--mon\" class=\"docClass\">mon</a> method.</p>\n"
 671     },
 672     {
 673       "tagname": "method",
 674       "name": "resumeEvents",
 675       "member": "Ext.util.Observable",
 676       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-suspendEvents\" rel=\"Ext.layout.container.boxOverflow.Scroller-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",
 677       "params": [
 678
 679       ],
 680       "return": {
 681         "type": "void",
 682         "doc": "\n"
 683       },
 684       "private": false,
 685       "static": false,
 686       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 687       "linenr": 502,
 688       "html_filename": "Observable.html",
 689       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 690       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 691     },
 692     {
 693       "tagname": "method",
 694       "name": "scrollToItem",
 695       "member": "Ext.layout.container.boxOverflow.Scroller",
 696       "doc": "<p>Scrolls to the given component.</p>\n",
 697       "params": [
 698         {
 699           "type": "String|Number|Ext.Component",
 700           "name": "item",
 701           "doc": "<p>The item to scroll to. Can be a numerical index, component id\nor a reference to the component itself.</p>\n",
 702           "optional": false
 703         },
 704         {
 705           "type": "Boolean",
 706           "name": "animate",
 707           "doc": "<p>True to animate the scrolling</p>\n",
 708           "optional": false
 709         }
 710       ],
 711       "return": {
 712         "type": "void",
 713         "doc": "\n"
 714       },
 715       "private": false,
 716       "static": false,
 717       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 718       "linenr": 364,
 719       "html_filename": "Scroller2.html",
 720       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-method-scrollToItem",
 721       "shortDoc": "<p>Scrolls to the given component.</p>\n"
 722     },
 723     {
 724       "tagname": "method",
 725       "name": "suspendEvents",
 726       "member": "Ext.util.Observable",
 727       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-resumeEvents\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 728       "params": [
 729         {
 730           "type": "Boolean",
 731           "name": "queueSuspended",
 732           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-resumeEvents\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 733           "optional": false
 734         }
 735       ],
 736       "return": {
 737         "type": "void",
 738         "doc": "\n"
 739       },
 740       "private": false,
 741       "static": false,
 742       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 743       "linenr": 490,
 744       "html_filename": "Observable.html",
 745       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 746       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-resumeEvents\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 747     },
 748     {
 749       "tagname": "method",
 750       "name": "un",
 751       "member": "Ext.util.Observable",
 752       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-removeListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 753       "params": [
 754         {
 755           "type": "String",
 756           "name": "eventName",
 757           "doc": "<p>The type of event the handler was associated with.</p>\n",
 758           "optional": false
 759         },
 760         {
 761           "type": "Function",
 762           "name": "handler",
 763           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-addListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 764           "optional": false
 765         },
 766         {
 767           "type": "Object",
 768           "name": "scope",
 769           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 770           "optional": true
 771         }
 772       ],
 773       "return": {
 774         "type": "void",
 775         "doc": "\n"
 776       },
 777       "private": false,
 778       "static": false,
 779       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 780       "linenr": 608,
 781       "html_filename": "Observable.html",
 782       "href": "Observable.html#Ext-util-Observable-method-un",
 783       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.layout.container.boxOverflow.Scroller-method-removeListener\" rel=\"Ext.layout.container.boxOverflow.Scroller-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 784     }
 785   ],
 786   "property": [
 787     {
 788       "tagname": "property",
 789       "name": "afterScroller",
 790       "member": "Ext.layout.container.boxOverflow.Scroller",
 791       "type": "Ext.core.Element",
 792       "doc": "<p>The left scroller element. Only created when needed.</p>\n",
 793       "private": false,
 794       "static": false,
 795       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 796       "linenr": 226,
 797       "html_filename": "Scroller2.html",
 798       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-property-afterScroller"
 799     },
 800     {
 801       "tagname": "property",
 802       "name": "beforeScroller",
 803       "member": "Ext.layout.container.boxOverflow.Scroller",
 804       "type": "Ext.core.Element",
 805       "doc": "<p>The left scroller element. Only created when needed.</p>\n",
 806       "private": false,
 807       "static": false,
 808       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 809       "linenr": 219,
 810       "html_filename": "Scroller2.html",
 811       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-property-beforeScroller"
 812     }
 813   ],
 814   "event": [
 815     {
 816       "tagname": "event",
 817       "name": "scroll",
 818       "member": "Ext.layout.container.boxOverflow.Scroller",
 819       "doc": "\n",
 820       "params": [
 821         {
 822           "type": "Ext.layout.container.boxOverflow.Scroller",
 823           "name": "scroller",
 824           "doc": "<p>The layout scroller</p>\n",
 825           "optional": false
 826         },
 827         {
 828           "type": "Number",
 829           "name": "newPosition",
 830           "doc": "<p>The new position of the scroller</p>\n",
 831           "optional": false
 832         },
 833         {
 834           "type": "Boolean/Object",
 835           "name": "animate",
 836           "doc": "<p>If animating or not. If true, it will be a animation configuration, else it will be false</p>\n",
 837           "optional": false
 838         }
 839       ],
 840       "private": false,
 841       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 842       "linenr": 82,
 843       "html_filename": "Scroller2.html",
 844       "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller-event-scroll",
 845       "shortDoc": "\n"
 846     }
 847   ],
 848   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/boxOverflow/Scroller.js",
 849   "linenr": 1,
 850   "html_filename": "Scroller2.html",
 851   "href": "Scroller2.html#Ext-layout-container-boxOverflow-Scroller",
 852   "cssVar": [
 853
 854   ],
 855   "cssMixin": [
 856
 857   ],
 858   "component": false,
 859   "superclasses": [
 860     "Ext.layout.container.boxOverflow.None"
 861   ],
 862   "subclasses": [
 863
 864   ],
 865   "mixedInto": [
 866
 867   ],
 868   "allMixins": [
 869     "Ext.util.Observable"
 870   ]
 871 });