Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / PluginManager.html
index 00686cc..4254cd9 100644 (file)
@@ -1,14 +1,42 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-PluginManager'>/**
-</span> * @class Ext.PluginManager
- * @extends Ext.AbstractManager
- * &lt;p&gt;Provides a registry of available Plugin &lt;i&gt;classes&lt;/i&gt; indexed by a mnemonic code known as the Plugin's ptype.
- * The &lt;code&gt;{@link Ext.Component#xtype xtype}&lt;/code&gt; provides a way to avoid instantiating child Components
- * when creating a full, nested config object for a complete Ext page.&lt;/p&gt;
- * &lt;p&gt;A child Component may be specified simply as a &lt;i&gt;config object&lt;/i&gt;
- * as long as the correct &lt;code&gt;{@link Ext.Component#xtype xtype}&lt;/code&gt; is specified so that if and when the Component
- * needs rendering, the correct type can be looked up for lazy instantiation.&lt;/p&gt;
- * &lt;p&gt;For a list of all available &lt;code&gt;{@link Ext.Component#xtype xtypes}&lt;/code&gt;, see {@link Ext.Component}.&lt;/p&gt;
- * @singleton
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <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>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-PluginManager'>/**
+</span> * @singleton
+ *
+ * Provides a registry of available Plugin classes indexed by a mnemonic code known as the Plugin's ptype.
+ *
+ * A plugin may be specified simply as a *config object* as long as the correct `ptype` is specified:
+ *
+ *     {
+ *         ptype: 'gridviewdragdrop',
+ *         dragText: 'Drag and drop to reorganize'
+ *     }
+ *
+ * Or just use the ptype on its own:
+ *
+ *     'gridviewdragdrop'
+ *
+ * Alternatively you can instantiate the plugin with Ext.create:
+ *
+ *     Ext.create('Ext.view.plugin.AutoComplete', {
+ *         ptype: 'gridviewdragdrop',
+ *         dragText: 'Drag and drop to reorganize'
+ *     })
  */
 Ext.define('Ext.PluginManager', {
     extend: 'Ext.AbstractManager',
@@ -17,11 +45,11 @@ Ext.define('Ext.PluginManager', {
     typeName: 'ptype',
 
 <span id='Ext-PluginManager-method-create'>    /**
-</span>     * Creates a new Plugin from the specified config object using the
-     * config object's ptype to determine the class to instantiate.
+</span>     * Creates a new Plugin from the specified config object using the config object's ptype to determine the class to
+     * instantiate.
      * @param {Object} config A configuration object for the Plugin you wish to create.
-     * @param {Constructor} defaultType The constructor to provide the default Plugin type if
-     * the config object does not contain a &lt;code&gt;ptype&lt;/code&gt;. (Optional if the config contains a &lt;code&gt;ptype&lt;/code&gt;).
+     * @param {Function} defaultType (optional) The constructor to provide the default Plugin type if the config object does not
+     * contain a `ptype`. (Optional if the config contains a `ptype`).
      * @return {Ext.Component} The newly instantiated Plugin.
      */
     //create: function(plugin, defaultType) {
@@ -48,7 +76,7 @@ Ext.define('Ext.PluginManager', {
         } else {
             return Ext.createByAlias('plugin.' + (config.ptype || defaultType), config);
         }
-        
+
         // Prior system supported Singleton plugins.
         //var PluginCls = this.types[config.ptype || defaultType];
         //if (PluginCls.init) {
@@ -61,8 +89,9 @@ Ext.define('Ext.PluginManager', {
 <span id='Ext-PluginManager-method-findByType'>    /**
 </span>     * Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.
      * @param {String} type The type to search for
-     * @param {Boolean} defaultsOnly True to only return plugins of this type where the plugin's isDefault property is truthy
-     * @return {Array} All matching plugins
+     * @param {Boolean} defaultsOnly True to only return plugins of this type where the plugin's isDefault property is
+     * truthy
+     * @return {Ext.AbstractPlugin[]} All matching plugins
      */
     findByType: function(type, defaultsOnly) {
         var matches = [],
@@ -81,12 +110,12 @@ Ext.define('Ext.PluginManager', {
 
         return matches;
     }
-}, function() {    
+}, function() {
 <span id='Ext-method-preg'>    /**
 </span>     * Shorthand for {@link Ext.PluginManager#registerType}
      * @param {String} ptype The ptype mnemonic string by which the Plugin class
      * may be looked up.
-     * @param {Constructor} cls The new Plugin class.
+     * @param {Function} cls The new Plugin class.
      * @member Ext
      * @method preg
      */
@@ -94,4 +123,6 @@ Ext.define('Ext.PluginManager', {
         return Ext.PluginManager.registerType.apply(Ext.PluginManager, arguments);
     };
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>