source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.StoreMgr.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 68.6 KB
Line 
1        <div class="body-wrap">
2        <div class="top-tools">
3            <a class="inner-link" href="#Ext.StoreMgr-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4            <a class="inner-link" href="#Ext.StoreMgr-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5            <a class="inner-link" href="#Ext.StoreMgr-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                        <a class="bookmark" href="../docs/?class=Ext.StoreMgr"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7        </div>
8                <div class="inheritance res-block">
9<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
10  <img src="resources/elbow-end.gif"/><a ext:cls="Ext.util.MixedCollection" ext:member="" href="output/Ext.util.MixedCollection.html">MixedCollection</a>
11    <img src="resources/elbow-end.gif"/>StoreMgr</pre></div>
12                <h1>Class Ext.StoreMgr</h1>
13        <table cellspacing="0">
14            <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
15            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/StoreMgr.js" target="_blank">StoreMgr.js</a></td></tr>
16            <tr><td class="label">Class:</td><td class="hd-info">StoreMgr</td></tr>
17                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.MixedCollection" ext:member="" href="output/Ext.util.MixedCollection.html">MixedCollection</a></td></tr>
18                    </table>
19        <div class="description">
20            *
21The default global group of stores.<br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
22       
23        <div class="hr"></div>
24                <a id="Ext.StoreMgr-props"></a>
25        <h2>Public Properties</h2>
26        <div class="no-members">This class has no public properties.</div>        <a id="Ext.StoreMgr-methods"></a>
27        <h2>Public Methods</h2>
28                <table cellspacing="0" class="member-table">
29            <tr>
30                <th class="sig-header" colspan="2">Method</th>
31                <th class="msource-header">Defined By</th>
32            </tr>
33                <tr class="method-row inherited expandable">
34        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
35        <td class="sig">
36        <a id="Ext.StoreMgr-add"></a>
37            <b>add</b>(&nbsp;<code>String key</code>, <code>Object o</code>&nbsp;) : Object            <div class="mdesc">
38                        <div class="short">Adds an item to the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="add" href="output/Ext.util.MixedCollection.html#add">add</a> event when complete.</div>
39            <div class="long">
40                Adds an item to the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="add" href="output/Ext.util.MixedCollection.html#add">add</a> event when complete.    <div class="mdetail-params">
41        <strong>Parameters:</strong>
42        <ul><li><code>key</code> : String<div class="sub-desc"><p>The key to associate with the item, or the new item.</p>
43<p>If you supplied a <a ext:cls="Ext.util.MixedCollection" ext:member="getKey" href="output/Ext.util.MixedCollection.html#getKey">getKey</a> implementation for this MixedCollection, or if the key
44of your stored items is in a property called <tt><b>id</b></tt>, then the MixedCollection
45will be able to <i>derive</i> the key for the new item. In this case just pass the new item in
46this parameter.</p></div></li><li><code>o</code> : Object<div class="sub-desc">The item to add.</div></li>        </ul>
47        <strong>Returns:</strong>
48        <ul>
49            <li><code>Object</code><div class="sub-desc">The item added.</div></li>
50        </ul>
51    </div>
52                </div>
53                        </div>
54        </td>
55        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#add" href="output/Ext.util.MixedCollection.html#add">MixedCollection</a></td>
56    </tr>
57        <tr class="method-row inherited alt expandable">
58        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
59        <td class="sig">
60        <a id="Ext.StoreMgr-addAll"></a>
61            <b>addAll</b>(&nbsp;<code>Object/Array objs</code>&nbsp;) : void            <div class="mdesc">
62                        <div class="short">Adds all elements of an Array or an Object to the collection.</div>
63            <div class="long">
64                Adds all elements of an Array or an Object to the collection.    <div class="mdetail-params">
65        <strong>Parameters:</strong>
66        <ul><li><code>objs</code> : Object/Array<div class="sub-desc">An Object containing properties which will be added to the collection, or
67an Array of values, each of which are added to the collection.</div></li>        </ul>
68        <strong>Returns:</strong>
69        <ul>
70            <li><code>void</code></li>
71        </ul>
72    </div>
73                </div>
74                        </div>
75        </td>
76        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#addAll" href="output/Ext.util.MixedCollection.html#addAll">MixedCollection</a></td>
77    </tr>
78        <tr class="method-row inherited expandable">
79        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
80        <td class="sig">
81        <a id="Ext.StoreMgr-addEvents"></a>
82            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
83                        <div class="short">Used to define events on this Observable</div>
84            <div class="long">
85                Used to define events on this Observable    <div class="mdetail-params">
86        <strong>Parameters:</strong>
87        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
88        <strong>Returns:</strong>
89        <ul>
90            <li><code>void</code></li>
91        </ul>
92    </div>
93                </div>
94                        </div>
95        </td>
96        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
97    </tr>
98        <tr class="method-row inherited alt expandable">
99        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
100        <td class="sig">
101        <a id="Ext.StoreMgr-addListener"></a>
102            <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
103                        <div class="short">Appends an event handler to this component</div>
104            <div class="long">
105                Appends an event handler to this component    <div class="mdetail-params">
106        <strong>Parameters:</strong>
107        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
108function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
109properties. This may contain any of the following properties:<ul>
110<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
111<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
112<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
113<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
114by the specified number of milliseconds. If the event fires again within that time, the original
115handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
116</ul><br>
117<p>
118<b>Combining Options</b><br>
119Using the options argument, it is possible to combine different types of listeners:<br>
120<br>
121A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
122<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
123    single: true,
124    delay: 100,
125    forumId: 4
126});</code></pre>
127<p>
128<b>Attaching multiple handlers in 1 call</b><br>
129The method also allows for a single argument to be passed which is a config object containing properties
130which specify multiple handlers.
131<p>
132<pre><code>foo.on({
133    <em>'click'</em> : {
134        fn: <b>this</b>.onClick,
135        scope: <b>this</b>,
136        delay: 100
137    },
138    <em>'mouseover'</em> : {
139        fn: <b>this</b>.onMouseOver,
140        scope: <b>this</b>
141    },
142    <em>'mouseout'</em> : {
143        fn: <b>this</b>.onMouseOut,
144        scope: <b>this</b>
145    }
146});</code></pre>
147<p>
148Or a shorthand syntax:<br>
149<pre><code>foo.on({
150    <em>'click'</em> : <b>this</b>.onClick,
151    <em>'mouseover'</em> : <b>this</b>.onMouseOver,
152    <em>'mouseout'</em> : <b>this</b>.onMouseOut,
153     scope: <b>this</b>
154});</code></pre></div></li>        </ul>
155        <strong>Returns:</strong>
156        <ul>
157            <li><code>void</code></li>
158        </ul>
159    </div>
160                </div>
161                        </div>
162        </td>
163        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
164    </tr>
165        <tr class="method-row inherited expandable">
166        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
167        <td class="sig">
168        <a id="Ext.StoreMgr-clear"></a>
169            <b>clear</b>() : void            <div class="mdesc">
170                        <div class="short">Removes all items from the collection.  Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="clear" href="output/Ext.util.MixedCollection.html#clear">clear</a> event when complete.</div>
171            <div class="long">
172                Removes all items from the collection.  Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="clear" href="output/Ext.util.MixedCollection.html#clear">clear</a> event when complete.    <div class="mdetail-params">
173        <strong>Parameters:</strong>
174        <ul><li>None.</li>        </ul>
175        <strong>Returns:</strong>
176        <ul>
177            <li><code>void</code></li>
178        </ul>
179    </div>
180                </div>
181                        </div>
182        </td>
183        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#clear" href="output/Ext.util.MixedCollection.html#clear">MixedCollection</a></td>
184    </tr>
185        <tr class="method-row inherited alt expandable">
186        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
187        <td class="sig">
188        <a id="Ext.StoreMgr-clone"></a>
189            <b>clone</b>() : MixedCollection            <div class="mdesc">
190                        <div class="short">Creates a shallow copy of this collection</div>
191            <div class="long">
192                Creates a shallow copy of this collection    <div class="mdetail-params">
193        <strong>Parameters:</strong>
194        <ul><li>None.</li>        </ul>
195        <strong>Returns:</strong>
196        <ul>
197            <li><code>MixedCollection</code></li>
198        </ul>
199    </div>
200                </div>
201                        </div>
202        </td>
203        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#clone" href="output/Ext.util.MixedCollection.html#clone">MixedCollection</a></td>
204    </tr>
205        <tr class="method-row inherited expandable">
206        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
207        <td class="sig">
208        <a id="Ext.StoreMgr-contains"></a>
209            <b>contains</b>(&nbsp;<code>Object o</code>&nbsp;) : Boolean            <div class="mdesc">
210                        <div class="short">Returns true if the collection contains the passed Object as an item.</div>
211            <div class="long">
212                Returns true if the collection contains the passed Object as an item.    <div class="mdetail-params">
213        <strong>Parameters:</strong>
214        <ul><li><code>o</code> : Object<div class="sub-desc">The Object to look for in the collection.</div></li>        </ul>
215        <strong>Returns:</strong>
216        <ul>
217            <li><code>Boolean</code><div class="sub-desc">True if the collection contains the Object as an item.</div></li>
218        </ul>
219    </div>
220                </div>
221                        </div>
222        </td>
223        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#contains" href="output/Ext.util.MixedCollection.html#contains">MixedCollection</a></td>
224    </tr>
225        <tr class="method-row inherited alt expandable">
226        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
227        <td class="sig">
228        <a id="Ext.StoreMgr-containsKey"></a>
229            <b>containsKey</b>(&nbsp;<code>String key</code>&nbsp;) : Boolean            <div class="mdesc">
230                        <div class="short">Returns true if the collection contains the passed Object as a key.</div>
231            <div class="long">
232                Returns true if the collection contains the passed Object as a key.    <div class="mdetail-params">
233        <strong>Parameters:</strong>
234        <ul><li><code>key</code> : String<div class="sub-desc">The key to look for in the collection.</div></li>        </ul>
235        <strong>Returns:</strong>
236        <ul>
237            <li><code>Boolean</code><div class="sub-desc">True if the collection contains the Object as a key.</div></li>
238        </ul>
239    </div>
240                </div>
241                        </div>
242        </td>
243        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#containsKey" href="output/Ext.util.MixedCollection.html#containsKey">MixedCollection</a></td>
244    </tr>
245        <tr class="method-row inherited expandable">
246        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
247        <td class="sig">
248        <a id="Ext.StoreMgr-each"></a>
249            <b>each</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
250                        <div class="short">Executes the specified function once for every item in the collection, passing the following arguments:
251
252item : Mixed...</div>
253            <div class="long">
254                Executes the specified function once for every item in the collection, passing the following arguments:
255<div class="mdetail-params"><ul>
256<li><b>item</b> : Mixed<p class="sub-desc">The collection item</p></li>
257<li><b>index</b> : Number<p class="sub-desc">The item's index</p></li>
258<li><b>length</b> : Number<p class="sub-desc">The total number of items in the collection</p></li>
259</ul></div>
260The function should return a boolean value. Returning false from the function will stop the iteration.    <div class="mdetail-params">
261        <strong>Parameters:</strong>
262        <ul><li><code>fn</code> : Function<div class="sub-desc">The function to execute for each item.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the function.</div></li>        </ul>
263        <strong>Returns:</strong>
264        <ul>
265            <li><code>void</code></li>
266        </ul>
267    </div>
268                </div>
269                        </div>
270        </td>
271        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#each" href="output/Ext.util.MixedCollection.html#each">MixedCollection</a></td>
272    </tr>
273        <tr class="method-row inherited alt expandable">
274        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
275        <td class="sig">
276        <a id="Ext.StoreMgr-eachKey"></a>
277            <b>eachKey</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
278                        <div class="short">Executes the specified function once for every key in the collection, passing each
279key, and its associated item as th...</div>
280            <div class="long">
281                Executes the specified function once for every key in the collection, passing each
282key, and its associated item as the first two parameters.    <div class="mdetail-params">
283        <strong>Parameters:</strong>
284        <ul><li><code>fn</code> : Function<div class="sub-desc">The function to execute for each item.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the function.</div></li>        </ul>
285        <strong>Returns:</strong>
286        <ul>
287            <li><code>void</code></li>
288        </ul>
289    </div>
290                </div>
291                        </div>
292        </td>
293        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#eachKey" href="output/Ext.util.MixedCollection.html#eachKey">MixedCollection</a></td>
294    </tr>
295        <tr class="method-row inherited expandable">
296        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
297        <td class="sig">
298        <a id="Ext.StoreMgr-filter"></a>
299            <b>filter</b>(&nbsp;<code>String property</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span>&nbsp;) : MixedCollection            <div class="mdesc">
300                        <div class="short">Filter the <i>objects</i> in this collection by a specific property.
301Returns a new collection that has been filtered.</div>
302            <div class="long">
303                Filter the <i>objects</i> in this collection by a specific property.
304Returns a new collection that has been filtered.    <div class="mdetail-params">
305        <strong>Parameters:</strong>
306        <ul><li><code>property</code> : String<div class="sub-desc">A property on your objects</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">Either string that the property values
307should start with or a RegExp to test against the property</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) True to match any part of the string, not just the beginning</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) True for case sensitive comparison (defaults to False).</div></li>        </ul>
308        <strong>Returns:</strong>
309        <ul>
310            <li><code>MixedCollection</code><div class="sub-desc">The new filtered collection</div></li>
311        </ul>
312    </div>
313                </div>
314                        </div>
315        </td>
316        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#filter" href="output/Ext.util.MixedCollection.html#filter">MixedCollection</a></td>
317    </tr>
318        <tr class="method-row inherited alt expandable">
319        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
320        <td class="sig">
321        <a id="Ext.StoreMgr-filterBy"></a>
322            <b>filterBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : MixedCollection            <div class="mdesc">
323                        <div class="short">Filter by a function. Returns a new collection that has been filtered.
324The passed function will be called with each o...</div>
325            <div class="long">
326                Filter by a function. Returns a <i>new</i> collection that has been filtered.
327The passed function will be called with each object in the collection.
328If the function returns true, the value is included otherwise it is filtered.    <div class="mdetail-params">
329        <strong>Parameters:</strong>
330        <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called, it will receive the args o (the object), k (the key)</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li>        </ul>
331        <strong>Returns:</strong>
332        <ul>
333            <li><code>MixedCollection</code><div class="sub-desc">The new filtered collection</div></li>
334        </ul>
335    </div>
336                </div>
337                        </div>
338        </td>
339        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#filterBy" href="output/Ext.util.MixedCollection.html#filterBy">MixedCollection</a></td>
340    </tr>
341        <tr class="method-row inherited expandable">
342        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
343        <td class="sig">
344        <a id="Ext.StoreMgr-find"></a>
345            <b>find</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : Object            <div class="mdesc">
346                        <div class="short">Returns the first item in the collection which elicits a true return value from the
347passed selection function.</div>
348            <div class="long">
349                Returns the first item in the collection which elicits a true return value from the
350passed selection function.    <div class="mdetail-params">
351        <strong>Parameters:</strong>
352        <ul><li><code>fn</code> : Function<div class="sub-desc">The selection function to execute for each item.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the function.</div></li>        </ul>
353        <strong>Returns:</strong>
354        <ul>
355            <li><code>Object</code><div class="sub-desc">The first item in the collection which returned true from the selection function.</div></li>
356        </ul>
357    </div>
358                </div>
359                        </div>
360        </td>
361        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#find" href="output/Ext.util.MixedCollection.html#find">MixedCollection</a></td>
362    </tr>
363        <tr class="method-row inherited alt expandable">
364        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
365        <td class="sig">
366        <a id="Ext.StoreMgr-findIndex"></a>
367            <b>findIndex</b>(&nbsp;<code>String property</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Number start</code>]</span>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span>&nbsp;) : Number            <div class="mdesc">
368                        <div class="short">Finds the index of the first matching object in this collection by a specific property/value.</div>
369            <div class="long">
370                Finds the index of the first matching object in this collection by a specific property/value.    <div class="mdetail-params">
371        <strong>Parameters:</strong>
372        <ul><li><code>property</code> : String<div class="sub-desc">The name of a property on your objects.</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">A string that the property values
373should start with or a RegExp to test against the property.</div></li><li><code>start</code> : Number<div class="sub-desc">(optional) The index to start searching at (defaults to 0).</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) True to match any part of the string, not just the beginning.</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) True for case sensitive comparison.</div></li>        </ul>
374        <strong>Returns:</strong>
375        <ul>
376            <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li>
377        </ul>
378    </div>
379                </div>
380                        </div>
381        </td>
382        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#findIndex" href="output/Ext.util.MixedCollection.html#findIndex">MixedCollection</a></td>
383    </tr>
384        <tr class="method-row inherited expandable">
385        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
386        <td class="sig">
387        <a id="Ext.StoreMgr-findIndexBy"></a>
388            <b>findIndexBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Number start</code>]</span>&nbsp;) : Number            <div class="mdesc">
389                        <div class="short">Find the index of the first matching object in this collection by a function.
390If the function returns true it is cons...</div>
391            <div class="long">
392                Find the index of the first matching object in this collection by a function.
393If the function returns <i>true</i> it is considered a match.    <div class="mdetail-params">
394        <strong>Parameters:</strong>
395        <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called, it will receive the args o (the object), k (the key).</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this).</div></li><li><code>start</code> : Number<div class="sub-desc">(optional) The index to start searching at (defaults to 0).</div></li>        </ul>
396        <strong>Returns:</strong>
397        <ul>
398            <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li>
399        </ul>
400    </div>
401                </div>
402                        </div>
403        </td>
404        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#findIndexBy" href="output/Ext.util.MixedCollection.html#findIndexBy">MixedCollection</a></td>
405    </tr>
406        <tr class="method-row inherited alt expandable">
407        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
408        <td class="sig">
409        <a id="Ext.StoreMgr-fireEvent"></a>
410            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
411                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
412            <div class="long">
413                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
414        <strong>Parameters:</strong>
415        <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>
416        <strong>Returns:</strong>
417        <ul>
418            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
419        </ul>
420    </div>
421                </div>
422                        </div>
423        </td>
424        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
425    </tr>
426        <tr class="method-row inherited expandable">
427        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
428        <td class="sig">
429        <a id="Ext.StoreMgr-first"></a>
430            <b>first</b>() : Object            <div class="mdesc">
431                        <div class="short">Returns the first item in the collection.</div>
432            <div class="long">
433                Returns the first item in the collection.    <div class="mdetail-params">
434        <strong>Parameters:</strong>
435        <ul><li>None.</li>        </ul>
436        <strong>Returns:</strong>
437        <ul>
438            <li><code>Object</code><div class="sub-desc">the first item in the collection..</div></li>
439        </ul>
440    </div>
441                </div>
442                        </div>
443        </td>
444        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#first" href="output/Ext.util.MixedCollection.html#first">MixedCollection</a></td>
445    </tr>
446        <tr class="method-row inherited alt expandable">
447        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
448        <td class="sig">
449        <a id="Ext.StoreMgr-get"></a>
450            <b>get</b>(&nbsp;<code>String/Number key</code>&nbsp;) : Object            <div class="mdesc">
451                        <div class="short">Returns the item associated with the passed key or index.</div>
452            <div class="long">
453                Returns the item associated with the passed key or index.    <div class="mdetail-params">
454        <strong>Parameters:</strong>
455        <ul><li><code>key</code> : String/Number<div class="sub-desc">The key or index of the item.</div></li>        </ul>
456        <strong>Returns:</strong>
457        <ul>
458            <li><code>Object</code><div class="sub-desc">The item associated with the passed key.</div></li>
459        </ul>
460    </div>
461                </div>
462                        </div>
463        </td>
464        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#get" href="output/Ext.util.MixedCollection.html#get">MixedCollection</a></td>
465    </tr>
466        <tr class="method-row inherited expandable">
467        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
468        <td class="sig">
469        <a id="Ext.StoreMgr-getCount"></a>
470            <b>getCount</b>() : Number            <div class="mdesc">
471                        <div class="short">Returns the number of items in the collection.</div>
472            <div class="long">
473                Returns the number of items in the collection.    <div class="mdetail-params">
474        <strong>Parameters:</strong>
475        <ul><li>None.</li>        </ul>
476        <strong>Returns:</strong>
477        <ul>
478            <li><code>Number</code><div class="sub-desc">the number of items in the collection.</div></li>
479        </ul>
480    </div>
481                </div>
482                        </div>
483        </td>
484        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#getCount" href="output/Ext.util.MixedCollection.html#getCount">MixedCollection</a></td>
485    </tr>
486        <tr class="method-row inherited alt expandable">
487        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
488        <td class="sig">
489        <a id="Ext.StoreMgr-getKey"></a>
490            <b>getKey</b>(&nbsp;<code>Object item</code>&nbsp;) : Object            <div class="mdesc">
491                        <div class="short">MixedCollection has a generic way to fetch keys if you implement getKey.  The default implementation
492simply returns i...</div>
493            <div class="long">
494                MixedCollection has a generic way to fetch keys if you implement getKey.  The default implementation
495simply returns <tt style="font-weight:bold;">item.id</tt> but you can provide your own implementation
496to return a different value as in the following examples:
497<pre><code><i>// normal way</i>
498<b>var</b> mc = <b>new</b> Ext.util.MixedCollection();
499mc.add(someEl.dom.id, someEl);
500mc.add(otherEl.dom.id, otherEl);
501<i>//and so on</i>
502
503<i>// using getKey</i>
504<b>var</b> mc = <b>new</b> Ext.util.MixedCollection();
505mc.getKey = <b>function</b>(el){
506   <b>return</b> el.dom.id;
507};
508mc.add(someEl);
509mc.add(otherEl);
510
511<i>// or via the constructor</i>
512<b>var</b> mc = <b>new</b> Ext.util.MixedCollection(false, <b>function</b>(el){
513   <b>return</b> el.dom.id;
514});
515mc.add(someEl);
516mc.add(otherEl);</code></pre>    <div class="mdetail-params">
517        <strong>Parameters:</strong>
518        <ul><li><code>item</code> : Object<div class="sub-desc">The item for which to find the key.</div></li>        </ul>
519        <strong>Returns:</strong>
520        <ul>
521            <li><code>Object</code><div class="sub-desc">The key for the passed item.</div></li>
522        </ul>
523    </div>
524                </div>
525                        </div>
526        </td>
527        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#getKey" href="output/Ext.util.MixedCollection.html#getKey">MixedCollection</a></td>
528    </tr>
529        <tr class="method-row inherited expandable">
530        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
531        <td class="sig">
532        <a id="Ext.StoreMgr-getRange"></a>
533            <b>getRange</b>(&nbsp;<span class="optional" title="Optional">[<code>Number startIndex</code>]</span>, <span class="optional" title="Optional">[<code>Number endIndex</code>]</span>&nbsp;) : Array            <div class="mdesc">
534                        <div class="short">Returns a range of items in this collection</div>
535            <div class="long">
536                Returns a range of items in this collection    <div class="mdetail-params">
537        <strong>Parameters:</strong>
538        <ul><li><code>startIndex</code> : Number<div class="sub-desc">(optional) defaults to 0</div></li><li><code>endIndex</code> : Number<div class="sub-desc">(optional) default to the last item</div></li>        </ul>
539        <strong>Returns:</strong>
540        <ul>
541            <li><code>Array</code><div class="sub-desc">An array of items</div></li>
542        </ul>
543    </div>
544                </div>
545                        </div>
546        </td>
547        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#getRange" href="output/Ext.util.MixedCollection.html#getRange">MixedCollection</a></td>
548    </tr>
549        <tr class="method-row inherited alt expandable">
550        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
551        <td class="sig">
552        <a id="Ext.StoreMgr-hasListener"></a>
553            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
554                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
555            <div class="long">
556                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
557        <strong>Parameters:</strong>
558        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
559        <strong>Returns:</strong>
560        <ul>
561            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
562        </ul>
563    </div>
564                </div>
565                        </div>
566        </td>
567        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
568    </tr>
569        <tr class="method-row inherited expandable">
570        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
571        <td class="sig">
572        <a id="Ext.StoreMgr-indexOf"></a>
573            <b>indexOf</b>(&nbsp;<code>Object o</code>&nbsp;) : Number            <div class="mdesc">
574                        <div class="short">Returns index within the collection of the passed Object.</div>
575            <div class="long">
576                Returns index within the collection of the passed Object.    <div class="mdetail-params">
577        <strong>Parameters:</strong>
578        <ul><li><code>o</code> : Object<div class="sub-desc">The item to find the index of.</div></li>        </ul>
579        <strong>Returns:</strong>
580        <ul>
581            <li><code>Number</code><div class="sub-desc">index of the item. Returns -1 if not found.</div></li>
582        </ul>
583    </div>
584                </div>
585                        </div>
586        </td>
587        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#indexOf" href="output/Ext.util.MixedCollection.html#indexOf">MixedCollection</a></td>
588    </tr>
589        <tr class="method-row inherited alt expandable">
590        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
591        <td class="sig">
592        <a id="Ext.StoreMgr-indexOfKey"></a>
593            <b>indexOfKey</b>(&nbsp;<code>String key</code>&nbsp;) : Number            <div class="mdesc">
594                        <div class="short">Returns index within the collection of the passed key.</div>
595            <div class="long">
596                Returns index within the collection of the passed key.    <div class="mdetail-params">
597        <strong>Parameters:</strong>
598        <ul><li><code>key</code> : String<div class="sub-desc">The key to find the index of.</div></li>        </ul>
599        <strong>Returns:</strong>
600        <ul>
601            <li><code>Number</code><div class="sub-desc">index of the key.</div></li>
602        </ul>
603    </div>
604                </div>
605                        </div>
606        </td>
607        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#indexOfKey" href="output/Ext.util.MixedCollection.html#indexOfKey">MixedCollection</a></td>
608    </tr>
609        <tr class="method-row inherited expandable">
610        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
611        <td class="sig">
612        <a id="Ext.StoreMgr-insert"></a>
613            <b>insert</b>(&nbsp;<code>Number index</code>, <code>String key</code>, <span class="optional" title="Optional">[<code>Object o</code>]</span>&nbsp;) : Object            <div class="mdesc">
614                        <div class="short">Inserts an item at the specified index in the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="add" href="output/Ext.util.MixedCollection.html#add">add</a> event when complete.</div>
615            <div class="long">
616                Inserts an item at the specified index in the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="add" href="output/Ext.util.MixedCollection.html#add">add</a> event when complete.    <div class="mdetail-params">
617        <strong>Parameters:</strong>
618        <ul><li><code>index</code> : Number<div class="sub-desc">The index to insert the item at.</div></li><li><code>key</code> : String<div class="sub-desc">The key to associate with the new item, or the item itself.</div></li><li><code>o</code> : Object<div class="sub-desc">(optional) If the second parameter was a key, the new item.</div></li>        </ul>
619        <strong>Returns:</strong>
620        <ul>
621            <li><code>Object</code><div class="sub-desc">The item inserted.</div></li>
622        </ul>
623    </div>
624                </div>
625                        </div>
626        </td>
627        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#insert" href="output/Ext.util.MixedCollection.html#insert">MixedCollection</a></td>
628    </tr>
629        <tr class="method-row inherited alt expandable">
630        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
631        <td class="sig">
632        <a id="Ext.StoreMgr-item"></a>
633            <b>item</b>(&nbsp;<code>String/Number key</code>&nbsp;) : Object            <div class="mdesc">
634                        <div class="short">Returns the item associated with the passed key OR index. Key has priority over index.  This is the equivalent
635of cal...</div>
636            <div class="long">
637                Returns the item associated with the passed key OR index. Key has priority over index.  This is the equivalent
638of calling <a ext:cls="Ext.util.MixedCollection" ext:member="key" href="output/Ext.util.MixedCollection.html#key">key</a> first, then if nothing matched calling <a ext:cls="Ext.util.MixedCollection" ext:member="itemAt" href="output/Ext.util.MixedCollection.html#itemAt">itemAt</a>.    <div class="mdetail-params">
639        <strong>Parameters:</strong>
640        <ul><li><code>key</code> : String/Number<div class="sub-desc">The key or index of the item.</div></li>        </ul>
641        <strong>Returns:</strong>
642        <ul>
643            <li><code>Object</code><div class="sub-desc">The item associated with the passed key.</div></li>
644        </ul>
645    </div>
646                </div>
647                        </div>
648        </td>
649        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#item" href="output/Ext.util.MixedCollection.html#item">MixedCollection</a></td>
650    </tr>
651        <tr class="method-row inherited expandable">
652        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
653        <td class="sig">
654        <a id="Ext.StoreMgr-itemAt"></a>
655            <b>itemAt</b>(&nbsp;<code>Number index</code>&nbsp;) : Object            <div class="mdesc">
656                        <div class="short">Returns the item at the specified index.</div>
657            <div class="long">
658                Returns the item at the specified index.    <div class="mdetail-params">
659        <strong>Parameters:</strong>
660        <ul><li><code>index</code> : Number<div class="sub-desc">The index of the item.</div></li>        </ul>
661        <strong>Returns:</strong>
662        <ul>
663            <li><code>Object</code><div class="sub-desc">The item at the specified index.</div></li>
664        </ul>
665    </div>
666                </div>
667                        </div>
668        </td>
669        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#itemAt" href="output/Ext.util.MixedCollection.html#itemAt">MixedCollection</a></td>
670    </tr>
671        <tr class="method-row inherited alt expandable">
672        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
673        <td class="sig">
674        <a id="Ext.StoreMgr-key"></a>
675            <b>key</b>(&nbsp;<code>String/Number key</code>&nbsp;) : Object            <div class="mdesc">
676                        <div class="short">Returns the item associated with the passed key.</div>
677            <div class="long">
678                Returns the item associated with the passed key.    <div class="mdetail-params">
679        <strong>Parameters:</strong>
680        <ul><li><code>key</code> : String/Number<div class="sub-desc">The key of the item.</div></li>        </ul>
681        <strong>Returns:</strong>
682        <ul>
683            <li><code>Object</code><div class="sub-desc">The item associated with the passed key.</div></li>
684        </ul>
685    </div>
686                </div>
687                        </div>
688        </td>
689        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#key" href="output/Ext.util.MixedCollection.html#key">MixedCollection</a></td>
690    </tr>
691        <tr class="method-row inherited expandable">
692        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
693        <td class="sig">
694        <a id="Ext.StoreMgr-keySort"></a>
695            <b>keySort</b>(&nbsp;<span class="optional" title="Optional">[<code>String direction</code>]</span>, <span class="optional" title="Optional">[<code>Function fn</code>]</span>&nbsp;) : void            <div class="mdesc">
696                        <div class="short">Sorts this collection by keys</div>
697            <div class="long">
698                Sorts this collection by keys    <div class="mdetail-params">
699        <strong>Parameters:</strong>
700        <ul><li><code>direction</code> : String<div class="sub-desc">(optional) "ASC" or "DESC"</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) a comparison function (defaults to case insensitive string)</div></li>        </ul>
701        <strong>Returns:</strong>
702        <ul>
703            <li><code>void</code></li>
704        </ul>
705    </div>
706                </div>
707                        </div>
708        </td>
709        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#keySort" href="output/Ext.util.MixedCollection.html#keySort">MixedCollection</a></td>
710    </tr>
711        <tr class="method-row inherited alt expandable">
712        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
713        <td class="sig">
714        <a id="Ext.StoreMgr-last"></a>
715            <b>last</b>() : Object            <div class="mdesc">
716                        <div class="short">Returns the last item in the collection.</div>
717            <div class="long">
718                Returns the last item in the collection.    <div class="mdetail-params">
719        <strong>Parameters:</strong>
720        <ul><li>None.</li>        </ul>
721        <strong>Returns:</strong>
722        <ul>
723            <li><code>Object</code><div class="sub-desc">the last item in the collection..</div></li>
724        </ul>
725    </div>
726                </div>
727                        </div>
728        </td>
729        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#last" href="output/Ext.util.MixedCollection.html#last">MixedCollection</a></td>
730    </tr>
731        <tr class="method-row expandable">
732        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
733        <td class="sig">
734        <a id="Ext.StoreMgr-lookup"></a>
735            <b>lookup</b>(&nbsp;<code>String/Object id</code>&nbsp;) : Ext.data.Store            <div class="mdesc">
736                        <div class="short">Gets a registered Store by id</div>
737            <div class="long">
738                Gets a registered Store by id    <div class="mdetail-params">
739        <strong>Parameters:</strong>
740        <ul><li><code>id</code> : String/Object<div class="sub-desc">The id of the Store, or a Store instance</div></li>        </ul>
741        <strong>Returns:</strong>
742        <ul>
743            <li><code>Ext.data.Store</code></li>
744        </ul>
745    </div>
746                </div>
747                        </div>
748        </td>
749        <td class="msource">StoreMgr</td>
750    </tr>
751        <tr class="method-row inherited alt expandable">
752        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
753        <td class="sig">
754        <a id="Ext.StoreMgr-on"></a>
755            <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
756                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
757            <div class="long">
758                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
759        <strong>Parameters:</strong>
760        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
761function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
762        <strong>Returns:</strong>
763        <ul>
764            <li><code>void</code></li>
765        </ul>
766    </div>
767                </div>
768                        </div>
769        </td>
770        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
771    </tr>
772        <tr class="method-row inherited expandable">
773        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
774        <td class="sig">
775        <a id="Ext.StoreMgr-purgeListeners"></a>
776            <b>purgeListeners</b>() : void            <div class="mdesc">
777                        <div class="short">Removes all listeners for this object</div>
778            <div class="long">
779                Removes all listeners for this object    <div class="mdetail-params">
780        <strong>Parameters:</strong>
781        <ul><li>None.</li>        </ul>
782        <strong>Returns:</strong>
783        <ul>
784            <li><code>void</code></li>
785        </ul>
786    </div>
787                </div>
788                        </div>
789        </td>
790        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
791    </tr>
792        <tr class="method-row alt expandable">
793        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
794        <td class="sig">
795        <a id="Ext.StoreMgr-register"></a>
796            <b>register</b>(&nbsp;<code>Ext.data.Store store1</code>, <span class="optional" title="Optional">[<code>Ext.data.Store store2</code>]</span>, <span class="optional" title="Optional">[<code>Ext.data.Store etc...</code>]</span>&nbsp;) : void            <div class="mdesc">
797                        <div class="short">
798Registers one or more Stores with the StoreMgr. You do not normally need to register stores
799manually.  Any store ini...</div>
800            <div class="long">
801               
802Registers one or more Stores with the StoreMgr. You do not normally need to register stores
803manually.  Any store initialized with a <a ext:cls="Ext.data.Store" ext:member="storeId" href="output/Ext.data.Store.html#storeId">Ext.data.Store.storeId</a> will be auto-registered.    <div class="mdetail-params">
804        <strong>Parameters:</strong>
805        <ul><li><code>store1</code> : Ext.data.Store<div class="sub-desc">A Store instance</div></li><li><code>store2</code> : Ext.data.Store<div class="sub-desc">(optional)</div></li><li><code>etc...</code> : Ext.data.Store<div class="sub-desc">(optional)</div></li>        </ul>
806        <strong>Returns:</strong>
807        <ul>
808            <li><code>void</code></li>
809        </ul>
810    </div>
811                </div>
812                        </div>
813        </td>
814        <td class="msource">StoreMgr</td>
815    </tr>
816        <tr class="method-row inherited expandable">
817        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
818        <td class="sig">
819        <a id="Ext.StoreMgr-relayEvents"></a>
820            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
821                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
822            <div class="long">
823                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
824        <strong>Parameters:</strong>
825        <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>
826        <strong>Returns:</strong>
827        <ul>
828            <li><code>void</code></li>
829        </ul>
830    </div>
831                </div>
832                        </div>
833        </td>
834        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
835    </tr>
836        <tr class="method-row inherited alt expandable">
837        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
838        <td class="sig">
839        <a id="Ext.StoreMgr-remove"></a>
840            <b>remove</b>(&nbsp;<code>Object o</code>&nbsp;) : Object            <div class="mdesc">
841                        <div class="short">Remove an item from the collection.</div>
842            <div class="long">
843                Remove an item from the collection.    <div class="mdetail-params">
844        <strong>Parameters:</strong>
845        <ul><li><code>o</code> : Object<div class="sub-desc">The item to remove.</div></li>        </ul>
846        <strong>Returns:</strong>
847        <ul>
848            <li><code>Object</code><div class="sub-desc">The item removed or false if no item was removed.</div></li>
849        </ul>
850    </div>
851                </div>
852                        </div>
853        </td>
854        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#remove" href="output/Ext.util.MixedCollection.html#remove">MixedCollection</a></td>
855    </tr>
856        <tr class="method-row inherited expandable">
857        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
858        <td class="sig">
859        <a id="Ext.StoreMgr-removeAt"></a>
860            <b>removeAt</b>(&nbsp;<code>Number index</code>&nbsp;) : Object            <div class="mdesc">
861                        <div class="short">Remove an item from a specified index in the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="remove" href="output/Ext.util.MixedCollection.html#remove">remove</a> event when complete.</div>
862            <div class="long">
863                Remove an item from a specified index in the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="remove" href="output/Ext.util.MixedCollection.html#remove">remove</a> event when complete.    <div class="mdetail-params">
864        <strong>Parameters:</strong>
865        <ul><li><code>index</code> : Number<div class="sub-desc">The index within the collection of the item to remove.</div></li>        </ul>
866        <strong>Returns:</strong>
867        <ul>
868            <li><code>Object</code><div class="sub-desc">The item removed or false if no item was removed.</div></li>
869        </ul>
870    </div>
871                </div>
872                        </div>
873        </td>
874        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#removeAt" href="output/Ext.util.MixedCollection.html#removeAt">MixedCollection</a></td>
875    </tr>
876        <tr class="method-row inherited alt expandable">
877        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
878        <td class="sig">
879        <a id="Ext.StoreMgr-removeKey"></a>
880            <b>removeKey</b>(&nbsp;<code>String key</code>&nbsp;) : Object            <div class="mdesc">
881                        <div class="short">Removed an item associated with the passed key fom the collection.</div>
882            <div class="long">
883                Removed an item associated with the passed key fom the collection.    <div class="mdetail-params">
884        <strong>Parameters:</strong>
885        <ul><li><code>key</code> : String<div class="sub-desc">The key of the item to remove.</div></li>        </ul>
886        <strong>Returns:</strong>
887        <ul>
888            <li><code>Object</code><div class="sub-desc">The item removed or false if no item was removed.</div></li>
889        </ul>
890    </div>
891                </div>
892                        </div>
893        </td>
894        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#removeKey" href="output/Ext.util.MixedCollection.html#removeKey">MixedCollection</a></td>
895    </tr>
896        <tr class="method-row inherited expandable">
897        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
898        <td class="sig">
899        <a id="Ext.StoreMgr-removeListener"></a>
900            <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
901                        <div class="short">Removes a listener</div>
902            <div class="long">
903                Removes a listener    <div class="mdetail-params">
904        <strong>Parameters:</strong>
905        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
906        <strong>Returns:</strong>
907        <ul>
908            <li><code>void</code></li>
909        </ul>
910    </div>
911                </div>
912                        </div>
913        </td>
914        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
915    </tr>
916        <tr class="method-row inherited alt expandable">
917        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
918        <td class="sig">
919        <a id="Ext.StoreMgr-replace"></a>
920            <b>replace</b>(&nbsp;<code>String key</code>, <span class="optional" title="Optional">[<code>o {Object}</code>]</span>&nbsp;) : Object            <div class="mdesc">
921                        <div class="short">Replaces an item in the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="replace" href="output/Ext.util.MixedCollection.html#replace">replace</a> event when complete.</div>
922            <div class="long">
923                Replaces an item in the collection. Fires the <a ext:cls="Ext.util.MixedCollection" ext:member="replace" href="output/Ext.util.MixedCollection.html#replace">replace</a> event when complete.    <div class="mdetail-params">
924        <strong>Parameters:</strong>
925        <ul><li><code>key</code> : String<div class="sub-desc"><p>The key associated with the item to replace, or the replacement item.</p>
926<p>If you supplied a <a ext:cls="Ext.util.MixedCollection" ext:member="getKey" href="output/Ext.util.MixedCollection.html#getKey">getKey</a> implementation for this MixedCollection, or if the key
927of your stored items is in a property called <tt><b>id</b></tt>, then the MixedCollection
928will be able to <i>derive</i> the key of the replacement item. If you want to replace an item
929with one having the same key value, then just pass the replacement item in this parameter.</p></div></li><li><code>{Object}</code> : o<div class="sub-desc">o (optional) If the first parameter passed was a key, the item to associate
930with that key.</div></li>        </ul>
931        <strong>Returns:</strong>
932        <ul>
933            <li><code>Object</code><div class="sub-desc">The new item.</div></li>
934        </ul>
935    </div>
936                </div>
937                        </div>
938        </td>
939        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#replace" href="output/Ext.util.MixedCollection.html#replace">MixedCollection</a></td>
940    </tr>
941        <tr class="method-row inherited expandable">
942        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
943        <td class="sig">
944        <a id="Ext.StoreMgr-resumeEvents"></a>
945            <b>resumeEvents</b>() : void            <div class="mdesc">
946                        <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
947            <div class="long">
948                Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">
949        <strong>Parameters:</strong>
950        <ul><li>None.</li>        </ul>
951        <strong>Returns:</strong>
952        <ul>
953            <li><code>void</code></li>
954        </ul>
955    </div>
956                </div>
957                        </div>
958        </td>
959        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
960    </tr>
961        <tr class="method-row inherited alt expandable">
962        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
963        <td class="sig">
964        <a id="Ext.StoreMgr-sort"></a>
965            <b>sort</b>(&nbsp;<span class="optional" title="Optional">[<code>String direction</code>]</span>, <span class="optional" title="Optional">[<code>Function fn</code>]</span>&nbsp;) : void            <div class="mdesc">
966                        <div class="short">Sorts this collection with the passed comparison function</div>
967            <div class="long">
968                Sorts this collection with the passed comparison function    <div class="mdetail-params">
969        <strong>Parameters:</strong>
970        <ul><li><code>direction</code> : String<div class="sub-desc">(optional) "ASC" or "DESC"</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) comparison function</div></li>        </ul>
971        <strong>Returns:</strong>
972        <ul>
973            <li><code>void</code></li>
974        </ul>
975    </div>
976                </div>
977                        </div>
978        </td>
979        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#sort" href="output/Ext.util.MixedCollection.html#sort">MixedCollection</a></td>
980    </tr>
981        <tr class="method-row inherited expandable">
982        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
983        <td class="sig">
984        <a id="Ext.StoreMgr-suspendEvents"></a>
985            <b>suspendEvents</b>() : void            <div class="mdesc">
986                        <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
987            <div class="long">
988                Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">
989        <strong>Parameters:</strong>
990        <ul><li>None.</li>        </ul>
991        <strong>Returns:</strong>
992        <ul>
993            <li><code>void</code></li>
994        </ul>
995    </div>
996                </div>
997                        </div>
998        </td>
999        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
1000    </tr>
1001        <tr class="method-row inherited alt expandable">
1002        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1003        <td class="sig">
1004        <a id="Ext.StoreMgr-un"></a>
1005            <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
1006                        <div class="short">Removes a listener (shorthand for removeListener)</div>
1007            <div class="long">
1008                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
1009        <strong>Parameters:</strong>
1010        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
1011        <strong>Returns:</strong>
1012        <ul>
1013            <li><code>void</code></li>
1014        </ul>
1015    </div>
1016                </div>
1017                        </div>
1018        </td>
1019        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
1020    </tr>
1021        <tr class="method-row expandable">
1022        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1023        <td class="sig">
1024        <a id="Ext.StoreMgr-unregister"></a>
1025            <b>unregister</b>(&nbsp;<code>String/Object id1</code>, <span class="optional" title="Optional">[<code>String/Object id2</code>]</span>, <span class="optional" title="Optional">[<code>String/Object etc...</code>]</span>&nbsp;) : void            <div class="mdesc">
1026                        <div class="short">Unregisters one or more Stores with the StoreMgr</div>
1027            <div class="long">
1028                Unregisters one or more Stores with the StoreMgr    <div class="mdetail-params">
1029        <strong>Parameters:</strong>
1030        <ul><li><code>id1</code> : String/Object<div class="sub-desc">The id of the Store, or a Store instance</div></li><li><code>id2</code> : String/Object<div class="sub-desc">(optional)</div></li><li><code>etc...</code> : String/Object<div class="sub-desc">(optional)</div></li>        </ul>
1031        <strong>Returns:</strong>
1032        <ul>
1033            <li><code>void</code></li>
1034        </ul>
1035    </div>
1036                </div>
1037                        </div>
1038        </td>
1039        <td class="msource">StoreMgr</td>
1040    </tr>
1041            </table>
1042                <a id="Ext.StoreMgr-events"></a>
1043        <h2>Public Events</h2>
1044                <table cellspacing="0" class="member-table">
1045            <tr>
1046                <th class="sig-header" colspan="2">Event</th>
1047                <th class="msource-header">Defined By</th>
1048            </tr>
1049                <tr class="event-row inherited expandable">
1050        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1051        <td class="sig">
1052        <a id="Ext.StoreMgr-add"></a>
1053            <b>add</b> : (&nbsp;<code>Number index</code>, <code>Object o</code>, <code>String key</code>&nbsp;)            <div class="mdesc">
1054                        <div class="short">Fires when an item is added to the collection.</div>
1055            <div class="long">
1056                Fires when an item is added to the collection.    <div class="mdetail-params">
1057        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1058        <ul><li><code>index</code> : Number<div class="sub-desc">The index at which the item was added.</div></li><li><code>o</code> : Object<div class="sub-desc">The item added.</div></li><li><code>key</code> : String<div class="sub-desc">The key associated with the added item.</div></li>        </ul>
1059    </div>
1060                </div>
1061                        </div>
1062        </td>
1063        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#event-add" href="output/Ext.util.MixedCollection.html#event-add">MixedCollection</a></td>
1064    </tr>
1065        <tr class="event-row inherited alt expandable">
1066        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1067        <td class="sig">
1068        <a id="Ext.StoreMgr-clear"></a>
1069            <b>clear</b> : ()            <div class="mdesc">
1070                        <div class="short">Fires when the collection is cleared.</div>
1071            <div class="long">
1072                Fires when the collection is cleared.    <div class="mdetail-params">
1073        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1074        <ul><li>None.</li>        </ul>
1075    </div>
1076                </div>
1077                        </div>
1078        </td>
1079        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#event-clear" href="output/Ext.util.MixedCollection.html#event-clear">MixedCollection</a></td>
1080    </tr>
1081        <tr class="event-row inherited expandable">
1082        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1083        <td class="sig">
1084        <a id="Ext.StoreMgr-remove"></a>
1085            <b>remove</b> : (&nbsp;<code>Object o</code>, <span class="optional" title="Optional">[<code>String key</code>]</span>&nbsp;)            <div class="mdesc">
1086                        <div class="short">Fires when an item is removed from the collection.</div>
1087            <div class="long">
1088                Fires when an item is removed from the collection.    <div class="mdetail-params">
1089        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1090        <ul><li><code>o</code> : Object<div class="sub-desc">The item being removed.</div></li><li><code>key</code> : String<div class="sub-desc">(optional) The key associated with the removed item.</div></li>        </ul>
1091    </div>
1092                </div>
1093                        </div>
1094        </td>
1095        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#event-remove" href="output/Ext.util.MixedCollection.html#event-remove">MixedCollection</a></td>
1096    </tr>
1097        <tr class="event-row inherited alt expandable">
1098        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1099        <td class="sig">
1100        <a id="Ext.StoreMgr-replace"></a>
1101            <b>replace</b> : (&nbsp;<code>String key</code>, <code>Object old</code>, <code>Object new</code>&nbsp;)            <div class="mdesc">
1102                        <div class="short">Fires when an item is replaced in the collection.</div>
1103            <div class="long">
1104                Fires when an item is replaced in the collection.    <div class="mdetail-params">
1105        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1106        <ul><li><code>key</code> : String<div class="sub-desc">he key associated with the new added.</div></li><li><code>old</code> : Object<div class="sub-desc">The item being replaced.</div></li><li><code>new</code> : Object<div class="sub-desc">The new item.</div></li>        </ul>
1107    </div>
1108                </div>
1109                        </div>
1110        </td>
1111        <td class="msource"><a ext:cls="Ext.util.MixedCollection" ext:member="#event-replace" href="output/Ext.util.MixedCollection.html#event-replace">MixedCollection</a></td>
1112    </tr>
1113            </table>
1114       
1115        </div>
Note: See TracBrowser for help on using the repository browser.