Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.data.Errors.html
1 <!DOCTYPE html><html><head><title>Ext.data.Errors | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.data.Errors',
13         docClass: 'Ext.data.Errors',
14         docReq: 'Ext.data.Errors',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Errors.html#Ext-data.Errors';
33     clsInfo = {"methods":["Errors","add","addAll","addEvents","addListener","addManagedListener","capture","clear","clearListeners","clearManagedListeners","clone","collect","contains","containsKey","each","eachKey","enableBubble","filter","filterBy","findBy","findIndex","findIndexBy","fireEvent","first","get","getAt","getByField","getByKey","getCount","getKey","getRange","getSortState","hasListener","indexOf","indexOfKey","initSortable","insert","isValid","last","observe","on","relayEvents","releaseCapture","remove","removeAll","removeAt","removeAtKey","removeListener","removeManagedListener","reorder","replace","resumeEvents","sort","sortBy","sortByKey","sum","suspendEvents","un"],"cfgs":["allowFunctions","listeners"],"properties":["defaultSortDirection","isSortable","sortRoot","sorters"],"events":["add","clear","remove","replace"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Errors.html#Ext-data.Errors" target="_blank">Ext.data.Errors</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.util.AbstractMixedCollection.html" rel="Ext.util.AbstractMixedCollection" class="cls docClass">Ext.util.AbstractMixedCollection</a><div class="subclass"><a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="cls docClass">Ext.util.MixedCollection</a><div class="subclass"><strong>Ext.data.Errors</strong></div></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div><div class="mixin"><a href="Ext.util.Sortable.html" rel="Ext.util.Sortable" class="cls docClass">Ext.util.Sortable</a></div></pre><p>Wraps a collection of validation error responses and provides convenient functions for
38 accessing and errors for specific fields.</p>
39
40
41
42
43 <p>Usually this class does not need to be instantiated directly - instances are instead created
44 automatically when <a href="Ext.data.Model.html#validate" rel="Ext.data.Model#validate" class="docClass">validate</a> on a model instance:</p>
45
46
47
48
49 <pre class="prettyprint"><code>//validate some existing model instance - in this case it returned 2 failures messages
50 var errors = myModel.validate();
51
52 errors.isValid(); //false
53
54 errors.length; //2
55 errors.getByField('name');  // [{field: 'name',  error: 'must be present'}]
56 errors.getByField('title'); // [{field: 'title', error: 'is too short'}]
57 </code></pre>
58
59 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-allowFunctions" class="member f inherited"><a href="Ext.data.Errors.html#config-allowFunctions" rel="config-allowFunctions" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-cfg-allowFunctions" class="viewSource">view source</a></div><a name="allowFunctions"></a><a name="config-allowFunctions"></a><a href="Ext.data.Errors.html#" rel="config-allowFunctions" class="cls expand">allowFunctions</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Specify <tt>true</tt> if the <a href="Ext.data.Errors.html#addAll" rel="Ext.data.Errors#addAll" class="docClass">addAll</a>
60 function should add function references to the collection. Defaults to
61 <tt>false</tt>.</p>
62 </div><div class="long"><p>Specify <tt>true</tt> if the <a href="Ext.data.Errors.html#addAll" rel="Ext.data.Errors#addAll" class="docClass">addAll</a>
63 function should add function references to the collection. Defaults to
64 <tt>false</tt>.</p>
65 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.data.Errors.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.data.Errors.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
66 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
67 object during initialization.  This should be a valid listeners config object as specified in the
68 <a href="Ext.data.Errors.html#addListener" rel="Ext.data.Errors#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
69
70 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
71
72
73 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
74
75
76 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
77 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
78 events directly from a child element of a Component, we need to specify the <code>element</code> option to
79 identify the Component property to add a DOM listener to:</p>
80
81 <pre><code>new Ext.panel.Panel({
82     width: 400,
83     height: 200,
84     dockedItems: [{
85         xtype: 'toolbar'
86     }],
87     listeners: {
88         click: {
89             element: 'el', //bind to the underlying el property on the panel
90             fn: function(){ console.log('click el'); }
91         },
92         dblclick: {
93             element: 'body', //bind to the underlying body property on the panel
94             fn: function(){ console.log('dblclick body'); }
95         }
96     }
97 });
98 </code></pre>
99
100
101 <p></p></p>
102 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-defaultSortDirection" class="member f inherited"><a href="Ext.data.Errors.html#property-defaultSortDirection" rel="property-defaultSortDirection" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-defaultSortDirection" class="viewSource">view source</a></div><a name="defaultSortDirection"></a><a name="property-defaultSortDirection"></a><a href="Ext.data.Errors.html#" rel="property-defaultSortDirection" class="cls expand">defaultSortDirection</a><span> : String</span></div><div class="description"><div class="short"><p>The default sort direction to use if one is not specified (defaults to "ASC")</p>
103 </div><div class="long"><p>The default sort direction to use if one is not specified (defaults to "ASC")</p>
104 </div></div></div><div id="property-isSortable" class="member inherited"><a href="Ext.data.Errors.html#property-isSortable" rel="property-isSortable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-isSortable" class="viewSource">view source</a></div><a name="isSortable"></a><a name="property-isSortable"></a><a href="Ext.data.Errors.html#" rel="property-isSortable" class="cls expand">isSortable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag denoting that this object is sortable. Always true.</p>
105 </div><div class="long"><p>Flag denoting that this object is sortable. Always true.</p>
106 </div></div></div><div id="property-sortRoot" class="member inherited"><a href="Ext.data.Errors.html#property-sortRoot" rel="property-sortRoot" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-sortRoot" class="viewSource">view source</a></div><a name="sortRoot"></a><a name="property-sortRoot"></a><a href="Ext.data.Errors.html#" rel="property-sortRoot" class="cls expand">sortRoot</a><span> : String</span></div><div class="description"><div class="short"><p>The property in each item that contains the data to sort. (defaults to null)</p>
107 </div><div class="long"><p>The property in each item that contains the data to sort. (defaults to null)</p>
108 </div></div></div><div id="property-sorters" class="member inherited"><a href="Ext.data.Errors.html#property-sorters" rel="property-sorters" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-sorters" class="viewSource">view source</a></div><a name="sorters"></a><a name="property-sorters"></a><a href="Ext.data.Errors.html#" rel="property-sorters" class="cls expand">sorters</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>The collection of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Sorters</a> currently applied to this Store</p>
109 </div><div class="long"><p>The collection of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Sorters</a> currently applied to this Store</p>
110 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Errors" class="member f inherited"><a href="Ext.data.Errors.html#method-Errors" rel="method-Errors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.MixedCollection.html" class="definedIn docClass">Ext.util.MixedCollection</a><br/><a href="../source/MixedCollection.html#Ext-util.MixedCollection-method-constructor" class="viewSource">view source</a></div><a name="Errors"></a><a name="method-Errors"></a><a href="Ext.data.Errors.html#" rel="method-Errors" class="cls expand">Errors</a>(
111 <span class="pre">Boolean allowFunctions, Function keyFn</span>)
112  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
113 <h3 class="pa">Parameters</h3><ul><li><span class="pre">allowFunctions</span> : Boolean<div class="sub-desc"><p>Specify <tt>true</tt> if the <a href="Ext.data.Errors.html#addAll" rel="Ext.data.Errors#addAll" class="docClass">addAll</a>
114 function should add function references to the collection. Defaults to
115 <tt>false</tt>.</p>
116 </div></li><li><span class="pre">keyFn</span> : Function<div class="sub-desc"><p>A function that can accept an item of the type(s) stored in this MixedCollection
117 and return the key value for that item.  This is used when available to look up the key on items that
118 were passed without an explicit key parameter to a MixedCollection method.  Passing this parameter is
119 equivalent to providing an implementation for the <a href="Ext.data.Errors.html#getKey" rel="Ext.data.Errors#getKey" class="docClass">getKey</a> method.</p>
120 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
121 </li></ul></div></div></div><div id="method-add" class="member inherited"><a href="Ext.data.Errors.html#method-add" rel="method-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-add" class="viewSource">view source</a></div><a name="add"></a><a name="method-add"></a><a href="Ext.data.Errors.html#" rel="method-add" class="cls expand">add</a>(
122 <span class="pre">String key, Object o</span>)
123  : Object</div><div class="description"><div class="short"><p>Adds an item to the collection. Fires the <a href="Ext.data.Errors.html#add" rel="Ext.data.Errors#add" class="docClass">add</a> event when complete.</p>
124 </div><div class="long"><p>Adds an item to the collection. Fires the <a href="Ext.data.Errors.html#add" rel="Ext.data.Errors#add" class="docClass">add</a> event when complete.</p>
125 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String<div class="sub-desc"><p>The key to associate with the item, or the new item.</p>
126
127
128 <p>If a <a href="Ext.data.Errors.html#getKey" rel="Ext.data.Errors#getKey" class="docClass">getKey</a> implementation was specified for this MixedCollection,
129 or if the key of the stored items is in a property called <tt><b>id</b></tt>,
130 the MixedCollection will be able to <i>derive</i> the key for the new item.
131 In this case just pass the new item in this parameter.</p>
132
133 </div></li><li><span class="pre">o</span> : Object<div class="sub-desc"><p>The item to add.</p>
134 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The item added.</p>
135 </li></ul></div></div></div><div id="method-addAll" class="member inherited"><a href="Ext.data.Errors.html#method-addAll" rel="method-addAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-addAll" class="viewSource">view source</a></div><a name="addAll"></a><a name="method-addAll"></a><a href="Ext.data.Errors.html#" rel="method-addAll" class="cls expand">addAll</a>(
136 <span class="pre">Object/Array objs</span>)
137  : void</div><div class="description"><div class="short"><p>Adds all elements of an Array or an Object to the collection.</p>
138 </div><div class="long"><p>Adds all elements of an Array or an Object to the collection.</p>
139 <h3 class="pa">Parameters</h3><ul><li><span class="pre">objs</span> : Object/Array<div class="sub-desc"><p>An Object containing properties which will be added
140 to the collection, or an Array of values, each of which are added to the collection.
141 Functions references will be added to the collection if <code><a href="Ext.data.Errors.html#allowFunctions" rel="Ext.data.Errors#allowFunctions" class="docClass">allowFunctions</a></code>
142 has been set to <tt>true</tt>.</p>
143 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
144 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.data.Errors.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.data.Errors.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
145 <span class="pre">Object/String o, String </span>)
146  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
147 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
148 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
149 or the first event name string if multiple event names are being passed as separate parameters.</p>
150 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
151 Usage:</p>
152
153 <pre><code>this.addEvents('storeloaded', 'storecleared');
154 </code></pre>
155
156 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
157 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.Errors.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.data.Errors.html#" rel="method-addListener" class="cls expand">addListener</a>(
158 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
159  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
160 </div><div class="long"><p>Appends an event handler to this object.</p>
161 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
162 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
163 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
164 <b>If omitted, defaults to the object which fired the event.</b></p>
165 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
166 properties. This may contain any of the following properties:<ul>
167 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
168 <b>If omitted, defaults to the object which fired the event.</b></div></li>
169 <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>
170 <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>
171 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
172 by the specified number of milliseconds. If the event fires again within that time, the original
173 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
174 <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>
175 if the event was bubbled up from a child Observable.</div></li>
176 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
177 The name of a Component property which references an element to add a listener to.</p>
178
179 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
180 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
181 <pre><code>new Ext.panel.Panel({
182     title: 'The title',
183     listeners: {
184         click: this.handlePanelClick,
185         element: 'body'
186     }
187 });
188 </code></pre></p>
189
190
191 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
192
193
194 <p></div></li>
195 </ul><br></p>
196
197 <p>
198 <b>Combining Options</b><br>
199 Using the options argument, it is possible to combine different types of listeners:<br>
200 <br>
201 A delayed, one-time listener.
202 <pre><code>myPanel.on('hide', this.handleClick, this, {
203 single: true,
204 delay: 100
205 });</code></pre>
206 <p>
207 <b>Attaching multiple handlers in 1 call</b><br>
208 The method also allows for a single argument to be passed which is a config object containing properties
209 which specify multiple events. For example:
210 <pre><code>myGridPanel.on({
211     cellClick: this.onCellClick,
212     mouseover: this.onMouseOver,
213     mouseout: this.onMouseOut,
214     scope: this // Important. Ensure "this" is correct during handler execution
215 });
216 </code></pre>.
217 <p>
218
219 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
220 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.Errors.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.data.Errors.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
221 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
222  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
223 is destroyed.
224
225 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
226 is destroyed.
227
228 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
229 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
230 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
231 is the handler function.</p>
232 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
233 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
234 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
235 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
236 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
237 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.Errors.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.data.Errors.html#" rel="method-capture" class="cls expand">capture</a>(
238 <span class="pre">Observable o, Function fn, [Object scope]</span>)
239  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
240 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
241 to the supplied function with the event name + standard signature of the event
242 <b>before</b> the event is fired. If the supplied function returns false,
243 the event will not fire.</p>
244 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
245 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
246 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
247 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
248 </li></ul></div></div></div><div id="method-clear" class="member inherited"><a href="Ext.data.Errors.html#method-clear" rel="method-clear" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-clear" class="viewSource">view source</a></div><a name="clear"></a><a name="method-clear"></a><a href="Ext.data.Errors.html#" rel="method-clear" class="cls expand">clear</a> : void</div><div class="description"><div class="short"><p>Removes all items from the collection.  Fires the <a href="Ext.data.Errors.html#clear" rel="Ext.data.Errors#clear" class="docClass">clear</a> event when complete.</p>
249 </div><div class="long"><p>Removes all items from the collection.  Fires the <a href="Ext.data.Errors.html#clear" rel="Ext.data.Errors#clear" class="docClass">clear</a> event when complete.</p>
250 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
251 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.Errors.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.data.Errors.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
252 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
253 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
254 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.Errors.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.data.Errors.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
255 </div><div class="long"><p>Removes all managed listeners for this object.</p>
256 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
257 </li></ul></div></div></div><div id="method-clone" class="member inherited"><a href="Ext.data.Errors.html#method-clone" rel="method-clone" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-clone" class="viewSource">view source</a></div><a name="clone"></a><a name="method-clone"></a><a href="Ext.data.Errors.html#" rel="method-clone" class="cls expand">clone</a> : MixedCollection</div><div class="description"><div class="short"><p>Creates a shallow copy of this collection</p>
258 </div><div class="long"><p>Creates a shallow copy of this collection</p>
259 <h3 class="pa">Returns</h3><ul><li><span class="pre">MixedCollection</span>&nbsp; &nbsp;
260 </li></ul></div></div></div><div id="method-collect" class="member inherited"><a href="Ext.data.Errors.html#method-collect" rel="method-collect" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-collect" class="viewSource">view source</a></div><a name="collect"></a><a name="method-collect"></a><a href="Ext.data.Errors.html#" rel="method-collect" class="cls expand">collect</a>(
261 <span class="pre">String property, String root, [Boolean allowBlank]</span>)
262  : Array</div><div class="description"><div class="short"><p>Collects unique values of a particular property in this MixedCollection</p>
263 </div><div class="long"><p>Collects unique values of a particular property in this MixedCollection</p>
264 <h3 class="pa">Parameters</h3><ul><li><span class="pre">property</span> : String<div class="sub-desc"><p>The property to collect on</p>
265 </div></li><li><span class="pre">root</span> : String<div class="sub-desc"><p>Optional 'root' property to extract the first argument from. This is used mainly when
266 summing fields in records, where the fields are all stored inside the 'data' object</p>
267 </div></li><li><span class="pre">allowBlank</span> : Boolean<div class="sub-desc"><p>(optional) Pass true to allow null, undefined or empty string values</p>
268 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The unique values</p>
269 </li></ul></div></div></div><div id="method-contains" class="member inherited"><a href="Ext.data.Errors.html#method-contains" rel="method-contains" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-contains" class="viewSource">view source</a></div><a name="contains"></a><a name="method-contains"></a><a href="Ext.data.Errors.html#" rel="method-contains" class="cls expand">contains</a>(
270 <span class="pre">Object o</span>)
271  : Boolean</div><div class="description"><div class="short"><p>Returns true if the collection contains the passed Object as an item.</p>
272 </div><div class="long"><p>Returns true if the collection contains the passed Object as an item.</p>
273 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object<div class="sub-desc"><p>The Object to look for in the collection.</p>
274 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the collection contains the Object as an item.</p>
275 </li></ul></div></div></div><div id="method-containsKey" class="member inherited"><a href="Ext.data.Errors.html#method-containsKey" rel="method-containsKey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-containsKey" class="viewSource">view source</a></div><a name="containsKey"></a><a name="method-containsKey"></a><a href="Ext.data.Errors.html#" rel="method-containsKey" class="cls expand">containsKey</a>(
276 <span class="pre">String key</span>)
277  : Boolean</div><div class="description"><div class="short"><p>Returns true if the collection contains the passed Object as a key.</p>
278 </div><div class="long"><p>Returns true if the collection contains the passed Object as a key.</p>
279 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String<div class="sub-desc"><p>The key to look for in the collection.</p>
280 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the collection contains the Object as a key.</p>
281 </li></ul></div></div></div><div id="method-each" class="member inherited"><a href="Ext.data.Errors.html#method-each" rel="method-each" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-each" class="viewSource">view source</a></div><a name="each"></a><a name="method-each"></a><a href="Ext.data.Errors.html#" rel="method-each" class="cls expand">each</a>(
282 <span class="pre">Function fn, [Object scope]</span>)
283  : void</div><div class="description"><div class="short">Executes the specified function once for every item in the collection, passing the following arguments:
284
285
286 item : Mixe...</div><div class="long"><p>Executes the specified function once for every item in the collection, passing the following arguments:</p>
287
288 <div class="mdetail-params"><ul>
289 <li><b>item</b> : Mixed<p class="sub-desc">The collection item</p></li>
290 <li><b>index</b> : Number<p class="sub-desc">The item's index</p></li>
291 <li><b>length</b> : Number<p class="sub-desc">The total number of items in the collection</p></li>
292 </ul></div>
293
294
295 <p>The function should return a boolean value. Returning false from the function will stop the iteration.</p>
296 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to execute for each item.</p>
297 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the current item in the iteration.</p>
298 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
299 </li></ul></div></div></div><div id="method-eachKey" class="member inherited"><a href="Ext.data.Errors.html#method-eachKey" rel="method-eachKey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-eachKey" class="viewSource">view source</a></div><a name="eachKey"></a><a name="method-eachKey"></a><a href="Ext.data.Errors.html#" rel="method-eachKey" class="cls expand">eachKey</a>(
300 <span class="pre">Function fn, [Object scope]</span>)
301  : void</div><div class="description"><div class="short">Executes the specified function once for every key in the collection, passing each
302 key, and its associated item as th...</div><div class="long"><p>Executes the specified function once for every key in the collection, passing each
303 key, and its associated item as the first two parameters.</p>
304 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to execute for each item.</p>
305 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</p>
306 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
307 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.Errors.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.data.Errors.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
308 <span class="pre">String/Array events</span>)
309  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
310 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
311 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
312
313
314 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
315 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
316 access the required target more quickly.</p>
317
318
319 <p>Example:</p>
320
321
322 <pre><code>Ext.override(Ext.form.field.Base, {
323 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
324 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
325     this.enableBubble('change');
326 }),
327
328 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
329 getBubbleTarget : function() {
330     if (!this.formPanel) {
331         this.formPanel = this.findParentByType('form');
332     }
333     return this.formPanel;
334 }
335 });
336
337 var myForm = new Ext.formPanel({
338 title: 'User Details',
339 items: [{
340     ...
341 }],
342 listeners: {
343     change: function() {
344         // Title goes red if form has been modified.
345         myForm.header.setStyle('color', 'red');
346     }
347 }
348 });
349 </code></pre>
350
351 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
352 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
353 </li></ul></div></div></div><div id="method-filter" class="member inherited"><a href="Ext.data.Errors.html#method-filter" rel="method-filter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-filter" class="viewSource">view source</a></div><a name="filter"></a><a name="method-filter"></a><a href="Ext.data.Errors.html#" rel="method-filter" class="cls expand">filter</a>(
354 <span class="pre">Array/String property, String/RegExp value, [Boolean anyMatch], [Boolean caseSensitive]</span>)
355  : MixedCollection</div><div class="description"><div class="short">Filters the objects in this collection by a set of Filters, or by a single
356 property/value pair with optional paramete...</div><div class="long"><p>Filters the objects in this collection by a set of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filter</a>s, or by a single
357 property/value pair with optional parameters for substring matching and case sensitivity. See
358 <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filter</a> for an example of using Filter objects (preferred). Alternatively,
359 MixedCollection can be easily filtered by property like this:</p>
360
361
362 <pre><code>//create a simple store with a few people defined
363 var people = new Ext.util.MixedCollection();
364 people.addAll([
365     {id: 1, age: 25, name: 'Ed'},
366     {id: 2, age: 24, name: 'Tommy'},
367     {id: 3, age: 24, name: 'Arne'},
368     {id: 4, age: 26, name: 'Aaron'}
369 ]);
370
371 //a new MixedCollection containing only the items where age == 24
372 var middleAged = people.filter('age', 24);
373 </code></pre>
374
375 <h3 class="pa">Parameters</h3><ul><li><span class="pre">property</span> : Array/String<div class="sub-desc"><p>A property on your objects, or an array of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filter</a> objects</p>
376 </div></li><li><span class="pre">value</span> : String/RegExp<div class="sub-desc"><p>Either string that the property values
377 should start with or a RegExp to test against the property</p>
378 </div></li><li><span class="pre">anyMatch</span> : Boolean<div class="sub-desc"><p>(optional) True to match any part of the string, not just the beginning</p>
379 </div></li><li><span class="pre">caseSensitive</span> : Boolean<div class="sub-desc"><p>(optional) True for case sensitive comparison (defaults to False).</p>
380 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">MixedCollection</span>&nbsp; &nbsp;<p>The new filtered collection</p>
381 </li></ul></div></div></div><div id="method-filterBy" class="member inherited"><a href="Ext.data.Errors.html#method-filterBy" rel="method-filterBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-filterBy" class="viewSource">view source</a></div><a name="filterBy"></a><a name="method-filterBy"></a><a href="Ext.data.Errors.html#" rel="method-filterBy" class="cls expand">filterBy</a>(
382 <span class="pre">Function fn, [Object scope]</span>)
383  : MixedCollection</div><div class="description"><div class="short">Filter by a function. Returns a new collection that has been filtered.
384 The passed function will be called with each o...</div><div class="long"><p>Filter by a function. Returns a <i>new</i> collection that has been filtered.
385 The passed function will be called with each object in the collection.
386 If the function returns true, the value is included otherwise it is filtered.</p>
387 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to be called, it will receive the args o (the object), k (the key)</p>
388 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.</p>
389 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">MixedCollection</span>&nbsp; &nbsp;<p>The new filtered collection</p>
390 </li></ul></div></div></div><div id="method-findBy" class="member inherited"><a href="Ext.data.Errors.html#method-findBy" rel="method-findBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-findBy" class="viewSource">view source</a></div><a name="findBy"></a><a name="method-findBy"></a><a href="Ext.data.Errors.html#" rel="method-findBy" class="cls expand">findBy</a>(
391 <span class="pre">Function fn, [Object scope]</span>)
392  : Object</div><div class="description"><div class="short"><p>Returns the first item in the collection which elicits a true return value from the
393 passed selection function.</p>
394 </div><div class="long"><p>Returns the first item in the collection which elicits a true return value from the
395 passed selection function.</p>
396 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The selection function to execute for each item.</p>
397 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</p>
398 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The first item in the collection which returned true from the selection function.</p>
399 </li></ul></div></div></div><div id="method-findIndex" class="member inherited"><a href="Ext.data.Errors.html#method-findIndex" rel="method-findIndex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-findIndex" class="viewSource">view source</a></div><a name="findIndex"></a><a name="method-findIndex"></a><a href="Ext.data.Errors.html#" rel="method-findIndex" class="cls expand">findIndex</a>(
400 <span class="pre">String property, String/RegExp value, [Number start], [Boolean anyMatch], [Boolean caseSensitive]</span>)
401  : Number</div><div class="description"><div class="short"><p>Finds the index of the first matching object in this collection by a specific property/value.</p>
402 </div><div class="long"><p>Finds the index of the first matching object in this collection by a specific property/value.</p>
403 <h3 class="pa">Parameters</h3><ul><li><span class="pre">property</span> : String<div class="sub-desc"><p>The name of a property on your objects.</p>
404 </div></li><li><span class="pre">value</span> : String/RegExp<div class="sub-desc"><p>A string that the property values
405 should start with or a RegExp to test against the property.</p>
406 </div></li><li><span class="pre">start</span> : Number<div class="sub-desc"><p>(optional) The index to start searching at (defaults to 0).</p>
407 </div></li><li><span class="pre">anyMatch</span> : Boolean<div class="sub-desc"><p>(optional) True to match any part of the string, not just the beginning.</p>
408 </div></li><li><span class="pre">caseSensitive</span> : Boolean<div class="sub-desc"><p>(optional) True for case sensitive comparison.</p>
409 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The matched index or -1</p>
410 </li></ul></div></div></div><div id="method-findIndexBy" class="member inherited"><a href="Ext.data.Errors.html#method-findIndexBy" rel="method-findIndexBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-findIndexBy" class="viewSource">view source</a></div><a name="findIndexBy"></a><a name="method-findIndexBy"></a><a href="Ext.data.Errors.html#" rel="method-findIndexBy" class="cls expand">findIndexBy</a>(
411 <span class="pre">Function fn, [Object scope], [Number start]</span>)
412  : Number</div><div class="description"><div class="short">Find the index of the first matching object in this collection by a function.
413 If the function returns true it is cons...</div><div class="long"><p>Find the index of the first matching object in this collection by a function.
414 If the function returns <i>true</i> it is considered a match.</p>
415 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to be called, it will receive the args o (the object), k (the key).</p>
416 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.</p>
417 </div></li><li><span class="pre">start</span> : Number<div class="sub-desc"><p>(optional) The index to start searching at (defaults to 0).</p>
418 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The matched index or -1</p>
419 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.Errors.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.data.Errors.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
420 <span class="pre">String eventName, Object... args</span>)
421  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
422
423
424 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
425
426
427 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
428 by calling <a href="Ext.data.Errors.html#enableBubble" rel="Ext.data.Errors#enableBubble" class="docClass">enableBubble</a>.</p>
429
430 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
431 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
432 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
433 </li></ul></div></div></div><div id="method-first" class="member inherited"><a href="Ext.data.Errors.html#method-first" rel="method-first" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-first" class="viewSource">view source</a></div><a name="first"></a><a name="method-first"></a><a href="Ext.data.Errors.html#" rel="method-first" class="cls expand">first</a> : Object</div><div class="description"><div class="short"><p>Returns the first item in the collection.</p>
434 </div><div class="long"><p>Returns the first item in the collection.</p>
435 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>the first item in the collection..</p>
436 </li></ul></div></div></div><div id="method-get" class="member inherited"><a href="Ext.data.Errors.html#method-get" rel="method-get" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-get" class="viewSource">view source</a></div><a name="get"></a><a name="method-get"></a><a href="Ext.data.Errors.html#" rel="method-get" class="cls expand">get</a>(
437 <span class="pre">String/Number key</span>)
438  : Object</div><div class="description"><div class="short">Returns the item associated with the passed key OR index.
439 Key has priority over index.  This is the equivalent
440 of cal...</div><div class="long"><p>Returns the item associated with the passed key OR index.
441 Key has priority over index.  This is the equivalent
442 of calling <a href="Ext.data.Errors.html#key" rel="Ext.data.Errors#key" class="docClass">key</a> first, then if nothing matched calling <a href="Ext.data.Errors.html#getAt" rel="Ext.data.Errors#getAt" class="docClass">getAt</a>.</p>
443 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String/Number<div class="sub-desc"><p>The key or index of the item.</p>
444 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>If the item is found, returns the item.  If the item was not found, returns <tt>undefined</tt>.
445 If an item was found, but is a Class, returns <tt>null</tt>.</p>
446 </li></ul></div></div></div><div id="method-getAt" class="member inherited"><a href="Ext.data.Errors.html#method-getAt" rel="method-getAt" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-getAt" class="viewSource">view source</a></div><a name="getAt"></a><a name="method-getAt"></a><a href="Ext.data.Errors.html#" rel="method-getAt" class="cls expand">getAt</a>(
447 <span class="pre">Number index</span>)
448  : Object</div><div class="description"><div class="short"><p>Returns the item at the specified index.</p>
449 </div><div class="long"><p>Returns the item at the specified index.</p>
450 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index of the item.</p>
451 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The item at the specified index.</p>
452 </li></ul></div></div></div><div id="method-getByField" class="member ni"><a href="Ext.data.Errors.html#method-getByField" rel="method-getByField" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Errors.html" class="definedIn docClass">Ext.data.Errors</a><br/><a href="../source/Errors.html#Ext-data.Errors-method-getByField" class="viewSource">view source</a></div><a name="getByField"></a><a name="method-getByField"></a><a href="Ext.data.Errors.html#" rel="method-getByField" class="cls expand">getByField</a>(
453 <span class="pre">String fieldName</span>)
454  : Array</div><div class="description"><div class="short"><p>Returns all of the errors for the given field</p>
455 </div><div class="long"><p>Returns all of the errors for the given field</p>
456 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fieldName</span> : String<div class="sub-desc"><p>The field to get errors for</p>
457 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>All errors for the given field</p>
458 </li></ul></div></div></div><div id="method-getByKey" class="member inherited"><a href="Ext.data.Errors.html#method-getByKey" rel="method-getByKey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-getByKey" class="viewSource">view source</a></div><a name="getByKey"></a><a name="method-getByKey"></a><a href="Ext.data.Errors.html#" rel="method-getByKey" class="cls expand">getByKey</a>(
459 <span class="pre">String/Number key</span>)
460  : Object</div><div class="description"><div class="short"><p>Returns the item associated with the passed key.</p>
461 </div><div class="long"><p>Returns the item associated with the passed key.</p>
462 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String/Number<div class="sub-desc"><p>The key of the item.</p>
463 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The item associated with the passed key.</p>
464 </li></ul></div></div></div><div id="method-getCount" class="member inherited"><a href="Ext.data.Errors.html#method-getCount" rel="method-getCount" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-getCount" class="viewSource">view source</a></div><a name="getCount"></a><a name="method-getCount"></a><a href="Ext.data.Errors.html#" rel="method-getCount" class="cls expand">getCount</a> : Number</div><div class="description"><div class="short"><p>Returns the number of items in the collection.</p>
465 </div><div class="long"><p>Returns the number of items in the collection.</p>
466 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>the number of items in the collection.</p>
467 </li></ul></div></div></div><div id="method-getKey" class="member inherited"><a href="Ext.data.Errors.html#method-getKey" rel="method-getKey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-getKey" class="viewSource">view source</a></div><a name="getKey"></a><a name="method-getKey"></a><a href="Ext.data.Errors.html#" rel="method-getKey" class="cls expand">getKey</a>(
468 <span class="pre">Object item</span>)
469  : Object</div><div class="description"><div class="short">MixedCollection has a generic way to fetch keys if you implement getKey.  The default implementation
470 simply returns i...</div><div class="long"><p>MixedCollection has a generic way to fetch keys if you implement getKey.  The default implementation
471 simply returns <b><code>item.id</code></b> but you can provide your own implementation
472 to return a different value as in the following examples:</p>
473
474 <pre><code>// normal way
475 var mc = new Ext.util.MixedCollection();
476 mc.add(someEl.dom.id, someEl);
477 mc.add(otherEl.dom.id, otherEl);
478 //and so on
479
480 // using getKey
481 var mc = new Ext.util.MixedCollection();
482 mc.getKey = function(el){
483    return el.dom.id;
484 };
485 mc.add(someEl);
486 mc.add(otherEl);
487
488 // or via the constructor
489 var mc = new Ext.util.MixedCollection(false, function(el){
490    return el.dom.id;
491 });
492 mc.add(someEl);
493 mc.add(otherEl);
494 </code></pre>
495
496 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Object<div class="sub-desc"><p>The item for which to find the key.</p>
497 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The key for the passed item.</p>
498 </li></ul></div></div></div><div id="method-getRange" class="member inherited"><a href="Ext.data.Errors.html#method-getRange" rel="method-getRange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-getRange" class="viewSource">view source</a></div><a name="getRange"></a><a name="method-getRange"></a><a href="Ext.data.Errors.html#" rel="method-getRange" class="cls expand">getRange</a>(
499 <span class="pre">[Number startIndex], [Number endIndex]</span>)
500  : Array</div><div class="description"><div class="short"><p>Returns a range of items in this collection</p>
501 </div><div class="long"><p>Returns a range of items in this collection</p>
502 <h3 class="pa">Parameters</h3><ul><li><span class="pre">startIndex</span> : Number<div class="sub-desc"><p>(optional) The starting index. Defaults to 0.</p>
503 </div></li><li><span class="pre">endIndex</span> : Number<div class="sub-desc"><p>(optional) The ending index. Defaults to the last item.</p>
504 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>An array of items</p>
505 </li></ul></div></div></div><div id="method-getSortState" class="member inherited"><a href="Ext.data.Errors.html#method-getSortState" rel="method-getSortState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-getSortState" class="viewSource">view source</a></div><a name="getSortState"></a><a name="method-getSortState"></a><a href="Ext.data.Errors.html#" rel="method-getSortState" class="cls expand">getSortState</a> : Object</div><div class="description"><div class="short"><p>Returns an object describing the current sort state of this Store.</p>
506 </div><div class="long"><p>Returns an object describing the current sort state of this Store.</p>
507 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The sort state of the Store. An object with two properties:<ul>
508 <li><b>field</b> : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
509 <li><b>direction</b> : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
510 </ul>
511 See <tt><a href="Ext.data.Errors.html#sortInfo" rel="Ext.data.Errors#sortInfo" class="docClass">sortInfo</a></tt> for additional details.</p>
512 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.Errors.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.data.Errors.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
513 <span class="pre">String eventName</span>)
514  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
515 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
516 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
517 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
518 </li></ul></div></div></div><div id="method-indexOf" class="member inherited"><a href="Ext.data.Errors.html#method-indexOf" rel="method-indexOf" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-indexOf" class="viewSource">view source</a></div><a name="indexOf"></a><a name="method-indexOf"></a><a href="Ext.data.Errors.html#" rel="method-indexOf" class="cls expand">indexOf</a>(
519 <span class="pre">Object o</span>)
520  : Number</div><div class="description"><div class="short"><p>Returns index within the collection of the passed Object.</p>
521 </div><div class="long"><p>Returns index within the collection of the passed Object.</p>
522 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object<div class="sub-desc"><p>The item to find the index of.</p>
523 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>index of the item. Returns -1 if not found.</p>
524 </li></ul></div></div></div><div id="method-indexOfKey" class="member inherited"><a href="Ext.data.Errors.html#method-indexOfKey" rel="method-indexOfKey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-indexOfKey" class="viewSource">view source</a></div><a name="indexOfKey"></a><a name="method-indexOfKey"></a><a href="Ext.data.Errors.html#" rel="method-indexOfKey" class="cls expand">indexOfKey</a>(
525 <span class="pre">String key</span>)
526  : Number</div><div class="description"><div class="short"><p>Returns index within the collection of the passed key.</p>
527 </div><div class="long"><p>Returns index within the collection of the passed key.</p>
528 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String<div class="sub-desc"><p>The key to find the index of.</p>
529 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>index of the key.</p>
530 </li></ul></div></div></div><div id="method-initSortable" class="member inherited"><a href="Ext.data.Errors.html#method-initSortable" rel="method-initSortable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-initSortable" class="viewSource">view source</a></div><a name="initSortable"></a><a name="method-initSortable"></a><a href="Ext.data.Errors.html#" rel="method-initSortable" class="cls expand">initSortable</a> : void</div><div class="description"><div class="short">Performs initialization of this mixin. Component classes using this mixin should call this method
531 during their own in...</div><div class="long"><p>Performs initialization of this mixin. Component classes using this mixin should call this method
532 during their own initialization.</p>
533 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
534 </li></ul></div></div></div><div id="method-insert" class="member inherited"><a href="Ext.data.Errors.html#method-insert" rel="method-insert" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-insert" class="viewSource">view source</a></div><a name="insert"></a><a name="method-insert"></a><a href="Ext.data.Errors.html#" rel="method-insert" class="cls expand">insert</a>(
535 <span class="pre">Number index, String key, [Object o]</span>)
536  : Object</div><div class="description"><div class="short"><p>Inserts an item at the specified index in the collection. Fires the <a href="Ext.data.Errors.html#add" rel="Ext.data.Errors#add" class="docClass">add</a> event when complete.</p>
537 </div><div class="long"><p>Inserts an item at the specified index in the collection. Fires the <a href="Ext.data.Errors.html#add" rel="Ext.data.Errors#add" class="docClass">add</a> event when complete.</p>
538 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index to insert the item at.</p>
539 </div></li><li><span class="pre">key</span> : String<div class="sub-desc"><p>The key to associate with the new item, or the item itself.</p>
540 </div></li><li><span class="pre">o</span> : Object<div class="sub-desc"><p>(optional) If the second parameter was a key, the new item.</p>
541 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The item inserted.</p>
542 </li></ul></div></div></div><div id="method-isValid" class="member ni"><a href="Ext.data.Errors.html#method-isValid" rel="method-isValid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Errors.html" class="definedIn docClass">Ext.data.Errors</a><br/><a href="../source/Errors.html#Ext-data.Errors-method-isValid" class="viewSource">view source</a></div><a name="isValid"></a><a name="method-isValid"></a><a href="Ext.data.Errors.html#" rel="method-isValid" class="cls expand">isValid</a> : Boolean</div><div class="description"><div class="short"><p>Returns true if there are no errors in the collection</p>
543 </div><div class="long"><p>Returns true if there are no errors in the collection</p>
544 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
545 </li></ul></div></div></div><div id="method-last" class="member inherited"><a href="Ext.data.Errors.html#method-last" rel="method-last" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-last" class="viewSource">view source</a></div><a name="last"></a><a name="method-last"></a><a href="Ext.data.Errors.html#" rel="method-last" class="cls expand">last</a> : Object</div><div class="description"><div class="short"><p>Returns the last item in the collection.</p>
546 </div><div class="long"><p>Returns the last item in the collection.</p>
547 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>the last item in the collection..</p>
548 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.Errors.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.data.Errors.html#" rel="method-observe" class="cls expand">observe</a>(
549 <span class="pre">Function c, Object listeners</span>)
550  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
551
552 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
553
554 <p>This makes any event fired on any instance of the passed class also fire a single event through
555 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
556
557 <p>Usage:</p>
558
559 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
560 Ext.data.Connection.on('beforerequest', function(con, options) {
561     console.log('Ajax request made to ' + options.url);
562 });
563 </code></pre>
564 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
565 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.data.Errors.html#addListener" rel="Ext.data.Errors#addListener" class="docClass">addListener</a>.</p>
566 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
567 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.Errors.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.data.Errors.html#" rel="method-on" class="cls expand">on</a>(
568 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
569  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Errors.html#addListener" rel="Ext.data.Errors#addListener" class="docClass">addListener</a>.)</p>
570 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Errors.html#addListener" rel="Ext.data.Errors#addListener" class="docClass">addListener</a>.)</p>
571 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
572 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
573 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
574 <b>If omitted, defaults to the object which fired the event.</b></p>
575 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
576 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
577 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.Errors.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.data.Errors.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
578 <span class="pre">Object origin, Array events, Object prefix</span>)
579  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
580 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
581 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
582 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
583 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
584 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
585 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.Errors.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.data.Errors.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
586 <span class="pre">Observable o</span>)
587  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
588 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
589 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
590 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
591 </li></ul></div></div></div><div id="method-remove" class="member inherited"><a href="Ext.data.Errors.html#method-remove" rel="method-remove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="method-remove"></a><a href="Ext.data.Errors.html#" rel="method-remove" class="cls expand">remove</a>(
592 <span class="pre">Object o</span>)
593  : Object</div><div class="description"><div class="short"><p>Remove an item from the collection.</p>
594 </div><div class="long"><p>Remove an item from the collection.</p>
595 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object<div class="sub-desc"><p>The item to remove.</p>
596 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The item removed or false if no item was removed.</p>
597 </li></ul></div></div></div><div id="method-removeAll" class="member inherited"><a href="Ext.data.Errors.html#method-removeAll" rel="method-removeAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-removeAll" class="viewSource">view source</a></div><a name="removeAll"></a><a name="method-removeAll"></a><a href="Ext.data.Errors.html#" rel="method-removeAll" class="cls expand">removeAll</a>(
598 <span class="pre">Array items</span>)
599  : Ext.util.MixedCollection</div><div class="description"><div class="short"><p>Remove all items in the passed array from the collection.</p>
600 </div><div class="long"><p>Remove all items in the passed array from the collection.</p>
601 <h3 class="pa">Parameters</h3><ul><li><span class="pre">items</span> : Array<div class="sub-desc"><p>An array of items to be removed.</p>
602 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.MixedCollection</span>&nbsp; &nbsp;<p>this object</p>
603 </li></ul></div></div></div><div id="method-removeAt" class="member inherited"><a href="Ext.data.Errors.html#method-removeAt" rel="method-removeAt" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-removeAt" class="viewSource">view source</a></div><a name="removeAt"></a><a name="method-removeAt"></a><a href="Ext.data.Errors.html#" rel="method-removeAt" class="cls expand">removeAt</a>(
604 <span class="pre">Number index</span>)
605  : Object</div><div class="description"><div class="short"><p>Remove an item from a specified index in the collection. Fires the <a href="Ext.data.Errors.html#remove" rel="Ext.data.Errors#remove" class="docClass">remove</a> event when complete.</p>
606 </div><div class="long"><p>Remove an item from a specified index in the collection. Fires the <a href="Ext.data.Errors.html#remove" rel="Ext.data.Errors#remove" class="docClass">remove</a> event when complete.</p>
607 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index within the collection of the item to remove.</p>
608 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The item removed or false if no item was removed.</p>
609 </li></ul></div></div></div><div id="method-removeAtKey" class="member inherited"><a href="Ext.data.Errors.html#method-removeAtKey" rel="method-removeAtKey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-removeAtKey" class="viewSource">view source</a></div><a name="removeAtKey"></a><a name="method-removeAtKey"></a><a href="Ext.data.Errors.html#" rel="method-removeAtKey" class="cls expand">removeAtKey</a>(
610 <span class="pre">String key</span>)
611  : Object</div><div class="description"><div class="short"><p>Removed an item associated with the passed key fom the collection.</p>
612 </div><div class="long"><p>Removed an item associated with the passed key fom the collection.</p>
613 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String<div class="sub-desc"><p>The key of the item to remove.</p>
614 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The item removed or false if no item was removed.</p>
615 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.Errors.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.data.Errors.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
616 <span class="pre">String eventName, Function handler, [Object scope]</span>)
617  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
618 </div><div class="long"><p>Removes an event handler.</p>
619 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
620 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Errors.html#addListener" rel="Ext.data.Errors#addListener" class="docClass">addListener</a> call.</b></p>
621 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
622 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
623 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.Errors.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.data.Errors.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
624 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
625  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.Errors.html#mon" rel="Ext.data.Errors#mon" class="docClass">mon</a> method.</p>
626 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.Errors.html#mon" rel="Ext.data.Errors#mon" class="docClass">mon</a> method.</p>
627 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
628 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
629 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
630 is the handler function.</p>
631 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
632 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
633 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
634 </li></ul></div></div></div><div id="method-reorder" class="member inherited"><a href="Ext.data.Errors.html#method-reorder" rel="method-reorder" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.MixedCollection.html" class="definedIn docClass">Ext.util.MixedCollection</a><br/><a href="../source/MixedCollection.html#Ext-util.MixedCollection-method-reorder" class="viewSource">view source</a></div><a name="reorder"></a><a name="method-reorder"></a><a href="Ext.data.Errors.html#" rel="method-reorder" class="cls expand">reorder</a>(
635 <span class="pre">Object mapping</span>)
636  : void</div><div class="description"><div class="short">Reorders each of the items based on a mapping from old index to new index. Internally this
637 just translates into a sor...</div><div class="long"><p>Reorders each of the items based on a mapping from old index to new index. Internally this
638 just translates into a sort. The 'sort' event is fired whenever reordering has occured.</p>
639 <h3 class="pa">Parameters</h3><ul><li><span class="pre">mapping</span> : Object<div class="sub-desc"><p>Mapping from old item index to new item index</p>
640 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
641 </li></ul></div></div></div><div id="method-replace" class="member inherited"><a href="Ext.data.Errors.html#method-replace" rel="method-replace" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-replace" class="viewSource">view source</a></div><a name="replace"></a><a name="method-replace"></a><a href="Ext.data.Errors.html#" rel="method-replace" class="cls expand">replace</a>(
642 <span class="pre">String key, [Object o]</span>)
643  : Object</div><div class="description"><div class="short"><p>Replaces an item in the collection. Fires the <a href="Ext.data.Errors.html#replace" rel="Ext.data.Errors#replace" class="docClass">replace</a> event when complete.</p>
644 </div><div class="long"><p>Replaces an item in the collection. Fires the <a href="Ext.data.Errors.html#replace" rel="Ext.data.Errors#replace" class="docClass">replace</a> event when complete.</p>
645 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String<div class="sub-desc"><p>The key associated with the item to replace, or the replacement item.</p>
646
647
648 <p>If you supplied a <a href="Ext.data.Errors.html#getKey" rel="Ext.data.Errors#getKey" class="docClass">getKey</a> implementation for this MixedCollection, or if the key
649 of your stored items is in a property called <tt><b>id</b></tt>, then the MixedCollection
650 will be able to <i>derive</i> the key of the replacement item. If you want to replace an item
651 with one having the same key value, then just pass the replacement item in this parameter.</p>
652
653 </div></li><li><span class="pre">o</span> : Object<div class="sub-desc"><p>{Object} o (optional) If the first parameter passed was a key, the item to associate
654 with that key.</p>
655 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The new item.</p>
656 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.Errors.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.data.Errors.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
657 If events were suspended using the queueSuspended parameter, then all
658 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.Errors.html#suspendEvents" rel="Ext.data.Errors#suspendEvents" class="docClass">suspendEvents</a>)
659 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
660 events fired during event suspension will be sent to any listeners now.</p>
661 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
662 </li></ul></div></div></div><div id="method-sort" class="member inherited"><a href="Ext.data.Errors.html#method-sort" rel="method-sort" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-sort" class="viewSource">view source</a></div><a name="sort"></a><a name="method-sort"></a><a href="Ext.data.Errors.html#" rel="method-sort" class="cls expand">sort</a>(
663 <span class="pre">String|Array sorters, String direction, Object where, Object doSort</span>)
664  : void</div><div class="description"><div class="short">Sorts the data in the Store by one or more of its properties. Example usage:
665
666
667 //sort by a single field
668 myStore.sort(...</div><div class="long"><p>Sorts the data in the Store by one or more of its properties. Example usage:</p>
669
670
671 <pre><code>//sort by a single field
672 myStore.sort('myField', 'DESC');
673
674 //sorting by multiple fields
675 myStore.sort([
676     {
677         property : 'age',
678         direction: 'ASC'
679     },
680     {
681         property : 'name',
682         direction: 'DESC'
683     }
684 ]);
685 </code></pre>
686
687
688 <p>Internally, Store converts the passed arguments into an array of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Ext.util.Sorter</a> instances, and delegates the actual
689 sorting to its internal <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">Ext.util.MixedCollection</a>.</p>
690
691
692 <p>When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:</p>
693
694
695 <pre><code>store.sort('myField');
696 store.sort('myField');
697      </code></pre>
698
699
700 <p>Is equivalent to this code, because Store handles the toggling automatically:</p>
701
702
703 <pre><code>store.sort('myField', 'ASC');
704 store.sort('myField', 'DESC');
705 </code></pre>
706
707 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sorters</span> : String|Array<div class="sub-desc"><p>Either a string name of one of the fields in this Store's configured <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a>,
708 or an Array of sorter configurations.</p>
709 </div></li><li><span class="pre">direction</span> : String<div class="sub-desc"><p>The overall direction to sort the data by. Defaults to "ASC".</p>
710 </div></li><li><span class="pre">where</span> : Object<div class="sub-desc">
711 </div></li><li><span class="pre">doSort</span> : Object<div class="sub-desc">
712 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
713 </li></ul></div></div></div><div id="method-sortBy" class="member inherited"><a href="Ext.data.Errors.html#method-sortBy" rel="method-sortBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.MixedCollection.html" class="definedIn docClass">Ext.util.MixedCollection</a><br/><a href="../source/MixedCollection.html#Ext-util.MixedCollection-method-sortBy" class="viewSource">view source</a></div><a name="sortBy"></a><a name="method-sortBy"></a><a href="Ext.data.Errors.html#" rel="method-sortBy" class="cls expand">sortBy</a>(
714 <span class="pre">Function sorterFn</span>)
715  : void</div><div class="description"><div class="short"><p>Sorts the collection by a single sorter function</p>
716 </div><div class="long"><p>Sorts the collection by a single sorter function</p>
717 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sorterFn</span> : Function<div class="sub-desc"><p>The function to sort by</p>
718 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
719 </li></ul></div></div></div><div id="method-sortByKey" class="member inherited"><a href="Ext.data.Errors.html#method-sortByKey" rel="method-sortByKey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.MixedCollection.html" class="definedIn docClass">Ext.util.MixedCollection</a><br/><a href="../source/MixedCollection.html#Ext-util.MixedCollection-method-sortByKey" class="viewSource">view source</a></div><a name="sortByKey"></a><a name="method-sortByKey"></a><a href="Ext.data.Errors.html#" rel="method-sortByKey" class="cls expand">sortByKey</a>(
720 <span class="pre">[String direction], [Function fn]</span>)
721  : void</div><div class="description"><div class="short"><p>Sorts this collection by <b>key</b>s.</p>
722 </div><div class="long"><p>Sorts this collection by <b>key</b>s.</p>
723 <h3 class="pa">Parameters</h3><ul><li><span class="pre">direction</span> : String<div class="sub-desc"><p>(optional) 'ASC' or 'DESC'. Defaults to 'ASC'.</p>
724 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>(optional) Comparison function that defines the sort order.
725 Defaults to sorting by case insensitive string.</p>
726 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
727 </li></ul></div></div></div><div id="method-sum" class="member inherited"><a href="Ext.data.Errors.html#method-sum" rel="method-sum" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-method-sum" class="viewSource">view source</a></div><a name="sum"></a><a name="method-sum"></a><a href="Ext.data.Errors.html#" rel="method-sum" class="cls expand">sum</a>(
728 <span class="pre">String property, String root, [Number start], [Number end]</span>)
729  : Number</div><div class="description"><div class="short"><p>Collects all of the values of the given property and returns their sum</p>
730 </div><div class="long"><p>Collects all of the values of the given property and returns their sum</p>
731 <h3 class="pa">Parameters</h3><ul><li><span class="pre">property</span> : String<div class="sub-desc"><p>The property to sum by</p>
732 </div></li><li><span class="pre">root</span> : String<div class="sub-desc"><p>Optional 'root' property to extract the first argument from. This is used mainly when
733 summing fields in records, where the fields are all stored inside the 'data' object</p>
734 </div></li><li><span class="pre">start</span> : Number<div class="sub-desc"><p>(optional) The record index to start at (defaults to <tt>0</tt>)</p>
735 </div></li><li><span class="pre">end</span> : Number<div class="sub-desc"><p>(optional) The record index to end at (defaults to <tt>-1</tt>)</p>
736 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The total</p>
737 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.Errors.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.data.Errors.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
738 <span class="pre">Boolean queueSuspended</span>)
739  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.Errors.html#resumeEvents" rel="Ext.data.Errors#resumeEvents" class="docClass">resumeEvents</a>)</p>
740 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.Errors.html#resumeEvents" rel="Ext.data.Errors#resumeEvents" class="docClass">resumeEvents</a>)</p>
741 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
742 after the <a href="Ext.data.Errors.html#resumeEvents" rel="Ext.data.Errors#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
743 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
744 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.Errors.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.data.Errors.html#" rel="method-un" class="cls expand">un</a>(
745 <span class="pre">String eventName, Function handler, [Object scope]</span>)
746  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.Errors.html#removeListener" rel="Ext.data.Errors#removeListener" class="docClass">removeListener</a>.)</p>
747 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.Errors.html#removeListener" rel="Ext.data.Errors#removeListener" class="docClass">removeListener</a>.)</p>
748 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
749 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Errors.html#addListener" rel="Ext.data.Errors#addListener" class="docClass">addListener</a> call.</b></p>
750 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
751 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
752 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-add" class="member f inherited"><a href="Ext.data.Errors.html#event-add" rel="event-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-event-add" class="viewSource">view source</a></div><a name="add"></a><a name="event-add"></a><a href="Ext.data.Errors.html#" rel="event-add" class="cls expand">add</a>(
753 <span class="pre">Number index, Object o, String key</span>)
754 </div><div class="description"><div class="short"><p>Fires when an item is added to the collection.</p>
755 </div><div class="long"><p>Fires when an item is added to the collection.</p>
756 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index at which the item was added.</p>
757 </div></li><li><span class="pre">o</span> : Object<div class="sub-desc"><p>The item added.</p>
758 </div></li><li><span class="pre">key</span> : String<div class="sub-desc"><p>The key associated with the added item.</p>
759 </div></li></ul></div></div></div><div id="event-clear" class="member inherited"><a href="Ext.data.Errors.html#event-clear" rel="event-clear" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-event-clear" class="viewSource">view source</a></div><a name="clear"></a><a name="event-clear"></a><a href="Ext.data.Errors.html#" rel="event-clear" class="cls expand">clear</a></div><div class="description"><div class="short"><p>Fires when the collection is cleared.</p>
760 </div><div class="long"><p>Fires when the collection is cleared.</p>
761 </div></div></div><div id="event-remove" class="member inherited"><a href="Ext.data.Errors.html#event-remove" rel="event-remove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-event-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="event-remove"></a><a href="Ext.data.Errors.html#" rel="event-remove" class="cls expand">remove</a>(
762 <span class="pre">Object o, [String key]</span>)
763 </div><div class="description"><div class="short"><p>Fires when an item is removed from the collection.</p>
764 </div><div class="long"><p>Fires when an item is removed from the collection.</p>
765 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object<div class="sub-desc"><p>The item being removed.</p>
766 </div></li><li><span class="pre">key</span> : String<div class="sub-desc"><p>(optional) The key associated with the removed item.</p>
767 </div></li></ul></div></div></div><div id="event-replace" class="member inherited"><a href="Ext.data.Errors.html#event-replace" rel="event-replace" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.AbstractMixedCollection.html" class="definedIn docClass">Ext.util.AbstractMixedCollection</a><br/><a href="../source/AbstractMixedCollection.html#Ext-util.AbstractMixedCollection-event-replace" class="viewSource">view source</a></div><a name="replace"></a><a name="event-replace"></a><a href="Ext.data.Errors.html#" rel="event-replace" class="cls expand">replace</a>(
768 <span class="pre">String key, Object old, Object new</span>)
769 </div><div class="description"><div class="short"><p>Fires when an item is replaced in the collection.</p>
770 </div><div class="long"><p>Fires when an item is replaced in the collection.</p>
771 <h3 class="pa">Parameters</h3><ul><li><span class="pre">key</span> : String<div class="sub-desc"><p>he key associated with the new added.</p>
772 </div></li><li><span class="pre">old</span> : Object<div class="sub-desc"><p>The item being replaced.</p>
773 </div></li><li><span class="pre">new</span> : Object<div class="sub-desc"><p>The new item.</p>
774 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>