-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.direct.RemotingProvider-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.direct.RemotingProvider-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.direct.RemotingProvider-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.direct.RemotingProvider-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.direct.RemotingProvider"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.direct.Provider.html" ext:member="" ext:cls="Ext.direct.Provider">Provider</a> <img src="resources/elbow-end.gif"><a href="output/Ext.direct.JsonProvider.html" ext:member="" ext:cls="Ext.direct.JsonProvider">JsonProvider</a> <img src="resources/elbow-end.gif">RemotingProvider</pre></div><h1>Class <a href="source/RemotingProvider.html#cls-Ext.direct.RemotingProvider">Ext.direct.RemotingProvider</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.direct</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">RemotingProvider.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/RemotingProvider.html#cls-Ext.direct.RemotingProvider">RemotingProvider</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.direct.JsonProvider.html" ext:cls="Ext.direct.JsonProvider" ext:member="">JsonProvider</a></td></tr></table><div class="description"><p>The <a href="output/Ext.direct.RemotingProvider.html" ext:cls="Ext.direct.RemotingProvider">RemotingProvider</a> exposes access to\r
-server side methods on the client (a remote procedure call (RPC) type of\r
-connection where the client can initiate a procedure on the server).</p>\r
-<p>This allows for code to be organized in a fashion that is maintainable,\r
-while providing a clear path between client and server, something that is\r
-not always apparent when using URLs.</p>\r
-<p>To accomplish this the server-side needs to describe what classes and methods\r
-are available on the client-side. This configuration will typically be\r
-outputted by the server-side Ext.Direct stack when the API description is built.</p></div><div class="hr"></div><a id="Ext.direct.RemotingProvider-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.RemotingProvider-actions"></a><b><a href="source/RemotingProvider.html#cfg-Ext.direct.RemotingProvider-actions">actions</a></b> : Object<div class="mdesc"><div class="short">Object literal defining the server side actions and methods. For example, if
-the Provider is configured with:
-"acti...</div><div class="long">Object literal defining the server side actions and methods. For example, if\r
-the Provider is configured with:\r
-<pre><code><em>"actions"</em>:{ <i>// each property within the <em>'actions'</em> object represents a server side Class \r</i>
- <em>"TestAction"</em>:[ <i>// array of methods within each server side Class to be \r</i>
- { <i>// stubbed out on client\r</i>
- <em>"name"</em>:<em>"doEcho"</em>, \r
- <em>"len"</em>:1 \r
- },{\r
- <em>"name"</em>:<em>"multiply"</em>,<i>// name of method\r</i>
- <em>"len"</em>:2 <i>// The number of parameters that will be used to create an\r</i>
- <i>// array of data to send to the server side <b>function</b>.\r</i>
- <i>// Ensure the server sends back a Number, not a String. \r</i>
- },{\r
- <em>"name"</em>:<em>"doForm"</em>,\r
- <em>"formHandler"</em>:true, <i>// direct the client to use specialized form handling method \r</i>
- <em>"len"</em>:1\r
- }]\r
-}</code></pre>\r
-<p>Note that a Store is not required, a server method can be called at any time.\r
-In the following example a <b>client side</b> handler is used to call the\r
-server side method "multiply" in the server-side "TestAction" Class:</p>\r
-<pre><code>TestAction.multiply(\r
- 2, 4, <i>// pass two arguments to server, so specify len=2\r</i>
- <i>// callback <b>function</b> after the server is called\r</i>
- <i>// result: the result returned by the server\r</i>
- <i>// e: Ext.Direct.RemotingEvent object\r</i>
- <b>function</b>(result, e){\r
- <b>var</b> t = e.getTransaction();\r
- <b>var</b> action = t.action; <i>// server side Class called\r</i>
- <b>var</b> method = t.method; <i>// server side method called\r</i>
- <b>if</b>(e.status){\r
- <b>var</b> answer = Ext.encode(result); <i>// 8\r</i>
- \r
- }<b>else</b>{\r
- <b>var</b> msg = e.message; <i>// failure message\r</i>
- }\r
- }\r
-);</code></pre>\r
-In the example above, the server side "multiply" function will be passed two\r
-arguments (2 and 4). The "multiply" method should return the value 8 which will be\r
-available as the <tt>result</tt> in the example above.</div></div></td><td class="msource">RemotingProvider</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.RemotingProvider-enableBuffer"></a><b><a href="source/RemotingProvider.html#cfg-Ext.direct.RemotingProvider-enableBuffer">enableBuffer</a></b> : Number/Boolean<div class="mdesc"><div class="short">true or false to enable or disable combining of method
-calls. If a number is specified this is the amount of time in...</div><div class="long"><p><tt>true</tt> or <tt>false</tt> to enable or disable combining of method\r
-calls. If a number is specified this is the amount of time in milliseconds\r
-to wait before sending a batched request (defaults to <tt>10</tt>).</p>\r
-<br><p>Calls which are received within the specified timeframe will be\r
-concatenated together and sent in a single request, optimizing the\r
-application by reducing the amount of round trips that have to be made\r
-to the server.</p></div></div></td><td class="msource">RemotingProvider</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.RemotingProvider-enableUrlEncode"></a><b><a href="source/RemotingProvider.html#cfg-Ext.direct.RemotingProvider-enableUrlEncode">enableUrlEncode</a></b> : String<div class="mdesc">Specify which param will hold the arguments for the method.\r
-Defaults to <tt>'data'</tt>.</div></td><td class="msource">RemotingProvider</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.Provider-id"></a><b><a href="source/Provider1.html#cfg-Ext.direct.Provider-id">id</a></b> : String<div class="mdesc"><div class="short">The unique id of the provider (defaults to an auto-assigned id).
-You should assign an id if you need to be able to a...</div><div class="long">The unique id of the provider (defaults to an <a href="output/Ext.html#Ext-id" ext:member="id" ext:cls="Ext">auto-assigned id</a>).\r
-You should assign an id if you need to be able to access the provider later and you do\r
-not have an object reference available, for example:\r
-<pre><code>Ext.Direct.addProvider(\r
- {\r
- type: <em>'polling'</em>,\r
- url: <em>'php/poll.php'</em>,\r
- id: <em>'poll-provider'</em>\r
- }\r
-);\r
- \r
-<b>var</b> p = <a href="output/Ext.Direct.html" ext:cls="Ext.Direct">Ext.Direct</a>.<a href="output/Ext.Direct.html#Ext.Direct-getProvider" ext:member="getProvider" ext:cls="Ext.Direct">getProvider</a>(<em>'poll-provider'</em>);\r
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.direct.RemotingProvider-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.direct.RemotingProvider-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.direct.RemotingProvider-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.direct.RemotingProvider-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.direct.RemotingProvider"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>
+ <img src="resources/elbow-end.gif"><a href="output/Ext.direct.Provider.html" ext:member="" ext:cls="Ext.direct.Provider">Provider</a>
+ <img src="resources/elbow-end.gif"><a href="output/Ext.direct.JsonProvider.html" ext:member="" ext:cls="Ext.direct.JsonProvider">JsonProvider</a>
+ <img src="resources/elbow-end.gif">RemotingProvider</pre></div><h1>Class <a href="source/RemotingProvider.html#cls-Ext.direct.RemotingProvider">Ext.direct.RemotingProvider</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.direct</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/RemotingProvider.html#cls-Ext.direct.RemotingProvider">RemotingProvider.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/RemotingProvider.html#cls-Ext.direct.RemotingProvider">RemotingProvider</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.direct.JsonProvider.html" ext:cls="Ext.direct.JsonProvider" ext:member="">JsonProvider</a></td></tr></table><div class="description"><p>The <a href="output/Ext.direct.RemotingProvider.html" ext:cls="Ext.direct.RemotingProvider">RemotingProvider</a> exposes access to
+server side methods on the client (a remote procedure call (RPC) type of
+connection where the client can initiate a procedure on the server).</p>
+<p>This allows for code to be organized in a fashion that is maintainable,
+while providing a clear path between client and server, something that is
+not always apparent when using URLs.</p>
+<p>To accomplish this the server-side needs to describe what classes and methods
+are available on the client-side. This configuration will typically be
+outputted by the server-side Ext.Direct stack when the API description is built.</p></div><div class="hr"></div><a id="Ext.direct.RemotingProvider-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.RemotingProvider-actions"></a><b><a href="source/RemotingProvider.html#cfg-Ext.direct.RemotingProvider-actions">actions</a></b> : Object<div class="mdesc"><div class="short">Object literal defining the server side actions and methods. For example, if
+the Provider is configured with:
+"action...</div><div class="long">Object literal defining the server side actions and methods. For example, if
+the Provider is configured with:
+<pre><code><em>"actions"</em>:{ <i>// each property within the <em>'actions'</em> object represents a server side Class </i>
+ <em>"TestAction"</em>:[ <i>// array of methods within each server side Class to be </i>
+ { <i>// stubbed out on client</i>
+ <em>"name"</em>:<em>"doEcho"</em>,
+ <em>"len"</em>:1
+ },{
+ <em>"name"</em>:<em>"multiply"</em>,<i>// name of method</i>
+ <em>"len"</em>:2 <i>// The number of parameters that will be used to create an</i>
+ <i>// array of data to send to the server side <b>function</b>.</i>
+ <i>// Ensure the server sends back a Number, not a String. </i>
+ },{
+ <em>"name"</em>:<em>"doForm"</em>,
+ <em>"formHandler"</em>:true, <i>// direct the client to use specialized form handling method </i>
+ <em>"len"</em>:1
+ }]
+}</code></pre>
+<p>Note that a Store is not required, a server method can be called at any time.
+In the following example a <b>client side</b> handler is used to call the
+server side method "multiply" in the server-side "TestAction" Class:</p>
+<pre><code>TestAction.multiply(
+ 2, 4, <i>// pass two arguments to server, so specify len=2</i>
+ <i>// callback <b>function</b> after the server is called</i>
+ <i>// result: the result returned by the server</i>
+ <i>// e: Ext.Direct.RemotingEvent object</i>
+ <b>function</b>(result, e){
+ <b>var</b> t = e.getTransaction();
+ <b>var</b> action = t.action; <i>// server side Class called</i>
+ <b>var</b> method = t.method; <i>// server side method called</i>
+ <b>if</b>(e.status){
+ <b>var</b> answer = Ext.encode(result); <i>// 8</i>
+
+ }<b>else</b>{
+ <b>var</b> msg = e.message; <i>// failure message</i>
+ }
+ }
+);</code></pre>
+In the example above, the server side "multiply" function will be passed two
+arguments (2 and 4). The "multiply" method should return the value 8 which will be
+available as the <tt>result</tt> in the example above.</div></div></td><td class="msource">RemotingProvider</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.RemotingProvider-enableBuffer"></a><b><a href="source/RemotingProvider.html#cfg-Ext.direct.RemotingProvider-enableBuffer">enableBuffer</a></b> : Number/Boolean<div class="mdesc"><div class="short">true or false to enable or disable combining of method
+calls. If a number is specified this is the amount of time in ...</div><div class="long"><p><tt>true</tt> or <tt>false</tt> to enable or disable combining of method
+calls. If a number is specified this is the amount of time in milliseconds
+to wait before sending a batched request (defaults to <tt>10</tt>).</p>
+<br><p>Calls which are received within the specified timeframe will be
+concatenated together and sent in a single request, optimizing the
+application by reducing the amount of round trips that have to be made
+to the server.</p></div></div></td><td class="msource">RemotingProvider</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.RemotingProvider-enableUrlEncode"></a><b><a href="source/RemotingProvider.html#cfg-Ext.direct.RemotingProvider-enableUrlEncode">enableUrlEncode</a></b> : String<div class="mdesc">Specify which param will hold the arguments for the method.
+Defaults to <tt>'data'</tt>.</div></td><td class="msource">RemotingProvider</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.direct.Provider-id"></a><b><a href="source/Provider.html#cfg-Ext.direct.Provider-id">id</a></b> : String<div class="mdesc"><div class="short">The unique id of the provider (defaults to an auto-assigned id).
+You should assign an id if you need to be able to ac...</div><div class="long">The unique id of the provider (defaults to an <a href="output/Ext.html#Ext-id" ext:member="id" ext:cls="Ext">auto-assigned id</a>).
+You should assign an id if you need to be able to access the provider later and you do
+not have an object reference available, for example:
+<pre><code>Ext.Direct.addProvider(
+ {
+ type: <em>'polling'</em>,
+ url: <em>'php/poll.php'</em>,
+ id: <em>'poll-provider'</em>
+ }
+);
+
+<b>var</b> p = <a href="output/Ext.Direct.html" ext:cls="Ext.Direct">Ext.Direct</a>.<a href="output/Ext.Direct.html#Ext.Direct-getProvider" ext:member="getProvider" ext:cls="Ext.Direct">getProvider</a>(<em>'poll-provider'</em>);
git.ithinksw.org / extjs.git / blobdiff