docs/output/Ext.direct.Manager.js

   1 Ext.data.JsonP.Ext_direct_Manager({
   2   "tagname": "class",
   3   "name": "Ext.direct.Manager",
   4   "doc": "<p><b><u>Overview</u></b></p>\n\n\n\n\n<p>Ext.Direct aims to streamline communication between the client and server\nby providing a single interface that reduces the amount of common code\ntypically required to validate data and handle returned data packets\n(reading data, error conditions, etc).</p>\n\n\n\n\n<p>The Ext.direct namespace includes several classes for a closer integration\nwith the server-side. The Ext.data namespace also includes classes for working\nwith Ext.data.Stores which are backed by data from an Ext.Direct method.</p>\n\n\n\n\n<p><b><u>Specification</u></b></p>\n\n\n\n\n<p>For additional information consult the\n<a href=\"http://sencha.com/products/extjs/extdirect\">Ext.Direct Specification</a>.</p>\n\n\n\n\n<p><b><u>Providers</u></b></p>\n\n\n\n\n<p>Ext.Direct uses a provider architecture, where one or more providers are\nused to transport data to and from the server. There are several providers\nthat exist in the core at the moment:</p>\n\n\n<div class=\"mdetail-params\"><ul>\n\n<li><a href=\"#/api/Ext.direct.JsonProvider\" rel=\"Ext.direct.JsonProvider\" class=\"docClass\">JsonProvider</a> for simple JSON operations</li>\n<li><a href=\"#/api/Ext.direct.PollingProvider\" rel=\"Ext.direct.PollingProvider\" class=\"docClass\">PollingProvider</a> for repeated requests</li>\n<li><a href=\"#/api/Ext.direct.RemotingProvider\" rel=\"Ext.direct.RemotingProvider\" class=\"docClass\">RemotingProvider</a> exposes server side\non the client.</li>\n</ul></div>\n\n\n\n\n<p>A provider does not need to be invoked directly, providers are added via\n<a href=\"#/api/Ext.direct.Manager\" rel=\"Ext.direct.Manager\" class=\"docClass\">Ext.direct.Manager</a>.<a href=\"#/api/Ext.direct.Manager--add\" rel=\"Ext.direct.Manager--add\" class=\"docClass\">add</a>.</p>\n\n\n\n\n<p><b><u>Router</u></b></p>\n\n\n\n\n<p>Ext.Direct utilizes a \"router\" on the server to direct requests from the client\nto the appropriate server-side method. Because the Ext.Direct API is completely\nplatform-agnostic, you could completely swap out a Java based server solution\nand replace it with one that uses C# without changing the client side JavaScript\nat all.</p>\n\n\n\n\n<p><b><u>Server side events</u></b></p>\n\n\n\n\n<p>Custom events from the server may be handled by the client by adding\nlisteners, for example:</p>\n\n\n<pre><code>{\"type\":\"event\",\"name\":\"message\",\"data\":\"Successfully polled at: 11:19:30 am\"}\n\n// add a handler for a 'message' event sent by the server\nExt.direct.Manager.on('message', function(e){\n    out.append(String.format('&lt;p>&lt;i>{0}&lt;/i>&lt;/p>', e.data));\n            out.el.scrollTo('t', 100000, true);\n});\n</code></pre>\n\n",
   5   "extends": null,
   6   "mixins": [
   7     "Ext.util.Observable"
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "listeners",
  21       "member": "Ext.util.Observable",
  22       "type": "Object",
  23       "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.direct.Manager-method-addListener\" rel=\"Ext.direct.Manager-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",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  26       "linenr": 103,
  27       "html_filename": "Observable.html",
  28       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  29       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
  30     }
  31   ],
  32   "method": [
  33     {
  34       "tagname": "method",
  35       "name": "addEvents",
  36       "member": "Ext.util.Observable",
  37       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
  38       "params": [
  39         {
  40           "type": "Object/String",
  41           "name": "o",
  42           "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",
  43           "optional": false
  44         },
  45         {
  46           "type": "String",
  47           "name": "",
  48           "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",
  49           "optional": false
  50         }
  51       ],
  52       "return": {
  53         "type": "void",
  54         "doc": "\n"
  55       },
  56       "private": false,
  57       "static": false,
  58       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  59       "linenr": 452,
  60       "html_filename": "Observable.html",
  61       "href": "Observable.html#Ext-util-Observable-method-addEvents",
  62       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
  63     },
  64     {
  65       "tagname": "method",
  66       "name": "addListener",
  67       "member": "Ext.util.Observable",
  68       "doc": "<p>Appends an event handler to this object.</p>\n",
  69       "params": [
  70         {
  71           "type": "String",
  72           "name": "eventName",
  73           "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",
  74           "optional": false
  75         },
  76         {
  77           "type": "Function",
  78           "name": "handler",
  79           "doc": "<p>The method the event invokes.</p>\n",
  80           "optional": false
  81         },
  82         {
  83           "type": "Object",
  84           "name": "scope",
  85           "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",
  86           "optional": true
  87         },
  88         {
  89           "type": "Object",
  90           "name": "options",
  91           "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",
  92           "optional": true
  93         }
  94       ],
  95       "return": {
  96         "type": "void",
  97         "doc": "\n"
  98       },
  99       "private": false,
 100       "static": false,
 101       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 102       "linenr": 271,
 103       "html_filename": "Observable.html",
 104       "href": "Observable.html#Ext-util-Observable-method-addListener",
 105       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 106     },
 107     {
 108       "tagname": "method",
 109       "name": "addManagedListener",
 110       "member": "Ext.util.Observable",
 111       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 112       "params": [
 113         {
 114           "type": "Observable/Element",
 115           "name": "item",
 116           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 117           "optional": false
 118         },
 119         {
 120           "type": "Object/String",
 121           "name": "ename",
 122           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 123           "optional": false
 124         },
 125         {
 126           "type": "Function",
 127           "name": "fn",
 128           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 129           "optional": false
 130         },
 131         {
 132           "type": "Object",
 133           "name": "scope",
 134           "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",
 135           "optional": false
 136         },
 137         {
 138           "type": "Object",
 139           "name": "opt",
 140           "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",
 141           "optional": false
 142         }
 143       ],
 144       "return": {
 145         "type": "void",
 146         "doc": "\n"
 147       },
 148       "private": false,
 149       "static": false,
 150       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 151       "linenr": 155,
 152       "html_filename": "Observable.html",
 153       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 154       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 155     },
 156     {
 157       "tagname": "method",
 158       "name": "addProvider",
 159       "member": "Ext.direct.Manager",
 160       "doc": "<p>Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.\nIf the provider is not already connected, it will auto-connect.</p>\n\n<pre><code>var pollProv = new Ext.direct.PollingProvider({\n    url: 'php/poll2.php'\n});\n\nExt.direct.Manager.addProvider({\n    \"type\":\"remoting\",       // create a <a href=\"#/api/Ext.direct.RemotingProvider\" rel=\"Ext.direct.RemotingProvider\" class=\"docClass\">Ext.direct.RemotingProvider</a>\n    \"url\":\"php\\/router.php\", // url to connect to the Ext.Direct server-side router.\n    \"actions\":{              // each property within the actions object represents a Class\n        \"TestAction\":[       // array of methods within each server side Class\n        {\n            \"name\":\"doEcho\", // name of method\n            \"len\":1\n        },{\n            \"name\":\"multiply\",\n            \"len\":1\n        },{\n            \"name\":\"doForm\",\n            \"formHandler\":true, // handle form on server with Ext.Direct.Transaction\n            \"len\":1\n        }]\n    },\n    \"namespace\":\"myApplication\",// namespace to create the Remoting Provider in\n},{\n    type: 'polling', // create a <a href=\"#/api/Ext.direct.PollingProvider\" rel=\"Ext.direct.PollingProvider\" class=\"docClass\">Ext.direct.PollingProvider</a>\n    url:  'php/poll.php'\n}, pollProv); // reference to previously created instance\n</code></pre>\n\n",
 161       "params": [
 162         {
 163           "type": "Object/Array",
 164           "name": "provider",
 165           "doc": "<p>Accepts either an Array of Provider descriptions (an instance\nor config object for a Provider) or any number of Provider descriptions as arguments.  Each\nProvider description instructs Ext.Direct how to create client-side stub methods.</p>\n",
 166           "optional": false
 167         }
 168       ],
 169       "return": {
 170         "type": "void",
 171         "doc": "\n"
 172       },
 173       "private": false,
 174       "static": false,
 175       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Manager.js",
 176       "linenr": 104,
 177       "html_filename": "Manager2.html",
 178       "href": "Manager2.html#Ext-direct-Manager-method-addProvider",
 179       "shortDoc": "Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.\nIf the provider is ..."
 180     },
 181     {
 182       "tagname": "method",
 183       "name": "capture",
 184       "member": "Ext.util.Observable",
 185       "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",
 186       "params": [
 187         {
 188           "type": "Observable",
 189           "name": "o",
 190           "doc": "<p>The Observable to capture events from.</p>\n",
 191           "optional": false
 192         },
 193         {
 194           "type": "Function",
 195           "name": "fn",
 196           "doc": "<p>The function to call when an event is fired.</p>\n",
 197           "optional": false
 198         },
 199         {
 200           "type": "Object",
 201           "name": "scope",
 202           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 203           "optional": true
 204         }
 205       ],
 206       "return": {
 207         "type": "void",
 208         "doc": "\n"
 209       },
 210       "private": false,
 211       "static": true,
 212       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 213       "linenr": 55,
 214       "html_filename": "Observable.html",
 215       "href": "Observable.html#Ext-util-Observable-method-capture",
 216       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 217     },
 218     {
 219       "tagname": "method",
 220       "name": "clearListeners",
 221       "member": "Ext.util.Observable",
 222       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 223       "params": [
 224
 225       ],
 226       "return": {
 227         "type": "void",
 228         "doc": "\n"
 229       },
 230       "private": false,
 231       "static": false,
 232       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 233       "linenr": 383,
 234       "html_filename": "Observable.html",
 235       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 236       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 237     },
 238     {
 239       "tagname": "method",
 240       "name": "clearManagedListeners",
 241       "member": "Ext.util.Observable",
 242       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 243       "params": [
 244
 245       ],
 246       "return": {
 247         "type": "void",
 248         "doc": "\n"
 249       },
 250       "private": false,
 251       "static": false,
 252       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 253       "linenr": 412,
 254       "html_filename": "Observable.html",
 255       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 256       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 257     },
 258     {
 259       "tagname": "method",
 260       "name": "enableBubble",
 261       "member": "Ext.util.Observable",
 262       "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",
 263       "params": [
 264         {
 265           "type": "String/Array",
 266           "name": "events",
 267           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 268           "optional": false
 269         }
 270       ],
 271       "return": {
 272         "type": "void",
 273         "doc": "\n"
 274       },
 275       "private": false,
 276       "static": false,
 277       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 278       "linenr": 554,
 279       "html_filename": "Observable.html",
 280       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 281       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 282     },
 283     {
 284       "tagname": "method",
 285       "name": "fireEvent",
 286       "member": "Ext.util.Observable",
 287       "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.direct.Manager-method-enableBubble\" rel=\"Ext.direct.Manager-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 288       "params": [
 289         {
 290           "type": "String",
 291           "name": "eventName",
 292           "doc": "<p>The name of the event to fire.</p>\n",
 293           "optional": false
 294         },
 295         {
 296           "type": "Object...",
 297           "name": "args",
 298           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 299           "optional": false
 300         }
 301       ],
 302       "return": {
 303         "type": "Boolean",
 304         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 305       },
 306       "private": false,
 307       "static": false,
 308       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 309       "linenr": 232,
 310       "html_filename": "Observable.html",
 311       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 312       "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..."
 313     },
 314     {
 315       "tagname": "method",
 316       "name": "getProvider",
 317       "member": "Ext.direct.Manager",
 318       "doc": "<p>Retrieve a <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">provider</a> by the\n<b><tt><a href=\"#/api/Ext.direct.Provider-cfg-id\" rel=\"Ext.direct.Provider-cfg-id\" class=\"docClass\">id</a></tt></b> specified when the provider is\n<a href=\"#/api/Ext.direct.Manager-method-addProvider\" rel=\"Ext.direct.Manager-method-addProvider\" class=\"docClass\">added</a>.</p>\n",
 319       "params": [
 320         {
 321           "type": "String/Ext.data.Provider",
 322           "name": "id",
 323           "doc": "<p>The id of the provider, or the provider instance.</p>\n",
 324           "optional": false
 325         }
 326       ],
 327       "return": {
 328         "type": "void",
 329         "doc": "\n"
 330       },
 331       "private": false,
 332       "static": false,
 333       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Manager.js",
 334       "linenr": 167,
 335       "html_filename": "Manager2.html",
 336       "href": "Manager2.html#Ext-direct-Manager-method-getProvider",
 337       "shortDoc": "<p>Retrieve a <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">provider</a> by the\n<b><tt><a href=\"#/api/Ext.direct.Provider-cfg-id\" rel=\"Ext.direct.Provider-cfg-id\" class=\"docClass\">id</a></tt></b> specified when the provider is\n<a href=\"#/api/Ext.direct.Manager-method-addProvider\" rel=\"Ext.direct.Manager-method-addProvider\" class=\"docClass\">added</a>.</p>\n"
 338     },
 339     {
 340       "tagname": "method",
 341       "name": "hasListener",
 342       "member": "Ext.util.Observable",
 343       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 344       "params": [
 345         {
 346           "type": "String",
 347           "name": "eventName",
 348           "doc": "<p>The name of the event to check for</p>\n",
 349           "optional": false
 350         }
 351       ],
 352       "return": {
 353         "type": "Boolean",
 354         "doc": "<p>True if the event is being listened for, else false</p>\n"
 355       },
 356       "private": false,
 357       "static": false,
 358       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 359       "linenr": 480,
 360       "html_filename": "Observable.html",
 361       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 362       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 363     },
 364     {
 365       "tagname": "method",
 366       "name": "observe",
 367       "member": "Ext.util.Observable",
 368       "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",
 369       "params": [
 370         {
 371           "type": "Function",
 372           "name": "c",
 373           "doc": "<p>The class constructor to make observable.</p>\n",
 374           "optional": false
 375         },
 376         {
 377           "type": "Object",
 378           "name": "listeners",
 379           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.direct.Manager-method-addListener\" rel=\"Ext.direct.Manager-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 380           "optional": false
 381         }
 382       ],
 383       "return": {
 384         "type": "void",
 385         "doc": "\n"
 386       },
 387       "private": false,
 388       "static": true,
 389       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 390       "linenr": 69,
 391       "html_filename": "Observable.html",
 392       "href": "Observable.html#Ext-util-Observable-method-observe",
 393       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 394     },
 395     {
 396       "tagname": "method",
 397       "name": "on",
 398       "member": "Ext.util.Observable",
 399       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.Manager-method-addListener\" rel=\"Ext.direct.Manager-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 400       "params": [
 401         {
 402           "type": "String",
 403           "name": "eventName",
 404           "doc": "<p>The type of event to listen for</p>\n",
 405           "optional": false
 406         },
 407         {
 408           "type": "Function",
 409           "name": "handler",
 410           "doc": "<p>The method the event invokes</p>\n",
 411           "optional": false
 412         },
 413         {
 414           "type": "Object",
 415           "name": "scope",
 416           "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",
 417           "optional": true
 418         },
 419         {
 420           "type": "Object",
 421           "name": "options",
 422           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 423           "optional": true
 424         }
 425       ],
 426       "return": {
 427         "type": "void",
 428         "doc": "\n"
 429       },
 430       "private": false,
 431       "static": false,
 432       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 433       "linenr": 616,
 434       "html_filename": "Observable.html",
 435       "href": "Observable.html#Ext-util-Observable-method-on",
 436       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.Manager-method-addListener\" rel=\"Ext.direct.Manager-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 437     },
 438     {
 439       "tagname": "method",
 440       "name": "relayEvents",
 441       "member": "Ext.util.Observable",
 442       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 443       "params": [
 444         {
 445           "type": "Object",
 446           "name": "origin",
 447           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 448           "optional": false
 449         },
 450         {
 451           "type": "Array",
 452           "name": "events",
 453           "doc": "<p>Array of event names to relay.</p>\n",
 454           "optional": false
 455         },
 456         {
 457           "type": "Object",
 458           "name": "prefix",
 459           "doc": "\n",
 460           "optional": false
 461         }
 462       ],
 463       "return": {
 464         "type": "void",
 465         "doc": "\n"
 466       },
 467       "private": false,
 468       "static": false,
 469       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 470       "linenr": 520,
 471       "html_filename": "Observable.html",
 472       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 473       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 474     },
 475     {
 476       "tagname": "method",
 477       "name": "releaseCapture",
 478       "member": "Ext.util.Observable",
 479       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 480       "params": [
 481         {
 482           "type": "Observable",
 483           "name": "o",
 484           "doc": "<p>The Observable to release</p>\n",
 485           "optional": false
 486         }
 487       ],
 488       "return": {
 489         "type": "void",
 490         "doc": "\n"
 491       },
 492       "private": false,
 493       "static": true,
 494       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 495       "linenr": 46,
 496       "html_filename": "Observable.html",
 497       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 498       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 499     },
 500     {
 501       "tagname": "method",
 502       "name": "removeListener",
 503       "member": "Ext.util.Observable",
 504       "doc": "<p>Removes an event handler.</p>\n",
 505       "params": [
 506         {
 507           "type": "String",
 508           "name": "eventName",
 509           "doc": "<p>The type of event the handler was associated with.</p>\n",
 510           "optional": false
 511         },
 512         {
 513           "type": "Function",
 514           "name": "handler",
 515           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.Manager-method-addListener\" rel=\"Ext.direct.Manager-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 516           "optional": false
 517         },
 518         {
 519           "type": "Object",
 520           "name": "scope",
 521           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 522           "optional": true
 523         }
 524       ],
 525       "return": {
 526         "type": "void",
 527         "doc": "\n"
 528       },
 529       "private": false,
 530       "static": false,
 531       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 532       "linenr": 352,
 533       "html_filename": "Observable.html",
 534       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 535       "shortDoc": "<p>Removes an event handler.</p>\n"
 536     },
 537     {
 538       "tagname": "method",
 539       "name": "removeManagedListener",
 540       "member": "Ext.util.Observable",
 541       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.Manager--mon\" rel=\"Ext.direct.Manager--mon\" class=\"docClass\">mon</a> method.</p>\n",
 542       "params": [
 543         {
 544           "type": "Observable|Element",
 545           "name": "item",
 546           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 547           "optional": false
 548         },
 549         {
 550           "type": "Object|String",
 551           "name": "ename",
 552           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 553           "optional": false
 554         },
 555         {
 556           "type": "Function",
 557           "name": "fn",
 558           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 559           "optional": false
 560         },
 561         {
 562           "type": "Object",
 563           "name": "scope",
 564           "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",
 565           "optional": false
 566         }
 567       ],
 568       "return": {
 569         "type": "void",
 570         "doc": "\n"
 571       },
 572       "private": false,
 573       "static": false,
 574       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 575       "linenr": 196,
 576       "html_filename": "Observable.html",
 577       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 578       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.Manager--mon\" rel=\"Ext.direct.Manager--mon\" class=\"docClass\">mon</a> method.</p>\n"
 579     },
 580     {
 581       "tagname": "method",
 582       "name": "removeProvider",
 583       "member": "Ext.direct.Manager",
 584       "doc": "<p>Removes the provider.</p>\n",
 585       "params": [
 586         {
 587           "type": "String/Ext.direct.Provider",
 588           "name": "provider",
 589           "doc": "<p>The provider instance or the id of the provider.</p>\n",
 590           "optional": false
 591         }
 592       ],
 593       "return": {
 594         "type": "Ext.direct.Provider",
 595         "doc": "<p>The provider, null if not found.</p>\n"
 596       },
 597       "private": false,
 598       "static": false,
 599       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Manager.js",
 600       "linenr": 177,
 601       "html_filename": "Manager2.html",
 602       "href": "Manager2.html#Ext-direct-Manager-method-removeProvider",
 603       "shortDoc": "<p>Removes the provider.</p>\n"
 604     },
 605     {
 606       "tagname": "method",
 607       "name": "resumeEvents",
 608       "member": "Ext.util.Observable",
 609       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.direct.Manager-method-suspendEvents\" rel=\"Ext.direct.Manager-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",
 610       "params": [
 611
 612       ],
 613       "return": {
 614         "type": "void",
 615         "doc": "\n"
 616       },
 617       "private": false,
 618       "static": false,
 619       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 620       "linenr": 502,
 621       "html_filename": "Observable.html",
 622       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 623       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 624     },
 625     {
 626       "tagname": "method",
 627       "name": "suspendEvents",
 628       "member": "Ext.util.Observable",
 629       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.Manager-method-resumeEvents\" rel=\"Ext.direct.Manager-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 630       "params": [
 631         {
 632           "type": "Boolean",
 633           "name": "queueSuspended",
 634           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.direct.Manager-method-resumeEvents\" rel=\"Ext.direct.Manager-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 635           "optional": false
 636         }
 637       ],
 638       "return": {
 639         "type": "void",
 640         "doc": "\n"
 641       },
 642       "private": false,
 643       "static": false,
 644       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 645       "linenr": 490,
 646       "html_filename": "Observable.html",
 647       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 648       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.Manager-method-resumeEvents\" rel=\"Ext.direct.Manager-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 649     },
 650     {
 651       "tagname": "method",
 652       "name": "un",
 653       "member": "Ext.util.Observable",
 654       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.Manager-method-removeListener\" rel=\"Ext.direct.Manager-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 655       "params": [
 656         {
 657           "type": "String",
 658           "name": "eventName",
 659           "doc": "<p>The type of event the handler was associated with.</p>\n",
 660           "optional": false
 661         },
 662         {
 663           "type": "Function",
 664           "name": "handler",
 665           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.Manager-method-addListener\" rel=\"Ext.direct.Manager-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 666           "optional": false
 667         },
 668         {
 669           "type": "Object",
 670           "name": "scope",
 671           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 672           "optional": true
 673         }
 674       ],
 675       "return": {
 676         "type": "void",
 677         "doc": "\n"
 678       },
 679       "private": false,
 680       "static": false,
 681       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 682       "linenr": 608,
 683       "html_filename": "Observable.html",
 684       "href": "Observable.html#Ext-util-Observable-method-un",
 685       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.Manager-method-removeListener\" rel=\"Ext.direct.Manager-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 686     }
 687   ],
 688   "property": [
 689
 690   ],
 691   "event": [
 692     {
 693       "tagname": "event",
 694       "name": "event",
 695       "member": "Ext.direct.Manager",
 696       "doc": "<p>Fires after an event.</p>\n",
 697       "params": [
 698         {
 699           "type": "event",
 700           "name": "e",
 701           "doc": "<p>The <a href=\"#/api/Ext.direct.Event\" rel=\"Ext.direct.Event\" class=\"docClass\">Ext.direct.Event</a> type that occurred.</p>\n",
 702           "optional": false
 703         },
 704         {
 705           "type": "Ext.direct.Provider",
 706           "name": "provider",
 707           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
 708           "optional": false
 709         }
 710       ],
 711       "private": false,
 712       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Manager.js",
 713       "linenr": 84,
 714       "html_filename": "Manager2.html",
 715       "href": "Manager2.html#Ext-direct-Manager-event-event",
 716       "shortDoc": "<p>Fires after an event.</p>\n"
 717     },
 718     {
 719       "tagname": "event",
 720       "name": "exception",
 721       "member": "Ext.direct.Manager",
 722       "doc": "<p>Fires after an event exception.</p>\n",
 723       "params": [
 724         {
 725           "type": "event",
 726           "name": "e",
 727           "doc": "<p>The <a href=\"#/api/Ext.direct.Event\" rel=\"Ext.direct.Event\" class=\"docClass\">Ext.direct.Event</a> type that occurred.</p>\n",
 728           "optional": false
 729         }
 730       ],
 731       "private": false,
 732       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Manager.js",
 733       "linenr": 91,
 734       "html_filename": "Manager2.html",
 735       "href": "Manager2.html#Ext-direct-Manager-event-exception",
 736       "shortDoc": "<p>Fires after an event exception.</p>\n"
 737     }
 738   ],
 739   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Manager.js",
 740   "linenr": 1,
 741   "html_filename": "Manager2.html",
 742   "href": "Manager2.html#Ext-direct-Manager",
 743   "cssVar": [
 744
 745   ],
 746   "cssMixin": [
 747
 748   ],
 749   "component": false,
 750   "superclasses": [
 751
 752   ],
 753   "subclasses": [
 754
 755   ],
 756   "mixedInto": [
 757
 758   ],
 759   "allMixins": [
 760     "Ext.util.Observable"
 761   ]
 762 });