/**
- * @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',
+
/**
+ * @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'
+});
- /**
- * @cfg {Ext.form.Basic} form The {@link Ext.form.Basic BasicForm} instance that
- * is invoking this Action. Required.
- */
+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()
+});
- /**
- * @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}.
- */
+// Change the text for all components using the Action
+action.setText('Something else');
- /**
- * @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.
- */
+// Reference an Action through a container using the itemId
+var btn = panel.getComponent('myAction');
+var aRef = btn.baseAction;
+aRef.setText('New text');
+</code></pre>
+ */
+Ext.define('Ext.Action', {
- /**
- * @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.
- */
+ /* Begin Definitions */
- /**
- * @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>
- */
+ /* End Definitions */
- /**
- * @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 {String} [text='']
+ * The text to set for all components configured by this Action.
*/
-
- /**
- * @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 {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.
+ * <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 {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 {Boolean} [disabled=false]
+ * True to disable all components configured by this Action, false to enable them.
*/
-
- /**
- * @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 {Boolean} [hidden=false]
+ * True to hide all components configured by this Action, false to show them.
*/
-
- /**
- * @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 {Function} handler
+ * The function that will be invoked by each component tied to this Action
+ * when the component's primary event is triggered.
*/
-
- /**
- * @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.
+ /**
+ * @cfg {String} itemId
+ * See {@link Ext.Component}.{@link Ext.Component#itemId itemId}.
*/
-
- /**
- * @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.
+ /**
+ * @cfg {Object} scope
+ * The scope (this reference) in which the {@link #handler} is executed.
+ * Defaults to the browser window.
*/
- /**
- * @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>.
+ /**
+ * Creates new Action.
+ * @param {Object} config Config object.
*/
+ constructor : function(config){
+ this.initialConfig = config;
+ this.itemId = config.itemId = (config.itemId || config.id || Ext.id());
+ this.items = [];
+ },
- /**
- * @property type
- * The type of action this Action instance performs.
- * Currently only "submit" and "load" are supported.
- * @type {String}
- */
+ // private
+ isAction : true,
- /**
- * 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}
+ /**
+ * Sets the text to be displayed by all components configured by this Action.
+ * @param {String} text The text to display
*/
+ setText : function(text){
+ this.initialConfig.text = text;
+ this.callEach('setText', [text]);
+ },
- /**
- * The raw XMLHttpRequest object used to perform the action.
- * @property response
- * @type {Object}
+ /**
+ * Gets the text currently displayed by all components configured by this Action.
*/
+ getText : function(){
+ return this.initialConfig.text;
+ },
- /**
- * The decoded response object containing a boolean <tt>success</tt> property and
- * other, action-specific properties.
- * @property result
- * @type {Object}
+ /**
+ * 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
*/
+ setIconCls : function(cls){
+ this.initialConfig.iconCls = cls;
+ this.callEach('setIconCls', [cls]);
+ },
- /**
- * Creates new Action.
- * @param {Object} config (optional) Config object.
+ /**
+ * Gets the icon CSS class currently used by all components configured by this Action.
*/
- 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);
- }
+ getIconCls : function(){
+ return this.initialConfig.iconCls;
},
- /**
- * Invokes this action using the current configuration.
+ /**
+ * 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
*/
- run: Ext.emptyFn,
+ setDisabled : function(v){
+ this.initialConfig.disabled = v;
+ this.callEach('setDisabled', [v]);
+ },
- /**
- * @private
- * @method onSuccess
- * Callback method that gets invoked when the action completes successfully. Must be implemented by subclasses.
- * @param {Object} response
+ /**
+ * Enables all components configured by this Action.
*/
+ enable : function(){
+ this.setDisabled(false);
+ },
- /**
- * @private
- * @method handleResponse
- * Handles the raw response and builds a result object from it. Must be implemented by subclasses.
- * @param {Object} response
+ /**
+ * Disables all components configured by this Action.
*/
+ disable : function(){
+ this.setDisabled(true);
+ },
- /**
- * @private
- * Handles a failure response.
- * @param {Object} response
+ /**
+ * Returns true if the components using this Action are currently disabled, else returns false.
*/
- onFailure : function(response){
- this.response = response;
- this.failureType = Ext.form.action.Action.CONNECT_FAILURE;
- this.form.afterAction(this, false);
+ isDisabled : function(){
+ return this.initialConfig.disabled;
},
- /**
- * @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.
+ /**
+ * 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
*/
- processResponse : function(response){
- this.response = response;
- if (!response.responseText && !response.responseXML) {
- return true;
- }
- return (this.result = this.handleResponse(response));
+ setHidden : function(v){
+ this.initialConfig.hidden = v;
+ this.callEach('setVisible', [!v]);
},
- /**
- * @private
- * Build the URL for the AJAX request. Used by the standard AJAX submit and load actions.
- * @return {String} The URL.
+ /**
+ * Shows all components configured by this Action.
*/
- getUrl: function() {
- return this.url || this.form.url;
+ show : function(){
+ this.setHidden(false);
},
- /**
- * @private
- * Determine the HTTP method to be used for the request.
- * @return {String} The HTTP method
+ /**
+ * Hides all components configured by this Action.
*/
- getMethod: function() {
- return (this.method || this.form.method || 'POST').toUpperCase();
+ hide : function(){
+ this.setHidden(true);
},
- /**
- * @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
+ /**
+ * Returns true if the components configured by this Action are currently hidden, else returns false.
*/
- getParams: function() {
- return Ext.apply({}, this.params, this.form.baseParams);
+ isHidden : function(){
+ return this.initialConfig.hidden;
},
- /**
- * @private
- * Creates a callback object.
+ /**
+ * 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.
*/
- 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
- };
+ setHandler : function(fn, scope){
+ this.initialConfig.handler = fn;
+ this.initialConfig.scope = scope;
+ this.callEach('setHandler', [fn, scope]);
},
- 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',
+ /**
+ * 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.
+ */
+ each : function(fn, scope){
+ Ext.each(this.items, fn, scope);
+ },
- /**
- * @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',
+ // private
+ callEach : function(fnName, args){
+ var items = this.items,
+ i = 0,
+ len = items.length;
- /**
- * @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',
+ for(; i < len; i++){
+ items[i][fnName].apply(items[i], args);
+ }
+ },
- /**
- * @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
+ addComponent : function(comp){
+ this.items.push(comp);
+ comp.on('destroy', this.removeComponent, this);
+ },
+ // 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 {Object...} args (optional) Variable number of arguments passed to the handler function
+ */
+ execute : function(){
+ this.initialConfig.handler.apply(this.initialConfig.scope || Ext.global, arguments);
}
});