docs/api/Ext.PluginManager.html

   1 <!DOCTYPE html><html><head><title>Ext.PluginManager | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.PluginManager',
  13         docClass: 'Ext.PluginManager',
  14         docReq: 'Ext.PluginManager',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'PluginManager.html#Ext-PluginManager';
  33     clsInfo = {"methods":["create","each","findByType","get","getCount","isRegistered","onAvailable","register","registerType","unregister"],"cfgs":[],"properties":["all"],"events":[],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/PluginManager.html#Ext-PluginManager" target="_blank">Ext.PluginManager</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.AbstractManager.html" rel="Ext.AbstractManager" class="cls docClass">Ext.AbstractManager</a><div class="subclass"><strong>Ext.PluginManager</strong></div></div></pre><p>Provides a registry of available Plugin <i>classes</i> indexed by a mnemonic code known as the Plugin's ptype.
  38 The <code><a href="Ext.Component.html#xtype" rel="Ext.Component#xtype" class="docClass">xtype</a></code> provides a way to avoid instantiating child Components
  39 when creating a full, nested config object for a complete <a href="Ext.html" rel="Ext" class="docClass">Ext</a> page.</p>
  40
  41
  42 <p>A child Component may be specified simply as a <i>config object</i>
  43 as long as the correct <code><a href="Ext.Component.html#xtype" rel="Ext.Component#xtype" class="docClass">xtype</a></code> is specified so that if and when the Component
  44 needs rendering, the correct type can be looked up for lazy instantiation.</p>
  45
  46
  47 <p>For a list of all available <code><a href="Ext.Component.html#xtype" rel="Ext.Component#xtype" class="docClass">xtypes</a></code>, see <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>.</p>
  48
  49 <div class="members"><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-all" class="member f inherited"><a href="Ext.PluginManager.html#property-all" rel="property-all" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-property-all" class="viewSource">view source</a></div><a name="all"></a><a name="property-all"></a><a href="Ext.PluginManager.html#" rel="property-all" class="cls expand">all</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>Contains all of the items currently managed</p>
  50 </div><div class="long"><p>Contains all of the items currently managed</p>
  51 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-create" class="member f ni"><a href="Ext.PluginManager.html#method-create" rel="method-create" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.PluginManager.html" class="definedIn docClass">Ext.PluginManager</a><br/><a href="../source/PluginManager.html#Ext-PluginManager-method-create" class="viewSource">view source</a></div><a name="create"></a><a name="method-create"></a><a href="Ext.PluginManager.html#" rel="method-create" class="cls expand">create</a>(
  52 <span class="pre">Object config, Constructor defaultType</span>)
  53  : Ext.Component</div><div class="description"><div class="short">Creates a new Plugin from the specified config object using the
  54 config object's ptype to determine the class to insta...</div><div class="long"><p>Creates a new Plugin from the specified config object using the
  55 config object's ptype to determine the class to instantiate.</p>
  56 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>A configuration object for the Plugin you wish to create.</p>
  57 </div></li><li><span class="pre">defaultType</span> : Constructor<div class="sub-desc"><p>The constructor to provide the default Plugin type if
  58 the config object does not contain a <code>ptype</code>. (Optional if the config contains a <code>ptype</code>).</p>
  59 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>The newly instantiated Plugin.</p>
  60 </li></ul></div></div></div><div id="method-each" class="member inherited"><a href="Ext.PluginManager.html#method-each" rel="method-each" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-each" class="viewSource">view source</a></div><a name="each"></a><a name="method-each"></a><a href="Ext.PluginManager.html#" rel="method-each" class="cls expand">each</a>(
  61 <span class="pre">Object fn, Object scope</span>)
  62  : void</div><div class="description"><div class="short">Executes the specified function once for each item in the collection.
  63 Returning false from the function will cease it...</div><div class="long"><p>Executes the specified function once for each item in the collection.
  64 Returning false from the function will cease iteration.</p>
  65
  66 <p>The paramaters passed to the function are:</p>
  67
  68 <div class="mdetail-params"><ul>
  69 <li><b>key</b> : String<p class="sub-desc">The key of the item</p></li>
  70 <li><b>value</b> : Number<p class="sub-desc">The value of the item</p></li>
  71 <li><b>length</b> : Number<p class="sub-desc">The total number of items in the collection</p></li>
  72 </ul></div>
  73
  74 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Object<div class="sub-desc"><p>The function to execute.</p>
  75 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>The scope to execute in. Defaults to <tt>this</tt>.</p>
  76 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
  77 </li></ul></div></div></div><div id="method-findByType" class="member ni"><a href="Ext.PluginManager.html#method-findByType" rel="method-findByType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.PluginManager.html" class="definedIn docClass">Ext.PluginManager</a><br/><a href="../source/PluginManager.html#Ext-PluginManager-method-findByType" class="viewSource">view source</a></div><a name="findByType"></a><a name="method-findByType"></a><a href="Ext.PluginManager.html#" rel="method-findByType" class="cls expand">findByType</a>(
  78 <span class="pre">String type, Boolean defaultsOnly</span>)
  79  : Array</div><div class="description"><div class="short"><p>Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.</p>
  80 </div><div class="long"><p>Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.</p>
  81 <h3 class="pa">Parameters</h3><ul><li><span class="pre">type</span> : String<div class="sub-desc"><p>The type to search for</p>
  82 </div></li><li><span class="pre">defaultsOnly</span> : Boolean<div class="sub-desc"><p>True to only return plugins of this type where the plugin's isDefault property is truthy</p>
  83 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>All matching plugins</p>
  84 </li></ul></div></div></div><div id="method-get" class="member inherited"><a href="Ext.PluginManager.html#method-get" rel="method-get" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-get" class="viewSource">view source</a></div><a name="get"></a><a name="method-get"></a><a href="Ext.PluginManager.html#" rel="method-get" class="cls expand">get</a>(
  85 <span class="pre">String id</span>)
  86  : Mixed</div><div class="description"><div class="short"><p>Returns an item by id.
  87 For additional details see <a href="Ext.util.HashMap.html#get" rel="Ext.util.HashMap#get" class="docClass">Ext.util.HashMap.get</a>.</p>
  88 </div><div class="long"><p>Returns an item by id.
  89 For additional details see <a href="Ext.util.HashMap.html#get" rel="Ext.util.HashMap#get" class="docClass">Ext.util.HashMap.get</a>.</p>
  90 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the item</p>
  91 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>The item, <code>undefined</code> if not found.</p>
  92 </li></ul></div></div></div><div id="method-getCount" class="member inherited"><a href="Ext.PluginManager.html#method-getCount" rel="method-getCount" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-getCount" class="viewSource">view source</a></div><a name="getCount"></a><a name="method-getCount"></a><a href="Ext.PluginManager.html#" rel="method-getCount" class="cls expand">getCount</a> : Number</div><div class="description"><div class="short"><p>Gets the number of items in the collection.</p>
  93 </div><div class="long"><p>Gets the number of items in the collection.</p>
  94 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The number of items in the collection.</p>
  95 </li></ul></div></div></div><div id="method-isRegistered" class="member inherited"><a href="Ext.PluginManager.html#method-isRegistered" rel="method-isRegistered" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-isRegistered" class="viewSource">view source</a></div><a name="isRegistered"></a><a name="method-isRegistered"></a><a href="Ext.PluginManager.html#" rel="method-isRegistered" class="cls expand">isRegistered</a>(
  96 <span class="pre">String type</span>)
  97  : Boolean</div><div class="description"><div class="short"><p>Checks if an item type is registered.</p>
  98 </div><div class="long"><p>Checks if an item type is registered.</p>
  99 <h3 class="pa">Parameters</h3><ul><li><span class="pre">type</span> : String<div class="sub-desc"><p>The mnemonic string by which the class may be looked up</p>
 100 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>Whether the type is registered.</p>
 101 </li></ul></div></div></div><div id="method-onAvailable" class="member inherited"><a href="Ext.PluginManager.html#method-onAvailable" rel="method-onAvailable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-onAvailable" class="viewSource">view source</a></div><a name="onAvailable"></a><a name="method-onAvailable"></a><a href="Ext.PluginManager.html#" rel="method-onAvailable" class="cls expand">onAvailable</a>(
 102 <span class="pre">String id, Function fn, Object scope</span>)
 103  : void</div><div class="description"><div class="short">Registers a function that will be called when an item with the specified id is added to the manager. This will happen...</div><div class="long"><p>Registers a function that will be called when an item with the specified id is added to the manager. This will happen on instantiation.</p>
 104 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>The item id</p>
 105 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The callback function. Called with a single parameter, the item.</p>
 106 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>The scope (<code>this</code> reference) in which the callback is executed. Defaults to the item.</p>
 107 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 108 </li></ul></div></div></div><div id="method-register" class="member inherited"><a href="Ext.PluginManager.html#method-register" rel="method-register" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-register" class="viewSource">view source</a></div><a name="register"></a><a name="method-register"></a><a href="Ext.PluginManager.html#" rel="method-register" class="cls expand">register</a>(
 109 <span class="pre">Mixed item</span>)
 110  : void</div><div class="description"><div class="short"><p>Registers an item to be managed</p>
 111 </div><div class="long"><p>Registers an item to be managed</p>
 112 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Mixed<div class="sub-desc"><p>The item to register</p>
 113 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 114 </li></ul></div></div></div><div id="method-registerType" class="member inherited"><a href="Ext.PluginManager.html#method-registerType" rel="method-registerType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-registerType" class="viewSource">view source</a></div><a name="registerType"></a><a name="method-registerType"></a><a href="Ext.PluginManager.html#" rel="method-registerType" class="cls expand">registerType</a>(
 115 <span class="pre">String type, Constructor cls</span>)
 116  : void</div><div class="description"><div class="short"><p>Registers a new item constructor, keyed by a type key.
 117
 118 </div><div class="long"><p>Registers a new item constructor, keyed by a type key.
 119
 120 <h3 class="pa">Parameters</h3><ul><li><span class="pre">type</span> : String<div class="sub-desc"><p>The mnemonic string by which the class may be looked up.</p>
 121 </div></li><li><span class="pre">cls</span> : Constructor<div class="sub-desc"><p>The new instance class.</p>
 122 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 123 </li></ul></div></div></div><div id="method-unregister" class="member inherited"><a href="Ext.PluginManager.html#method-unregister" rel="method-unregister" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractManager.html" class="definedIn docClass">Ext.AbstractManager</a><br/><a href="../source/AbstractManager.html#Ext-AbstractManager-method-unregister" class="viewSource">view source</a></div><a name="unregister"></a><a name="method-unregister"></a><a href="Ext.PluginManager.html#" rel="method-unregister" class="cls expand">unregister</a>(
 124 <span class="pre">Mixed item</span>)
 125  : void</div><div class="description"><div class="short"><p>Unregisters an item by removing it from this manager</p>
 126 </div><div class="long"><p>Unregisters an item by removing it from this manager</p>
 127 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Mixed<div class="sub-desc"><p>The item to unregister</p>
 128 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 129 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>