Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.AbstractPlugin.js
index 5f1e1d1..5b44cbb 100644 (file)
 Ext.data.JsonP.Ext_AbstractPlugin({
-  "tagname": "class",
-  "name": "Ext.AbstractPlugin",
-  "doc": "<p>Plugins are injected</p>\n",
-  "extends": "Object",
-  "mixins": [
-
-  ],
-  "alternateClassNames": [
+  "allMixins": [
 
   ],
-  "xtype": null,
-  "author": null,
+  "deprecated": null,
   "docauthor": null,
-  "singleton": false,
-  "private": false,
-  "cfg": [
+  "members": {
+    "cfg": [
 
-  ],
-  "method": [
-    {
-      "tagname": "method",
-      "name": "destroy",
-      "member": "Ext.AbstractPlugin",
-      "doc": "<p>The destroy method is invoked by the owning Component at the time the Component is being destroyed.\nUse this method to clean up an resources.</p>\n",
-      "params": [
+    ],
+    "method": [
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-destroy",
+        "shortDoc": "The destroy method is invoked by the owning Component at the time the Component is being destroyed. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
+        "private": false,
+        "params": [
 
-      ],
-      "return": {
-        "type": "void",
-        "doc": "\n"
+        ],
+        "name": "destroy",
+        "owner": "Ext.AbstractPlugin",
+        "doc": "<p>The destroy method is invoked by the owning Component at the time the Component is being destroyed.</p>\n\n\n<p>The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.</p>\n\n",
+        "linenr": 42,
+        "return": {
+          "type": "void",
+          "doc": "\n"
+        },
+        "html_filename": "AbstractPlugin.html"
       },
-      "private": false,
-      "static": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js",
-      "linenr": 30,
-      "html_filename": "AbstractPlugin.html",
-      "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-destroy",
-      "shortDoc": "The destroy method is invoked by the owning Component at the time the Component is being destroyed.\nUse this method t..."
-    },
-    {
-      "tagname": "method",
-      "name": "disable",
-      "member": "Ext.AbstractPlugin",
-      "doc": "<p>Disable the plugin and set the disabled flag to true.</p>\n",
-      "params": [
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-disable",
+        "shortDoc": "The base implementation just sets the plugin's disabled flag to true\n\n\nPlugin subclasses which need more complex proc...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
+        "private": false,
+        "params": [
 
-      ],
-      "return": {
-        "type": "void",
-        "doc": "\n"
+        ],
+        "name": "disable",
+        "owner": "Ext.AbstractPlugin",
+        "doc": "<p>The base implementation just sets the plugin's <code>disabled</code> flag to <code>true</code></p>\n\n\n<p>Plugin subclasses which need more complex processing may implement an overriding implementation.</p>\n\n",
+        "linenr": 57,
+        "return": {
+          "type": "void",
+          "doc": "\n"
+        },
+        "html_filename": "AbstractPlugin.html"
       },
-      "private": false,
-      "static": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js",
-      "linenr": 44,
-      "html_filename": "AbstractPlugin.html",
-      "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-disable",
-      "shortDoc": "<p>Disable the plugin and set the disabled flag to true.</p>\n"
-    },
-    {
-      "tagname": "method",
-      "name": "enable",
-      "member": "Ext.AbstractPlugin",
-      "doc": "<p>Enable the plugin and set the disabled flag to false.</p>\n",
-      "params": [
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-enable",
+        "shortDoc": "The base implementation just sets the plugin's disabled flag to false\n\n\nPlugin subclasses which need more complex pro...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
+        "private": false,
+        "params": [
 
-      ],
-      "return": {
-        "type": "void",
-        "doc": "\n"
+        ],
+        "name": "enable",
+        "owner": "Ext.AbstractPlugin",
+        "doc": "<p>The base implementation just sets the plugin's <code>disabled</code> flag to <code>false</code></p>\n\n\n<p>Plugin subclasses which need more complex processing may implement an overriding implementation.</p>\n\n",
+        "linenr": 49,
+        "return": {
+          "type": "void",
+          "doc": "\n"
+        },
+        "html_filename": "AbstractPlugin.html"
       },
-      "private": false,
-      "static": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js",
-      "linenr": 37,
-      "html_filename": "AbstractPlugin.html",
-      "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-enable",
-      "shortDoc": "<p>Enable the plugin and set the disabled flag to false.</p>\n"
-    },
-    {
-      "tagname": "method",
-      "name": "init",
-      "member": "Ext.AbstractPlugin",
-      "doc": "<p>The init method is invoked after initComponent has been run for the\ncomponent which we are injecting the plugin into.</p>\n",
-      "params": [
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-init",
+        "shortDoc": "The init method is invoked after initComponent has been run for the client Component. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
+        "private": false,
+        "params": [
+          {
+            "type": "Component",
+            "optional": false,
+            "doc": "<p>The client Component which owns this plugin.</p>\n",
+            "name": "client"
+          }
+        ],
+        "name": "init",
+        "owner": "Ext.AbstractPlugin",
+        "doc": "<p>The init method is invoked after initComponent has been run for the client Component.</p>\n\n\n<p>The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional\nlinks between the plugin and its client Component in their own implementation of this method.</p>\n\n",
+        "linenr": 33,
+        "return": {
+          "type": "void",
+          "doc": "\n"
+        },
+        "html_filename": "AbstractPlugin.html"
+      }
+    ],
+    "property": [
 
-      ],
-      "return": {
-        "type": "void",
-        "doc": "\n"
-      },
-      "private": false,
-      "static": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js",
-      "linenr": 23,
-      "html_filename": "AbstractPlugin.html",
-      "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-init",
-      "shortDoc": "<p>The init method is invoked after initComponent has been run for the\ncomponent which we are injecting the plugin into.</p>\n"
-    }
-  ],
-  "property": [
+    ],
+    "cssVar": [
 
-  ],
-  "event": [
+    ],
+    "cssMixin": [
 
-  ],
-  "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js",
-  "linenr": 1,
-  "html_filename": "AbstractPlugin.html",
-  "href": "AbstractPlugin.html#Ext-AbstractPlugin",
-  "cssVar": [
+    ],
+    "event": [
 
-  ],
-  "cssMixin": [
+    ]
+  },
+  "singleton": false,
+  "alias": null,
+  "superclasses": [
 
   ],
-  "component": false,
-  "superclasses": [
+  "protected": false,
+  "tagname": "class",
+  "mixins": [
 
   ],
+  "href": "AbstractPlugin.html#Ext-AbstractPlugin",
   "subclasses": [
     "Ext.grid.plugin.DragDrop",
     "Ext.tree.ViewDDPlugin"
   ],
+  "static": false,
+  "author": null,
+  "component": false,
+  "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
+  "private": false,
+  "alternateClassNames": [
+
+  ],
+  "name": "Ext.AbstractPlugin",
+  "doc": "<p>The AbstractPlugin class is the base class from which user-implemented plugins should inherit.</p>\n\n\n<p>This class defines the essential API of plugins as used by Components by defining the following methods:</p>\n\n\n<ul>\n<li><code>init</code> : The plugin initialization method which the owning Component calls at Component initialization\ntime.<div class=\"sub-desc\"><p>The Component passes itself as the sole parameter.</p><p>Subclasses should set up bidirectional\nlinks between the plugin and its client Component here.</p></div></li>\n<li><code>destroy</code> : The plugin cleanup method which the owning Component calls at Component destruction time.<div class=\"sub-desc\">Use\nthis method to break links between the plugin and the Component and to free any allocated resources.</div></li>\n<li><code>enable</code> : The base implementation just sets the plugin's <code>disabled</code> flag to <code>false</code><div class=\"sub-desc\"></div></li>\n<li><code>disable</code> : The base implementation just sets the plugin's <code>disabled</code> flag to <code>true</code><div class=\"sub-desc\"></div></li>\n</ul>\n\n",
   "mixedInto": [
 
   ],
-  "allMixins": [
+  "linenr": 1,
+  "xtypes": [
 
-  ]
+  ],
+  "html_filename": "AbstractPlugin.html",
+  "extends": "Object"
 });
\ No newline at end of file