docs/source/Action2.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-form.action.Action-method-constructor'><span id='Ext-form.action.Action'>/**
   2 </span></span> * @class Ext.form.action.Action
   3  * @extends Ext.Base
   4  * &lt;p&gt;The subclasses of this class provide actions to perform upon {@link Ext.form.Basic Form}s.&lt;/p&gt;
   5  * &lt;p&gt;Instances of this class are only created by a {@link Ext.form.Basic Form} when
   6  * the Form needs to perform an action such as submit or load. The Configuration options
   7  * listed for this class are set through the Form's action methods: {@link Ext.form.Basic#submit submit},
   8  * {@link Ext.form.Basic#load load} and {@link Ext.form.Basic#doAction doAction}&lt;/p&gt;
   9  * &lt;p&gt;The instance of Action which performed the action is passed to the success
  10  * and failure callbacks of the Form's action methods ({@link Ext.form.Basic#submit submit},
  11  * {@link Ext.form.Basic#load load} and {@link Ext.form.Basic#doAction doAction}),
  12  * and to the {@link Ext.form.Basic#actioncomplete actioncomplete} and
  13  * {@link Ext.form.Basic#actionfailed actionfailed} event handlers.&lt;/p&gt;
  14  * @constructor
  15  * @param {Object} config The configuration for this instance.
  16  */
  17 Ext.define('Ext.form.action.Action', {
  18     alternateClassName: 'Ext.form.Action',
  19
  20 <span id='Ext-form.action.Action-cfg-form'>    /**
  21 </span>     * @cfg {Ext.form.Basic} form The {@link Ext.form.Basic BasicForm} instance that
  22      * is invoking this Action. Required.
  23      */
  24
  25 <span id='Ext-form.action.Action-cfg-url'>    /**
  26 </span>     * @cfg {String} url The URL that the Action is to invoke. Will default to the {@link Ext.form.Basic#url url}
  27      * configured on the {@link #form}.
  28      */
  29
  30 <span id='Ext-form.action.Action-cfg-reset'>    /**
  31 </span>     * @cfg {Boolean} reset When set to &lt;tt&gt;&lt;b&gt;true&lt;/b&gt;&lt;/tt&gt;, causes the Form to be
  32      * {@link Ext.form.Basic#reset reset} on Action success. If specified, this happens
  33      * before the {@link #success} callback is called and before the Form's
  34      * {@link Ext.form.Basic#actioncomplete actioncomplete} event fires.
  35      */
  36
  37 <span id='Ext-form.action.Action-cfg-method'>    /**
  38 </span>     * @cfg {String} method The HTTP method to use to access the requested URL. Defaults to the
  39      * {@link Ext.form.Basic#method BasicForm's method}, or 'POST' if not specified.
  40      */
  41
  42 <span id='Ext-form.action.Action-cfg-params'>    /**
  43 </span>     * @cfg {Object/String} params &lt;p&gt;Extra parameter values to pass. These are added to the Form's
  44      * {@link Ext.form.Basic#baseParams} and passed to the specified URL along with the Form's
  45      * input fields.&lt;/p&gt;
  46      * &lt;p&gt;Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode Ext.Object.toQueryString}.&lt;/p&gt;
  47      */
  48
  49 <span id='Ext-form.action.Action-cfg-headers'>    /**
  50 </span>     * @cfg {Object} headers &lt;p&gt;Extra headers to be sent in the AJAX request for submit and load actions. See
  51      * {@link Ext.data.Connection#headers}.&lt;/p&gt;
  52      */
  53
  54 <span id='Ext-form.action.Action-cfg-timeout'>    /**
  55 </span>     * @cfg {Number} timeout The number of seconds to wait for a server response before
  56      * failing with the {@link #failureType} as {@link Ext.form.action.Action#CONNECT_FAILURE}. If not specified,
  57      * defaults to the configured &lt;tt&gt;{@link Ext.form.Basic#timeout timeout}&lt;/tt&gt; of the
  58      * {@link #form}.
  59      */
  60
  61 <span id='Ext-form.action.Action-cfg-success'>    /**
  62 </span>     * @cfg {Function} success The function to call when a valid success return packet is received.
  63      * The function is passed the following parameters:&lt;ul class=&quot;mdetail-params&quot;&gt;
  64      * &lt;li&gt;&lt;b&gt;form&lt;/b&gt; : Ext.form.Basic&lt;div class=&quot;sub-desc&quot;&gt;The form that requested the action&lt;/div&gt;&lt;/li&gt;
  65      * &lt;li&gt;&lt;b&gt;action&lt;/b&gt; : Ext.form.action.Action&lt;div class=&quot;sub-desc&quot;&gt;The Action class. The {@link #result}
  66      * property of this object may be examined to perform custom postprocessing.&lt;/div&gt;&lt;/li&gt;
  67      * &lt;/ul&gt;
  68      */
  69
  70 <span id='Ext-form.action.Action-cfg-failure'>    /**
  71 </span>     * @cfg {Function} failure The function to call when a failure packet was received, or when an
  72      * error ocurred in the Ajax communication.
  73      * The function is passed the following parameters:&lt;ul class=&quot;mdetail-params&quot;&gt;
  74      * &lt;li&gt;&lt;b&gt;form&lt;/b&gt; : Ext.form.Basic&lt;div class=&quot;sub-desc&quot;&gt;The form that requested the action&lt;/div&gt;&lt;/li&gt;
  75      * &lt;li&gt;&lt;b&gt;action&lt;/b&gt; : Ext.form.action.Action&lt;div class=&quot;sub-desc&quot;&gt;The Action class. If an Ajax
  76      * error ocurred, the failure type will be in {@link #failureType}. The {@link #result}
  77      * property of this object may be examined to perform custom postprocessing.&lt;/div&gt;&lt;/li&gt;
  78      * &lt;/ul&gt;
  79      */
  80
  81 <span id='Ext-form.action.Action-cfg-scope'>    /**
  82 </span>     * @cfg {Object} scope The scope in which to call the configured &lt;tt&gt;success&lt;/tt&gt; and &lt;tt&gt;failure&lt;/tt&gt;
  83      * callback functions (the &lt;tt&gt;this&lt;/tt&gt; reference for the callback functions).
  84      */
  85
  86 <span id='Ext-form.action.Action-cfg-waitMsg'>    /**
  87 </span>     * @cfg {String} waitMsg The message to be displayed by a call to {@link Ext.window.MessageBox#wait}
  88      * during the time the action is being processed.
  89      */
  90
  91 <span id='Ext-form.action.Action-cfg-waitTitle'>    /**
  92 </span>     * @cfg {String} waitTitle The title to be displayed by a call to {@link Ext.window.MessageBox#wait}
  93      * during the time the action is being processed.
  94      */
  95
  96 <span id='Ext-form.action.Action-cfg-submitEmptyText'>    /**
  97 </span>     * @cfg {Boolean} submitEmptyText If set to &lt;tt&gt;true&lt;/tt&gt;, the emptyText value will be sent with the form
  98      * when it is submitted. Defaults to &lt;tt&gt;true&lt;/tt&gt;.
  99      */
 100
 101 <span id='Ext-form.action.Action-property-type'>    /**
 102 </span>     * @property type
 103      * The type of action this Action instance performs.
 104      * Currently only &quot;submit&quot; and &quot;load&quot; are supported.
 105      * @type {String}
 106      */
 107
 108 <span id='Ext-form.action.Action-property-failureType'>    /**
 109 </span>     * The type of failure detected will be one of these: {@link Ext.form.action.Action#CLIENT_INVALID},
 110      * {@link Ext.form.action.Action#SERVER_INVALID}, {@link Ext.form.action.Action#CONNECT_FAILURE}, or
 111      * {@link Ext.form.action.Action#LOAD_FAILURE}.  Usage:
 112      * &lt;pre&gt;&lt;code&gt;
 113 var fp = new Ext.form.Panel({
 114 ...
 115 buttons: [{
 116     text: 'Save',
 117     formBind: true,
 118     handler: function(){
 119         if(fp.getForm().isValid()){
 120             fp.getForm().submit({
 121                 url: 'form-submit.php',
 122                 waitMsg: 'Submitting your data...',
 123                 success: function(form, action){
 124                     // server responded with success = true
 125                     var result = action.{@link #result};
 126                 },
 127                 failure: function(form, action){
 128                     if (action.{@link #failureType} === {@link Ext.form.action.Action#CONNECT_FAILURE}) {
 129                         Ext.Msg.alert('Error',
 130                             'Status:'+action.{@link #response}.status+': '+
 131                             action.{@link #response}.statusText);
 132                     }
 133                     if (action.failureType === {@link Ext.form.action.Action#SERVER_INVALID}){
 134                         // server responded with success = false
 135                         Ext.Msg.alert('Invalid', action.{@link #result}.errormsg);
 136                     }
 137                 }
 138             });
 139         }
 140     }
 141 },{
 142     text: 'Reset',
 143     handler: function(){
 144         fp.getForm().reset();
 145     }
 146 }]
 147      * &lt;/code&gt;&lt;/pre&gt;
 148      * @property failureType
 149      * @type {String}
 150      */
 151
 152 <span id='Ext-form.action.Action-property-response'>    /**
 153 </span>     * The raw XMLHttpRequest object used to perform the action.
 154      * @property response
 155      * @type {Object}
 156      */
 157
 158 <span id='Ext-form.action.Action-property-result'>    /**
 159 </span>     * The decoded response object containing a boolean &lt;tt&gt;success&lt;/tt&gt; property and
 160      * other, action-specific properties.
 161      * @property result
 162      * @type {Object}
 163      */
 164
 165
 166
 167     constructor: function(config) {
 168         if (config) {
 169             Ext.apply(this, config);
 170         }
 171
 172         // Normalize the params option to an Object
 173         var params = config.params;
 174         if (Ext.isString(params)) {
 175             this.params = Ext.Object.fromQueryString(params);
 176         }
 177     },
 178
 179 <span id='Ext-form.action.Action-property-run'>    /**
 180 </span>     * Invokes this action using the current configuration.
 181      */
 182     run: Ext.emptyFn,
 183
 184 <span id='Ext-form.action.Action-method-onSuccess'>    /**
 185 </span>     * @private
 186      * @method onSuccess
 187      * Callback method that gets invoked when the action completes successfully. Must be implemented by subclasses.
 188      * @param {Object} response
 189      */
 190
 191 <span id='Ext-form.action.Action-method-handleResponse'>    /**
 192 </span>     * @private
 193      * @method handleResponse
 194      * Handles the raw response and builds a result object from it. Must be implemented by subclasses.
 195      * @param {Object} response
 196      */
 197
 198 <span id='Ext-form.action.Action-method-onFailure'>    /**
 199 </span>     * @private
 200      * Handles a failure response.
 201      * @param {Object} response
 202      */
 203     onFailure : function(response){
 204         this.response = response;
 205         this.failureType = Ext.form.action.Action.CONNECT_FAILURE;
 206         this.form.afterAction(this, false);
 207     },
 208
 209 <span id='Ext-form.action.Action-method-processResponse'>    /**
 210 </span>     * @private
 211      * Validates that a response contains either responseText or responseXML and invokes
 212      * {@link #handleResponse} to build the result object.
 213      * @param {Object} response The raw response object.
 214      * @return {Object/Boolean} result The result object as built by handleResponse, or &lt;tt&gt;true&lt;/tt&gt; if
 215      *                         the response had empty responseText and responseXML.
 216      */
 217     processResponse : function(response){
 218         this.response = response;
 219         if (!response.responseText &amp;&amp; !response.responseXML) {
 220             return true;
 221         }
 222         return (this.result = this.handleResponse(response));
 223     },
 224
 225 <span id='Ext-form.action.Action-method-getUrl'>    /**
 226 </span>     * @private
 227      * Build the URL for the AJAX request. Used by the standard AJAX submit and load actions.
 228      * @return {String} The URL.
 229      */
 230     getUrl: function() {
 231         return this.url || this.form.url;
 232     },
 233
 234 <span id='Ext-form.action.Action-method-getMethod'>    /**
 235 </span>     * @private
 236      * Determine the HTTP method to be used for the request.
 237      * @return {String} The HTTP method
 238      */
 239     getMethod: function() {
 240         return (this.method || this.form.method || 'POST').toUpperCase();
 241     },
 242
 243 <span id='Ext-form.action.Action-method-getParams'>    /**
 244 </span>     * @private
 245      * Get the set of parameters specified in the BasicForm's baseParams and/or the params option.
 246      * Items in params override items of the same name in baseParams.
 247      * @return {Object} the full set of parameters
 248      */
 249     getParams: function() {
 250         return Ext.apply({}, this.params, this.form.baseParams);
 251     },
 252
 253 <span id='Ext-form.action.Action-method-createCallback'>    /**
 254 </span>     * @private
 255      * Creates a callback object.
 256      */
 257     createCallback: function() {
 258         var me = this,
 259             undef,
 260             form = me.form;
 261         return {
 262             success: me.onSuccess,
 263             failure: me.onFailure,
 264             scope: me,
 265             timeout: (this.timeout * 1000) || (form.timeout * 1000),
 266             upload: form.fileUpload ? me.onSuccess : undef
 267         };
 268     },
 269
 270     statics: {
 271 <span id='Ext-form.action.Action-property-CLIENT_INVALID'>        /**
 272 </span>         * @property CLIENT_INVALID
 273          * Failure type returned when client side validation of the Form fails
 274          * thus aborting a submit action. Client side validation is performed unless
 275          * {@link Ext.form.action.Submit#clientValidation} is explicitly set to &lt;tt&gt;false&lt;/tt&gt;.
 276          * @type {String}
 277          * @static
 278          */
 279         CLIENT_INVALID: 'client',
 280
 281 <span id='Ext-form.action.Action-property-SERVER_INVALID'>        /**
 282 </span>         * @property SERVER_INVALID
 283          * &lt;p&gt;Failure type returned when server side processing fails and the {@link #result}'s
 284          * &lt;tt&gt;success&lt;/tt&gt; property is set to &lt;tt&gt;false&lt;/tt&gt;.&lt;/p&gt;
 285          * &lt;p&gt;In the case of a form submission, field-specific error messages may be returned in the
 286          * {@link #result}'s &lt;tt&gt;errors&lt;/tt&gt; property.&lt;/p&gt;
 287          * @type {String}
 288          * @static
 289          */
 290         SERVER_INVALID: 'server',
 291
 292 <span id='Ext-form.action.Action-property-CONNECT_FAILURE'>        /**
 293 </span>         * @property CONNECT_FAILURE
 294          * Failure type returned when a communication error happens when attempting
 295          * to send a request to the remote server. The {@link #response} may be examined to
 296          * provide further information.
 297          * @type {String}
 298          * @static
 299          */
 300         CONNECT_FAILURE: 'connect',
 301
 302 <span id='Ext-form.action.Action-property-LOAD_FAILURE'>        /**
 303 </span>         * @property LOAD_FAILURE
 304          * Failure type returned when the response's &lt;tt&gt;success&lt;/tt&gt;
 305          * property is set to &lt;tt&gt;false&lt;/tt&gt;, or no field values are returned in the response's
 306          * &lt;tt&gt;data&lt;/tt&gt; property.
 307          * @type {String}
 308          * @static
 309          */
 310         LOAD_FAILURE: 'load'
 311
 312
 313     }
 314 });
 315 </pre></pre></body></html>