docs/source/AbstractPlugin.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-AbstractPlugin'>/**
  19 </span> * @class Ext.AbstractPlugin
  20  * @extends Object
  21  *
  22  * &lt;p&gt;The AbstractPlugin class is the base class from which user-implemented plugins should inherit.&lt;/p&gt;
  23  * &lt;p&gt;This class defines the essential API of plugins as used by Components by defining the following methods:&lt;/p&gt;
  24  * &lt;ul&gt;
  25  * &lt;li&gt;&lt;code&gt;init&lt;/code&gt; : The plugin initialization method which the owning Component calls at Component initialization
  26  * time.&lt;div class=&quot;sub-desc&quot;&gt;&lt;p&gt;The Component passes itself as the sole parameter.&lt;/p&gt;&lt;p&gt;Subclasses should set up bidirectional
  27  * links between the plugin and its client Component here.&lt;/p&gt;&lt;/div&gt;&lt;/li&gt;
  28  * &lt;li&gt;&lt;code&gt;destroy&lt;/code&gt; : The plugin cleanup method which the owning Component calls at Component destruction time.&lt;div class=&quot;sub-desc&quot;&gt;Use
  29  * this method to break links between the plugin and the Component and to free any allocated resources.&lt;/div&gt;&lt;/li&gt;
  30  * &lt;li&gt;&lt;code&gt;enable&lt;/code&gt; : The base implementation just sets the plugin's &lt;code&gt;disabled&lt;/code&gt; flag to &lt;code&gt;false&lt;/code&gt;&lt;div class=&quot;sub-desc&quot;&gt;&lt;/div&gt;&lt;/li&gt;
  31  * &lt;li&gt;&lt;code&gt;disable&lt;/code&gt; : The base implementation just sets the plugin's &lt;code&gt;disabled&lt;/code&gt; flag to &lt;code&gt;true&lt;/code&gt;&lt;div class=&quot;sub-desc&quot;&gt;&lt;/div&gt;&lt;/li&gt;
  32  * &lt;/ul&gt;
  33  */
  34 Ext.define('Ext.AbstractPlugin', {
  35     disabled: false,
  36
  37     constructor: function(config) {
  38         //&lt;debug&gt;
  39         if (!config.cmp &amp;&amp; Ext.global.console) {
  40             Ext.global.console.warn(&quot;Attempted to attach a plugin &quot;);
  41         }
  42         //&lt;/debug&gt;
  43         Ext.apply(this, config);
  44     },
  45
  46     getCmp: function() {
  47         return this.cmp;
  48     },
  49
  50 <span id='Ext-AbstractPlugin-method-init'>    /**
  51 </span>     * &lt;p&gt;The init method is invoked after {@link Ext.Component#initComponent initComponent} has been run for the client Component.&lt;/p&gt;
  52      * &lt;p&gt;The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional
  53      * links between the plugin and its client Component in their own implementation of this method.&lt;/p&gt;
  54      * @param {Component} client The client Component which owns this plugin.
  55      * @method
  56      */
  57     init: Ext.emptyFn,
  58
  59 <span id='Ext-AbstractPlugin-method-destroy'>    /**
  60 </span>     * &lt;p&gt;The destroy method is invoked by the owning Component at the time the Component is being destroyed.&lt;/p&gt;
  61      * &lt;p&gt;The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.&lt;/p&gt;
  62      * @method
  63      */
  64     destroy: Ext.emptyFn,
  65
  66 <span id='Ext-AbstractPlugin-method-enable'>    /**
  67 </span>     * &lt;p&gt;The base implementation just sets the plugin's &lt;code&gt;disabled&lt;/code&gt; flag to &lt;code&gt;false&lt;/code&gt;&lt;/p&gt;
  68      * &lt;p&gt;Plugin subclasses which need more complex processing may implement an overriding implementation.&lt;/p&gt;
  69      */
  70     enable: function() {
  71         this.disabled = false;
  72     },
  73
  74 <span id='Ext-AbstractPlugin-method-disable'>    /**
  75 </span>     * &lt;p&gt;The base implementation just sets the plugin's &lt;code&gt;disabled&lt;/code&gt; flag to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
  76      * &lt;p&gt;Plugin subclasses which need more complex processing may implement an overriding implementation.&lt;/p&gt;
  77      */
  78     disable: function() {
  79         this.disabled = true;
  80     }
  81 });</pre>
  82 </body>
  83 </html>