webgui/www/extras/extjs/docs/output/Ext.ComponentMgr.html

104 lines
No EOL
5.1 KiB
HTML

<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>Ext.ComponentMgr</title>
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
<!-- GC -->
</head>
<body>
<div class="body-wrap">
<div class="top-tools">
<img src="../resources/print.gif" width="16" height="16" align="absmiddle">&nbsp;<a href="Ext.ComponentMgr.html" target="_blank">Print Friendly</a><br/>
</div>
<h1>Class Ext.ComponentMgr</h1>
<table cellspacing="0">
<tr><td class="label">Package:</td><td>Ext</td></tr>
<tr><td class="label">Class:</td><td>ComponentMgr</td></tr>
<tr><td class="label">Extends:</td><td>Object</td></tr>
<tr><td class="label">Defined In:</td><td><a href="Component.jss.html">Component.js</a></td></tr>
</table>
<div class="description">
Provides a common registry of all components on a page so that they can be easily accessed by component id.<br><br><i>This class is a singleton and cannot be created directly.</i> </div>
<br />
<a href="#properties">Properties</a>
&nbsp;&nbsp;-&nbsp;&nbsp;<a href="#methods">Methods</a>
&nbsp;&nbsp;-&nbsp;&nbsp;<a href="#events">Events</a>
<hr />
<a name="properties"></a>
<h2>Public Properties</h2>
<div class="no-members">This class has no public properties.</div> <a name="methods"></a>
<h2>Public Methods</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Method</th>
<th class="msource-header">Defined By</th>
</tr>
<tr>
<td class="micon" rowspan="2">&nbsp;</td>
<td class="sig"><a class="mlink" href="#get">get</a>(<code>String id</code>) : void</td>
<td class="msource" rowspan="2">ComponentMgr</td>
</tr>
<tr>
<td class="mdesc">Returns a component by id</td>
</tr>
<tr class="alt">
<td class="micon" rowspan="2">&nbsp;</td>
<td class="sig"><a class="mlink" href="#onAvailable">onAvailable</a>(<code>String id</code>, <code>Funtction fn</code>, <code>Object scope</code>) : void</td>
<td class="msource" rowspan="2">ComponentMgr</td>
</tr>
<tr class="alt">
<td class="mdesc">Registers a function that will be called when a specified component is added to ComponentMgr</td>
</tr>
</table>
<a name="events"></a>
<h2>Public Events</h2>
<div class="no-members">This class has no public events.</div>
<h2 class="mdetail-head">Method Details</h2>
<div class="detail-wrap">
<a name="get"></a>
<div class="mdetail">
<h3>get</i></h3>
<code>public function get(<code>String id</code>)</code>
<div class="mdetail-desc">
Returns a component by id
<div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>id</code> : String<div class="sub-desc">The component id</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
<div class="mdetail-def">This method is defined by ComponentMgr.</div>
</div>
<a name="onAvailable"></a>
<div class="mdetail alt">
<h3>onAvailable</i></h3>
<code>public function onAvailable(<code>String id</code>, <code>Funtction fn</code>, <code>Object scope</code>)</code>
<div class="mdetail-desc">
Registers a function that will be called when a specified component is added to ComponentMgr
<div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>id</code> : String<div class="sub-desc">The component id</div></li><li><code>fn</code> : Funtction<div class="sub-desc">The callback function</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope of the callback</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
<div class="mdetail-def">This method is defined by ComponentMgr.</div>
</div>
</div>
</div>
<hr>
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright &copy; 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
</body>
</html>