Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.selection.TreeModel.js
1 Ext.data.JsonP.Ext_selection_TreeModel({
2   "tagname": "class",
3   "name": "Ext.selection.TreeModel",
4   "doc": "<p>Adds custom behavior for left/right keyboard navigation for use with a tree.\nDepends on the view having an expand and collapse method which accepts a\nrecord.</p>\n",
5   "extends": "Ext.selection.RowModel",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": true,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "allowDeselect",
21       "member": "Ext.selection.Model",
22       "type": "Boolean",
23       "doc": "<p>Allow users to deselect a record in a DataView, List or Grid. Only applicable when the SelectionModel's mode is 'SINGLE'. Defaults to false.</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
26       "linenr": 28,
27       "html_filename": "Model2.html",
28       "href": "Model2.html#Ext-selection-Model-cfg-allowDeselect",
29       "shortDoc": "Allow users to deselect a record in a DataView, List or Grid. Only applicable when the SelectionModel's mode is 'SING..."
30     },
31     {
32       "tagname": "cfg",
33       "name": "enableKeyNav",
34       "member": "Ext.selection.RowModel",
35       "type": "Boolean",
36       "doc": "<p>Turns on/off keyboard navigation within the grid. Defaults to true.</p>\n",
37       "private": false,
38       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/selection/RowModel.js",
39       "linenr": 21,
40       "html_filename": "RowModel.html",
41       "href": "RowModel.html#Ext-selection-RowModel-cfg-enableKeyNav"
42     },
43     {
44       "tagname": "cfg",
45       "name": "listeners",
46       "member": "Ext.util.Observable",
47       "type": "Object",
48       "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.selection.TreeModel-method-addListener\" rel=\"Ext.selection.TreeModel-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",
49       "private": false,
50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
51       "linenr": 103,
52       "html_filename": "Observable.html",
53       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
54       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
55     },
56     {
57       "tagname": "cfg",
58       "name": "mode",
59       "member": "Ext.selection.Model",
60       "type": "String",
61       "doc": "<p>Modes of selection.\nValid values are SINGLE, SIMPLE, and MULTI. Defaults to 'SINGLE'</p>\n",
62       "private": false,
63       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
64       "linenr": 22,
65       "html_filename": "Model2.html",
66       "href": "Model2.html#Ext-selection-Model-cfg-mode"
67     }
68   ],
69   "method": [
70     {
71       "tagname": "method",
72       "name": "addEvents",
73       "member": "Ext.util.Observable",
74       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
75       "params": [
76         {
77           "type": "Object/String",
78           "name": "o",
79           "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",
80           "optional": false
81         },
82         {
83           "type": "String",
84           "name": "",
85           "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",
86           "optional": false
87         }
88       ],
89       "return": {
90         "type": "void",
91         "doc": "\n"
92       },
93       "private": false,
94       "static": false,
95       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
96       "linenr": 452,
97       "html_filename": "Observable.html",
98       "href": "Observable.html#Ext-util-Observable-method-addEvents",
99       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
100     },
101     {
102       "tagname": "method",
103       "name": "addListener",
104       "member": "Ext.util.Observable",
105       "doc": "<p>Appends an event handler to this object.</p>\n",
106       "params": [
107         {
108           "type": "String",
109           "name": "eventName",
110           "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",
111           "optional": false
112         },
113         {
114           "type": "Function",
115           "name": "handler",
116           "doc": "<p>The method the event invokes.</p>\n",
117           "optional": false
118         },
119         {
120           "type": "Object",
121           "name": "scope",
122           "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",
123           "optional": true
124         },
125         {
126           "type": "Object",
127           "name": "options",
128           "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",
129           "optional": true
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": 271,
140       "html_filename": "Observable.html",
141       "href": "Observable.html#Ext-util-Observable-method-addListener",
142       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
143     },
144     {
145       "tagname": "method",
146       "name": "addManagedListener",
147       "member": "Ext.util.Observable",
148       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
149       "params": [
150         {
151           "type": "Observable/Element",
152           "name": "item",
153           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
154           "optional": false
155         },
156         {
157           "type": "Object/String",
158           "name": "ename",
159           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
160           "optional": false
161         },
162         {
163           "type": "Function",
164           "name": "fn",
165           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
166           "optional": false
167         },
168         {
169           "type": "Object",
170           "name": "scope",
171           "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",
172           "optional": false
173         },
174         {
175           "type": "Object",
176           "name": "opt",
177           "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",
178           "optional": false
179         }
180       ],
181       "return": {
182         "type": "void",
183         "doc": "\n"
184       },
185       "private": false,
186       "static": false,
187       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
188       "linenr": 155,
189       "html_filename": "Observable.html",
190       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
191       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
192     },
193     {
194       "tagname": "method",
195       "name": "capture",
196       "member": "Ext.util.Observable",
197       "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",
198       "params": [
199         {
200           "type": "Observable",
201           "name": "o",
202           "doc": "<p>The Observable to capture events from.</p>\n",
203           "optional": false
204         },
205         {
206           "type": "Function",
207           "name": "fn",
208           "doc": "<p>The function to call when an event is fired.</p>\n",
209           "optional": false
210         },
211         {
212           "type": "Object",
213           "name": "scope",
214           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
215           "optional": true
216         }
217       ],
218       "return": {
219         "type": "void",
220         "doc": "\n"
221       },
222       "private": false,
223       "static": true,
224       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
225       "linenr": 55,
226       "html_filename": "Observable.html",
227       "href": "Observable.html#Ext-util-Observable-method-capture",
228       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
229     },
230     {
231       "tagname": "method",
232       "name": "clearListeners",
233       "member": "Ext.util.Observable",
234       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
235       "params": [
236
237       ],
238       "return": {
239         "type": "void",
240         "doc": "\n"
241       },
242       "private": false,
243       "static": false,
244       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
245       "linenr": 383,
246       "html_filename": "Observable.html",
247       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
248       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
249     },
250     {
251       "tagname": "method",
252       "name": "clearManagedListeners",
253       "member": "Ext.util.Observable",
254       "doc": "<p>Removes all managed listeners for this object.</p>\n",
255       "params": [
256
257       ],
258       "return": {
259         "type": "void",
260         "doc": "\n"
261       },
262       "private": false,
263       "static": false,
264       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
265       "linenr": 412,
266       "html_filename": "Observable.html",
267       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
268       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
269     },
270     {
271       "tagname": "method",
272       "name": "deselect",
273       "member": "Ext.selection.Model",
274       "doc": "<p>Deselects a record instance by record instance or index.</p>\n",
275       "params": [
276         {
277           "type": "Ext.data.Model/Index",
278           "name": "records",
279           "doc": "<p>An array of records or an index</p>\n",
280           "optional": false
281         },
282         {
283           "type": "Boolean",
284           "name": "suppressEvent",
285           "doc": "<p>Set to false to not fire a deselect event</p>\n",
286           "optional": false
287         }
288       ],
289       "return": {
290         "type": "void",
291         "doc": "\n"
292       },
293       "private": false,
294       "static": false,
295       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
296       "linenr": 262,
297       "html_filename": "Model2.html",
298       "href": "Model2.html#Ext-selection-Model-method-deselect",
299       "shortDoc": "<p>Deselects a record instance by record instance or index.</p>\n"
300     },
301     {
302       "tagname": "method",
303       "name": "deselectAll",
304       "member": "Ext.selection.Model",
305       "doc": "<p>Deselect all records in the view.</p>\n",
306       "params": [
307         {
308           "type": "Boolean",
309           "name": "suppressEvent",
310           "doc": "<p>True to suppress any deselect events</p>\n",
311           "optional": false
312         }
313       ],
314       "return": {
315         "type": "void",
316         "doc": "\n"
317       },
318       "private": false,
319       "static": false,
320       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
321       "linenr": 131,
322       "html_filename": "Model2.html",
323       "href": "Model2.html#Ext-selection-Model-method-deselectAll",
324       "shortDoc": "<p>Deselect all records in the view.</p>\n"
325     },
326     {
327       "tagname": "method",
328       "name": "enableBubble",
329       "member": "Ext.util.Observable",
330       "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",
331       "params": [
332         {
333           "type": "String/Array",
334           "name": "events",
335           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
336           "optional": false
337         }
338       ],
339       "return": {
340         "type": "void",
341         "doc": "\n"
342       },
343       "private": false,
344       "static": false,
345       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
346       "linenr": 554,
347       "html_filename": "Observable.html",
348       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
349       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
350     },
351     {
352       "tagname": "method",
353       "name": "fireEvent",
354       "member": "Ext.util.Observable",
355       "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.selection.TreeModel-method-enableBubble\" rel=\"Ext.selection.TreeModel-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
356       "params": [
357         {
358           "type": "String",
359           "name": "eventName",
360           "doc": "<p>The name of the event to fire.</p>\n",
361           "optional": false
362         },
363         {
364           "type": "Object...",
365           "name": "args",
366           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
367           "optional": false
368         }
369       ],
370       "return": {
371         "type": "Boolean",
372         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
373       },
374       "private": false,
375       "static": false,
376       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
377       "linenr": 232,
378       "html_filename": "Observable.html",
379       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
380       "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..."
381     },
382     {
383       "tagname": "method",
384       "name": "getLastSelected",
385       "member": "Ext.selection.Model",
386       "doc": "<p>Returns the last selected record.</p>\n",
387       "params": [
388
389       ],
390       "return": {
391         "type": "void",
392         "doc": "\n"
393       },
394       "private": false,
395       "static": false,
396       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
397       "linenr": 410,
398       "html_filename": "Model2.html",
399       "href": "Model2.html#Ext-selection-Model-method-getLastSelected",
400       "shortDoc": "<p>Returns the last selected record.</p>\n"
401     },
402     {
403       "tagname": "method",
404       "name": "getSelection",
405       "member": "Ext.selection.Model",
406       "doc": "<p>Returns an array of the currently selected records.</p>\n",
407       "params": [
408
409       ],
410       "return": {
411         "type": "void",
412         "doc": "\n"
413       },
414       "private": false,
415       "static": false,
416       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
417       "linenr": 421,
418       "html_filename": "Model2.html",
419       "href": "Model2.html#Ext-selection-Model-method-getSelection",
420       "shortDoc": "<p>Returns an array of the currently selected records.</p>\n"
421     },
422     {
423       "tagname": "method",
424       "name": "getSelectionMode",
425       "member": "Ext.selection.Model",
426       "doc": "<p>Returns the current selectionMode. SINGLE, MULTI or SIMPLE.</p>\n",
427       "params": [
428
429       ],
430       "return": {
431         "type": "void",
432         "doc": "\n"
433       },
434       "private": false,
435       "static": false,
436       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
437       "linenr": 428,
438       "html_filename": "Model2.html",
439       "href": "Model2.html#Ext-selection-Model-method-getSelectionMode",
440       "shortDoc": "<p>Returns the current selectionMode. SINGLE, MULTI or SIMPLE.</p>\n"
441     },
442     {
443       "tagname": "method",
444       "name": "hasListener",
445       "member": "Ext.util.Observable",
446       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
447       "params": [
448         {
449           "type": "String",
450           "name": "eventName",
451           "doc": "<p>The name of the event to check for</p>\n",
452           "optional": false
453         }
454       ],
455       "return": {
456         "type": "Boolean",
457         "doc": "<p>True if the event is being listened for, else false</p>\n"
458       },
459       "private": false,
460       "static": false,
461       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
462       "linenr": 480,
463       "html_filename": "Observable.html",
464       "href": "Observable.html#Ext-util-Observable-method-hasListener",
465       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
466     },
467     {
468       "tagname": "method",
469       "name": "hasSelection",
470       "member": "Ext.selection.Model",
471       "doc": "<p>Returns true if there is a selected record.</p>\n",
472       "params": [
473
474       ],
475       "return": {
476         "type": "Boolean",
477         "doc": "\n"
478       },
479       "private": false,
480       "static": false,
481       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
482       "linenr": 472,
483       "html_filename": "Model2.html",
484       "href": "Model2.html#Ext-selection-Model-method-hasSelection",
485       "shortDoc": "<p>Returns true if there is a selected record.</p>\n"
486     },
487     {
488       "tagname": "method",
489       "name": "isFocused",
490       "member": "Ext.selection.Model",
491       "doc": "<p>Determines if this record is currently focused.</p>\n",
492       "params": [
493         {
494           "type": "Object",
495           "name": "Ext",
496           "doc": "<p>.data.Record record</p>\n",
497           "optional": false
498         }
499       ],
500       "return": {
501         "type": "void",
502         "doc": "\n"
503       },
504       "private": false,
505       "static": false,
506       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
507       "linenr": 392,
508       "html_filename": "Model2.html",
509       "href": "Model2.html#Ext-selection-Model-method-isFocused",
510       "shortDoc": "<p>Determines if this record is currently focused.</p>\n"
511     },
512     {
513       "tagname": "method",
514       "name": "isLocked",
515       "member": "Ext.selection.Model",
516       "doc": "<p>Returns true if the selections are locked.</p>\n",
517       "params": [
518
519       ],
520       "return": {
521         "type": "Boolean",
522         "doc": "\n"
523       },
524       "private": false,
525       "static": false,
526       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
527       "linenr": 445,
528       "html_filename": "Model2.html",
529       "href": "Model2.html#Ext-selection-Model-method-isLocked",
530       "shortDoc": "<p>Returns true if the selections are locked.</p>\n"
531     },
532     {
533       "tagname": "method",
534       "name": "isSelected",
535       "member": "Ext.selection.Model",
536       "doc": "<p>Returns <tt>true</tt> if the specified row is selected.</p>\n",
537       "params": [
538         {
539           "type": "Record/Number",
540           "name": "record",
541           "doc": "<p>The record or index of the record to check</p>\n",
542           "optional": false
543         }
544       ],
545       "return": {
546         "type": "Boolean",
547         "doc": "\n"
548       },
549       "private": false,
550       "static": false,
551       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
552       "linenr": 462,
553       "html_filename": "Model2.html",
554       "href": "Model2.html#Ext-selection-Model-method-isSelected",
555       "shortDoc": "<p>Returns <tt>true</tt> if the specified row is selected.</p>\n"
556     },
557     {
558       "tagname": "method",
559       "name": "observe",
560       "member": "Ext.util.Observable",
561       "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",
562       "params": [
563         {
564           "type": "Function",
565           "name": "c",
566           "doc": "<p>The class constructor to make observable.</p>\n",
567           "optional": false
568         },
569         {
570           "type": "Object",
571           "name": "listeners",
572           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.selection.TreeModel-method-addListener\" rel=\"Ext.selection.TreeModel-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
573           "optional": false
574         }
575       ],
576       "return": {
577         "type": "void",
578         "doc": "\n"
579       },
580       "private": false,
581       "static": true,
582       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
583       "linenr": 69,
584       "html_filename": "Observable.html",
585       "href": "Observable.html#Ext-util-Observable-method-observe",
586       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
587     },
588     {
589       "tagname": "method",
590       "name": "on",
591       "member": "Ext.util.Observable",
592       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.selection.TreeModel-method-addListener\" rel=\"Ext.selection.TreeModel-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
593       "params": [
594         {
595           "type": "String",
596           "name": "eventName",
597           "doc": "<p>The type of event to listen for</p>\n",
598           "optional": false
599         },
600         {
601           "type": "Function",
602           "name": "handler",
603           "doc": "<p>The method the event invokes</p>\n",
604           "optional": false
605         },
606         {
607           "type": "Object",
608           "name": "scope",
609           "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",
610           "optional": true
611         },
612         {
613           "type": "Object",
614           "name": "options",
615           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
616           "optional": true
617         }
618       ],
619       "return": {
620         "type": "void",
621         "doc": "\n"
622       },
623       "private": false,
624       "static": false,
625       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
626       "linenr": 616,
627       "html_filename": "Observable.html",
628       "href": "Observable.html#Ext-util-Observable-method-on",
629       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.selection.TreeModel-method-addListener\" rel=\"Ext.selection.TreeModel-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
630     },
631     {
632       "tagname": "method",
633       "name": "relayEvents",
634       "member": "Ext.util.Observable",
635       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
636       "params": [
637         {
638           "type": "Object",
639           "name": "origin",
640           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
641           "optional": false
642         },
643         {
644           "type": "Array",
645           "name": "events",
646           "doc": "<p>Array of event names to relay.</p>\n",
647           "optional": false
648         },
649         {
650           "type": "Object",
651           "name": "prefix",
652           "doc": "\n",
653           "optional": false
654         }
655       ],
656       "return": {
657         "type": "void",
658         "doc": "\n"
659       },
660       "private": false,
661       "static": false,
662       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
663       "linenr": 520,
664       "html_filename": "Observable.html",
665       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
666       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
667     },
668     {
669       "tagname": "method",
670       "name": "releaseCapture",
671       "member": "Ext.util.Observable",
672       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
673       "params": [
674         {
675           "type": "Observable",
676           "name": "o",
677           "doc": "<p>The Observable to release</p>\n",
678           "optional": false
679         }
680       ],
681       "return": {
682         "type": "void",
683         "doc": "\n"
684       },
685       "private": false,
686       "static": true,
687       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
688       "linenr": 46,
689       "html_filename": "Observable.html",
690       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
691       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
692     },
693     {
694       "tagname": "method",
695       "name": "removeListener",
696       "member": "Ext.util.Observable",
697       "doc": "<p>Removes an event handler.</p>\n",
698       "params": [
699         {
700           "type": "String",
701           "name": "eventName",
702           "doc": "<p>The type of event the handler was associated with.</p>\n",
703           "optional": false
704         },
705         {
706           "type": "Function",
707           "name": "handler",
708           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.selection.TreeModel-method-addListener\" rel=\"Ext.selection.TreeModel-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
709           "optional": false
710         },
711         {
712           "type": "Object",
713           "name": "scope",
714           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
715           "optional": true
716         }
717       ],
718       "return": {
719         "type": "void",
720         "doc": "\n"
721       },
722       "private": false,
723       "static": false,
724       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
725       "linenr": 352,
726       "html_filename": "Observable.html",
727       "href": "Observable.html#Ext-util-Observable-method-removeListener",
728       "shortDoc": "<p>Removes an event handler.</p>\n"
729     },
730     {
731       "tagname": "method",
732       "name": "removeManagedListener",
733       "member": "Ext.util.Observable",
734       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.selection.TreeModel--mon\" rel=\"Ext.selection.TreeModel--mon\" class=\"docClass\">mon</a> method.</p>\n",
735       "params": [
736         {
737           "type": "Observable|Element",
738           "name": "item",
739           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
740           "optional": false
741         },
742         {
743           "type": "Object|String",
744           "name": "ename",
745           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
746           "optional": false
747         },
748         {
749           "type": "Function",
750           "name": "fn",
751           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
752           "optional": false
753         },
754         {
755           "type": "Object",
756           "name": "scope",
757           "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",
758           "optional": false
759         }
760       ],
761       "return": {
762         "type": "void",
763         "doc": "\n"
764       },
765       "private": false,
766       "static": false,
767       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
768       "linenr": 196,
769       "html_filename": "Observable.html",
770       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
771       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.selection.TreeModel--mon\" rel=\"Ext.selection.TreeModel--mon\" class=\"docClass\">mon</a> method.</p>\n"
772     },
773     {
774       "tagname": "method",
775       "name": "resumeEvents",
776       "member": "Ext.util.Observable",
777       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.selection.TreeModel-method-suspendEvents\" rel=\"Ext.selection.TreeModel-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",
778       "params": [
779
780       ],
781       "return": {
782         "type": "void",
783         "doc": "\n"
784       },
785       "private": false,
786       "static": false,
787       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
788       "linenr": 502,
789       "html_filename": "Observable.html",
790       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
791       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
792     },
793     {
794       "tagname": "method",
795       "name": "select",
796       "member": "Ext.selection.Model",
797       "doc": "<p>Selects a record instance by record instance or index.</p>\n",
798       "params": [
799         {
800           "type": "Ext.data.Model/Index",
801           "name": "records",
802           "doc": "<p>An array of records or an index</p>\n",
803           "optional": false
804         },
805         {
806           "type": "Boolean",
807           "name": "keepExisting",
808           "doc": "\n",
809           "optional": false
810         },
811         {
812           "type": "Boolean",
813           "name": "suppressEvent",
814           "doc": "<p>Set to false to not fire a select event</p>\n",
815           "optional": false
816         }
817       ],
818       "return": {
819         "type": "void",
820         "doc": "\n"
821       },
822       "private": false,
823       "static": false,
824       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
825       "linenr": 252,
826       "html_filename": "Model2.html",
827       "href": "Model2.html#Ext-selection-Model-method-select",
828       "shortDoc": "<p>Selects a record instance by record instance or index.</p>\n"
829     },
830     {
831       "tagname": "method",
832       "name": "selectAll",
833       "member": "Ext.selection.Model",
834       "doc": "<p>Select all records in the view.</p>\n",
835       "params": [
836         {
837           "type": "Boolean",
838           "name": "suppressEvent",
839           "doc": "<p>True to suppress any selects event</p>\n",
840           "optional": false
841         }
842       ],
843       "return": {
844         "type": "void",
845         "doc": "\n"
846       },
847       "private": false,
848       "static": false,
849       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
850       "linenr": 111,
851       "html_filename": "Model2.html",
852       "href": "Model2.html#Ext-selection-Model-method-selectAll",
853       "shortDoc": "<p>Select all records in the view.</p>\n"
854     },
855     {
856       "tagname": "method",
857       "name": "selectRange",
858       "member": "Ext.selection.Model",
859       "doc": "<p>Selects a range of rows if the selection model <a href=\"#/api/Ext.selection.TreeModel-method-isLocked\" rel=\"Ext.selection.TreeModel-method-isLocked\" class=\"docClass\">is not locked</a>.\nAll rows in between startRow and endRow are also selected.</p>\n",
860       "params": [
861         {
862           "type": "Ext.data.Model/Number",
863           "name": "startRow",
864           "doc": "<p>The record or index of the first row in the range</p>\n",
865           "optional": false
866         },
867         {
868           "type": "Ext.data.Model/Number",
869           "name": "endRow",
870           "doc": "<p>The record or index of the last row in the range</p>\n",
871           "optional": false
872         },
873         {
874           "type": "Boolean",
875           "name": "keepExisting",
876           "doc": "<p>(optional) True to retain existing selections</p>\n",
877           "optional": true
878         },
879         {
880           "type": "Object",
881           "name": "dir",
882           "doc": "\n",
883           "optional": false
884         }
885       ],
886       "return": {
887         "type": "void",
888         "doc": "\n"
889       },
890       "private": false,
891       "static": false,
892       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
893       "linenr": 190,
894       "html_filename": "Model2.html",
895       "href": "Model2.html#Ext-selection-Model-method-selectRange",
896       "shortDoc": "Selects a range of rows if the selection model is not locked.\nAll rows in between startRow and endRow are also select..."
897     },
898     {
899       "tagname": "method",
900       "name": "setLastFocused",
901       "member": "Ext.selection.Model",
902       "doc": "\n",
903       "params": [
904         {
905           "type": "Ext.data.Model",
906           "name": "record",
907           "doc": "<p>Set a record as the last focused record. This does NOT mean\nthat the record has been selected.</p>\n",
908           "optional": false
909         },
910         {
911           "type": "Object",
912           "name": "supressFocus",
913           "doc": "\n",
914           "optional": false
915         }
916       ],
917       "return": {
918         "type": "void",
919         "doc": "\n"
920       },
921       "private": false,
922       "static": false,
923       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
924       "linenr": 380,
925       "html_filename": "Model2.html",
926       "href": "Model2.html#Ext-selection-Model-method-setLastFocused",
927       "shortDoc": "\n"
928     },
929     {
930       "tagname": "method",
931       "name": "setLocked",
932       "member": "Ext.selection.Model",
933       "doc": "<p>Locks the current selection and disables any changes from\nhappening to the selection.</p>\n",
934       "params": [
935         {
936           "type": "Boolean",
937           "name": "locked",
938           "doc": "\n",
939           "optional": false
940         }
941       ],
942       "return": {
943         "type": "void",
944         "doc": "\n"
945       },
946       "private": false,
947       "static": false,
948       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
949       "linenr": 453,
950       "html_filename": "Model2.html",
951       "href": "Model2.html#Ext-selection-Model-method-setLocked",
952       "shortDoc": "<p>Locks the current selection and disables any changes from\nhappening to the selection.</p>\n"
953     },
954     {
955       "tagname": "method",
956       "name": "setSelectionMode",
957       "member": "Ext.selection.Model",
958       "doc": "<p>Sets the current selectionMode. SINGLE, MULTI or SIMPLE.</p>\n",
959       "params": [
960         {
961           "type": "Object",
962           "name": "selMode",
963           "doc": "\n",
964           "optional": false
965         }
966       ],
967       "return": {
968         "type": "void",
969         "doc": "\n"
970       },
971       "private": false,
972       "static": false,
973       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
974       "linenr": 435,
975       "html_filename": "Model2.html",
976       "href": "Model2.html#Ext-selection-Model-method-setSelectionMode",
977       "shortDoc": "<p>Sets the current selectionMode. SINGLE, MULTI or SIMPLE.</p>\n"
978     },
979     {
980       "tagname": "method",
981       "name": "suspendEvents",
982       "member": "Ext.util.Observable",
983       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.selection.TreeModel-method-resumeEvents\" rel=\"Ext.selection.TreeModel-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
984       "params": [
985         {
986           "type": "Boolean",
987           "name": "queueSuspended",
988           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.selection.TreeModel-method-resumeEvents\" rel=\"Ext.selection.TreeModel-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
989           "optional": false
990         }
991       ],
992       "return": {
993         "type": "void",
994         "doc": "\n"
995       },
996       "private": false,
997       "static": false,
998       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
999       "linenr": 490,
1000       "html_filename": "Observable.html",
1001       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1002       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.selection.TreeModel-method-resumeEvents\" rel=\"Ext.selection.TreeModel-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
1003     },
1004     {
1005       "tagname": "method",
1006       "name": "un",
1007       "member": "Ext.util.Observable",
1008       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.selection.TreeModel-method-removeListener\" rel=\"Ext.selection.TreeModel-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
1009       "params": [
1010         {
1011           "type": "String",
1012           "name": "eventName",
1013           "doc": "<p>The type of event the handler was associated with.</p>\n",
1014           "optional": false
1015         },
1016         {
1017           "type": "Function",
1018           "name": "handler",
1019           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.selection.TreeModel-method-addListener\" rel=\"Ext.selection.TreeModel-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1020           "optional": false
1021         },
1022         {
1023           "type": "Object",
1024           "name": "scope",
1025           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1026           "optional": true
1027         }
1028       ],
1029       "return": {
1030         "type": "void",
1031         "doc": "\n"
1032       },
1033       "private": false,
1034       "static": false,
1035       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1036       "linenr": 608,
1037       "html_filename": "Observable.html",
1038       "href": "Observable.html#Ext-util-Observable-method-un",
1039       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.selection.TreeModel-method-removeListener\" rel=\"Ext.selection.TreeModel-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
1040     }
1041   ],
1042   "property": [
1043     {
1044       "tagname": "property",
1045       "name": "selected",
1046       "member": "Ext.selection.Model",
1047       "type": "Object",
1048       "doc": "<p>READ-ONLY A MixedCollection that maintains all of the currently selected\nrecords.</p>\n",
1049       "private": false,
1050       "static": false,
1051       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
1052       "linenr": 34,
1053       "html_filename": "Model2.html",
1054       "href": "Model2.html#Ext-selection-Model-property-selected"
1055     }
1056   ],
1057   "event": [
1058     {
1059       "tagname": "event",
1060       "name": "deselect",
1061       "member": "Ext.selection.RowModel",
1062       "doc": "<p>Fired after a record is deselected</p>\n",
1063       "params": [
1064         {
1065           "type": "Ext.selection.RowSelectionModel",
1066           "name": "this",
1067           "doc": "\n",
1068           "optional": false
1069         },
1070         {
1071           "type": "Ext.data.Model",
1072           "name": "record",
1073           "doc": "<p>The deselected record</p>\n",
1074           "optional": false
1075         },
1076         {
1077           "type": "Number",
1078           "name": "index",
1079           "doc": "<p>The row index deselected</p>\n",
1080           "optional": false
1081         }
1082       ],
1083       "private": false,
1084       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/selection/RowModel.js",
1085       "linenr": 30,
1086       "html_filename": "RowModel.html",
1087       "href": "RowModel.html#Ext-selection-RowModel-event-deselect",
1088       "shortDoc": "<p>Fired after a record is deselected</p>\n"
1089     },
1090     {
1091       "tagname": "event",
1092       "name": "select",
1093       "member": "Ext.selection.RowModel",
1094       "doc": "<p>Fired after a record is selected</p>\n",
1095       "params": [
1096         {
1097           "type": "Ext.selection.RowSelectionModel",
1098           "name": "this",
1099           "doc": "\n",
1100           "optional": false
1101         },
1102         {
1103           "type": "Ext.data.Model",
1104           "name": "record",
1105           "doc": "<p>The selected record</p>\n",
1106           "optional": false
1107         },
1108         {
1109           "type": "Number",
1110           "name": "index",
1111           "doc": "<p>The row index selected</p>\n",
1112           "optional": false
1113         }
1114       ],
1115       "private": false,
1116       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/selection/RowModel.js",
1117       "linenr": 39,
1118       "html_filename": "RowModel.html",
1119       "href": "RowModel.html#Ext-selection-RowModel-event-select",
1120       "shortDoc": "<p>Fired after a record is selected</p>\n"
1121     },
1122     {
1123       "tagname": "event",
1124       "name": "selectionchange",
1125       "member": "Ext.selection.Model",
1126       "doc": "<p>Fired after a selection change has occurred</p>\n",
1127       "params": [
1128         {
1129           "type": "Ext.selection.Model",
1130           "name": "this",
1131           "doc": "\n",
1132           "optional": false
1133         },
1134         {
1135           "type": "Array",
1136           "name": "selected",
1137           "doc": "<p>The selected records</p>\n",
1138           "optional": false
1139         }
1140       ],
1141       "private": false,
1142       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/selection/Model.js",
1143       "linenr": 57,
1144       "html_filename": "Model2.html",
1145       "href": "Model2.html#Ext-selection-Model-event-selectionchange",
1146       "shortDoc": "<p>Fired after a selection change has occurred</p>\n"
1147     }
1148   ],
1149   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/selection/TreeModel.js",
1150   "linenr": 1,
1151   "html_filename": "TreeModel.html",
1152   "href": "TreeModel.html#Ext-selection-TreeModel",
1153   "cssVar": [
1154
1155   ],
1156   "cssMixin": [
1157
1158   ],
1159   "component": false,
1160   "superclasses": [
1161     "Ext.util.Observable",
1162     "Ext.selection.Model",
1163     "Ext.selection.RowModel"
1164   ],
1165   "subclasses": [
1166
1167   ],
1168   "mixedInto": [
1169
1170   ],
1171   "allMixins": [
1172
1173   ]
1174 });