X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..HEAD:/docs/source/AbstractPlugin.html diff --git a/docs/source/AbstractPlugin.html b/docs/source/AbstractPlugin.html index f09fc4dd..407c5275 100644 --- a/docs/source/AbstractPlugin.html +++ b/docs/source/AbstractPlugin.html @@ -1,12 +1,42 @@ -Sencha Documentation Project
/**
- * @class Ext.AbstractPlugin
- * @extends Object
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
+ * The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
+ *
+ * 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.
  *
- * Plugins are injected 
+ *   - `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) {
         //<debug>
         if (!config.cmp && Ext.global.console) {
@@ -15,35 +45,47 @@ Ext.define('Ext.AbstractPlugin', {
         //</debug>
         Ext.apply(this, config);
     },
-    
+
     getCmp: function() {
         return this.cmp;
     },
 
-    /**
-     * The init method is invoked after initComponent has been run for the
-     * component which we are injecting the plugin into.
+    /**
+     * @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,
 
-    /**
-     * 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
+     * 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,
 
     /**
-     * Enable the plugin and set the disabled flag to false.
+     * 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;
     },
 
     /**
-     * Disable the plugin and set the disabled flag to true.
+     * 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;
     }
-});
-

\ No newline at end of file
+});
+ +