X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/source/Action.html diff --git a/docs/source/Action.html b/docs/source/Action.html index f9a22324..e2a67a9e 100644 --- a/docs/source/Action.html +++ b/docs/source/Action.html @@ -15,267 +15,318 @@ -
/**
- * @class Ext.Action
- * <p>An Action is a piece of reusable functionality that can be abstracted out of any particular component so that it
- * can be usefully shared among multiple components.  Actions let you share handlers, configuration options and UI
- * updates across any components that support the Action interface (primarily {@link Ext.toolbar.Toolbar}, {@link Ext.button.Button}
- * and {@link Ext.menu.Menu} components).</p>
- * <p>Use a single Action instance as the config object for any number of UI Components which share the same configuration. The
- * Action not only supplies the configuration, but allows all Components based upon it to have a common set of methods
- * called at once through a single call to the Action.</p>
- * <p>Any Component that is to be configured with an Action must also support
- * the following methods:<ul>
- * <li><code>setText(string)</code></li>
- * <li><code>setIconCls(string)</code></li>
- * <li><code>setDisabled(boolean)</code></li>
- * <li><code>setVisible(boolean)</code></li>
- * <li><code>setHandler(function)</code></li></ul>.</p>
- * <p>This allows the Action to control its associated Components.</p>
- * Example usage:<br>
- * <pre><code>
-// Define the shared Action.  Each Component below will have the same
-// display text and icon, and will display the same message on click.
-var action = new Ext.Action({
-    {@link #text}: 'Do something',
-    {@link #handler}: function(){
-        Ext.Msg.alert('Click', 'You did something.');
-    },
-    {@link #iconCls}: 'do-something',
-    {@link #itemId}: 'myAction'
-});
-
-var panel = new Ext.panel.Panel({
-    title: 'Actions',
-    width: 500,
-    height: 300,
-    tbar: [
-        // Add the Action directly to a toolbar as a menu button
-        action,
-        {
-            text: 'Action Menu',
-            // Add the Action to a menu as a text item
-            menu: [action]
-        }
-    ],
-    items: [
-        // Add the Action to the panel body as a standard button
-        new Ext.button.Button(action)
-    ],
-    renderTo: Ext.getBody()
-});
+  /**
+ * @class Ext.form.action.Action
+ * @extends Ext.Base
+ * <p>The subclasses of this class provide actions to perform upon {@link Ext.form.Basic Form}s.</p>
+ * <p>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}</p>
+ * <p>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.</p>
+ */
+Ext.define('Ext.form.action.Action', {
+    alternateClassName: 'Ext.form.Action',
 
-// Change the text for all components using the Action
-action.setText('Something else');
+    /**
+     * @cfg {Ext.form.Basic} form The {@link Ext.form.Basic BasicForm} instance that
+     * is invoking this Action. Required.
+     */
 
-// Reference an Action through a container using the itemId
-var btn = panel.getComponent('myAction');
-var aRef = btn.baseAction;
-aRef.setText('New text');
-</code></pre>
- * @constructor
- * @param {Object} config The configuration options
- */
-Ext.define('Ext.Action', {
+    /**
+     * @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}.
+     */
 
-    /* Begin Definitions */
+    /**
+     * @cfg {Boolean} reset When set to <tt><b>true</b></tt>, 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.
+     */
 
-    /* End Definitions */
+    /**
+     * @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.
+     */
 
-    /**
-     * @cfg {String} text The text to set for all components configured by this Action (defaults to '').
+    /**
+     * @cfg {Object/String} params <p>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.</p>
+     * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode Ext.Object.toQueryString}.</p>
      */
-    /**
-     * @cfg {String} iconCls
-     * The CSS class selector that specifies a background image to be used as the header icon for
-     * all components configured by this Action (defaults to '').
-     * <p>An example of specifying a custom icon class would be something like:
-     * </p><pre><code>
-// specify the property in the config for the class:
-     ...
-     iconCls: 'do-something'
-
-// css class that specifies background image to be used as the icon image:
-.do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }
-</code></pre>
+
+    /**
+     * @cfg {Object} headers <p>Extra headers to be sent in the AJAX request for submit and load actions. See
+     * {@link Ext.data.Connection#headers}.</p>
      */
-    /**
-     * @cfg {Boolean} disabled True to disable all components configured by this Action, false to enable them (defaults to false).
+
+    /**
+     * @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 <tt>{@link Ext.form.Basic#timeout timeout}</tt> of the
+     * {@link #form}.
      */
-    /**
-     * @cfg {Boolean} hidden True to hide all components configured by this Action, false to show them (defaults to false).
+
+    /**
+     * @cfg {Function} success The function to call when a valid success return packet is received.
+     * The function is passed the following parameters:<ul class="mdetail-params">
+     * <li><b>form</b> : Ext.form.Basic<div class="sub-desc">The form that requested the action</div></li>
+     * <li><b>action</b> : Ext.form.action.Action<div class="sub-desc">The Action class. The {@link #result}
+     * property of this object may be examined to perform custom postprocessing.</div></li>
+     * </ul>
      */
-    /**
-     * @cfg {Function} handler The function that will be invoked by each component tied to this Action
-     * when the component's primary event is triggered (defaults to undefined).
+
+    /**
+     * @cfg {Function} failure The function to call when a failure packet was received, or when an
+     * error ocurred in the Ajax communication.
+     * The function is passed the following parameters:<ul class="mdetail-params">
+     * <li><b>form</b> : Ext.form.Basic<div class="sub-desc">The form that requested the action</div></li>
+     * <li><b>action</b> : Ext.form.action.Action<div class="sub-desc">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.</div></li>
+     * </ul>
      */
-    /**
-     * @cfg {String} itemId
-     * See {@link Ext.Component}.{@link Ext.Component#itemId itemId}.
+
+    /**
+     * @cfg {Object} scope The scope in which to call the configured <tt>success</tt> and <tt>failure</tt>
+     * callback functions (the <tt>this</tt> reference for the callback functions).
      */
-    /**
-     * @cfg {Object} scope The scope (<code><b>this</b></code> reference) in which the
-     * <code>{@link #handler}</code> is executed. Defaults to the browser window.
+
+    /**
+     * @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.
      */
 
-    constructor : function(config){
-        this.initialConfig = config;
-        this.itemId = config.itemId = (config.itemId || config.id || Ext.id());
-        this.items = [];
-    },
+    /**
+     * @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.
+     */
 
-    // private
-    isAction : true,
+    /**
+     * @cfg {Boolean} submitEmptyText If set to <tt>true</tt>, the emptyText value will be sent with the form
+     * when it is submitted. Defaults to <tt>true</tt>.
+     */
 
-    /**
-     * Sets the text to be displayed by all components configured by this Action.
-     * @param {String} text The text to display
+    /**
+     * @property type
+     * The type of action this Action instance performs.
+     * Currently only "submit" and "load" are supported.
+     * @type {String}
      */
-    setText : function(text){
-        this.initialConfig.text = text;
-        this.callEach('setText', [text]);
-    },
 
-    /**
-     * Gets the text currently displayed by all components configured by this Action.
+    /**
+     * The type of failure detected will be one of these: {@link Ext.form.action.Action#CLIENT_INVALID},
+     * {@link Ext.form.action.Action#SERVER_INVALID}, {@link Ext.form.action.Action#CONNECT_FAILURE}, or
+     * {@link Ext.form.action.Action#LOAD_FAILURE}.  Usage:
+     * <pre><code>
+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} === {@link Ext.form.action.Action#CONNECT_FAILURE}) {
+                        Ext.Msg.alert('Error',
+                            'Status:'+action.{@link #response}.status+': '+
+                            action.{@link #response}.statusText);
+                    }
+                    if (action.failureType === {@link 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();
+    }
+}]
+     * </code></pre>
+     * @property failureType
+     * @type {String}
      */
-    getText : function(){
-        return this.initialConfig.text;
-    },
 
-    /**
-     * Sets the icon CSS class for all components configured by this Action.  The class should supply
-     * a background image that will be used as the icon image.
-     * @param {String} cls The CSS class supplying the icon image
+    /**
+     * The raw XMLHttpRequest object used to perform the action.
+     * @property response
+     * @type {Object}
      */
-    setIconCls : function(cls){
-        this.initialConfig.iconCls = cls;
-        this.callEach('setIconCls', [cls]);
-    },
 
-    /**
-     * Gets the icon CSS class currently used by all components configured by this Action.
+    /**
+     * The decoded response object containing a boolean <tt>success</tt> property and
+     * other, action-specific properties.
+     * @property result
+     * @type {Object}
      */
-    getIconCls : function(){
-        return this.initialConfig.iconCls;
-    },
 
-    /**
-     * Sets the disabled state of all components configured by this Action.  Shortcut method
-     * for {@link #enable} and {@link #disable}.
-     * @param {Boolean} disabled True to disable the component, false to enable it
+    /**
+     * Creates new Action.
+     * @param {Object} config (optional) Config object.
      */
-    setDisabled : function(v){
-        this.initialConfig.disabled = v;
-        this.callEach('setDisabled', [v]);
+    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);
+        }
     },
 
-    /**
-     * Enables all components configured by this Action.
+    /**
+     * Invokes this action using the current configuration.
      */
-    enable : function(){
-        this.setDisabled(false);
-    },
+    run: Ext.emptyFn,
 
-    /**
-     * Disables all components configured by this Action.
+    /**
+     * @private
+     * @method onSuccess
+     * Callback method that gets invoked when the action completes successfully. Must be implemented by subclasses.
+     * @param {Object} response
      */
-    disable : function(){
-        this.setDisabled(true);
-    },
 
-    /**
-     * Returns true if the components using this Action are currently disabled, else returns false.  
+    /**
+     * @private
+     * @method handleResponse
+     * Handles the raw response and builds a result object from it. Must be implemented by subclasses.
+     * @param {Object} response
      */
-    isDisabled : function(){
-        return this.initialConfig.disabled;
-    },
 
-    /**
-     * Sets the hidden state of all components configured by this Action.  Shortcut method
-     * for <code>{@link #hide}</code> and <code>{@link #show}</code>.
-     * @param {Boolean} hidden True to hide the component, false to show it
+    /**
+     * @private
+     * Handles a failure response.
+     * @param {Object} response
      */
-    setHidden : function(v){
-        this.initialConfig.hidden = v;
-        this.callEach('setVisible', [!v]);
+    onFailure : function(response){
+        this.response = response;
+        this.failureType = Ext.form.action.Action.CONNECT_FAILURE;
+        this.form.afterAction(this, false);
     },
 
-    /**
-     * Shows all components configured by this Action.
+    /**
+     * @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} result The result object as built by handleResponse, or <tt>true</tt> if
+     *                         the response had empty responseText and responseXML.
      */
-    show : function(){
-        this.setHidden(false);
+    processResponse : function(response){
+        this.response = response;
+        if (!response.responseText && !response.responseXML) {
+            return true;
+        }
+        return (this.result = this.handleResponse(response));
     },
 
-    /**
-     * Hides all components configured by this Action.
+    /**
+     * @private
+     * Build the URL for the AJAX request. Used by the standard AJAX submit and load actions.
+     * @return {String} The URL.
      */
-    hide : function(){
-        this.setHidden(true);
+    getUrl: function() {
+        return this.url || this.form.url;
     },
 
-    /**
-     * Returns true if the components configured by this Action are currently hidden, else returns false.
+    /**
+     * @private
+     * Determine the HTTP method to be used for the request.
+     * @return {String} The HTTP method
      */
-    isHidden : function(){
-        return this.initialConfig.hidden;
+    getMethod: function() {
+        return (this.method || this.form.method || 'POST').toUpperCase();
     },
 
-    /**
-     * Sets the function that will be called by each Component using this action when its primary event is triggered.
-     * @param {Function} fn The function that will be invoked by the action's components.  The function
-     * will be called with no arguments.
-     * @param {Object} scope The scope (<code>this</code> reference) in which the function is executed. Defaults to the Component firing the event.
+    /**
+     * @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
      */
-    setHandler : function(fn, scope){
-        this.initialConfig.handler = fn;
-        this.initialConfig.scope = scope;
-        this.callEach('setHandler', [fn, scope]);
+    getParams: function() {
+        return Ext.apply({}, this.params, this.form.baseParams);
     },
 
-    /**
-     * Executes the specified function once for each Component currently tied to this Action.  The function passed
-     * in should accept a single argument that will be an object that supports the basic Action config/method interface.
-     * @param {Function} fn The function to execute for each component
-     * @param {Object} scope The scope (<code>this</code> reference) in which the function is executed.  Defaults to the Component.
+    /**
+     * @private
+     * Creates a callback object.
      */
-    each : function(fn, scope){
-        Ext.each(this.items, fn, scope);
+    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
+        };
     },
 
-    // private
-    callEach : function(fnName, args){
-        var items = this.items,
-            i = 0,
-            len = items.length;
-            
-        for(; i < len; i++){
-            items[i][fnName].apply(items[i], args);
-        }
-    },
+    statics: {
+        /**
+         * @property CLIENT_INVALID
+         * 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 <tt>false</tt>.
+         * @type {String}
+         * @static
+         */
+        CLIENT_INVALID: 'client',
 
-    // private
-    addComponent : function(comp){
-        this.items.push(comp);
-        comp.on('destroy', this.removeComponent, this);
-    },
+        /**
+         * @property SERVER_INVALID
+         * <p>Failure type returned when server side processing fails and the {@link #result}'s
+         * <tt>success</tt> property is set to <tt>false</tt>.</p>
+         * <p>In the case of a form submission, field-specific error messages may be returned in the
+         * {@link #result}'s <tt>errors</tt> property.</p>
+         * @type {String}
+         * @static
+         */
+        SERVER_INVALID: 'server',
+
+        /**
+         * @property CONNECT_FAILURE
+         * 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.
+         * @type {String}
+         * @static
+         */
+        CONNECT_FAILURE: 'connect',
+
+        /**
+         * @property LOAD_FAILURE
+         * Failure type returned when the response's <tt>success</tt>
+         * property is set to <tt>false</tt>, or no field values are returned in the response's
+         * <tt>data</tt> property.
+         * @type {String}
+         * @static
+         */
+        LOAD_FAILURE: 'load'
 
-    // private
-    removeComponent : function(comp){
-        Ext.Array.remove(this.items, comp);
-    },
 
-    /**
-     * Executes this Action manually using the handler function specified in the original config object
-     * or the handler function set with <code>{@link #setHandler}</code>.  Any arguments passed to this
-     * function will be passed on to the handler function.
-     * @param {Mixed} arg1 (optional) Variable number of arguments passed to the handler function
-     * @param {Mixed} arg2 (optional)
-     * @param {Mixed} etc... (optional)
-     */
-    execute : function(){
-        this.initialConfig.handler.apply(this.initialConfig.scope || Ext.global, arguments);
     }
 });