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="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../resources/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> * The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
  20  *
  21  * This class defines the essential API of plugins as used by Components by defining the following methods:
  22  *
  23  *   - `init` : The plugin initialization method which the owning Component calls at Component initialization time.
  24  *
  25  *     The Component passes itself as the sole parameter.
  26  *
  27  *     Subclasses should set up bidirectional links between the plugin and its client Component here.
  28  *
  29  *   - `destroy` : The plugin cleanup method which the owning Component calls at Component destruction time.
  30  *
  31  *     Use this method to break links between the plugin and the Component and to free any allocated resources.
  32  *
  33  *   - `enable` : The base implementation just sets the plugin's `disabled` flag to `false`
  34  *
  35  *   - `disable` : The base implementation just sets the plugin's `disabled` flag to `true`
  36  */
  37 Ext.define('Ext.AbstractPlugin', {
  38     disabled: false,
  39
  40     constructor: function(config) {
  41         //&lt;debug&gt;
  42         if (!config.cmp &amp;&amp; Ext.global.console) {
  43             Ext.global.console.warn(&quot;Attempted to attach a plugin &quot;);
  44         }
  45         //&lt;/debug&gt;
  46         Ext.apply(this, config);
  47     },
  48
  49     getCmp: function() {
  50         return this.cmp;
  51     },
  52
  53 <span id='Ext-AbstractPlugin-method-init'>    /**
  54 </span>     * @method
  55      * The init method is invoked after initComponent method has been run for the client Component.
  56      *
  57      * The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional
  58      * links between the plugin and its client Component in their own implementation of this method.
  59      * @param {Ext.Component} client The client Component which owns this plugin.
  60      */
  61     init: Ext.emptyFn,
  62
  63 <span id='Ext-AbstractPlugin-method-destroy'>    /**
  64 </span>     * @method
  65      * The destroy method is invoked by the owning Component at the time the Component is being destroyed.
  66      *
  67      * The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of
  68      * this method.
  69      */
  70     destroy: Ext.emptyFn,
  71
  72 <span id='Ext-AbstractPlugin-method-enable'>    /**
  73 </span>     * The base implementation just sets the plugin's `disabled` flag to `false`
  74      *
  75      * Plugin subclasses which need more complex processing may implement an overriding implementation.
  76      */
  77     enable: function() {
  78         this.disabled = false;
  79     },
  80
  81 <span id='Ext-AbstractPlugin-method-disable'>    /**
  82 </span>     * The base implementation just sets the plugin's `disabled` flag to `true`
  83      *
  84      * Plugin subclasses which need more complex processing may implement an overriding implementation.
  85      */
  86     disable: function() {
  87         this.disabled = true;
  88     }
  89 });</pre>
  90 </body>
  91 </html>