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