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>
49 A delayed Element creator...
51 Mypart.xyx = new Roo.XComponent({
53 parent : 'Mypart.xyz', // empty == document.element.!!
57 disabled : function() {}
63 xtype : 'NestedLayoutPanel',
68 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.XComponent
73 <!-- ============================== class title / details ============================ -->
76 <h1 class="classTitle">
81 <table cellspacing="0" class="class-summary-table">
83 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
85 <tr><td class="label">Defined In:</td><td class="hd-info">
87 <a href="./src/Roo_XComponent.js.html">Roo/XComponent.js</a>.
90 <tr><td class="label">Class:</td><td class="hd-info">XComponent</td></tr>
95 <tr><td class="label">Extends:</td><td class="hd-info">
96 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
99 A delayed Element creator...
101 Mypart.xyx = new Roo.XComponent({
103 parent : 'Mypart.xyz', // empty == document.element.!!
107 disabled : function() {}
113 xtype : 'NestedLayoutPanel',
125 <!-- ============================== class summary ========================== -->
126 <div class="description">
127 This needs some more thought..
131 <!-- ============================== Class comment block... ========================== -->
133 <div class="comments">
134 <b>Class Comments / Notes</B> =>
135 <u onclick="parent.CommentDialog.showCommentId = 'Roo.XComponent';">[Add Your comment/notes about this class]</u>
137 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
138 src="/blog.php/GtkDjsComments/Roo.XComponent.html"></iframe>
143 <!-- ============================== config options ========================== -->
148 <div class="hr"></div>
149 <a id="Roo.XComponent-configs"></a>
155 <table cellspacing="0" class="member-table">
156 <caption>Config Options (Usually are also Properties)</caption>
160 <th class="sig-header" colspan="2">Options</th>
162 <th class="msource-header">Defined By</th>
169 <tr class="config-row expandable config-row-alt0 notInherited">
170 <td class="micon"><a class="exi" href="#expand"> </a></td>
173 <a id="Roo.XComponent-cfg-disabled" name=".disabled"></a>
174 <div class="fixedFont">
175 <b class="itemname">disabled</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>|boolean
181 <div class="short">If this module is disabled by some rule, return true from the funtion</div>
185 <div class="long">If this module is disabled by some rule, return true from the funtion</div>
199 <tr class="config-row expandable config-row-alt1 notInherited">
200 <td class="micon"><a class="exi" href="#expand"> </a></td>
203 <a id="Roo.XComponent-cfg-items" name=".items"></a>
204 <div class="fixedFont">
205 <b class="itemname">items</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
211 <div class="short">A single item array - the first element is the root of the tree.</div>
215 <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>
229 <tr class="config-row expandable config-row-alt0 notInherited">
230 <td class="micon"><a class="exi" href="#expand"> </a></td>
233 <a id="Roo.XComponent-cfg-name" name=".name"></a>
234 <div class="fixedFont">
235 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
241 <div class="short">String to display while loading.</div>
245 <div class="long">String to display while loading.</div>
259 <tr class="config-row expandable config-row-alt1 notInherited">
260 <td class="micon"><a class="exi" href="#expand"> </a></td>
263 <a id="Roo.XComponent-cfg-order" name=".order"></a>
264 <div class="fixedFont">
265 <b class="itemname">order</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
271 <div class="short">Used to set the order in which elements are created (usefull for multiple tabs)</div>
275 <div class="long">Used to set the order in which elements are created (usefull for multiple tabs)</div>
289 <tr class="config-row expandable config-row-alt0 notInherited">
290 <td class="micon"><a class="exi" href="#expand"> </a></td>
293 <a id="Roo.XComponent-cfg-parent" name=".parent"></a>
294 <div class="fixedFont">
295 <b class="itemname">parent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
301 <div class="short">Name of parent element which it get xtype added to.</div>
305 <div class="long">Name of parent element which it get xtype added to..</div>
329 <!-- ============================== public properties ==================== -->
333 <a id="Roo.XComponent-props"></a>
341 <table cellspacing="0" class="member-table">
342 <caption>Public Properties </caption>
344 <th class="sig-header" colspan="2">Property</th>
345 <th class="sig-header">Description</th>
346 <th class="msource-header">Defined By</th>
356 <tr class="property-row config-row-alt0 notInherited">
358 <a class="exi" href="#expand"> </a>
361 <a id="Roo.XComponent-prop-buildCompleted" name=".buildCompleted"></a>
362 <div class="fixedFont">
363 <span class="attributes">Roo.XComponent.</span><b class="itemname">buildCompleted</b> :
364 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
372 True when the builder has completed building the interface.
380 True when the builder has completed building the interface.
395 <tr class="property-row config-row-alt1 notInherited">
397 <a class="exi" href="#expand"> </a>
400 <a id="Roo.XComponent-prop-modules" name=".modules"></a>
401 <div class="fixedFont">
402 <span class="attributes">Roo.XComponent.</span><b class="itemname">modules</b> :
403 <span type="etype"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span>
411 array of modules to be created by registration system.
419 array of modules to be created by registration system.
434 <tr class="property-row config-row-alt0 notInherited">
436 <a class="exi" href="#expand"> </a>
439 <a id="Roo.XComponent-prop-topModule" name=".topModule"></a>
440 <div class="fixedFont">
441 <span class="attributes">Roo.XComponent.</span><b class="itemname">topModule</b> :
442 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
450 the upper most module - uses document.element as it's constructor.
458 the upper most module - uses document.element as it's constructor.
474 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
475 <tr class="property-row alt">
482 <!-- ============================== methods summary / details ======================== -->
485 <a id="Roo.XComponent-methods"></a>
486 <!-- constructor?? -->
493 <!-- then dynamics first -->
500 <table cellspacing="0" class="member-table">
501 <caption>Public Methods</caption>
503 <th class="sig-header" colspan="2">Method</th>
504 <th class="msource-header">Defined By</th>
514 <tr class="method-row config-row-alt0 notInherited">
515 <td class="micon"><a class="exi" href="#expand"> </a></td>
519 <a id="Roo-method-XComponent" name=".XComponent"></a>
520 <div class="fixedFont">
521 <span class="attributes">new <B>Roo.</B></span><b class="itemname">XComponent</b>
531 <div class="short">Create a new Roo.XComponent</div>
538 Create a new Roo.XComponent
561 <tr class="method-row config-row-alt1 expandable notInherited">
562 <td class="micon"><a class="exi" href="#expand"> </a></td>
566 <a id="Roo.XComponent-method-build" name=".build"></a>
567 <div class="fixedFont">
568 <span class="attributes">Roo.XComponent.</span><b class="itemname">build</b>
570 (<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>)
577 <div class="short">Build the registered modules.</div>
583 Build the registered modules.
590 <dl class="detailList">
591 <dt class="heading">Parameters:</dt>
594 <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>
600 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>optional</b>
603 <dd>method to call after module has been added.</dd>
629 <tr class="method-row config-row-alt0 expandable notInherited">
630 <td class="micon"><a class="exi" href="#expand"> </a></td>
634 <a id="Roo.XComponent-method-buildOrder" name=".buildOrder"></a>
635 <div class="fixedFont">
636 <span class="attributes">Roo.XComponent.</span><b class="itemname">buildOrder</b>
644 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
653 <div class="short">make a list of modules to build.</div>
659 make a list of modules to build.
670 <dl class="detailList">
671 <dt class="heading">Returns:</dt>
673 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> list of modules.</dd>
695 <tr class="method-row config-row-alt1 expandable notInherited">
696 <td class="micon"><a class="exi" href="#expand"> </a></td>
700 <a id="Roo.XComponent-method-preBuild" name=".preBuild"></a>
701 <div class="fixedFont">
702 <span class="attributes">Roo.XComponent.</span><b class="itemname">preBuild</b>
711 <div class="short">move modules into their correct place in the tree.</div>
717 move modules into their correct place in the tree..
746 <tr class="method-row config-row-alt0 expandable notInherited">
747 <td class="micon"><a class="exi" href="#expand"> </a></td>
751 <a id="Roo.XComponent-method-register" name=".register"></a>
752 <div class="fixedFont">
753 <span class="attributes">Roo.XComponent.</span><b class="itemname">register</b>
755 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>details</i></B>)
762 <div class="short">Register components to be built later.</div>
768 Register components to be built later.
775 <dl class="detailList">
776 <dt class="heading">Parameters:</dt>
779 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>details</b>
782 <dd>about module<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/> })</dd>
808 <tr class="method-row config-row-alt1 expandable notInherited">
809 <td class="micon"><a class="exi" href="#expand"> </a></td>
813 <a id="Roo.XComponent-method-toObject" name=".toObject"></a>
814 <div class="fixedFont">
815 <span class="attributes">Roo.XComponent.</span><b class="itemname">toObject</b>
824 <div class="short">convert a string to an object.</div>
830 convert a string to an object..
862 <!-- ============================== events summary / details ======================== -->
865 <a id="Roo.XComponent-events"></a>
874 <table cellspacing="0" class="member-table">
875 <caption>Events</caption>
878 <th class="sig-header" colspan="2">Event</th>
879 <th class="msource-header">Defined By</th>
888 <tr class="method-row expandable config-row-alt0 notInherited">
889 <td class="micon"><a class="exi" href="#expand"> </a></td>
892 <a id="Roo.XComponent-event-*buildcomplete"></a>
894 <div class="fixedFont">
895 <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>)
901 <div class="short">Fires on the top level element when all elements have been built
907 Fires on the top level element when all elements have been built
913 <dl class="detailList">
914 <dt class="heading">Parameters:</dt>
917 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
920 <dd>the top level component.</dd>
943 <tr class="method-row expandable config-row-alt1 notInherited">
944 <td class="micon"><a class="exi" href="#expand"> </a></td>
947 <a id="Roo.XComponent-event-*built"></a>
949 <div class="fixedFont">
950 <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>)
956 <div class="short">Fires when this the componnt is built
962 Fires when this the componnt is built
968 <dl class="detailList">
969 <dt class="heading">Parameters:</dt>
972 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
975 <dd>the component</dd>
1005 <!-- ============================== footer ================================= -->
1006 <div class="fineprint" style="clear:both">
1008 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:05:46 GMT+0800 (HKT)
1010 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>