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-build_from_html" name=".build_from_html"></a>
419 <div class="fixedFont">
420 <span class="attributes">Roo.XComponent.</span><b class="itemname">build_from_html</b> :
421 <span type="etype">true (default false)</span>
429 Build elements from html - used by bootstrap HTML stuff <br/> - this is cleared after build is completed
437 Build elements from html - used by bootstrap HTML stuff <br/> - this is cleared after build is completed
452 <tr class="property-row config-row-alt0 notInherited">
454 <a class="exi" href="#expand"> </a>
457 <a id="Roo.XComponent-prop-elmodules" name=".elmodules"></a>
458 <div class="fixedFont">
459 <span class="attributes">Roo.XComponent.</span><b class="itemname">elmodules</b> :
460 <span type="etype">of Roo.XComponent</span>
468 array of modules to be created by which use <b>ID</b>
476 array of modules to be created by which use <b>ID</b>
491 <tr class="property-row config-row-alt1 notInherited">
493 <a class="exi" href="#expand"> </a>
496 <a id="Roo.XComponent-prop-event" name=".event"></a>
497 <div class="fixedFont">
498 <span class="attributes">Roo.XComponent.</span><b class="itemname">event</b> :
499 <span type="etype"></span>
530 <tr class="property-row config-row-alt0 notInherited">
532 <a class="exi" href="#expand"> </a>
535 <a id="Roo.XComponent-prop-hideProgress" name=".hideProgress"></a>
536 <div class="fixedFont">
537 <span class="attributes">Roo.XComponent.</span><b class="itemname">hideProgress</b> :
538 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
546 true to disable the building progress bar.
554 true to disable the building progress bar.. usefull on single page renders.
569 <tr class="property-row config-row-alt1 notInherited">
571 <a class="exi" href="#expand"> </a>
574 <a id="Roo.XComponent-prop-modules" name=".modules"></a>
575 <div class="fixedFont">
576 <span class="attributes">Roo.XComponent.</span><b class="itemname">modules</b> :
577 <span type="etype">of Roo.XComponent</span>
585 array of modules to be created by registration system.
593 array of modules to be created by registration system.
608 <tr class="property-row config-row-alt0 notInherited">
610 <a class="exi" href="#expand"> </a>
613 <a id="Roo.XComponent-prop-on" name=".on"></a>
614 <div class="fixedFont">
615 <span class="attributes">Roo.XComponent.</span><b class="itemname">on</b> :
616 <span type="etype"></span>
624 wrapper for event.on - aliased later.
632 wrapper for event.on - aliased later.. <br/>Typically use to register a event handler for register:<br/><br/>eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
647 <tr class="property-row config-row-alt1 notInherited">
649 <a class="exi" href="#expand"> </a>
652 <a id="Roo.XComponent-prop-topModule" name=".topModule"></a>
653 <div class="fixedFont">
654 <span class="attributes">Roo.XComponent.</span><b class="itemname">topModule</b> :
655 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
663 the upper most module - uses document.element as it's constructor.
671 the upper most module - uses document.element as it's constructor.
687 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
688 <tr class="property-row alt">
695 <!-- ============================== methods summary / details ======================== -->
698 <a id="Roo.XComponent-methods"></a>
699 <!-- constructor?? -->
706 <!-- then dynamics first -->
713 <table cellspacing="0" class="member-table">
714 <caption>Public Methods</caption>
716 <th class="sig-header" colspan="2">Method</th>
717 <th class="msource-header">Defined By</th>
727 <tr class="method-row config-row-alt0 expandable notInherited">
728 <td class="micon"><a class="exi" href="#expand"> </a></td>
732 <a id="Roo-method-XComponent" name=".XComponent"></a>
733 <div class="fixedFont">
734 <span class="attributes">new <B>Roo.</B></span><b class="itemname">XComponent</b>
744 <div class="short">Create a new Roo.XComponent</div>
751 Create a new Roo.XComponent
754 <dl class="detailList">
755 <dt class="heading">Parameters:</dt>
761 <dd>{Object} configuration of component</dd>
785 <tr class="method-row config-row-alt1 expandable notInherited">
786 <td class="micon"><a class="exi" href="#expand"> </a></td>
790 <a id="Roo.XComponent-method-build" name=".build"></a>
791 <div class="fixedFont">
792 <span class="attributes">Roo.XComponent.</span><b class="itemname">build</b>
794 (<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>)
801 <div class="short">Build the registered modules.</div>
807 Build the registered modules.
814 <dl class="detailList">
815 <dt class="heading">Parameters:</dt>
818 <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>
824 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>optional</b>
827 <dd>method to call after module has been added.</dd>
853 <tr class="method-row config-row-alt0 expandable notInherited">
854 <td class="micon"><a class="exi" href="#expand"> </a></td>
858 <a id="Roo.XComponent-method-buildOrder" name=".buildOrder"></a>
859 <div class="fixedFont">
860 <span class="attributes">Roo.XComponent.</span><b class="itemname">buildOrder</b>
868 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
877 <div class="short">make a list of modules to build.</div>
883 make a list of modules to build.
894 <dl class="detailList">
895 <dt class="heading">Returns:</dt>
897 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> list of modules.</dd>
919 <tr class="method-row config-row-alt1 expandable notInherited">
920 <td class="micon"><a class="exi" href="#expand"> </a></td>
924 <a id="Roo.XComponent-method-preBuild" name=".preBuild"></a>
925 <div class="fixedFont">
926 <span class="attributes">Roo.XComponent.</span><b class="itemname">preBuild</b>
935 <div class="short">move modules into their correct place in the tree.</div>
941 move modules into their correct place in the tree..
970 <tr class="method-row config-row-alt0 expandable notInherited">
971 <td class="micon"><a class="exi" href="#expand"> </a></td>
975 <a id="Roo.XComponent-method-register" name=".register"></a>
976 <div class="fixedFont">
977 <span class="attributes">Roo.XComponent.</span><b class="itemname">register</b>
986 <div class="short">Register components to be built later.</div>
992 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
1013 <td class="msource">
1021 <tr class="method-row config-row-alt1 expandable notInherited">
1022 <td class="micon"><a class="exi" href="#expand"> </a></td>
1026 <a id="Roo.XComponent-method-toObject" name=".toObject"></a>
1027 <div class="fixedFont">
1028 <span class="attributes">Roo.XComponent.</span><b class="itemname">toObject</b>
1037 <div class="short">convert a string to an object.</div>
1043 convert a string to an object..<br/>eg. 'AAA.BBB' -> finds AAA.BBB
1064 <td class="msource">
1072 <tr class="method-row config-row-alt0 expandable">
1073 <td class="micon"><a class="exi" href="#expand"> </a></td>
1077 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1078 <div class="fixedFont">
1079 <span class="attributes"></span><b class="itemname">addEvents</b>
1081 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1088 <div class="short">Used to define events on this Observable</div>
1094 Used to define events on this Observable
1101 <dl class="detailList">
1102 <dt class="heading">Parameters:</dt>
1105 <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>
1108 <dd>The object with the events defined</dd>
1126 <td class="msource">
1128 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1134 <tr class="method-row config-row-alt1 expandable">
1135 <td class="micon"><a class="exi" href="#expand"> </a></td>
1139 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1140 <div class="fixedFont">
1141 <span class="attributes"></span><b class="itemname">addListener</b>
1143 (<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>)
1150 <div class="short">Appends an event handler to this component</div>
1156 Appends an event handler to this component
1163 <dl class="detailList">
1164 <dt class="heading">Parameters:</dt>
1167 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1170 <dd>The type of event to listen for</dd>
1173 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1176 <dd>The method the event invokes</dd>
1179 <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>
1182 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1185 <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>
1188 <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>
1206 <td class="msource">
1208 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1214 <tr class="method-row config-row-alt0 expandable">
1215 <td class="micon"><a class="exi" href="#expand"> </a></td>
1219 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1220 <div class="fixedFont">
1221 <span class="attributes"></span><b class="itemname">fireEvent</b>
1223 (<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>)
1229 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1238 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1244 Fires the specified event with the passed parameters (minus the event name).
1251 <dl class="detailList">
1252 <dt class="heading">Parameters:</dt>
1255 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1261 <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>
1264 <dd>Variable number of parameters are passed to handlers</dd>
1272 <dl class="detailList">
1273 <dt class="heading">Returns:</dt>
1275 <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>
1289 <td class="msource">
1291 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1297 <tr class="method-row config-row-alt1 expandable">
1298 <td class="micon"><a class="exi" href="#expand"> </a></td>
1302 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1303 <div class="fixedFont">
1304 <span class="attributes"></span><b class="itemname">hasListener</b>
1306 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1312 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1321 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1327 Checks to see if this object has any listeners for a specified event
1334 <dl class="detailList">
1335 <dt class="heading">Parameters:</dt>
1338 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1341 <dd>The name of the event to check for</dd>
1349 <dl class="detailList">
1350 <dt class="heading">Returns:</dt>
1352 <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>
1366 <td class="msource">
1368 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1374 <tr class="method-row config-row-alt0 expandable">
1375 <td class="micon"><a class="exi" href="#expand"> </a></td>
1379 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1380 <div class="fixedFont">
1381 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1390 <div class="short">Removes all listeners for this object</div>
1396 Removes all listeners for this object
1417 <td class="msource">
1419 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1425 <tr class="method-row config-row-alt1 expandable">
1426 <td class="micon"><a class="exi" href="#expand"> </a></td>
1430 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1431 <div class="fixedFont">
1432 <span class="attributes"></span><b class="itemname">removeListener</b>
1434 (<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>)
1441 <div class="short">Removes a listener</div>
1454 <dl class="detailList">
1455 <dt class="heading">Parameters:</dt>
1458 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1461 <dd>The type of event to listen for</dd>
1464 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1467 <dd>The handler to remove</dd>
1470 <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>
1473 <dd>(optional) The scope (this object) for the handler</dd>
1491 <td class="msource">
1493 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1499 <tr class="method-row config-row-alt0 expandable notInherited">
1500 <td class="micon"><a class="exi" href="#expand"> </a></td>
1504 <a id="Roo.XComponent-method-render" name=".render"></a>
1505 <div class="fixedFont">
1506 <span class="attributes"></span><b class="itemname">render</b>
1508 (<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>)
1515 <div class="short">render<br/>render element to dom or tree</div>
1521 render<br/>render element to dom or tree
1528 <dl class="detailList">
1529 <dt class="heading">Parameters:</dt>
1532 <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>
1535 <dd>render to if parent is not set.</dd>
1553 <td class="msource">
1561 <tr class="method-row config-row-alt1 expandable">
1562 <td class="micon"><a class="exi" href="#expand"> </a></td>
1566 <a id="Roo.util.Observable-method-un" name=".un"></a>
1567 <div class="fixedFont">
1568 <span class="attributes"></span><b class="itemname">un</b>
1570 (<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>)
1577 <div class="short">Removes a listener (shorthand for removeListener)</div>
1583 Removes a listener (shorthand for removeListener)
1590 <dl class="detailList">
1591 <dt class="heading">Parameters:</dt>
1594 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1597 <dd>The type of event to listen for</dd>
1600 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1603 <dd>The handler to remove</dd>
1606 <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>
1609 <dd>(optional) The scope (this object) for the handler</dd>
1627 <td class="msource">
1629 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1638 <!-- ============================== events summary / details ======================== -->
1641 <a id="Roo.XComponent-events"></a>
1650 <table cellspacing="0" class="member-table">
1651 <caption>Events</caption>
1654 <th class="sig-header" colspan="2">Event</th>
1655 <th class="msource-header">Defined By</th>
1664 <tr class="method-row expandable config-row-alt0 notInherited">
1665 <td class="micon"><a class="exi" href="#expand"> </a></td>
1668 <a id="Roo.XComponent-event-*built"></a>
1670 <div class="fixedFont">
1671 <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>)
1677 <div class="short">Fires when this the componnt is built
1683 Fires when this the componnt is built
1689 <dl class="detailList">
1690 <dt class="heading">Parameters:</dt>
1693 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
1696 <dd>the component</dd>
1714 <td class="msource">
1726 <!-- ============================== footer ================================= -->
1727 <div class="fineprint" style="clear:both">
1729 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Apr 24 2014 16:32:54 GMT+0800 (HKT)
1731 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>