X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/ee06f37b0f6f6d94cd05a6ffae556660f7c4a2bc..c930e9176a5a85509c5b0230e2bff5c22a591432:/docs/output/Ext.data.JsonReader.html diff --git a/docs/output/Ext.data.JsonReader.html b/docs/output/Ext.data.JsonReader.html index 5c49b9a2..2894b555 100644 --- a/docs/output/Ext.data.JsonReader.html +++ b/docs/output/Ext.data.JsonReader.html @@ -1,238 +1,113 @@ -
-
- Properties - Methods - Events - Config Options - Direct Link -
-
-
DataReader
-  JsonReader
-

Class Ext.data.JsonReader

- - - - - - -
Package:Ext.data
Defined In:JsonReader.js
Class:JsonReader
Subclasses:ArrayReader
Extends:DataReader
-
- * -Data reader class to create an Array of Ext.data.Record objects from a JSON response -based on mappings in a provided Ext.data.Record constructor.
-

-Example code: -

var Employee = Ext.data.Record.create([
-    {name: 'firstname'},                  // Map the Record's "firstname" field to the row object's key of the same name
-    {name: 'job', mapping: 'occupation'}  // Map the "job" field to the row object's "occupation" key
+
Properties
Methods
Events
Config Options
Direct Link
DataReader
  JsonReader
Class Ext.data.JsonReader
Package:Ext.data
Defined In:JsonReader.js
Class:JsonReader
Subclasses:ArrayReader
Extends:DataReader
Data reader class to create an Array of Ext.data.Record objects from a JSON response
+based on mappings in a provided Ext.data.Record constructor.

+
Example code:

+
var Employee = Ext.data.Record.create([
+    {name: 'firstname'},                  // map the Record's "firstname" field to the row object's key of the same name
+    {name: 'job', mapping: 'occupation'}  // map the Record's "job" field to the row object's "occupation" key
 ]);
-var myReader = new Ext.data.JsonReader({
-    totalProperty: "results",             // The property which contains the total dataset size (optional)
-    root: "rows",                         // The property which contains an Array of row objects
-    id: "id"                              // The property within each row object that provides an ID for the record (optional)
-}, Employee);

-

-This would consume a JSON object of the form:
-
{
-    results: 2,
-    rows: [
+var myReader = new Ext.data.JsonReader(
+    {                             // The metadata property, with configuration options:
+        totalProperty: "results", //   the property which contains the total dataset size (optional)
+        root: "rows",             //   the property which contains an Array of record data objects
+        idProperty: "id"          //   the property within each row object that provides an ID for the record (optional)
+    },
+    Employee  // Ext.data.Record constructor that provides mapping for JSON object
+);

+
This would consume a JSON data object of the form:
{
+    results: 2,  // Reader's configured totalProperty
+    rows: [      // Reader's configured root
         { id: 1, firstname: 'Bill', occupation: 'Gardener' },         // a row object
         { id: 2, firstname: 'Ben' , occupation: 'Horticulturalist' }  // another row object
     ]
 }

-
It is possible to change a JsonReader's metadata at any time by including a
-metaData property in the data object. If this is detected in the
-object, a Store object using this Reader will reconfigure
-itself to use the newly provided field definition and fire its
-metachange event. In
-undergoing this change, the Store sets its sortInfo property
-from the sortInfo property in the new metadata. Note that reconfiguring a Store
-potentially invalidates objects which may refer to Fields or Records which no longer exist.

-
The metaData property may contain any of the configuration
-options for this class. Additionally, it may contain a fields
-property which the JsonReader will use as an argument to Ext.data.Record.create
-to configure the layout of the Records which it will produce.

-Using the metaData property, and the Store's metachange event,
-it is possible to have a Store-driven control initialize itself. The metachange
-event handler may interrogate the metaData property (which
-may contain any user-defined properties needed) and the metaData.fields
-property to perform any configuration required.

-
To use this facility to send the same data as the above example without
-having to code the creation of the Record constructor, you would create the
-JsonReader like this:
var myReader = new Ext.data.JsonReader();

-
The first data packet from the server would configure the reader by
-containing a metaData property as well as the data:
{
+
Automatic configuration using metaData

+
It is possible to change a JsonReader's metadata at any time by including a metaData
+property in the JSON data object. If the JSON data object has a metaData property, a
+Store object using this Reader will reconfigure itself to use the newly provided
+field definition and fire its metachange event. The metachange event
+handler may interrogate the metaData property to perform any configuration required.
+Note that reconfiguring a Store potentially invalidates objects which may refer to Fields or Records
+which no longer exist.

+
The metaData property in the JSON data object may contain:

+
    
+
  • any of the configuration options for this class
    • 
+
  • a fields property which the JsonReader will
+use as an argument to the data Record create method in order to
+configure the layout of the Records it will produce.
    • 
+
  • a sortInfo property which the JsonReader will
+use to set the Ext.data.Store's sortInfo property
    • 
+
  • any user-defined properties needed
    • 
+

+
To use this facility to send the same data as the example above (without having to code the creation
+of the Record constructor), you would create the JsonReader like this:
var myReader = new Ext.data.JsonReader();

+
The first data packet from the server would configure the reader by containing a
+metaData property and the data. For example, the JSON data object might take
+the form:

+
{
     metaData: {
-        totalProperty: 'results',
+        idProperty: 'id',
         root: 'rows',
-        id: 'id',
+        totalProperty: 'results',
         fields: [
             {name: 'name'},
-            {name: 'occupation'}
-        ]
+            {name: 'job', mapping: 'occupation'}
+        ],
+        sortInfo: {field: 'name', direction:'ASC'}, // used by store to set its sortInfo
+        foo: 'bar' // custom property
     },
     results: 2,
-    rows: [
+    rows: [ // an Array
         { 'id': 1, 'name': 'Bill', occupation: 'Gardener' },
         { 'id': 2, 'name': 'Ben', occupation: 'Horticulturalist' }
     ]
-}
        

-        
-        

-                
-        
Config Options

-        
-            
-                
-                
-            
-                
-        
-        
-        
-    
-        
-        
-        
-        
-    
-        
-        
-        
-        
-    
-        
-        
-        
-        
-    
-            
Config OptionsDefined By
 
-        
-            id : String            

-                            Name of the property within a row object that contains a record identifier value.                        

-        		JsonReader
 
-        
-            root : String            

-                            name of the property which contains the Array of row objects.                        

-        		JsonReader
 
-        
-            successProperty : String            

-                            Name of the property from which to retrieve the success attribute used by forms.                        

-        		JsonReader

-                
-        
Public Properties

-                
-            
-                
-                
-            
-                
-        
-        
-        
-    
-        
-        
-        
-        
-    
-            
PropertyDefined By
 
-        
-            meta : Mixed            

-                            This JsonReader's metadata as passed to the constructor, or as passed in
-the last data packet's metaData property.                        

-        		JsonReader

-                
-        
Public Methods

-                
-            
-                
-                
-            
-                
-        
-        
-        
-    
-        
-        
-        
-        
-    
-        
-        
-        
MethodDefined By
Public Events
This class has no public events.

\ No newline at end of file