123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327 |
- <!DOCTYPE html>
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>The source code</title>
- <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
- <script type="text/javascript" src="../resources/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-form-action-Action'>/**
- </span> * The subclasses of this class provide actions to perform upon {@link Ext.form.Basic Form}s.
- *
- * Instances of this class are only created by a {@link Ext.form.Basic Form} when the Form needs to perform an action
- * such as submit or load. The Configuration options listed for this class are set through the Form's action methods:
- * {@link Ext.form.Basic#submit submit}, {@link Ext.form.Basic#load load} and {@link Ext.form.Basic#doAction doAction}
- *
- * The instance of Action which performed the action is passed to the success and failure callbacks of the Form's action
- * methods ({@link Ext.form.Basic#submit submit}, {@link Ext.form.Basic#load load} and
- * {@link Ext.form.Basic#doAction doAction}), and to the {@link Ext.form.Basic#actioncomplete actioncomplete} and
- * {@link Ext.form.Basic#actionfailed actionfailed} event handlers.
- */
- Ext.define('Ext.form.action.Action', {
- alternateClassName: 'Ext.form.Action',
- <span id='Ext-form-action-Action-cfg-form'> /**
- </span> * @cfg {Ext.form.Basic} form
- * The {@link Ext.form.Basic BasicForm} instance that is invoking this Action. Required.
- */
- <span id='Ext-form-action-Action-cfg-url'> /**
- </span> * @cfg {String} url
- * The URL that the Action is to invoke. Will default to the {@link Ext.form.Basic#url url} configured on the
- * {@link #form}.
- */
- <span id='Ext-form-action-Action-cfg-reset'> /**
- </span> * @cfg {Boolean} reset
- * When set to **true**, causes the Form to be {@link Ext.form.Basic#reset reset} on Action success. If specified,
- * this happens before the {@link #success} callback is called and before the Form's
- * {@link Ext.form.Basic#actioncomplete actioncomplete} event fires.
- */
- <span id='Ext-form-action-Action-cfg-method'> /**
- </span> * @cfg {String} method
- * The HTTP method to use to access the requested URL.
- * Defaults to the {@link Ext.form.Basic#method BasicForm's method}, or 'POST' if not specified.
- */
- <span id='Ext-form-action-Action-cfg-params'> /**
- </span> * @cfg {Object/String} params
- * Extra parameter values to pass. These are added to the Form's {@link Ext.form.Basic#baseParams} and passed to the
- * specified URL along with the Form's input fields.
- *
- * Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode Ext.Object.toQueryString}.
- */
- <span id='Ext-form-action-Action-cfg-headers'> /**
- </span> * @cfg {Object} headers
- * Extra headers to be sent in the AJAX request for submit and load actions.
- * See {@link Ext.data.proxy.Ajax#headers}.
- */
- <span id='Ext-form-action-Action-cfg-timeout'> /**
- </span> * @cfg {Number} timeout
- * The number of seconds to wait for a server response before failing with the {@link #failureType} as
- * {@link Ext.form.action.Action#CONNECT_FAILURE}. If not specified, defaults to the configured
- * {@link Ext.form.Basic#timeout timeout} of the {@link #form}.
- */
- <span id='Ext-form-action-Action-cfg-success'> /**
- </span> * @cfg {Function} success
- * The function to call when a valid success return packet is received.
- * @cfg {Ext.form.Basic} success.form The form that requested the action
- * @cfg {Ext.form.action.Action} success.action The Action class. The {@link #result} property of this object may
- * be examined to perform custom postprocessing.
- */
- <span id='Ext-form-action-Action-cfg-failure'> /**
- </span> * @cfg {Function} failure
- * The function to call when a failure packet was received, or when an error ocurred in the Ajax communication.
- * @cfg {Ext.form.Basic} failure.form The form that requested the action
- * @cfg {Ext.form.action.Action} failure.action The Action class. If an Ajax error ocurred, the failure type will
- * be in {@link #failureType}. The {@link #result} property of this object may be examined to perform custom
- * postprocessing.
- */
- <span id='Ext-form-action-Action-cfg-scope'> /**
- </span> * @cfg {Object} scope
- * The scope in which to call the configured #success and #failure callback functions
- * (the `this` reference for the callback functions).
- */
- <span id='Ext-form-action-Action-cfg-waitMsg'> /**
- </span> * @cfg {String} waitMsg
- * The message to be displayed by a call to {@link Ext.window.MessageBox#wait} during the time the action is being
- * processed.
- */
- <span id='Ext-form-action-Action-cfg-waitTitle'> /**
- </span> * @cfg {String} waitTitle
- * The title to be displayed by a call to {@link Ext.window.MessageBox#wait} during the time the action is being
- * processed.
- */
- <span id='Ext-form-action-Action-cfg-submitEmptyText'> /**
- </span> * @cfg {Boolean} submitEmptyText
- * If set to true, the emptyText value will be sent with the form when it is submitted.
- */
- submitEmptyText : true,
- <span id='Ext-form-action-Action-property-type'> /**
- </span> * @property {String} type
- * The type of action this Action instance performs. Currently only "submit" and "load" are supported.
- */
- <span id='Ext-form-action-Action-property-failureType'> /**
- </span> * @property {String} failureType
- * The type of failure detected will be one of these:
- * {@link #CLIENT_INVALID}, {@link #SERVER_INVALID}, {@link #CONNECT_FAILURE}, or {@link #LOAD_FAILURE}.
- *
- * Usage:
- *
- * var fp = new Ext.form.Panel({
- * ...
- * buttons: [{
- * text: 'Save',
- * formBind: true,
- * handler: function(){
- * if(fp.getForm().isValid()){
- * fp.getForm().submit({
- * url: 'form-submit.php',
- * waitMsg: 'Submitting your data...',
- * success: function(form, action){
- * // server responded with success = true
- * var result = action.{@link #result};
- * },
- * failure: function(form, action){
- * if (action.{@link #failureType} === Ext.form.action.Action.CONNECT_FAILURE) {
- * Ext.Msg.alert('Error',
- * 'Status:'+action.{@link #response}.status+': '+
- * action.{@link #response}.statusText);
- * }
- * if (action.failureType === Ext.form.action.Action.SERVER_INVALID){
- * // server responded with success = false
- * Ext.Msg.alert('Invalid', action.{@link #result}.errormsg);
- * }
- * }
- * });
- * }
- * }
- * },{
- * text: 'Reset',
- * handler: function(){
- * fp.getForm().reset();
- * }
- * }]
- */
- <span id='Ext-form-action-Action-property-response'> /**
- </span> * @property {Object} response
- * The raw XMLHttpRequest object used to perform the action.
- */
- <span id='Ext-form-action-Action-property-result'> /**
- </span> * @property {Object} result
- * The decoded response object containing a boolean `success` property and other, action-specific properties.
- */
- <span id='Ext-form-action-Action-method-constructor'> /**
- </span> * Creates new Action.
- * @param {Object} [config] Config object.
- */
- constructor: function(config) {
- if (config) {
- Ext.apply(this, config);
- }
- // Normalize the params option to an Object
- var params = config.params;
- if (Ext.isString(params)) {
- this.params = Ext.Object.fromQueryString(params);
- }
- },
- <span id='Ext-form-action-Action-method-run'> /**
- </span> * @method
- * Invokes this action using the current configuration.
- */
- run: Ext.emptyFn,
- <span id='Ext-form-action-Action-method-onSuccess'> /**
- </span> * @private
- * @method onSuccess
- * Callback method that gets invoked when the action completes successfully. Must be implemented by subclasses.
- * @param {Object} response
- */
- <span id='Ext-form-action-Action-method-handleResponse'> /**
- </span> * @private
- * @method handleResponse
- * Handles the raw response and builds a result object from it. Must be implemented by subclasses.
- * @param {Object} response
- */
- <span id='Ext-form-action-Action-method-onFailure'> /**
- </span> * @private
- * Handles a failure response.
- * @param {Object} response
- */
- onFailure : function(response){
- this.response = response;
- this.failureType = Ext.form.action.Action.CONNECT_FAILURE;
- this.form.afterAction(this, false);
- },
- <span id='Ext-form-action-Action-method-processResponse'> /**
- </span> * @private
- * Validates that a response contains either responseText or responseXML and invokes
- * {@link #handleResponse} to build the result object.
- * @param {Object} response The raw response object.
- * @return {Object/Boolean} The result object as built by handleResponse, or `true` if
- * the response had empty responseText and responseXML.
- */
- processResponse : function(response){
- this.response = response;
- if (!response.responseText && !response.responseXML) {
- return true;
- }
- return (this.result = this.handleResponse(response));
- },
- <span id='Ext-form-action-Action-method-getUrl'> /**
- </span> * @private
- * Build the URL for the AJAX request. Used by the standard AJAX submit and load actions.
- * @return {String} The URL.
- */
- getUrl: function() {
- return this.url || this.form.url;
- },
- <span id='Ext-form-action-Action-method-getMethod'> /**
- </span> * @private
- * Determine the HTTP method to be used for the request.
- * @return {String} The HTTP method
- */
- getMethod: function() {
- return (this.method || this.form.method || 'POST').toUpperCase();
- },
- <span id='Ext-form-action-Action-method-getParams'> /**
- </span> * @private
- * Get the set of parameters specified in the BasicForm's baseParams and/or the params option.
- * Items in params override items of the same name in baseParams.
- * @return {Object} the full set of parameters
- */
- getParams: function() {
- return Ext.apply({}, this.params, this.form.baseParams);
- },
- <span id='Ext-form-action-Action-method-createCallback'> /**
- </span> * @private
- * Creates a callback object.
- */
- createCallback: function() {
- var me = this,
- undef,
- form = me.form;
- return {
- success: me.onSuccess,
- failure: me.onFailure,
- scope: me,
- timeout: (this.timeout * 1000) || (form.timeout * 1000),
- upload: form.fileUpload ? me.onSuccess : undef
- };
- },
- statics: {
- <span id='Ext-form-action-Action-static-property-CLIENT_INVALID'> /**
- </span> * @property
- * Failure type returned when client side validation of the Form fails thus aborting a submit action. Client
- * side validation is performed unless {@link Ext.form.action.Submit#clientValidation} is explicitly set to
- * false.
- * @static
- */
- CLIENT_INVALID: 'client',
- <span id='Ext-form-action-Action-static-property-SERVER_INVALID'> /**
- </span> * @property
- * Failure type returned when server side processing fails and the {@link #result}'s `success` property is set to
- * false.
- *
- * In the case of a form submission, field-specific error messages may be returned in the {@link #result}'s
- * errors property.
- * @static
- */
- SERVER_INVALID: 'server',
- <span id='Ext-form-action-Action-static-property-CONNECT_FAILURE'> /**
- </span> * @property
- * Failure type returned when a communication error happens when attempting to send a request to the remote
- * server. The {@link #response} may be examined to provide further information.
- * @static
- */
- CONNECT_FAILURE: 'connect',
- <span id='Ext-form-action-Action-static-property-LOAD_FAILURE'> /**
- </span> * @property
- * Failure type returned when the response's `success` property is set to false, or no field values are returned
- * in the response's data property.
- * @static
- */
- LOAD_FAILURE: 'load'
- }
- });
- </pre>
- </body>
- </html>
|