docs/output/Ext.LoadMask.js

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