1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.XComponent</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.XComponent-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.XComponent-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.XComponent-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.XComponent-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.XComponent
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_XComponent.js.html">Roo/XComponent.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">XComponent</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 A delayed Element creator...<br/>Or a way to group chunks of interface together.<br/><br/>Mypart.xyx = new Roo.XComponent({<br/><br/> parent : 'Mypart.xyz', // empty == document.element.!!<br/> order : '001',<br/> name : 'xxxx'<br/> region : 'xxxx'<br/> disabled : function() {} <br/> <br/> tree : function() { // return an tree of xtype declared components<br/> var MODULE = this;<br/> return <br/> {<br/> xtype : 'NestedLayoutPanel',<br/> // technicall<br/> }<br/> ]<br/>})<br/><br/><br/>It can be used to build a big heiracy, with parent etc.<br/>or you can just use this to render a single compoent to a dom element<br/>MYPART.render(Roo.Element | String(id) | dom_element )
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.XComponent';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.XComponent.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.XComponent-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.XComponent-cfg-disabled" name=".disabled"></a>
132 <div class="fixedFont">
133 <b class="itemname">disabled</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>|boolean
139 <div class="short">If this module is disabled by some rule, return true from the funtion</div>
143 <div class="long">If this module is disabled by some rule, return true from the funtion</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.XComponent-cfg-items" name=".items"></a>
162 <div class="fixedFont">
163 <b class="itemname">items</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
169 <div class="short">A single item array - the first element is the root of the tree.</div>
173 <div class="long">A single item array - the first element is the root of the tree..<br/>It's done this way to stay compatible with the Xtype system...</div>
187 <tr class="config-row expandable config-row-alt0">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
192 <div class="fixedFont">
193 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
199 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
203 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
211 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.XComponent-cfg-name" name=".name"></a>
222 <div class="fixedFont">
223 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
229 <div class="short">String to display while loading.</div>
233 <div class="long">String to display while loading.</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.XComponent-cfg-order" name=".order"></a>
252 <div class="fixedFont">
253 <b class="itemname">order</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">Used to set the order in which elements are created (usefull for multiple tabs)</div>
263 <div class="long">Used to set the order in which elements are created (usefull for multiple tabs)</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.XComponent-cfg-parent" name=".parent"></a>
282 <div class="fixedFont">
283 <b class="itemname">parent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
289 <div class="short">Name of parent element which it get xtype added to.</div>
293 <div class="long">Name of parent element which it get xtype added to..</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.XComponent-cfg-region" name=".region"></a>
312 <div class="fixedFont">
313 <b class="itemname">region</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
319 <div class="short">Region to render component to (defaults to center)</div>
323 <div class="long">Region to render component to (defaults to center)</div>
347 <!-- ============================== public properties ==================== -->
351 <a id="Roo.XComponent-props"></a>
359 <table cellspacing="0" class="member-table">
360 <caption>Public Properties </caption>
362 <th class="sig-header" colspan="2">Property</th>
363 <th class="sig-header">Description</th>
364 <th class="msource-header">Defined By</th>
374 <tr class="property-row config-row-alt0 notInherited">
376 <a class="exi" href="#expand"> </a>
379 <a id="Roo.XComponent-prop-buildCompleted" name=".buildCompleted"></a>
380 <div class="fixedFont">
381 <span class="attributes">Roo.XComponent.</span><b class="itemname">buildCompleted</b> :
382 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
390 True when the builder has completed building the interface.
398 True when the builder has completed building the interface.
413 <tr class="property-row config-row-alt1 notInherited">
415 <a class="exi" href="#expand"> </a>
418 <a id="Roo.XComponent-prop-elmodules" name=".elmodules"></a>
419 <div class="fixedFont">
420 <span class="attributes">Roo.XComponent.</span><b class="itemname">elmodules</b> :
421 <span type="etype">of Roo.XComponent</span>
429 array of modules to be created by which use <b>ID</b>
437 array of modules to be created by which use <b>ID</b>
452 <tr class="property-row config-row-alt0 notInherited">
454 <a class="exi" href="#expand"> </a>
457 <a id="Roo.XComponent-prop-modules" name=".modules"></a>
458 <div class="fixedFont">
459 <span class="attributes">Roo.XComponent.</span><b class="itemname">modules</b> :
460 <span type="etype">of Roo.XComponent</span>
468 array of modules to be created by registration system.
476 array of modules to be created by registration system.
491 <tr class="property-row config-row-alt1 notInherited">
493 <a class="exi" href="#expand"> </a>
496 <a id="Roo.XComponent-prop-topModule" name=".topModule"></a>
497 <div class="fixedFont">
498 <span class="attributes">Roo.XComponent.</span><b class="itemname">topModule</b> :
499 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
507 the upper most module - uses document.element as it's constructor.
515 the upper most module - uses document.element as it's constructor.
531 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
532 <tr class="property-row alt">
539 <!-- ============================== methods summary / details ======================== -->
542 <a id="Roo.XComponent-methods"></a>
543 <!-- constructor?? -->
550 <!-- then dynamics first -->
557 <table cellspacing="0" class="member-table">
558 <caption>Public Methods</caption>
560 <th class="sig-header" colspan="2">Method</th>
561 <th class="msource-header">Defined By</th>
571 <tr class="method-row config-row-alt0 expandable notInherited">
572 <td class="micon"><a class="exi" href="#expand"> </a></td>
576 <a id="Roo-method-XComponent" name=".XComponent"></a>
577 <div class="fixedFont">
578 <span class="attributes">new <B>Roo.</B></span><b class="itemname">XComponent</b>
588 <div class="short">Create a new Roo.XComponent</div>
595 Create a new Roo.XComponent
598 <dl class="detailList">
599 <dt class="heading">Parameters:</dt>
605 <dd>{Object} configuration of component</dd>
629 <tr class="method-row config-row-alt1 expandable notInherited">
630 <td class="micon"><a class="exi" href="#expand"> </a></td>
634 <a id="Roo.XComponent-method-build" name=".build"></a>
635 <div class="fixedFont">
636 <span class="attributes">Roo.XComponent.</span><b class="itemname">build</b>
638 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>parent</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>optional</i></B>)
645 <div class="short">Build the registered modules.</div>
651 Build the registered modules.
658 <dl class="detailList">
659 <dt class="heading">Parameters:</dt>
662 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>parent</b>
668 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>optional</b>
671 <dd>method to call after module has been added.</dd>
697 <tr class="method-row config-row-alt0 expandable notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
702 <a id="Roo.XComponent-method-buildOrder" name=".buildOrder"></a>
703 <div class="fixedFont">
704 <span class="attributes">Roo.XComponent.</span><b class="itemname">buildOrder</b>
712 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
721 <div class="short">make a list of modules to build.</div>
727 make a list of modules to build.
738 <dl class="detailList">
739 <dt class="heading">Returns:</dt>
741 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> list of modules.</dd>
763 <tr class="method-row config-row-alt1 expandable notInherited">
764 <td class="micon"><a class="exi" href="#expand"> </a></td>
768 <a id="Roo.XComponent-method-preBuild" name=".preBuild"></a>
769 <div class="fixedFont">
770 <span class="attributes">Roo.XComponent.</span><b class="itemname">preBuild</b>
779 <div class="short">move modules into their correct place in the tree.</div>
785 move modules into their correct place in the tree..
814 <tr class="method-row config-row-alt0 expandable notInherited">
815 <td class="micon"><a class="exi" href="#expand"> </a></td>
819 <a id="Roo.XComponent-method-register" name=".register"></a>
820 <div class="fixedFont">
821 <span class="attributes">Roo.XComponent.</span><b class="itemname">register</b>
830 <div class="short">Register components to be built later.</div>
836 Register components to be built later.<br/><br/>This solves the following issues<br/>- Building is not done on page load, but after an authentication process has occured.<br/>- Interface elements are registered on page load<br/>- Parent Interface elements may not be loaded before child, so this handles that..<br/><br/><br/>example:<br/><br/>MyApp.register({<br/> order : '000001',<br/> module : 'Pman.Tab.projectMgr',<br/> region : 'center',<br/> parent : 'Pman.layout',<br/> disabled : false, // or use a function..<br/> })<br/>* <b>param</b> {Object} details about module
865 <tr class="method-row config-row-alt1 expandable notInherited">
866 <td class="micon"><a class="exi" href="#expand"> </a></td>
870 <a id="Roo.XComponent-method-toObject" name=".toObject"></a>
871 <div class="fixedFont">
872 <span class="attributes">Roo.XComponent.</span><b class="itemname">toObject</b>
881 <div class="short">convert a string to an object.</div>
887 convert a string to an object..<br/>eg. 'AAA.BBB' -> finds AAA.BBB
916 <tr class="method-row config-row-alt0 expandable">
917 <td class="micon"><a class="exi" href="#expand"> </a></td>
921 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
922 <div class="fixedFont">
923 <span class="attributes"></span><b class="itemname">addEvents</b>
925 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
932 <div class="short">Used to define events on this Observable</div>
938 Used to define events on this Observable
945 <dl class="detailList">
946 <dt class="heading">Parameters:</dt>
949 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
952 <dd>The object with the events defined</dd>
972 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
978 <tr class="method-row config-row-alt1 expandable">
979 <td class="micon"><a class="exi" href="#expand"> </a></td>
983 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
984 <div class="fixedFont">
985 <span class="attributes"></span><b class="itemname">addListener</b>
987 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
994 <div class="short">Appends an event handler to this component</div>
1000 Appends an event handler to this component
1007 <dl class="detailList">
1008 <dt class="heading">Parameters:</dt>
1011 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1014 <dd>The type of event to listen for</dd>
1017 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1020 <dd>The method the event invokes</dd>
1023 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1026 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1029 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1032 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
1050 <td class="msource">
1052 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1058 <tr class="method-row config-row-alt0 expandable">
1059 <td class="micon"><a class="exi" href="#expand"> </a></td>
1063 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1064 <div class="fixedFont">
1065 <span class="attributes"></span><b class="itemname">fireEvent</b>
1067 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1073 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1082 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1088 Fires the specified event with the passed parameters (minus the event name).
1095 <dl class="detailList">
1096 <dt class="heading">Parameters:</dt>
1099 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1105 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
1108 <dd>Variable number of parameters are passed to handlers</dd>
1116 <dl class="detailList">
1117 <dt class="heading">Returns:</dt>
1119 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
1133 <td class="msource">
1135 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1141 <tr class="method-row config-row-alt1 expandable">
1142 <td class="micon"><a class="exi" href="#expand"> </a></td>
1146 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1147 <div class="fixedFont">
1148 <span class="attributes"></span><b class="itemname">hasListener</b>
1150 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1156 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1165 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1171 Checks to see if this object has any listeners for a specified event
1178 <dl class="detailList">
1179 <dt class="heading">Parameters:</dt>
1182 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1185 <dd>The name of the event to check for</dd>
1193 <dl class="detailList">
1194 <dt class="heading">Returns:</dt>
1196 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1210 <td class="msource">
1212 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1218 <tr class="method-row config-row-alt0 expandable">
1219 <td class="micon"><a class="exi" href="#expand"> </a></td>
1223 <a id="Roo.util.Observable-method-on" name=".on"></a>
1224 <div class="fixedFont">
1225 <span class="attributes"></span><b class="itemname">on</b>
1227 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1234 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1240 Appends an event handler to this element (shorthand for addListener)
1247 <dl class="detailList">
1248 <dt class="heading">Parameters:</dt>
1251 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1254 <dd>The type of event to listen for</dd>
1257 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1260 <dd>The method the event invokes</dd>
1263 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1266 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1269 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1290 <td class="msource">
1292 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1298 <tr class="method-row config-row-alt1 expandable">
1299 <td class="micon"><a class="exi" href="#expand"> </a></td>
1303 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1304 <div class="fixedFont">
1305 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1314 <div class="short">Removes all listeners for this object</div>
1320 Removes all listeners for this object
1341 <td class="msource">
1343 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1349 <tr class="method-row config-row-alt0 expandable">
1350 <td class="micon"><a class="exi" href="#expand"> </a></td>
1354 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1355 <div class="fixedFont">
1356 <span class="attributes"></span><b class="itemname">removeListener</b>
1358 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1365 <div class="short">Removes a listener</div>
1378 <dl class="detailList">
1379 <dt class="heading">Parameters:</dt>
1382 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1385 <dd>The type of event to listen for</dd>
1388 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1391 <dd>The handler to remove</dd>
1394 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1397 <dd>(optional) The scope (this object) for the handler</dd>
1415 <td class="msource">
1417 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1423 <tr class="method-row config-row-alt1 expandable notInherited">
1424 <td class="micon"><a class="exi" href="#expand"> </a></td>
1428 <a id="Roo.XComponent-method-render" name=".render"></a>
1429 <div class="fixedFont">
1430 <span class="attributes"></span><b class="itemname">render</b>
1432 (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>|<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DomElement <B><i>optional</i></B>)
1439 <div class="short">render<br/>render element to dom or tree</div>
1445 render<br/>render element to dom or tree
1452 <dl class="detailList">
1453 <dt class="heading">Parameters:</dt>
1456 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>|<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DomElement</span> <b>optional</b>
1459 <dd>render to if parent is not set.</dd>
1477 <td class="msource">
1485 <tr class="method-row config-row-alt0 expandable">
1486 <td class="micon"><a class="exi" href="#expand"> </a></td>
1490 <a id="Roo.util.Observable-method-un" name=".un"></a>
1491 <div class="fixedFont">
1492 <span class="attributes"></span><b class="itemname">un</b>
1494 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1501 <div class="short">Removes a listener (shorthand for removeListener)</div>
1507 Removes a listener (shorthand for removeListener)
1514 <dl class="detailList">
1515 <dt class="heading">Parameters:</dt>
1518 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1521 <dd>The type of event to listen for</dd>
1524 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1527 <dd>The handler to remove</dd>
1530 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1533 <dd>(optional) The scope (this object) for the handler</dd>
1551 <td class="msource">
1553 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1562 <!-- ============================== events summary / details ======================== -->
1565 <a id="Roo.XComponent-events"></a>
1574 <table cellspacing="0" class="member-table">
1575 <caption>Events</caption>
1578 <th class="sig-header" colspan="2">Event</th>
1579 <th class="msource-header">Defined By</th>
1588 <tr class="method-row expandable config-row-alt0 notInherited">
1589 <td class="micon"><a class="exi" href="#expand"> </a></td>
1592 <a id="Roo.XComponent-event-*buildcomplete"></a>
1594 <div class="fixedFont">
1595 <b class="itemname">buildcomplete</b> (<a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a> <B><i>c</i></B>)
1601 <div class="short">Fires on the top level element when all elements have been built
1607 Fires on the top level element when all elements have been built
1613 <dl class="detailList">
1614 <dt class="heading">Parameters:</dt>
1617 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
1620 <dd>the top level component.</dd>
1638 <td class="msource">
1643 <tr class="method-row expandable config-row-alt1 notInherited">
1644 <td class="micon"><a class="exi" href="#expand"> </a></td>
1647 <a id="Roo.XComponent-event-*built"></a>
1649 <div class="fixedFont">
1650 <b class="itemname">built</b> (<a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a> <B><i>c</i></B>)
1656 <div class="short">Fires when this the componnt is built
1662 Fires when this the componnt is built
1668 <dl class="detailList">
1669 <dt class="heading">Parameters:</dt>
1672 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
1675 <dd>the component</dd>
1693 <td class="msource">
1705 <!-- ============================== footer ================================= -->
1706 <div class="fineprint" style="clear:both">
1708 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Dec 16 2011 12:06:03 GMT+0800 (HKT)
1710 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>