Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / source / JsonProvider.html
index 88a0450..730e184 100644 (file)
-<html>\r
-<head>\r
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.direct.JsonProvider"></div>/**\r
- * @class Ext.direct.JsonProvider\r
- * @extends Ext.direct.Provider\r
- */\r
-Ext.direct.JsonProvider = Ext.extend(Ext.direct.Provider, {\r
-    parseResponse: function(xhr){\r
-        if(!Ext.isEmpty(xhr.responseText)){\r
-            if(typeof xhr.responseText == 'object'){\r
-                return xhr.responseText;\r
-            }\r
-            return Ext.decode(xhr.responseText);\r
-        }\r
-        return null;\r
-    },\r
-\r
-    getEvents: function(xhr){\r
-        var data = null;\r
-        try{\r
-            data = this.parseResponse(xhr);\r
-        }catch(e){\r
-            var event = new Ext.Direct.ExceptionEvent({\r
-                data: e,\r
-                xhr: xhr,\r
-                code: Ext.Direct.exceptions.PARSE,\r
-                message: 'Error parsing json response: \n\n ' + data\r
-            })\r
-            return [event];\r
-        }\r
-        var events = [];\r
-        if(Ext.isArray(data)){\r
-            for(var i = 0, len = data.length; i < len; i++){\r
-                events.push(Ext.Direct.createEvent(data[i]));\r
-            }\r
-        }else{\r
-            events.push(Ext.Direct.createEvent(data));\r
-        }\r
-        return events;\r
-    }\r
-});</pre>    \r
-</body>\r
-</html>
\ No newline at end of file
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-direct-JsonProvider'>/**
+</span> * @class Ext.direct.JsonProvider
+ * @extends Ext.direct.Provider
+
+A base provider for communicating using JSON. This is an abstract class
+and should not be instanced directly.
+
+ * @markdown
+ * @abstract
+ */
+
+Ext.define('Ext.direct.JsonProvider', {
+    
+    /* Begin Definitions */
+    
+    extend: 'Ext.direct.Provider',
+    
+    alias: 'direct.jsonprovider',
+    
+    uses: ['Ext.direct.ExceptionEvent'],
+    
+    /* End Definitions */
+   
+<span id='Ext-direct-JsonProvider-method-parseResponse'>   /**
+</span>    * Parse the JSON response
+    * @private
+    * @param {Object} response The XHR response object
+    * @return {Object} The data in the response.
+    */
+   parseResponse: function(response){
+        if (!Ext.isEmpty(response.responseText)) {
+            if (Ext.isObject(response.responseText)) {
+                return response.responseText;
+            }
+            return Ext.decode(response.responseText);
+        }
+        return null;
+    },
+
+<span id='Ext-direct-JsonProvider-method-createEvents'>    /**
+</span>     * Creates a set of events based on the XHR response
+     * @private
+     * @param {Object} response The XHR response
+     * @return {Array} An array of Ext.direct.Event
+     */
+    createEvents: function(response){
+        var data = null,
+            events = [],
+            event,
+            i = 0,
+            len;
+            
+        try{
+            data = this.parseResponse(response);
+        } catch(e) {
+            event = Ext.create('Ext.direct.ExceptionEvent', {
+                data: e,
+                xhr: response,
+                code: Ext.direct.Manager.self.exceptions.PARSE,
+                message: 'Error parsing json response: \n\n ' + data
+            });
+            return [event];
+        }
+        
+        if (Ext.isArray(data)) {
+            for (len = data.length; i &lt; len; ++i) {
+                events.push(this.createEvent(data[i]));
+            }
+        } else {
+            events.push(this.createEvent(data));
+        }
+        return events;
+    },
+    
+<span id='Ext-direct-JsonProvider-method-createEvent'>    /**
+</span>     * Create an event from a response object
+     * @param {Object} response The XHR response object
+     * @return {Ext.direct.Event} The event
+     */
+    createEvent: function(response){
+        return Ext.create('direct.' + response.type, response);
+    }
+});</pre>
+</body>
+</html>