Upgrade to ExtJS 4.0.1 - Released 05/18/2011

[extjs.git] / docs / source / RemotingMethod.html
diff --git a/docs/source/RemotingMethod.html b/docs/source/RemotingMethod.html

new file mode 100644 (file)

index 0000000..5698d42
--- /dev/null
+++ b/docs/source/RemotingMethod.html
@@ -0,0 +1,96 @@
+<!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-RemotingMethod'>/**
+</span> * Small utility class used internally to represent a Direct method.
+ * Thi class is used internally.
+ * @class Ext.direct.RemotingMethod
+ * @ignore
+ */
+Ext.define('Ext.direct.RemotingMethod', {
+    
+    constructor: function(config){
+        var me = this,
+            params = Ext.isDefined(config.params) ? config.params : config.len,
+            name;
+            
+        me.name = config.name;
+        me.formHandler = config.formHandler;
+        if (Ext.isNumber(params)) {
+            // given only the number of parameters
+            me.len = params;
+            me.ordered = true;
+        } else {
+            /*
+             * Given an array of either
+             * a) String
+             * b) Objects with a name property. We may want to encode extra info in here later
+             */
+            me.params = [];
+            Ext.each(params, function(param){
+                name = Ext.isObject(param) ? param.name : param;
+                me.params.push(name);
+            });
+        }
+    },
+    
+<span id='Ext-direct-RemotingMethod-method-getCallData'>    /**
+</span>     * Takes the arguments for the Direct function and splits the arguments
+     * from the scope and the callback.
+     * @param {Array} args The arguments passed to the direct call
+     * @return {Object} An object with 3 properties, args, callback &amp; scope.
+     */
+    getCallData: function(args){
+        var me = this,
+            data = null,
+            len  = me.len,
+            params = me.params,
+            callback,
+            scope,
+            name;
+            
+        if (me.ordered) {
+            callback = args[len];
+            scope = args[len + 1];
+            if (len !== 0) {
+                data = args.slice(0, len);
+            }
+        } else {
+            data = Ext.apply({}, args[0]);
+            callback = args[1];
+            scope = args[2];
+            
+            // filter out any non-existent properties
+            for (name in data) {
+                if (data.hasOwnProperty(name)) {
+                    if (!Ext.Array.contains(params, name)) {
+                        delete data[name];
+                    }
+                }
+            }
+        }
+        
+        return {
+            data: data,
+            callback: callback,
+            scope: scope    
+        };
+    }
+});
+</pre>
+</body>
+</html>