Upgrade to ExtJS 3.2.2 - Released 06/02/2010
[extjs.git] / docs / source / Store.html
index 1d9e7a9..67c8632 100644 (file)
@@ -7,7 +7,7 @@
 </head>
 <body  onload="prettyPrint();">
     <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.2.0
+ * Ext JS Library 3.2.2
  * Copyright(c) 2006-2010 Ext JS, Inc.
  * licensing@extjs.com
  * http://www.extjs.com/license
@@ -266,16 +266,14 @@ sortInfo: {
         dir : 'dir'
     },
 
-    <div id="prop-Ext.data.Store-isDestroyed"></div>/**
-     * @property isDestroyed
-     * @type Boolean
+    <div id="prop-Ext.data.Store-{Boolean}"></div>/**
+     * @property {Boolean} isDestroyed
      * True if the store has been destroyed already. Read only
      */
     isDestroyed: false,
 
-    <div id="prop-Ext.data.Store-hasMultiSort"></div>/**
-     * @property hasMultiSort
-     * @type Boolean
+    <div id="prop-Ext.data.Store-{Boolean}"></div>/**
+     * @property {Boolean} hasMultiSort
      * True if this store is currently sorted by more than one field/direction combination.
      */
     hasMultiSort: false,
@@ -461,7 +459,7 @@ sortInfo: {
              * @event clear
              * Fires when the data cache has been cleared.
              * @param {Store} this
-             * @param {Record[]} The records that were cleared.
+             * @param {Record[]} records The records that were cleared.
              */
             'clear',
             <div id="event-Ext.data.Store-exception"></div>/**
@@ -667,6 +665,7 @@ sortInfo: {
             Ext.each(record, function(r){
                 this.remove(r);
             }, this);
+            return;
         }
         var index = this.data.indexOf(record);
         if(index > -1){
@@ -1371,7 +1370,8 @@ myStore.reload(lastOptions);
         }
     },
 
-    <div id="method-Ext.data.Store-createSortFunction"></div>/**
+    /**
+     * @private
      * Creates and returns a function which sorts an array by the given field and direction
      * @param {String} field The field to create the sorter for
      * @param {String} direction The direction to sort by (defaults to "ASC")
@@ -1496,9 +1496,9 @@ myStore.reload(lastOptions);
         }
 
         <div id="prop-Ext.data.Store-multiSortInfo"></div>/**
+         * Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields
          * @property multiSortInfo
          * @type Object
-         * Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields
          */
         this.multiSortInfo = {
             sorters  : sorters,
@@ -1577,7 +1577,8 @@ myStore.reload(lastOptions);
         };
     },
 
-    <div id="method-Ext.data.Store-createMultipleFilterFn"></div>/**
+    /**
+     * @private
      * Given an array of filter functions (each with optional scope), constructs and returns a single function that returns
      * the result of all of the filters ANDed together
      * @param {Array} filters The array of filter objects (each object should contain an 'fn' and optional scope)
@@ -1605,6 +1606,7 @@ myStore.reload(lastOptions);
      * Single filter example:
      * store.filter('name', 'Ed', true, true); //finds all records containing the substring 'Ed'
      * Multiple filter example:
+     * <pre><code>
      * store.filter([
      *   {
      *     property     : 'name',
@@ -1621,6 +1623,7 @@ myStore.reload(lastOptions);
      *     scope: this
      *   }
      * ]);
+     * </code></pre>
      * @param {String|Array} field A field on your records, or an array containing multiple filter options
      * @param {String/RegExp} value Either a string that the field should begin with, or a RegExp to test
      * against the field.