/javascripts/lib/docs/output/Ext.StoreMgr.html
HTML | 269 lines | 269 code | 0 blank | 0 comment | 0 complexity | b282f850c5d81f0520624e34f9c50cf2 MD5 | raw file
Possible License(s): GPL-3.0
Large files files are truncated, but you can click here to view the full file
1<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.StoreMgr-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.StoreMgr-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.StoreMgr-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.StoreMgr-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.StoreMgr"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.util.MixedCollection.html" ext:member="" ext:cls="Ext.util.MixedCollection">MixedCollection</a> <img src="resources/elbow-end.gif">StoreMgr</pre></div><h1>Class <a href="source/StoreMgr.html#cls-Ext.StoreMgr">Ext.StoreMgr</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/StoreMgr.html#cls-Ext.StoreMgr">StoreMgr.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/StoreMgr.html#cls-Ext.StoreMgr">StoreMgr</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.MixedCollection.html" ext:cls="Ext.util.MixedCollection" ext:member="">MixedCollection</a></td></tr></table><div class="description">The default global group of stores.<br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.StoreMgr-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-allowFunctions"></a><b><a href="source/MixedCollection.html#cfg-Ext.util.MixedCollection-allowFunctions">allowFunctions</a></b> : Boolean<div class="mdesc">Specify <tt>true</tt> if the <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-addAll" ext:member="addAll" ext:cls="Ext.util.MixedCollection">addAll</a> 2function should add function references to the collection. Defaults to 3<tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#allowFunctions" ext:member="#allowFunctions" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr></tbody></table><a id="Ext.StoreMgr-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.StoreMgr-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-add"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-add">add</a></b>( <code>String key</code>, <code>Object o</code> ) 4 : 5 Object<div class="mdesc"><div class="short">Adds an item to the collection. Fires the add event when complete.</div><div class="long">Adds an item to the collection. Fires the <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-add" ext:member="add" ext:cls="Ext.util.MixedCollection">add</a> event when complete.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : String<div class="sub-desc"><p>The key to associate with the item, or the new item.</p> 6<p>If a <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-getKey" ext:member="getKey" ext:cls="Ext.util.MixedCollection">getKey</a> implementation was specified for this MixedCollection, 7or if the key of the stored items is in a property called <tt><b>id</b></tt>, 8the MixedCollection will be able to <i>derive</i> the key for the new item. 9In this case just pass the new item in this parameter.</p></div></li><li><code>o</code> : Object<div class="sub-desc">The item to add.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The item added.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#add" ext:member="#add" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-addAll"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-addAll">addAll</a></b>( <code>Object/Array objs</code> ) 10 : 11 void<div class="mdesc"><div class="short">Adds all elements of an Array or an Object to the collection.</div><div class="long">Adds all elements of an Array or an Object to the collection.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>objs</code> : Object/Array<div class="sub-desc">An Object containing properties which will be added 12to the collection, or an Array of values, each of which are added to the collection. 13Functions references will be added to the collection if <code><a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-allowFunctions" ext:member="allowFunctions" ext:cls="Ext.util.MixedCollection">allowFunctions</a></code> 14has been set to <tt>true</tt>.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#addAll" ext:member="#addAll" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object|String o</code>, <code>string Optional.</code> ) 15 : 16 void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code> 17or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters. 18Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> ) 19 : 20 void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the 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 (<code><b>this</b></code> reference) in which the handler function is executed. 21<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration. 22properties. This may contain any of the following properties:<ul> 23<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed. 24<b>If omitted, defaults to the object which fired the event.</b></div></li> 25<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> 26<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> 27<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed 28by the specified number of milliseconds. If the event fires again within that time, the original 29handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li> 30<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> 31if the event was bubbled up from a child Observable.</div></li> 32</ul><br> 33<p> 34<b>Combining Options</b><br> 35Using the options argument, it is possible to combine different types of listeners:<br> 36<br> 37A delayed, one-time listener. 38<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, { 39single: true, 40delay: 100 41});</code></pre> 42<p> 43<b>Attaching multiple handlers in 1 call</b><br> 44The method also allows for a single argument to be passed which is a config object containing properties 45which specify multiple handlers. 46<p> 47<pre><code>myGridPanel.on({ 48<em>'click'</em> : { 49 fn: this.onClick, 50 scope: this, 51 delay: 100 52}, 53<em>'mouseover'</em> : { 54 fn: this.onMouseOver, 55 scope: this 56}, 57<em>'mouseout'</em> : { 58 fn: this.onMouseOut, 59 scope: this 60} 61});</code></pre> 62<p> 63Or a shorthand syntax:<br> 64<pre><code>myGridPanel.on({ 65<em>'click'</em> : this.onClick, 66<em>'mouseover'</em> : this.onMouseOver, 67<em>'mouseout'</em> : this.onMouseOut, 68 scope: this 69});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-clear"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-clear">clear</a></b>() 70 : 71 void<div class="mdesc"><div class="short">Removes all items from the collection. Fires the clear event when complete.</div><div class="long">Removes all items from the collection. Fires the <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-clear" ext:member="clear" ext:cls="Ext.util.MixedCollection">clear</a> event when complete.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#clear" ext:member="#clear" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-clone"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-clone">clone</a></b>() 72 : 73 MixedCollection<div class="mdesc"><div class="short">Creates a shallow copy of this collection</div><div class="long">Creates a shallow copy of this collection<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>MixedCollection</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#clone" ext:member="#clone" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-contains"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-contains">contains</a></b>( <code>Object o</code> ) 74 : 75 Boolean<div class="mdesc"><div class="short">Returns true if the collection contains the passed Object as an item.</div><div class="long">Returns true if the collection contains the passed Object as an item.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Object to look for in the collection.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the collection contains the Object as an item.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#contains" ext:member="#contains" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-containsKey"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-containsKey">containsKey</a></b>( <code>String key</code> ) 76 : 77 Boolean<div class="mdesc"><div class="short">Returns true if the collection contains the passed Object as a key.</div><div class="long">Returns true if the collection contains the passed Object as a key.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : String<div class="sub-desc">The key to look for in the collection.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the collection contains the Object as a key.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#containsKey" ext:member="#containsKey" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-each"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-each">each</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> ) 78 : 79 void<div class="mdesc"><div class="short">Executes the specified function once for every item in the collection, passing the following arguments: 80<div class="m...</div><div class="long">Executes the specified function once for every item in the collection, passing the following arguments: 81<div class="mdetail-params"><ul> 82<li><b>item</b> : Mixed<p class="sub-desc">The collection item</p></li> 83<li><b>index</b> : Number<p class="sub-desc">The item's index</p></li> 84<li><b>length</b> : Number<p class="sub-desc">The total number of items in the collection</p></li> 85</ul></div> 86The function should return a boolean value. Returning false from the function will stop the iteration.<div class="mdetail-params"><strong>Parameters:</strong><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 (<code>this</code> reference) in which the function is executed. Defaults to the current item in the iteration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#each" ext:member="#each" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-eachKey"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-eachKey">eachKey</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> ) 87 : 88 void<div class="mdesc"><div class="short">Executes the specified function once for every key in the collection, passing each 89key, and its associated item as th...</div><div class="long">Executes the specified function once for every key in the collection, passing each 90key, and its associated item as the first two parameters.<div class="mdetail-params"><strong>Parameters:</strong><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 (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#eachKey" ext:member="#eachKey" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>String/Array events</code> ) 91 : 92 void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling 93this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling 94<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p> 95<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default 96implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to 97access the required target more quickly.</p> 98<p>Example:</p><pre><code>Ext.override(Ext.form.Field, { 99 <i>// Add functionality to Field's initComponent to enable the change event to bubble</i> 100 initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() { 101 this.enableBubble(<em>'change'</em>); 102 }), 103 104 <i>// We know that we want Field's events to bubble directly to the FormPanel.</i> 105 getBubbleTarget : <b>function</b>() { 106 <b>if</b> (!this.formPanel) { 107 this.formPanel = this.findParentByType(<em>'form'</em>); 108 } 109 <b>return</b> this.formPanel; 110 } 111}); 112 113<b>var</b> myForm = <b>new</b> Ext.formPanel({ 114 title: <em>'User Details'</em>, 115 items: [{ 116 ... 117 }], 118 listeners: { 119 change: <b>function</b>() { 120 <i>// Title goes red <b>if</b> form has been modified.</i> 121 myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>); 122 } 123 } 124});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-filter"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-filter">filter</a></b>( <code>String property</code>, <code>String/RegExp value</code>, <span title="Optional" class="optional">[<code>Boolean anyMatch</code>]</span>, <span title="Optional" class="optional">[<code>Boolean caseSensitive</code>]</span> ) 125 : 126 MixedCollection<div class="mdesc"><div class="short">Filter the objects in this collection by a specific property. 127Returns a new collection that has been filtered.</div><div class="long">Filter the <i>objects</i> in this collection by a specific property. 128Returns a new collection that has been filtered.<div class="mdetail-params"><strong>Parameters:</strong><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 129should 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><strong>Returns:</strong><ul><li><code>MixedCollection</code><div class="sub-desc">The new filtered collection</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#filter" ext:member="#filter" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-filterBy"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-filterBy">filterBy</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> ) 130 : 131 MixedCollection<div class="mdesc"><div class="short">Filter by a function. Returns a new collection that has been filtered. 132The passed function will be called with each o...</div><div class="long">Filter by a function. Returns a <i>new</i> collection that has been filtered. 133The passed function will be called with each object in the collection. 134If the function returns true, the value is included otherwise it is filtered.<div class="mdetail-params"><strong>Parameters:</strong><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 (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.</div></li></ul><strong>Returns:</strong><ul><li><code>MixedCollection</code><div class="sub-desc">The new filtered collection</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#filterBy" ext:member="#filterBy" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-find"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-find">find</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> ) 135 : 136 Object<div class="mdesc"><div class="short">Returns the first item in the collection which elicits a true return value from the 137passed selection function.</div><div class="long">Returns the first item in the collection which elicits a true return value from the 138passed selection function.<div class="mdetail-params"><strong>Parameters:</strong><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 (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The first item in the collection which returned true from the selection function.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#find" ext:member="#find" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-findIndex"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-findIndex">findIndex</a></b>( <code>String property</code>, <code>String/RegExp value</code>, <span title="Optional" class="optional">[<code>Number start</code>]</span>, <span title="Optional" class="optional">[<code>Boolean anyMatch</code>]</span>, <span title="Optional" class="optional">[<code>Boolean caseSensitive</code>]</span> ) 139 : 140 Number<div class="mdesc"><div class="short">Finds the index of the first matching object in this collection by a specific property/value.</div><div class="long">Finds the index of the first matching object in this collection by a specific property/value.<div class="mdetail-params"><strong>Parameters:</strong><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 141should 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><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The matched index or -1</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#findIndex" ext:member="#findIndex" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-findIndexBy"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-findIndexBy">findIndexBy</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Number start</code>]</span> ) 142 : 143 Number<div class="mdesc"><div class="short">Find the index of the first matching object in this collection by a function. 144If the function returns true it is cons...</div><div class="long">Find the index of the first matching object in this collection by a function. 145If the function returns <i>true</i> it is considered a match.<div class="mdetail-params"><strong>Parameters:</strong><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 (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.</div></li><li><code>start</code> : Number<div class="sub-desc">(optional) The index to start searching at (defaults to 0).</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The matched index or -1</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#findIndexBy" ext:member="#findIndexBy" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> ) 146 : 147 Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name). 148An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p> 149<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>) 150by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-first"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-first">first</a></b>() 151 : 152 Object<div class="mdesc"><div class="short">Returns the first item in the collection.</div><div class="long">Returns the first item in the collection.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">the first item in the collection..</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#first" ext:member="#first" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-get"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-get">get</a></b>( <code>String/Number key</code> ) 153 : 154 Object<div class="mdesc"><div class="short">This method calls item(). 155Returns the item associated with the passed key OR index. Key has priority 156over index. Thi...</div><div class="long">This method calls <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-item" ext:member="item" ext:cls="Ext.util.MixedCollection">item()</a>. 157Returns the item associated with the passed key OR index. Key has priority 158over index. This is the equivalent of calling <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-key" ext:member="key" ext:cls="Ext.util.MixedCollection">key</a> first, then if 159nothing matched calling <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-itemAt" ext:member="itemAt" ext:cls="Ext.util.MixedCollection">itemAt</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : String/Number<div class="sub-desc">The key or index of the item.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">If the item is found, returns the item. If the item was 160not found, returns <tt>undefined</tt>. If an item was found, but is a Class, 161returns <tt>null</tt>.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#get" ext:member="#get" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-getCount"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-getCount">getCount</a></b>() 162 : 163 Number<div class="mdesc"><div class="short">Returns the number of items in the collection.</div><div class="long">Returns the number of items in the collection.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">the number of items in the collection.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#getCount" ext:member="#getCount" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-getKey"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-getKey">getKey</a></b>( <code>Object item</code> ) 164 : 165 Object<div class="mdesc"><div class="short">MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation 166simply returns i...</div><div class="long">MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation 167simply returns <b><code>item.id</code></b> but you can provide your own implementation 168to return a different value as in the following examples:<pre><code><i>// normal way</i> 169<b>var</b> mc = <b>new</b> Ext.util.MixedCollection(); 170mc.add(someEl.dom.id, someEl); 171mc.add(otherEl.dom.id, otherEl); 172<i>//and so on</i> 173 174<i>// using getKey</i> 175<b>var</b> mc = <b>new</b> Ext.util.MixedCollection(); 176mc.getKey = <b>function</b>(el){ 177 <b>return</b> el.dom.id; 178}; 179mc.add(someEl); 180mc.add(otherEl); 181 182<i>// or via the constructor</i> 183<b>var</b> mc = <b>new</b> Ext.util.MixedCollection(false, <b>function</b>(el){ 184 <b>return</b> el.dom.id; 185}); 186mc.add(someEl); 187mc.add(otherEl);</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>item</code> : Object<div class="sub-desc">The item for which to find the key.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The key for the passed item.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#getKey" ext:member="#getKey" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-getRange"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-getRange">getRange</a></b>( <span title="Optional" class="optional">[<code>Number startIndex</code>]</span>, <span title="Optional" class="optional">[<code>Number endIndex</code>]</span> ) 188 : 189 Array<div class="mdesc"><div class="short">Returns a range of items in this collection</div><div class="long">Returns a range of items in this collection<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The starting index. Defaults to 0.</div></li><li><code>endIndex</code> : Number<div class="sub-desc">(optional) The ending index. Defaults to the last item.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">An array of items</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#getRange" ext:member="#getRange" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> ) 190 : 191 Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-indexOf"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-indexOf">indexOf</a></b>( <code>Object o</code> ) 192 : 193 Number<div class="mdesc"><div class="short">Returns index within the collection of the passed Object.</div><div class="long">Returns index within the collection of the passed Object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The item to find the index of.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">index of the item. Returns -1 if not found.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#indexOf" ext:member="#indexOf" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-indexOfKey"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-indexOfKey">indexOfKey</a></b>( <code>String key</code> ) 194 : 195 Number<div class="mdesc"><div class="short">Returns index within the collection of the passed key.</div><div class="long">Returns index within the collection of the passed key.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : String<div class="sub-desc">The key to find the index of.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">index of the key.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#indexOfKey" ext:member="#indexOfKey" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-insert"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-insert">insert</a></b>( <code>Number index</code>, <code>String key</code>, <span title="Optional" class="optional">[<code>Object o</code>]</span> ) 196 : 197 Object<div class="mdesc"><div class="short">Inserts an item at the specified index in the collection. Fires the add event when complete.</div><div class="long">Inserts an item at the specified index in the collection. Fires the <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-add" ext:member="add" ext:cls="Ext.util.MixedCollection">add</a> event when complete.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The item inserted.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#insert" ext:member="#insert" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-item"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-item">item</a></b>( <code>String/Number key</code> ) 198 : 199 Object<div class="mdesc"><div class="short">Returns the item associated with the passed key OR index. 200Key has priority over index. This is the equivalent 201of cal...</div><div class="long">Returns the item associated with the passed key OR index. 202Key has priority over index. This is the equivalent 203of calling <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-key" ext:member="key" ext:cls="Ext.util.MixedCollection">key</a> first, then if nothing matched calling <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-itemAt" ext:member="itemAt" ext:cls="Ext.util.MixedCollection">itemAt</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : String/Number<div class="sub-desc">The key or index of the item.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">If the item is found, returns the item. If the item was not found, returns <tt>undefined</tt>. 204If an item was found, but is a Class, returns <tt>null</tt>.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#item" ext:member="#item" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-itemAt"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-itemAt">itemAt</a></b>( <code>Number index</code> ) 205 : 206 Object<div class="mdesc"><div class="short">Returns the item at the specified index.</div><div class="long">Returns the item at the specified index.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc">The index of the item.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The item at the specified index.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#itemAt" ext:member="#itemAt" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-key"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-key">key</a></b>( <code>String/Number key</code> ) 207 : 208 Object<div class="mdesc"><div class="short">Returns the item associated with the passed key.</div><div class="long">Returns the item associated with the passed key.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : String/Number<div class="sub-desc">The key of the item.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The item associated with the passed key.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#key" ext:member="#key" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-keySort"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-keySort">keySort</a></b>( <span title="Optional" class="optional">[<code>String direction</code>]</span>, <span title="Optional" class="optional">[<code>Function fn</code>]</span> ) 209 : 210 void<div class="mdesc"><div class="short">Sorts this collection by keys.</div><div class="long">Sorts this collection by <b>key</b>s.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>direction</code> : String<div class="sub-desc">(optional) 'ASC' or 'DESC'. Defaults to 'ASC'.</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) Comparison function that defines the sort order. 211Defaults to sorting by case insensitive string.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#keySort" ext:member="#keySort" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.MixedCollection-last"></a><b><a href="source/MixedCollection.html#method-Ext.util.MixedCollection-last">last</a></b>() 212 : 213 Object<div class="mdesc"><div class="short">Returns the last item in the collection.</div><div class="long">Returns the last item in the collection.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">the last item in the collection..</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.MixedCollection.html#last" ext:member="#last" ext:cls="Ext.util.MixedCollection">MixedCollection</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.StoreMgr-lookup"></a><b><a href="source/StoreMgr.html#method-Ext.StoreMgr-lookup">lookup</a></b>( <code>String/Object id</code> ) 214 : 215 Ext.data.Store<div class="mdesc"><div class="short">Gets a registered Store by id</div><div class="long">Gets a registered Store by id<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String/Object<div class="sub-desc">The id of the Store, or a Store instance</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.data.Store</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">StoreMgr</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> ) 216 : 217 void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><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 (<code><b>this</b></code> reference) in which the handler function is executed. 218<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class…
Large files files are truncated, but you can click here to view the full file