X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/b37ceabb82336ee82757cd32efe353cfab8ec267..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/source/Action.html diff --git a/docs/source/Action.html b/docs/source/Action.html index 9f428c6b..55b324fa 100644 --- a/docs/source/Action.html +++ b/docs/source/Action.html @@ -1,29 +1,23 @@ - - - - The source code - - - - -
/*!
- * Ext JS Library 3.2.2
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-
/** - * @class Ext.Action - *

An Action is a piece of reusable functionality that can be abstracted out of any particular component so that it +Sencha Documentation Project

/**
+ * @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}, {@link Ext.Button}
- * and {@link Ext.menu.Menu} components).

- *

Aside from supporting the config object interface, any component that needs to use Actions must also support - * the following method list, as these will be called as needed by the Action class: setText(string), setIconCls(string), - * setDisabled(boolean), setVisible(boolean) and setHandler(function).

- * Example usage:
- *

-// Define the shared action.  Each component below will have the same
+ * 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',
@@ -34,72 +28,77 @@ var action = new Ext.Action({
     {@link #itemId}: 'myAction'
 });
 
-var panel = new Ext.Panel({
+var panel = new Ext.panel.Panel({
     title: 'Actions',
     width: 500,
     height: 300,
     tbar: [
-        // Add the action directly to a toolbar as a menu button
+        // 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
+            // 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(action)
+        // Add the Action to the panel body as a standard button
+        new Ext.button.Button(action)
     ],
     renderTo: Ext.getBody()
 });
 
-// Change the text for all components using the action
+// Change the text for all components using the Action
 action.setText('Something else');
 
-// Reference an action through a container using the itemId
+// 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.Action = Ext.extend(Object, { -
/** - * @cfg {String} text The text to set for all components using this action (defaults to ''). +Ext.define('Ext.Action', { + + /* Begin Definitions */ + + /* End Definitions */ + + /** + * @cfg {String} text The text to set for all components configured by this Action (defaults to ''). */ -
/** - * @cfg {String} iconCls + /** + * @cfg {String} iconCls * The CSS class selector that specifies a background image to be used as the header icon for - * all components using this action (defaults to ''). - *

An example of specifying a custom icon class would be something like: - *


+     * 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 {Boolean} disabled True to disable all components using this action, false to enable them (defaults to false). + /** + * @cfg {Boolean} disabled True to disable all components configured by this Action, false to enable them (defaults to false). */ -
/** - * @cfg {Boolean} hidden True to hide all components using this action, false to show them (defaults to false). + /** + * @cfg {Boolean} hidden True to hide all components configured by this Action, false to show them (defaults to false). */ -
/** - * @cfg {Function} handler The function that will be invoked by each component tied to this action + /** + * @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 {String} itemId + /** + * @cfg {String} itemId * See {@link Ext.Component}.{@link Ext.Component#itemId itemId}. */ -
/** - * @cfg {Object} scope The scope (this reference) in which the - * {@link #handler} is executed. Defaults to this Button. + /** + * @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. */ constructor : function(config){ @@ -107,12 +106,12 @@ Ext.Action = Ext.extend(Object, { this.itemId = config.itemId = (config.itemId || config.id || Ext.id()); this.items = []; }, - + // private isAction : true, -
/** - * Sets the text to be displayed by all components using this action. + /** + * Sets the text to be displayed by all components configured by this Action. * @param {String} text The text to display */ setText : function(text){ @@ -120,32 +119,32 @@ Ext.Action = Ext.extend(Object, { this.callEach('setText', [text]); }, -
/** - * Gets the text currently displayed by all components using this action. + /** + * Gets the text currently displayed by all components configured by this Action. */ getText : function(){ return this.initialConfig.text; }, -
/** - * Sets the icon CSS class for all components using this action. The class should supply + /** + * 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 */ - setIconClass : function(cls){ + setIconCls : function(cls){ this.initialConfig.iconCls = cls; - this.callEach('setIconClass', [cls]); + this.callEach('setIconCls', [cls]); }, -
/** - * Gets the icon CSS class currently used by all components using this action. + /** + * Gets the icon CSS class currently used by all components configured by this Action. */ - getIconClass : function(){ + getIconCls : function(){ return this.initialConfig.iconCls; }, -
/** - * Sets the disabled state of all components using this action. Shortcut method + /** + * 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 */ @@ -154,30 +153,30 @@ Ext.Action = Ext.extend(Object, { this.callEach('setDisabled', [v]); }, -
/** - * Enables all components using this action. + /** + * Enables all components configured by this Action. */ enable : function(){ this.setDisabled(false); }, -
/** - * Disables all components using this action. + /** + * Disables all components configured by this Action. */ disable : function(){ this.setDisabled(true); }, -
/** - * Returns true if the components using this action are currently disabled, else returns false. + /** + * Returns true if the components using this Action are currently disabled, else returns false. */ isDisabled : function(){ return this.initialConfig.disabled; }, -
/** - * Sets the hidden state of all components using this action. Shortcut method - * for {@link #hide} and {@link #show}. + /** + * 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 */ setHidden : function(v){ @@ -185,32 +184,32 @@ Ext.Action = Ext.extend(Object, { this.callEach('setVisible', [!v]); }, -
/** - * Shows all components using this action. + /** + * Shows all components configured by this Action. */ show : function(){ this.setHidden(false); }, -
/** - * Hides all components using this action. + /** + * Hides all components configured by this Action. */ hide : function(){ this.setHidden(true); }, -
/** - * Returns true if the components using this action are currently hidden, else returns false. + /** + * Returns true if the components configured by this Action are currently hidden, else returns false. */ isHidden : function(){ return this.initialConfig.hidden; }, -
/** - * Sets the function that will be called by each Component using this action when its primary event is triggered. + /** + * 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 (this reference) in which the function is executed. Defaults to the Component firing the event. + * @param {Object} scope The scope (<code>this</code> reference) in which the function is executed. Defaults to the Component firing the event. */ setHandler : function(fn, scope){ this.initialConfig.handler = fn; @@ -218,11 +217,11 @@ Ext.Action = Ext.extend(Object, { this.callEach('setHandler', [fn, scope]); }, -
/** - * Executes the specified function once for each Component currently tied to this action. The function passed + /** + * 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 (this reference) in which the function is executed. Defaults to the 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); @@ -231,7 +230,7 @@ Ext.Action = Ext.extend(Object, { // private callEach : function(fnName, args){ var cs = this.items; - for(var i = 0, len = cs.length; i < len; i++){ + for(var i = 0, len = cs.length; i < len; i++){ cs[i][fnName].apply(cs[i], args); } }, @@ -247,18 +246,16 @@ Ext.Action = Ext.extend(Object, { this.items.remove(comp); }, -
/** - * Executes this action manually using the handler function specified in the original config object - * or the handler function set with {@link #setHandler}. Any arguments passed to this + /** + * 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 || window, arguments); + this.initialConfig.handler.apply(this.initialConfig.scope || Ext.global, arguments); } }); -
- - \ No newline at end of file +
\ No newline at end of file