Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / source / Action.html
1 <html>
2 <head>
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
4   <title>The source code</title>
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
7 </head>
8 <body  onload="prettyPrint();">
9     <pre class="prettyprint lang-js">/*!
10  * Ext JS Library 3.2.0
11  * Copyright(c) 2006-2010 Ext JS, Inc.
12  * licensing@extjs.com
13  * http://www.extjs.com/license
14  */
15 <div id="cls-Ext.form.Action"></div>/**
16  * @class Ext.form.Action
17  * <p>The subclasses of this class provide actions to perform upon {@link Ext.form.BasicForm Form}s.</p>
18  * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
19  * the Form needs to perform an action such as submit or load. The Configuration options
20  * listed for this class are set through the Form's action methods: {@link Ext.form.BasicForm#submit submit},
21  * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#doAction doAction}</p>
22  * <p>The instance of Action which performed the action is passed to the success
23  * and failure callbacks of the Form's action methods ({@link Ext.form.BasicForm#submit submit},
24  * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#doAction doAction}),
25  * and to the {@link Ext.form.BasicForm#actioncomplete actioncomplete} and
26  * {@link Ext.form.BasicForm#actionfailed actionfailed} event handlers.</p>
27  */
28 Ext.form.Action = function(form, options){
29     this.form = form;
30     this.options = options || {};
31 };
32
33 <div id="prop-Ext.form.Action-CLIENT_INVALID"></div>/**
34  * Failure type returned when client side validation of the Form fails
35  * thus aborting a submit action. Client side validation is performed unless
36  * {@link #clientValidation} is explicitly set to <tt>false</tt>.
37  * @type {String}
38  * @static
39  */
40 Ext.form.Action.CLIENT_INVALID = 'client';
41 <div id="prop-Ext.form.Action-SERVER_INVALID"></div>/**
42  * <p>Failure type returned when server side processing fails and the {@link #result}'s
43  * <tt style="font-weight:bold">success</tt> property is set to <tt>false</tt>.</p>
44  * <p>In the case of a form submission, field-specific error messages may be returned in the
45  * {@link #result}'s <tt style="font-weight:bold">errors</tt> property.</p>
46  * @type {String}
47  * @static
48  */
49 Ext.form.Action.SERVER_INVALID = 'server';
50 <div id="prop-Ext.form.Action-CONNECT_FAILURE"></div>/**
51  * Failure type returned when a communication error happens when attempting
52  * to send a request to the remote server. The {@link #response} may be examined to
53  * provide further information.
54  * @type {String}
55  * @static
56  */
57 Ext.form.Action.CONNECT_FAILURE = 'connect';
58 <div id="prop-Ext.form.Action-LOAD_FAILURE"></div>/**
59  * Failure type returned when the response's <tt style="font-weight:bold">success</tt>
60  * property is set to <tt>false</tt>, or no field values are returned in the response's
61  * <tt style="font-weight:bold">data</tt> property.
62  * @type {String}
63  * @static
64  */
65 Ext.form.Action.LOAD_FAILURE = 'load';
66
67 Ext.form.Action.prototype = {
68 <div id="cfg-Ext.form.Action-url"></div>/**
69  * @cfg {String} url The URL that the Action is to invoke.
70  */
71 <div id="cfg-Ext.form.Action-reset"></div>/**
72  * @cfg {Boolean} reset When set to <tt><b>true</b></tt>, causes the Form to be
73  * {@link Ext.form.BasicForm.reset reset} on Action success. If specified, this happens
74  * <b>before</b> the {@link #success} callback is called and before the Form's
75  * {@link Ext.form.BasicForm.actioncomplete actioncomplete} event fires.
76  */
77 <div id="cfg-Ext.form.Action-method"></div>/**
78  * @cfg {String} method The HTTP method to use to access the requested URL. Defaults to the
79  * {@link Ext.form.BasicForm}'s method, or if that is not specified, the underlying DOM form's method.
80  */
81 <div id="cfg-Ext.form.Action-params"></div>/**
82  * @cfg {Mixed} params <p>Extra parameter values to pass. These are added to the Form's
83  * {@link Ext.form.BasicForm#baseParams} and passed to the specified URL along with the Form's
84  * input fields.</p>
85  * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
86  */
87 <div id="cfg-Ext.form.Action-timeout"></div>/**
88  * @cfg {Number} timeout The number of seconds to wait for a server response before
89  * failing with the {@link #failureType} as {@link #Action.CONNECT_FAILURE}. If not specified,
90  * defaults to the configured <tt>{@link Ext.form.BasicForm#timeout timeout}</tt> of the
91  * {@link Ext.form.BasicForm form}.
92  */
93 <div id="cfg-Ext.form.Action-success"></div>/**
94  * @cfg {Function} success The function to call when a valid success return packet is recieved.
95  * The function is passed the following parameters:<ul class="mdetail-params">
96  * <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
97  * <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. The {@link #result}
98  * property of this object may be examined to perform custom postprocessing.</div></li>
99  * </ul>
100  */
101 <div id="cfg-Ext.form.Action-failure"></div>/**
102  * @cfg {Function} failure The function to call when a failure packet was recieved, or when an
103  * error ocurred in the Ajax communication.
104  * The function is passed the following parameters:<ul class="mdetail-params">
105  * <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
106  * <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. If an Ajax
107  * error ocurred, the failure type will be in {@link #failureType}. The {@link #result}
108  * property of this object may be examined to perform custom postprocessing.</div></li>
109  * </ul>
110  */
111 <div id="cfg-Ext.form.Action-scope"></div>/**
112  * @cfg {Object} scope The scope in which to call the callback functions (The <tt>this</tt> reference
113  * for the callback functions).
114  */
115 <div id="cfg-Ext.form.Action-waitMsg"></div>/**
116  * @cfg {String} waitMsg The message to be displayed by a call to {@link Ext.MessageBox#wait}
117  * during the time the action is being processed.
118  */
119 <div id="cfg-Ext.form.Action-waitTitle"></div>/**
120  * @cfg {String} waitTitle The title to be displayed by a call to {@link Ext.MessageBox#wait}
121  * during the time the action is being processed.
122  */
123
124 <div id="cfg-Ext.form.Action-submitEmptyText"></div>/**
125  * @cfg {Boolean} submitEmptyText If set to <tt>true</tt>, the emptyText value will be sent with the form
126  * when it is submitted.  Defaults to <tt>true</tt>.
127  */
128
129 <div id="prop-Ext.form.Action-type"></div>/**
130  * The type of action this Action instance performs.
131  * Currently only "submit" and "load" are supported.
132  * @type {String}
133  */
134     type : 'default',
135 <div id="prop-Ext.form.Action-failureType"></div>/**
136  * The type of failure detected will be one of these: {@link #CLIENT_INVALID},
137  * {@link #SERVER_INVALID}, {@link #CONNECT_FAILURE}, or {@link #LOAD_FAILURE}.  Usage:
138  * <pre><code>
139 var fp = new Ext.form.FormPanel({
140 ...
141 buttons: [{
142     text: 'Save',
143     formBind: true,
144     handler: function(){
145         if(fp.getForm().isValid()){
146             fp.getForm().submit({
147                 url: 'form-submit.php',
148                 waitMsg: 'Submitting your data...',
149                 success: function(form, action){
150                     // server responded with success = true
151                     var result = action.{@link #result};
152                 },
153                 failure: function(form, action){
154                     if (action.{@link #failureType} === Ext.form.Action.{@link #CONNECT_FAILURE}) {
155                         Ext.Msg.alert('Error',
156                             'Status:'+action.{@link #response}.status+': '+
157                             action.{@link #response}.statusText);
158                     }
159                     if (action.failureType === Ext.form.Action.{@link #SERVER_INVALID}){
160                         // server responded with success = false
161                         Ext.Msg.alert('Invalid', action.{@link #result}.errormsg);
162                     }
163                 }
164             });
165         }
166     }
167 },{
168     text: 'Reset',
169     handler: function(){
170         fp.getForm().reset();
171     }
172 }]
173  * </code></pre>
174  * @property failureType
175  * @type {String}
176  */
177  <div id="prop-Ext.form.Action-response"></div>/**
178  * The XMLHttpRequest object used to perform the action.
179  * @property response
180  * @type {Object}
181  */
182  <div id="prop-Ext.form.Action-result"></div>/**
183  * The decoded response object containing a boolean <tt style="font-weight:bold">success</tt> property and
184  * other, action-specific properties.
185  * @property result
186  * @type {Object}
187  */
188
189     // interface method
190     run : function(options){
191
192     },
193
194     // interface method
195     success : function(response){
196
197     },
198
199     // interface method
200     handleResponse : function(response){
201
202     },
203
204     // default connection failure
205     failure : function(response){
206         this.response = response;
207         this.failureType = Ext.form.Action.CONNECT_FAILURE;
208         this.form.afterAction(this, false);
209     },
210
211     // private
212     // shared code among all Actions to validate that there was a response
213     // with either responseText or responseXml
214     processResponse : function(response){
215         this.response = response;
216         if(!response.responseText && !response.responseXML){
217             return true;
218         }
219         this.result = this.handleResponse(response);
220         return this.result;
221     },
222
223     // utility functions used internally
224     getUrl : function(appendParams){
225         var url = this.options.url || this.form.url || this.form.el.dom.action;
226         if(appendParams){
227             var p = this.getParams();
228             if(p){
229                 url = Ext.urlAppend(url, p);
230             }
231         }
232         return url;
233     },
234
235     // private
236     getMethod : function(){
237         return (this.options.method || this.form.method || this.form.el.dom.method || 'POST').toUpperCase();
238     },
239
240     // private
241     getParams : function(){
242         var bp = this.form.baseParams;
243         var p = this.options.params;
244         if(p){
245             if(typeof p == "object"){
246                 p = Ext.urlEncode(Ext.applyIf(p, bp));
247             }else if(typeof p == 'string' && bp){
248                 p += '&' + Ext.urlEncode(bp);
249             }
250         }else if(bp){
251             p = Ext.urlEncode(bp);
252         }
253         return p;
254     },
255
256     // private
257     createCallback : function(opts){
258         var opts = opts || {};
259         return {
260             success: this.success,
261             failure: this.failure,
262             scope: this,
263             timeout: (opts.timeout*1000) || (this.form.timeout*1000),
264             upload: this.form.fileUpload ? this.success : undefined
265         };
266     }
267 };
268
269 <div id="cls-Ext.form.Action.Submit"></div>/**
270  * @class Ext.form.Action.Submit
271  * @extends Ext.form.Action
272  * <p>A class which handles submission of data from {@link Ext.form.BasicForm Form}s
273  * and processes the returned response.</p>
274  * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
275  * {@link Ext.form.BasicForm#submit submit}ting.</p>
276  * <p><u><b>Response Packet Criteria</b></u></p>
277  * <p>A response packet may contain:
278  * <div class="mdetail-params"><ul>
279  * <li><b><code>success</code></b> property : Boolean
280  * <div class="sub-desc">The <code>success</code> property is required.</div></li>
281  * <li><b><code>errors</code></b> property : Object
282  * <div class="sub-desc"><div class="sub-desc">The <code>errors</code> property,
283  * which is optional, contains error messages for invalid fields.</div></li>
284  * </ul></div>
285  * <p><u><b>JSON Packets</b></u></p>
286  * <p>By default, response packets are assumed to be JSON, so a typical response
287  * packet may look like this:</p><pre><code>
288 {
289     success: false,
290     errors: {
291         clientCode: "Client not found",
292         portOfLoading: "This field must not be null"
293     }
294 }</code></pre>
295  * <p>Other data may be placed into the response for processing by the {@link Ext.form.BasicForm}'s callback
296  * or event handler methods. The object decoded from this JSON is available in the
297  * {@link Ext.form.Action#result result} property.</p>
298  * <p>Alternatively, if an {@link #errorReader} is specified as an {@link Ext.data.XmlReader XmlReader}:</p><pre><code>
299     errorReader: new Ext.data.XmlReader({
300             record : 'field',
301             success: '@success'
302         }, [
303             'id', 'msg'
304         ]
305     )
306 </code></pre>
307  * <p>then the results may be sent back in XML format:</p><pre><code>
308 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
309 &lt;message success="false"&gt;
310 &lt;errors&gt;
311     &lt;field&gt;
312         &lt;id&gt;clientCode&lt;/id&gt;
313         &lt;msg&gt;&lt;![CDATA[Code not found. &lt;br /&gt;&lt;i&gt;This is a test validation message from the server &lt;/i&gt;]]&gt;&lt;/msg&gt;
314     &lt;/field&gt;
315     &lt;field&gt;
316         &lt;id&gt;portOfLoading&lt;/id&gt;
317         &lt;msg&gt;&lt;![CDATA[Port not found. &lt;br /&gt;&lt;i&gt;This is a test validation message from the server &lt;/i&gt;]]&gt;&lt;/msg&gt;
318     &lt;/field&gt;
319 &lt;/errors&gt;
320 &lt;/message&gt;
321 </code></pre>
322  * <p>Other elements may be placed into the response XML for processing by the {@link Ext.form.BasicForm}'s callback
323  * or event handler methods. The XML document is available in the {@link #errorReader}'s {@link Ext.data.XmlReader#xmlData xmlData} property.</p>
324  */
325 Ext.form.Action.Submit = function(form, options){
326     Ext.form.Action.Submit.superclass.constructor.call(this, form, options);
327 };
328
329 Ext.extend(Ext.form.Action.Submit, Ext.form.Action, {
330     <div id="cfg-Ext.form.Action.Submit-errorReader"></div>/**
331      * @cfg {Ext.data.DataReader} errorReader <p><b>Optional. JSON is interpreted with
332      * no need for an errorReader.</b></p>
333      * <p>A Reader which reads a single record from the returned data. The DataReader's
334      * <b>success</b> property specifies how submission success is determined. The Record's
335      * data provides the error messages to apply to any invalid form Fields.</p>
336      */
337     <div id="cfg-Ext.form.Action.Submit-clientValidation"></div>/**
338      * @cfg {boolean} clientValidation Determines whether a Form's fields are validated
339      * in a final call to {@link Ext.form.BasicForm#isValid isValid} prior to submission.
340      * Pass <tt>false</tt> in the Form's submit options to prevent this. If not defined, pre-submission field validation
341      * is performed.
342      */
343     type : 'submit',
344
345     // private
346     run : function(){
347         var o = this.options,
348             method = this.getMethod(),
349             isGet = method == 'GET';
350         if(o.clientValidation === false || this.form.isValid()){
351             if (o.submitEmptyText === false) {
352                 var fields = this.form.items,
353                     emptyFields = [];
354                 fields.each(function(f) {
355                     if (f.el.getValue() == f.emptyText) {
356                         emptyFields.push(f);
357                         f.el.dom.value = "";
358                     }
359                 });
360             }
361             Ext.Ajax.request(Ext.apply(this.createCallback(o), {
362                 form:this.form.el.dom,
363                 url:this.getUrl(isGet),
364                 method: method,
365                 headers: o.headers,
366                 params:!isGet ? this.getParams() : null,
367                 isUpload: this.form.fileUpload
368             }));
369             if (o.submitEmptyText === false) {
370                 Ext.each(emptyFields, function(f) {
371                     if (f.applyEmptyText) {
372                         f.applyEmptyText();
373                     }
374                 });
375             }
376         }else if (o.clientValidation !== false){ // client validation failed
377             this.failureType = Ext.form.Action.CLIENT_INVALID;
378             this.form.afterAction(this, false);
379         }
380     },
381
382     // private
383     success : function(response){
384         var result = this.processResponse(response);
385         if(result === true || result.success){
386             this.form.afterAction(this, true);
387             return;
388         }
389         if(result.errors){
390             this.form.markInvalid(result.errors);
391         }
392         this.failureType = Ext.form.Action.SERVER_INVALID;
393         this.form.afterAction(this, false);
394     },
395
396     // private
397     handleResponse : function(response){
398         if(this.form.errorReader){
399             var rs = this.form.errorReader.read(response);
400             var errors = [];
401             if(rs.records){
402                 for(var i = 0, len = rs.records.length; i < len; i++) {
403                     var r = rs.records[i];
404                     errors[i] = r.data;
405                 }
406             }
407             if(errors.length < 1){
408                 errors = null;
409             }
410             return {
411                 success : rs.success,
412                 errors : errors
413             };
414         }
415         return Ext.decode(response.responseText);
416     }
417 });
418
419
420 <div id="cls-Ext.form.Action.Load"></div>/**
421  * @class Ext.form.Action.Load
422  * @extends Ext.form.Action
423  * <p>A class which handles loading of data from a server into the Fields of an {@link Ext.form.BasicForm}.</p>
424  * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
425  * {@link Ext.form.BasicForm#load load}ing.</p>
426  * <p><u><b>Response Packet Criteria</b></u></p>
427  * <p>A response packet <b>must</b> contain:
428  * <div class="mdetail-params"><ul>
429  * <li><b><code>success</code></b> property : Boolean</li>
430  * <li><b><code>data</code></b> property : Object</li>
431  * <div class="sub-desc">The <code>data</code> property contains the values of Fields to load.
432  * The individual value object for each Field is passed to the Field's
433  * {@link Ext.form.Field#setValue setValue} method.</div></li>
434  * </ul></div>
435  * <p><u><b>JSON Packets</b></u></p>
436  * <p>By default, response packets are assumed to be JSON, so for the following form load call:<pre><code>
437 var myFormPanel = new Ext.form.FormPanel({
438     title: 'Client and routing info',
439     items: [{
440         fieldLabel: 'Client',
441         name: 'clientName'
442     }, {
443         fieldLabel: 'Port of loading',
444         name: 'portOfLoading'
445     }, {
446         fieldLabel: 'Port of discharge',
447         name: 'portOfDischarge'
448     }]
449 });
450 myFormPanel.{@link Ext.form.FormPanel#getForm getForm}().{@link Ext.form.BasicForm#load load}({
451     url: '/getRoutingInfo.php',
452     params: {
453         consignmentRef: myConsignmentRef
454     },
455     failure: function(form, action) {
456         Ext.Msg.alert("Load failed", action.result.errorMessage);
457     }
458 });
459 </code></pre>
460  * a <b>success response</b> packet may look like this:</p><pre><code>
461 {
462     success: true,
463     data: {
464         clientName: "Fred. Olsen Lines",
465         portOfLoading: "FXT",
466         portOfDischarge: "OSL"
467     }
468 }</code></pre>
469  * while a <b>failure response</b> packet may look like this:</p><pre><code>
470 {
471     success: false,
472     errorMessage: "Consignment reference not found"
473 }</code></pre>
474  * <p>Other data may be placed into the response for processing the {@link Ext.form.BasicForm Form}'s
475  * callback or event handler methods. The object decoded from this JSON is available in the
476  * {@link Ext.form.Action#result result} property.</p>
477  */
478 Ext.form.Action.Load = function(form, options){
479     Ext.form.Action.Load.superclass.constructor.call(this, form, options);
480     this.reader = this.form.reader;
481 };
482
483 Ext.extend(Ext.form.Action.Load, Ext.form.Action, {
484     // private
485     type : 'load',
486
487     // private
488     run : function(){
489         Ext.Ajax.request(Ext.apply(
490                 this.createCallback(this.options), {
491                     method:this.getMethod(),
492                     url:this.getUrl(false),
493                     headers: this.options.headers,
494                     params:this.getParams()
495         }));
496     },
497
498     // private
499     success : function(response){
500         var result = this.processResponse(response);
501         if(result === true || !result.success || !result.data){
502             this.failureType = Ext.form.Action.LOAD_FAILURE;
503             this.form.afterAction(this, false);
504             return;
505         }
506         this.form.clearInvalid();
507         this.form.setValues(result.data);
508         this.form.afterAction(this, true);
509     },
510
511     // private
512     handleResponse : function(response){
513         if(this.form.reader){
514             var rs = this.form.reader.read(response);
515             var data = rs.records && rs.records[0] ? rs.records[0].data : null;
516             return {
517                 success : rs.success,
518                 data : data
519             };
520         }
521         return Ext.decode(response.responseText);
522     }
523 });
524
525
526
527 <div id="cls-Ext.form.Action.DirectLoad"></div>/**
528  * @class Ext.form.Action.DirectLoad
529  * @extends Ext.form.Action.Load
530  * <p>Provides Ext.direct support for loading form data.</p>
531  * <p>This example illustrates usage of Ext.Direct to <b>load</b> a form through Ext.Direct.</p>
532  * <pre><code>
533 var myFormPanel = new Ext.form.FormPanel({
534     // configs for FormPanel
535     title: 'Basic Information',
536     renderTo: document.body,
537     width: 300, height: 160,
538     padding: 10,
539
540     // configs apply to child items
541     defaults: {anchor: '100%'},
542     defaultType: 'textfield',
543     items: [{
544         fieldLabel: 'Name',
545         name: 'name'
546     },{
547         fieldLabel: 'Email',
548         name: 'email'
549     },{
550         fieldLabel: 'Company',
551         name: 'company'
552     }],
553
554     // configs for BasicForm
555     api: {
556         // The server-side method to call for load() requests
557         load: Profile.getBasicInfo,
558         // The server-side must mark the submit handler as a 'formHandler'
559         submit: Profile.updateBasicInfo
560     },
561     // specify the order for the passed params
562     paramOrder: ['uid', 'foo']
563 });
564
565 // load the form
566 myFormPanel.getForm().load({
567     // pass 2 arguments to server side getBasicInfo method (len=2)
568     params: {
569         foo: 'bar',
570         uid: 34
571     }
572 });
573  * </code></pre>
574  * The data packet sent to the server will resemble something like:
575  * <pre><code>
576 [
577     {
578         "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
579         "data":[34,"bar"] // note the order of the params
580     }
581 ]
582  * </code></pre>
583  * The form will process a data packet returned by the server that is similar
584  * to the following format:
585  * <pre><code>
586 [
587     {
588         "action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
589         "result":{
590             "success":true,
591             "data":{
592                 "name":"Fred Flintstone",
593                 "company":"Slate Rock and Gravel",
594                 "email":"fred.flintstone@slaterg.com"
595             }
596         }
597     }
598 ]
599  * </code></pre>
600  */
601 Ext.form.Action.DirectLoad = Ext.extend(Ext.form.Action.Load, {
602     constructor: function(form, opts) {
603         Ext.form.Action.DirectLoad.superclass.constructor.call(this, form, opts);
604     },
605     type : 'directload',
606
607     run : function(){
608         var args = this.getParams();
609         args.push(this.success, this);
610         this.form.api.load.apply(window, args);
611     },
612
613     getParams : function() {
614         var buf = [], o = {};
615         var bp = this.form.baseParams;
616         var p = this.options.params;
617         Ext.apply(o, p, bp);
618         var paramOrder = this.form.paramOrder;
619         if(paramOrder){
620             for(var i = 0, len = paramOrder.length; i < len; i++){
621                 buf.push(o[paramOrder[i]]);
622             }
623         }else if(this.form.paramsAsHash){
624             buf.push(o);
625         }
626         return buf;
627     },
628     // Direct actions have already been processed and therefore
629     // we can directly set the result; Direct Actions do not have
630     // a this.response property.
631     processResponse : function(result) {
632         this.result = result;
633         return result;
634     },
635
636     success : function(response, trans){
637         if(trans.type == Ext.Direct.exceptions.SERVER){
638             response = {};
639         }
640         Ext.form.Action.DirectLoad.superclass.success.call(this, response);
641     }
642 });
643
644 <div id="cls-Ext.form.Action.DirectSubmit"></div>/**
645  * @class Ext.form.Action.DirectSubmit
646  * @extends Ext.form.Action.Submit
647  * <p>Provides Ext.direct support for submitting form data.</p>
648  * <p>This example illustrates usage of Ext.Direct to <b>submit</b> a form through Ext.Direct.</p>
649  * <pre><code>
650 var myFormPanel = new Ext.form.FormPanel({
651     // configs for FormPanel
652     title: 'Basic Information',
653     renderTo: document.body,
654     width: 300, height: 160,
655     padding: 10,
656     buttons:[{
657         text: 'Submit',
658         handler: function(){
659             myFormPanel.getForm().submit({
660                 params: {
661                     foo: 'bar',
662                     uid: 34
663                 }
664             });
665         }
666     }],
667
668     // configs apply to child items
669     defaults: {anchor: '100%'},
670     defaultType: 'textfield',
671     items: [{
672         fieldLabel: 'Name',
673         name: 'name'
674     },{
675         fieldLabel: 'Email',
676         name: 'email'
677     },{
678         fieldLabel: 'Company',
679         name: 'company'
680     }],
681
682     // configs for BasicForm
683     api: {
684         // The server-side method to call for load() requests
685         load: Profile.getBasicInfo,
686         // The server-side must mark the submit handler as a 'formHandler'
687         submit: Profile.updateBasicInfo
688     },
689     // specify the order for the passed params
690     paramOrder: ['uid', 'foo']
691 });
692  * </code></pre>
693  * The data packet sent to the server will resemble something like:
694  * <pre><code>
695 {
696     "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6",
697     "result":{
698         "success":true,
699         "id":{
700             "extAction":"Profile","extMethod":"updateBasicInfo",
701             "extType":"rpc","extTID":"6","extUpload":"false",
702             "name":"Aaron Conran","email":"aaron@extjs.com","company":"Ext JS, LLC"
703         }
704     }
705 }
706  * </code></pre>
707  * The form will process a data packet returned by the server that is similar
708  * to the following:
709  * <pre><code>
710 // sample success packet (batched requests)
711 [
712     {
713         "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":3,
714         "result":{
715             "success":true
716         }
717     }
718 ]
719
720 // sample failure packet (one request)
721 {
722         "action":"Profile","method":"updateBasicInfo","type":"rpc","tid":"6",
723         "result":{
724             "errors":{
725                 "email":"already taken"
726             },
727             "success":false,
728             "foo":"bar"
729         }
730 }
731  * </code></pre>
732  * Also see the discussion in {@link Ext.form.Action.DirectLoad}.
733  */
734 Ext.form.Action.DirectSubmit = Ext.extend(Ext.form.Action.Submit, {
735     constructor : function(form, opts) {
736         Ext.form.Action.DirectSubmit.superclass.constructor.call(this, form, opts);
737     },
738     type : 'directsubmit',
739     // override of Submit
740     run : function(){
741         var o = this.options;
742         if(o.clientValidation === false || this.form.isValid()){
743             // tag on any additional params to be posted in the
744             // form scope
745             this.success.params = this.getParams();
746             this.form.api.submit(this.form.el.dom, this.success, this);
747         }else if (o.clientValidation !== false){ // client validation failed
748             this.failureType = Ext.form.Action.CLIENT_INVALID;
749             this.form.afterAction(this, false);
750         }
751     },
752
753     getParams : function() {
754         var o = {};
755         var bp = this.form.baseParams;
756         var p = this.options.params;
757         Ext.apply(o, p, bp);
758         return o;
759     },
760     // Direct actions have already been processed and therefore
761     // we can directly set the result; Direct Actions do not have
762     // a this.response property.
763     processResponse : function(result) {
764         this.result = result;
765         return result;
766     },
767
768     success : function(response, trans){
769         if(trans.type == Ext.Direct.exceptions.SERVER){
770             response = {};
771         }
772         Ext.form.Action.DirectSubmit.superclass.success.call(this, response);
773     }
774 });
775
776 Ext.form.Action.ACTION_TYPES = {
777     'load' : Ext.form.Action.Load,
778     'submit' : Ext.form.Action.Submit,
779     'directload' : Ext.form.Action.DirectLoad,
780     'directsubmit' : Ext.form.Action.DirectSubmit
781 };
782 </pre>    
783 </body>
784 </html>