Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / AbstractPlugin.html
index 99ed401..407c527 100644 (file)
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <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>
 </head>
 <body onload="prettyPrint(); highlight();">
   <pre class="prettyprint lang-js"><span id='Ext-AbstractPlugin'>/**
-</span> * @class Ext.AbstractPlugin
- * @extends Object
+</span> * The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
  *
- * Plugins are injected 
+ * This class defines the essential API of plugins as used by Components by defining the following methods:
+ *
+ *   - `init` : The plugin initialization method which the owning Component calls at Component initialization time.
+ *
+ *     The Component passes itself as the sole parameter.
+ *
+ *     Subclasses should set up bidirectional links between the plugin and its client Component here.
+ *
+ *   - `destroy` : The plugin cleanup method which the owning Component calls at Component destruction time.
+ *
+ *     Use this method to break links between the plugin and the Component and to free any allocated resources.
+ *
+ *   - `enable` : The base implementation just sets the plugin's `disabled` flag to `false`
+ *
+ *   - `disable` : The base implementation just sets the plugin's `disabled` flag to `true`
  */
 Ext.define('Ext.AbstractPlugin', {
     disabled: false,
-    
+
     constructor: function(config) {
         //&lt;debug&gt;
         if (!config.cmp &amp;&amp; Ext.global.console) {
@@ -32,39 +45,47 @@ Ext.define('Ext.AbstractPlugin', {
         //&lt;/debug&gt;
         Ext.apply(this, config);
     },
-    
+
     getCmp: function() {
         return this.cmp;
     },
 
 <span id='Ext-AbstractPlugin-method-init'>    /**
-</span>     * The init method is invoked after initComponent has been run for the
-     * component which we are injecting the plugin into.
-     * @method
+</span>     * @method
+     * The init method is invoked after initComponent method has been run for the client Component.
+     *
+     * The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional
+     * links between the plugin and its client Component in their own implementation of this method.
+     * @param {Ext.Component} client The client Component which owns this plugin.
      */
     init: Ext.emptyFn,
 
 <span id='Ext-AbstractPlugin-method-destroy'>    /**
-</span>     * The destroy method is invoked by the owning Component at the time the Component is being destroyed.
-     * Use this method to clean up an resources.
-     * @method
+</span>     * @method
+     * The destroy method is invoked by the owning Component at the time the Component is being destroyed.
+     *
+     * The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of
+     * this method.
      */
     destroy: Ext.emptyFn,
 
 <span id='Ext-AbstractPlugin-method-enable'>    /**
-</span>     * Enable the plugin and set the disabled flag to false.
+</span>     * The base implementation just sets the plugin's `disabled` flag to `false`
+     *
+     * Plugin subclasses which need more complex processing may implement an overriding implementation.
      */
     enable: function() {
         this.disabled = false;
     },
 
 <span id='Ext-AbstractPlugin-method-disable'>    /**
-</span>     * Disable the plugin and set the disabled flag to true.
+</span>     * The base implementation just sets the plugin's `disabled` flag to `true`
+     *
+     * Plugin subclasses which need more complex processing may implement an overriding implementation.
      */
     disable: function() {
         this.disabled = true;
     }
-});
-</pre>
+});</pre>
 </body>
 </html>