git.roojs.org Git - roojs1/blob - docs/src/Roo_ComponentMgr.js.html

   1 <html><head><title>Roo/ComponentMgr.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * &lt;script type=&quot;text/javascript&quot;&gt;
  10  */
  11
  12
  13 /**
  14  * @class Roo.ComponentMgr
  15  * Provides a common registry of all components on a page so that they can be easily accessed by component id (see {@link Roo.getCmp}).
  16  * @singleton
  17  */
  18 </span><span class="jsdoc-var">Roo.ComponentMgr </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  19     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">all </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Roo.util.MixedCollection</span><span class="jsdoc-syntax">();
  20
  21     </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
  22         </span><span class="jsdoc-comment">/**
  23          * Registers a component.
  24          * @param {Roo.Component} c The component
  25          */
  26         </span><span class="jsdoc-var">register </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">c</span><span class="jsdoc-syntax">){
  27             </span><span class="jsdoc-var">all.add</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">c</span><span class="jsdoc-syntax">);
  28         },
  29
  30         </span><span class="jsdoc-comment">/**
  31          * Unregisters a component.
  32          * @param {Roo.Component} c The component
  33          */
  34         </span><span class="jsdoc-var">unregister </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">c</span><span class="jsdoc-syntax">){
  35             </span><span class="jsdoc-var">all.remove</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">c</span><span class="jsdoc-syntax">);
  36         },
  37
  38         </span><span class="jsdoc-comment">/**
  39          * Returns a component by id
  40          * @param {String} id The component id
  41          */
  42         </span><span class="jsdoc-var">get </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">){
  43             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">all.get</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">);
  44         },
  45
  46         </span><span class="jsdoc-comment">/**
  47          * Registers a function that will be called when a specified component is added to ComponentMgr
  48          * @param {String} id The component id
  49          * @param {Funtction} fn The callback function
  50          * @param {Object} scope The scope of the callback
  51          */
  52         </span><span class="jsdoc-var">onAvailable </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">fn</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">scope</span><span class="jsdoc-syntax">){
  53             </span><span class="jsdoc-var">all.on</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;add&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">index</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">o</span><span class="jsdoc-syntax">){
  54                 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">o.id </span><span class="jsdoc-syntax">== </span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">){
  55                     </span><span class="jsdoc-var">fn.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">scope </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">o</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">o</span><span class="jsdoc-syntax">);
  56                     </span><span class="jsdoc-var">all.un</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;add&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">fn</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">scope</span><span class="jsdoc-syntax">);
  57                 }
  58             });
  59         }
  60     };
  61 }();</span></code></body></html>