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</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-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo-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 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Defined In:</td><td class="hd-info">
57 <a href="./src/Roo.js.html">Roo.js</a>.
60 <tr><td class="label">Class:</td><td class="hd-info">Roo</td></tr>
68 <!-- ============================== class summary ========================== -->
69 <div class="description">
70 Roo core utilities and functions.
74 <!-- ============================== Class comment block... ========================== -->
76 <div class="comments">
77 <b>Class Comments / Notes</B> =>
78 <u onclick="parent.CommentDialog.showCommentId = 'Roo';">[Add Your comment/notes about this class]</u>
80 <iframe frameborder="0" id="comments-" style="border: none;width:100%;"
81 src="/blog.php/GtkDjsComments/Roo.html"></iframe>
86 <!-- ============================== config options ========================== -->
91 <div class="hr"></div>
92 <a id="Roo-configs"></a>
96 <table cellspacing="0" class="member-table">
97 <caption class="Empty">Config Options - Has None</caption>
111 <!-- ============================== public properties ==================== -->
115 <a id="Roo-props"></a>
123 <table cellspacing="0" class="member-table">
124 <caption>Public Properties </caption>
126 <th class="sig-header" colspan="2">Property</th>
127 <th class="sig-header">Description</th>
128 <th class="msource-header">Defined By</th>
138 <tr class="property-row config-row-alt0 notInherited">
140 <a class="exi" href="#expand"> </a>
143 <a id="Roo-prop-BLANK_IMAGE_URL" name=".BLANK_IMAGE_URL"></a>
144 <div class="fixedFont">
145 <span class="attributes">Roo.</span><b class="itemname">BLANK_IMAGE_URL</b> :
146 <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
154 URL to a 1x1 transparent gif image used by Roo to create inline icons with CSS background images.
162 URL to a 1x1 transparent gif image used by Roo to create inline icons with CSS background images. (Defaults to<br/>"http://Roojs.com/s.gif" and you should change this to a URL on your server).
177 <tr class="property-row config-row-alt1 notInherited">
179 <a class="exi" href="#expand"> </a>
182 <a id="Roo-prop-Msg" name=".Msg"></a>
183 <div class="fixedFont">
184 <span class="attributes">Roo.</span><b class="itemname">Msg</b> :
185 <span type="etype"></span>
193 Shorthand for {<b>link</b> Roo.MessageBox}
201 Shorthand for {<b>link</b> Roo.MessageBox}
216 <tr class="property-row config-row-alt0 notInherited">
218 <a class="exi" href="#expand"> </a>
221 <a id="Roo-prop-SSL_SECURE_URL" name=".SSL_SECURE_URL"></a>
222 <div class="fixedFont">
223 <span class="attributes">Roo.</span><b class="itemname">SSL_SECURE_URL</b> :
224 <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
232 URL to a blank file used by Roo when in secure mode for iframe src and onReady src to prevent<br/>the IE insecure content warning (defaults to javascript:false).
240 URL to a blank file used by Roo when in secure mode for iframe src and onReady src to prevent<br/>the IE insecure content warning (defaults to javascript:false).
255 <tr class="property-row config-row-alt1 notInherited">
257 <a class="exi" href="#expand"> </a>
260 <a id="Roo-prop-enableGarbageCollector" name=".enableGarbageCollector"></a>
261 <div class="fixedFont">
262 <span class="attributes">Roo.</span><b class="itemname">enableGarbageCollector</b> :
263 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
271 True to automatically uncache orphaned Roo.Elements periodically (defaults to true)
279 True to automatically uncache orphaned Roo.Elements periodically (defaults to true)
294 <tr class="property-row config-row-alt0 notInherited">
296 <a class="exi" href="#expand"> </a>
299 <a id="Roo-prop-enableListenerCollection" name=".enableListenerCollection"></a>
300 <div class="fixedFont">
301 <span class="attributes">Roo.</span><b class="itemname">enableListenerCollection</b> :
302 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
310 True to automatically purge event listeners after uncaching an element (defaults to false).
318 True to automatically purge event listeners after uncaching an element (defaults to false).<br/>Note: this only happens if enableGarbageCollector is true.
333 <tr class="property-row config-row-alt1 notInherited">
335 <a class="exi" href="#expand"> </a>
338 <a id="Roo-prop-isBorderBox" name=".isBorderBox"></a>
339 <div class="fixedFont">
340 <span class="attributes">Roo.</span><b class="itemname">isBorderBox</b> :
341 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
372 <tr class="property-row config-row-alt0 notInherited">
374 <a class="exi" href="#expand"> </a>
377 <a id="Roo-prop-isGecko" name=".isGecko"></a>
378 <div class="fixedFont">
379 <span class="attributes">Roo.</span><b class="itemname">isGecko</b> :
380 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
411 <tr class="property-row config-row-alt1 notInherited">
413 <a class="exi" href="#expand"> </a>
416 <a id="Roo-prop-isIE" name=".isIE"></a>
417 <div class="fixedFont">
418 <span class="attributes">Roo.</span><b class="itemname">isIE</b> :
419 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
450 <tr class="property-row config-row-alt0 notInherited">
452 <a class="exi" href="#expand"> </a>
455 <a id="Roo-prop-isIE7" name=".isIE7"></a>
456 <div class="fixedFont">
457 <span class="attributes">Roo.</span><b class="itemname">isIE7</b> :
458 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
489 <tr class="property-row config-row-alt1 notInherited">
491 <a class="exi" href="#expand"> </a>
494 <a id="Roo-prop-isLinux" name=".isLinux"></a>
495 <div class="fixedFont">
496 <span class="attributes">Roo.</span><b class="itemname">isLinux</b> :
497 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
528 <tr class="property-row config-row-alt0 notInherited">
530 <a class="exi" href="#expand"> </a>
533 <a id="Roo-prop-isMac" name=".isMac"></a>
534 <div class="fixedFont">
535 <span class="attributes">Roo.</span><b class="itemname">isMac</b> :
536 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
567 <tr class="property-row config-row-alt1 notInherited">
569 <a class="exi" href="#expand"> </a>
572 <a id="Roo-prop-isOpera" name=".isOpera"></a>
573 <div class="fixedFont">
574 <span class="attributes">Roo.</span><b class="itemname">isOpera</b> :
575 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
606 <tr class="property-row config-row-alt0 notInherited">
608 <a class="exi" href="#expand"> </a>
611 <a id="Roo-prop-isReady" name=".isReady"></a>
612 <div class="fixedFont">
613 <span class="attributes">Roo.</span><b class="itemname">isReady</b> :
614 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
622 True when the document is fully initialized and ready for action
630 True when the document is fully initialized and ready for action
645 <tr class="property-row config-row-alt1 notInherited">
647 <a class="exi" href="#expand"> </a>
650 <a id="Roo-prop-isSafari" name=".isSafari"></a>
651 <div class="fixedFont">
652 <span class="attributes">Roo.</span><b class="itemname">isSafari</b> :
653 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
684 <tr class="property-row config-row-alt0 notInherited">
686 <a class="exi" href="#expand"> </a>
689 <a id="Roo-prop-isSecure" name=".isSecure"></a>
690 <div class="fixedFont">
691 <span class="attributes">Roo.</span><b class="itemname">isSecure</b> :
692 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
700 True if the page is running over SSL
708 True if the page is running over SSL
723 <tr class="property-row config-row-alt1 notInherited">
725 <a class="exi" href="#expand"> </a>
728 <a id="Roo-prop-isStrict" name=".isStrict"></a>
729 <div class="fixedFont">
730 <span class="attributes">Roo.</span><b class="itemname">isStrict</b> :
731 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
739 True if the browser is in strict mode
747 True if the browser is in strict mode
762 <tr class="property-row config-row-alt0 notInherited">
764 <a class="exi" href="#expand"> </a>
767 <a id="Roo-prop-isWindows" name=".isWindows"></a>
768 <div class="fixedFont">
769 <span class="attributes">Roo.</span><b class="itemname">isWindows</b> :
770 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
801 <tr class="property-row config-row-alt1 notInherited">
803 <a class="exi" href="#expand"> </a>
806 <a id="Roo-prop-useShims" name=".useShims"></a>
807 <div class="fixedFont">
808 <span class="attributes">Roo.</span><b class="itemname">useShims</b> :
809 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
817 By default, Ext intelligently decides whether floating elements should be shimmed.
825 By default, Ext intelligently decides whether floating elements should be shimmed. If you are using flash,<br/>you may want to set this to true.
841 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
842 <tr class="property-row alt">
849 <!-- ============================== methods summary / details ======================== -->
852 <a id="Roo-methods"></a>
853 <!-- constructor?? -->
860 <!-- then dynamics first -->
867 <table cellspacing="0" class="member-table">
868 <caption>Public Methods</caption>
870 <th class="sig-header" colspan="2">Method</th>
871 <th class="msource-header">Defined By</th>
881 <tr class="method-row config-row-alt0 expandable notInherited">
882 <td class="micon"><a class="exi" href="#expand"> </a></td>
886 <a id="Roo-method-addBehaviors" name=".addBehaviors"></a>
887 <div class="fixedFont">
888 <span class="attributes">Roo.</span><b class="itemname">addBehaviors</b>
890 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>)
897 <div class="short">Applies event listeners to elements by selectors when the document is ready.</div>
903 Applies event listeners to elements by selectors when the document is ready.<br/>The event name is specified with an @ suffix.<br/><pre><code><br/>Roo.addBehaviors({<br/> // add a listener for click on all anchors in element with id foo<br/> '<b>foo</b> a<b>click</b>' : function(e, t){<br/> // do something<br/> },<br/><br/> // add the same listener to multiple selectors (separated by comma BEFORE the @)<br/> '<b>foo</b> a, <b>bar</b> span.some-class<b>mouseover</b>' : function(){<br/> // do something<br/> }<br/>});<br/></code></pre>
910 <dl class="detailList">
911 <dt class="heading">Parameters:</dt>
914 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>obj</b>
917 <dd>The list of behaviors to apply</dd>
943 <tr class="method-row config-row-alt1 expandable notInherited">
944 <td class="micon"><a class="exi" href="#expand"> </a></td>
948 <a id="Roo-method-apply" name=".apply"></a>
949 <div class="fixedFont">
950 <span class="attributes">Roo.</span><b class="itemname">apply</b>
952 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>defaults</i></B>)
958 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
967 <div class="short">Copies all the properties of config to obj.</div>
973 Copies all the properties of config to obj.
980 <dl class="detailList">
981 <dt class="heading">Parameters:</dt>
984 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>obj</b>
987 <dd>The receiver of the properties</dd>
990 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
993 <dd>The source of the properties</dd>
996 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>defaults</b>
999 <dd>A different object that will also be applied for default values</dd>
1007 <dl class="detailList">
1008 <dt class="heading">Returns:</dt>
1010 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> returns obj</dd>
1024 <td class="msource">
1032 <tr class="method-row config-row-alt0 expandable notInherited">
1033 <td class="micon"><a class="exi" href="#expand"> </a></td>
1037 <a id="Roo-method-applyIf" name=".applyIf"></a>
1038 <div class="fixedFont">
1039 <span class="attributes">Roo.</span><b class="itemname">applyIf</b>
1041 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1047 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1056 <div class="short">Copies all the properties of config to obj if they don't already exist.</div>
1062 Copies all the properties of config to obj if they don't already exist.
1069 <dl class="detailList">
1070 <dt class="heading">Parameters:</dt>
1073 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>obj</b>
1076 <dd>The receiver of the properties</dd>
1079 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
1082 <dd>The source of the properties</dd>
1090 <dl class="detailList">
1091 <dt class="heading">Returns:</dt>
1093 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> returns obj</dd>
1107 <td class="msource">
1115 <tr class="method-row config-row-alt1 expandable notInherited">
1116 <td class="micon"><a class="exi" href="#expand"> </a></td>
1120 <a id="Roo-method-decode" name=".decode"></a>
1121 <div class="fixedFont">
1122 <span class="attributes">Roo.</span><b class="itemname">decode</b>
1131 <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}</div>
1137 Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}
1158 <td class="msource">
1166 <tr class="method-row config-row-alt0 expandable notInherited">
1167 <td class="micon"><a class="exi" href="#expand"> </a></td>
1171 <a id="Roo-method-each" name=".each"></a>
1172 <div class="fixedFont">
1173 <span class="attributes">Roo.</span><b class="itemname">each</b>
1175 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/NodeList/Mixed <B><i>array</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</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>)
1182 <div class="short">Iterates an array calling the passed function with each item, stopping if your function returns false.</div>
1188 Iterates an array calling the passed function with each item, stopping if your function returns false. If the<br/>passed array is not really an array, your function is called once with it.<br/>The supplied function is called with (Object item, Number index, Array allItems).
1195 <dl class="detailList">
1196 <dt class="heading">Parameters:</dt>
1199 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/NodeList/Mixed</span> <b>array</b>
1205 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1211 <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>
1232 <td class="msource">
1240 <tr class="method-row config-row-alt1 expandable notInherited">
1241 <td class="micon"><a class="exi" href="#expand"> </a></td>
1245 <a id="Roo-method-encode" name=".encode"></a>
1246 <div class="fixedFont">
1247 <span class="attributes">Roo.</span><b class="itemname">encode</b>
1256 <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}</div>
1262 Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}
1283 <td class="msource">
1291 <tr class="method-row config-row-alt0 expandable notInherited">
1292 <td class="micon"><a class="exi" href="#expand"> </a></td>
1296 <a id="Roo-method-escapeRe" name=".escapeRe"></a>
1297 <div class="fixedFont">
1298 <span class="attributes">Roo.</span><b class="itemname">escapeRe</b>
1300 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>str</i></B>)
1306 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1315 <div class="short">Escapes the passed string for use in a regular expression</div>
1321 Escapes the passed string for use in a regular expression
1328 <dl class="detailList">
1329 <dt class="heading">Parameters:</dt>
1332 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>str</b>
1343 <dl class="detailList">
1344 <dt class="heading">Returns:</dt>
1346 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1360 <td class="msource">
1368 <tr class="method-row config-row-alt1 expandable notInherited">
1369 <td class="micon"><a class="exi" href="#expand"> </a></td>
1373 <a id="Roo-method-extend" name=".extend"></a>
1374 <div class="fixedFont">
1375 <span class="attributes">Roo.</span><b class="itemname">extend</b>
1377 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>subclass</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>superclass</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>overrides</i></B>)
1384 <div class="short">Extends one class with another class and optionally overrides members with the passed literal.</div>
1390 Extends one class with another class and optionally overrides members with the passed literal. This class<br/>also adds the function "override()" to the class that can be used to override<br/>members on an instance.
1397 <dl class="detailList">
1398 <dt class="heading">Parameters:</dt>
1401 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>subclass</b>
1404 <dd>The class inheriting the functionality</dd>
1407 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>superclass</b>
1410 <dd>The class being extended</dd>
1413 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>overrides</b>
1416 <dd>(optional) A literal with members</dd>
1434 <td class="msource">
1442 <tr class="method-row config-row-alt0 expandable notInherited">
1443 <td class="micon"><a class="exi" href="#expand"> </a></td>
1447 <a id="Roo-method-factory" name=".factory"></a>
1448 <div class="fixedFont">
1449 <span class="attributes">Roo.</span><b class="itemname">factory</b>
1451 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>classname</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>namespace</i></B>)
1458 <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
1464 Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:<br/><pre><code><br/>Roo.factory({ xns: Roo.data, xtype : 'Store', .....});<br/>Roo.factory(conf, Roo.data);<br/></code></pre>
1471 <dl class="detailList">
1472 <dt class="heading">Parameters:</dt>
1475 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>classname</b>
1481 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>namespace</b>
1502 <td class="msource">
1510 <tr class="method-row config-row-alt1 expandable notInherited">
1511 <td class="micon"><a class="exi" href="#expand"> </a></td>
1515 <a id="Roo-method-fly" name=".fly"></a>
1516 <div class="fixedFont">
1517 <span class="attributes">Roo.</span><b class="itemname">fly</b>
1519 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>named</i></B>)
1534 <div class="short">Gets the globally shared flyweight Element, with the passed node as the active element.</div>
1540 Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -<br/>the dom node can be overwritten by other code.<br/>Shorthand of {<b>link</b> Roo.Element<b>fly</b>}
1547 <dl class="detailList">
1548 <dt class="heading">Parameters:</dt>
1551 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span> <b>el</b>
1554 <dd>The dom node or id</dd>
1557 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>named</b>
1560 <dd>(optional) Allows for creation of named reusable flyweights to<br/> prevent conflicts (e.g. internally Roo uses "_internal")</dd>
1568 <dl class="detailList">
1569 <dt class="heading">Returns:</dt>
1571 <dd><span class="fixedFont">Element</span> The shared Element object</dd>
1585 <td class="msource">
1593 <tr class="method-row config-row-alt0 expandable notInherited">
1594 <td class="micon"><a class="exi" href="#expand"> </a></td>
1598 <a id="Roo-method-get" name=".get"></a>
1599 <div class="fixedFont">
1600 <span class="attributes">Roo.</span><b class="itemname">get</b>
1602 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1617 <div class="short">Static method to retrieve Element objects.</div>
1623 Static method to retrieve Element objects. Uses simple caching to consistently return the same object.<br/>Automatically fixes if an object was recreated with the same id via AJAX or DOM.<br/>Shorthand of {<b>link</b> Roo.Element<b>get</b>}
1630 <dl class="detailList">
1631 <dt class="heading">Parameters:</dt>
1634 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1637 <dd>The id of the node, a DOM Node or an existing Element.</dd>
1645 <dl class="detailList">
1646 <dt class="heading">Returns:</dt>
1648 <dd><span class="fixedFont">Element</span> The Element object</dd>
1662 <td class="msource">
1670 <tr class="method-row config-row-alt1 expandable notInherited">
1671 <td class="micon"><a class="exi" href="#expand"> </a></td>
1675 <a id="Roo-method-getCmp" name=".getCmp"></a>
1676 <div class="fixedFont">
1677 <span class="attributes">Roo.</span><b class="itemname">getCmp</b>
1679 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1694 <div class="short">Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}</div>
1700 Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}
1707 <dl class="detailList">
1708 <dt class="heading">Parameters:</dt>
1711 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1722 <dl class="detailList">
1723 <dt class="heading">Returns:</dt>
1725 <dd> Roo.Component</dd>
1739 <td class="msource">
1747 <tr class="method-row config-row-alt0 expandable notInherited">
1748 <td class="micon"><a class="exi" href="#expand"> </a></td>
1752 <a id="Roo-method-getDom" name=".getDom"></a>
1753 <div class="fixedFont">
1754 <span class="attributes">Roo.</span><b class="itemname">getDom</b>
1756 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>)
1771 <div class="short">Return the dom node for the passed string (id), dom node, or Roo.Element</div>
1777 Return the dom node for the passed string (id), dom node, or Roo.Element
1784 <dl class="detailList">
1785 <dt class="heading">Parameters:</dt>
1788 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
1799 <dl class="detailList">
1800 <dt class="heading">Returns:</dt>
1802 <dd> HTMLElement</dd>
1816 <td class="msource">
1824 <tr class="method-row config-row-alt1 expandable notInherited">
1825 <td class="micon"><a class="exi" href="#expand"> </a></td>
1829 <a id="Roo-method-id" name=".id"></a>
1830 <div class="fixedFont">
1831 <span class="attributes">Roo.</span><b class="itemname">id</b>
1833 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>prefix</i></B>)
1839 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1848 <div class="short">Generates unique ids.</div>
1854 Generates unique ids. If the element already has an id, it is unchanged
1861 <dl class="detailList">
1862 <dt class="heading">Parameters:</dt>
1865 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1868 <dd>(optional) The element to generate an id for</dd>
1871 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>prefix</b>
1874 <dd>(optional) Id prefix (defaults "Roo-gen")</dd>
1882 <dl class="detailList">
1883 <dt class="heading">Returns:</dt>
1885 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The generated Id.</dd>
1899 <td class="msource">
1907 <tr class="method-row config-row-alt0 expandable notInherited">
1908 <td class="micon"><a class="exi" href="#expand"> </a></td>
1912 <a id="Roo-method-isEmpty" name=".isEmpty"></a>
1913 <div class="fixedFont">
1914 <span class="attributes">Roo.</span><b class="itemname">isEmpty</b>
1916 (Mixed <B><i>value</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>allowBlank</i></B>)
1922 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1931 <div class="short">Returns true if the passed value is null, undefined or an empty string (optional).</div>
1937 Returns true if the passed value is null, undefined or an empty string (optional).
1944 <dl class="detailList">
1945 <dt class="heading">Parameters:</dt>
1948 <span class="fixedFont">Mixed</span> <b>value</b>
1951 <dd>The value to test</dd>
1954 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>allowBlank</b>
1957 <dd>(optional) Pass true if an empty string is not considered empty</dd>
1965 <dl class="detailList">
1966 <dt class="heading">Returns:</dt>
1968 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1982 <td class="msource">
1990 <tr class="method-row config-row-alt1 expandable notInherited">
1991 <td class="micon"><a class="exi" href="#expand"> </a></td>
1995 <a id="Roo-method-namespace" name=".namespace"></a>
1996 <div class="fixedFont">
1997 <span class="attributes">Roo.</span><b class="itemname">namespace</b>
1999 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>namespace1</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>namespace2</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>etc</i></B>)
2006 <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
2012 Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:<br/><pre><code><br/>Roo.namespace('Company', 'Company.data');<br/>Company.Widget = function() { ... }<br/>Company.data.CustomStore = function(config) { ... }<br/></code></pre>
2019 <dl class="detailList">
2020 <dt class="heading">Parameters:</dt>
2023 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>namespace1</b>
2029 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>namespace2</b>
2035 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>etc</b>
2056 <td class="msource">
2064 <tr class="method-row config-row-alt0 expandable notInherited">
2065 <td class="micon"><a class="exi" href="#expand"> </a></td>
2069 <a id="Roo-method-onReady" name=".onReady"></a>
2070 <div class="fixedFont">
2071 <span class="attributes">Roo.</span><b class="itemname">onReady</b>
2073 (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</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>, boolean <B><i>override</i></B>)
2080 <div class="short">Fires when the document is ready (before onload and before images are loaded).</div>
2086 Fires when the document is ready (before onload and before images are loaded). Shorthand of {<b>link</b> Roo.EventManager<b>onDocumentReady</b>}.
2093 <dl class="detailList">
2094 <dt class="heading">Parameters:</dt>
2097 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
2100 <dd>The method the event invokes</dd>
2103 <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>
2106 <dd>An object that becomes the scope of the handler</dd>
2109 <span class="fixedFont">boolean</span> <b>override</b>
2112 <dd>If true, the obj passed in becomes<br/> the execution scope of the listener</dd>
2130 <td class="msource">
2138 <tr class="method-row config-row-alt1 expandable notInherited">
2139 <td class="micon"><a class="exi" href="#expand"> </a></td>
2143 <a id="Roo-method-override" name=".override"></a>
2144 <div class="fixedFont">
2145 <span class="attributes">Roo.</span><b class="itemname">override</b>
2147 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>origclass</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>overrides</i></B>)
2154 <div class="short">Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.</div>
2160 Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.<br/>Usage:<pre><code><br/>Roo.override(MyClass, {<br/> newMethod1: function(){<br/> // etc.<br/> },<br/> newMethod2: function(foo){<br/> // etc.<br/> }<br/>});<br/> </code></pre>
2167 <dl class="detailList">
2168 <dt class="heading">Parameters:</dt>
2171 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>origclass</b>
2174 <dd>The class to override</dd>
2177 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>overrides</b>
2180 <dd>The list of functions to add to origClass. This should be specified as an object literal<br/>containing one or more methods.</dd>
2198 <td class="msource">
2206 <tr class="method-row config-row-alt0 expandable notInherited">
2207 <td class="micon"><a class="exi" href="#expand"> </a></td>
2211 <a id="Roo-method-query" name=".query"></a>
2212 <div class="fixedFont">
2213 <span class="attributes">Roo.</span><b class="itemname">query</b>
2215 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>path</i></B>, Node <B><i>root</i></B>)
2221 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
2230 <div class="short">Selects an array of DOM nodes by CSS/XPath selector.</div>
2236 Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {<b>link</b> Roo.DomQuery<b>select</b>}
2243 <dl class="detailList">
2244 <dt class="heading">Parameters:</dt>
2247 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>path</b>
2250 <dd>The selector/xpath query</dd>
2253 <span class="fixedFont">Node</span> <b>root</b>
2256 <dd>(optional) The start of the query (defaults to document).</dd>
2264 <dl class="detailList">
2265 <dt class="heading">Returns:</dt>
2267 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
2281 <td class="msource">
2289 <tr class="method-row config-row-alt1 expandable notInherited">
2290 <td class="micon"><a class="exi" href="#expand"> </a></td>
2294 <a id="Roo-method-select" name=".select"></a>
2295 <div class="fixedFont">
2296 <span class="attributes">Roo.</span><b class="itemname">select</b>
2298 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>selector</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>unique</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String <B><i>root</i></B>)
2304 CompositeElementLite/CompositeElement
2313 <div class="short">Selects elements based on the passed CSS selector to enable working on them as 1.</div>
2319 Selects elements based on the passed CSS selector to enable working on them as 1.
2326 <dl class="detailList">
2327 <dt class="heading">Parameters:</dt>
2330 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span> <b>selector</b>
2333 <dd>The CSS selector or an array of elements</dd>
2336 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>unique</b>
2339 <dd>(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)</dd>
2342 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String</span> <b>root</b>
2345 <dd>(optional) The root element of the query or id of the root</dd>
2353 <dl class="detailList">
2354 <dt class="heading">Returns:</dt>
2356 <dd><span class="fixedFont">CompositeElementLite/CompositeElement</span> </dd>
2370 <td class="msource">
2378 <tr class="method-row config-row-alt0 expandable notInherited">
2379 <td class="micon"><a class="exi" href="#expand"> </a></td>
2383 <a id="Roo-method-type" name=".type"></a>
2384 <div class="fixedFont">
2385 <span class="attributes">Roo.</span><b class="itemname">type</b>
2387 (Mixed <B><i>object</i></B>)
2393 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2402 <div class="short">Returns the type of object that is passed in.</div>
2408 Returns the type of object that is passed in. If the object passed in is null or undefined it<br/>return false otherwise it returns one of the following values:<ul><br/><li><b>string</b>: If the object passed is a string</li><br/><li><b>number</b>: If the object passed is a number</li><br/><li><b>boolean</b>: If the object passed is a boolean value</li><br/><li><b>function</b>: If the object passed is a function reference</li><br/><li><b>object</b>: If the object passed is an object</li><br/><li><b>array</b>: If the object passed is an array</li><br/><li><b>regexp</b>: If the object passed is a regular expression</li><br/><li><b>element</b>: If the object passed is a DOM Element</li><br/><li><b>nodelist</b>: If the object passed is a DOM NodeList</li><br/><li><b>textnode</b>: If the object passed is a DOM text node and contains something other than whitespace</li><br/><li><b>whitespace</b>: If the object passed is a DOM text node and contains only whitespace</li>
2415 <dl class="detailList">
2416 <dt class="heading">Parameters:</dt>
2419 <span class="fixedFont">Mixed</span> <b>object</b>
2430 <dl class="detailList">
2431 <dt class="heading">Returns:</dt>
2433 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
2447 <td class="msource">
2455 <tr class="method-row config-row-alt1 expandable notInherited">
2456 <td class="micon"><a class="exi" href="#expand"> </a></td>
2460 <a id="Roo-method-urlDecode" name=".urlDecode"></a>
2461 <div class="fixedFont">
2462 <span class="attributes">Roo.</span><b class="itemname">urlDecode</b>
2464 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>string</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>overwrite</i></B>)
2470 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2479 <div class="short">Takes an encoded URL and and converts it to an object.</div>
2485 Takes an encoded URL and and converts it to an object. e.g. Roo.urlDecode("foo=1&bar=2"); would return {foo: 1, bar: 2} or Roo.urlDecode("foo=1&bar=2&bar=3&bar=4", true); would return {foo: 1, bar: [2, 3, 4]}.
2492 <dl class="detailList">
2493 <dt class="heading">Parameters:</dt>
2496 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>string</b>
2502 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>overwrite</b>
2505 <dd>(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).</dd>
2513 <dl class="detailList">
2514 <dt class="heading">Returns:</dt>
2516 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> A literal with members</dd>
2530 <td class="msource">
2538 <tr class="method-row config-row-alt0 expandable notInherited">
2539 <td class="micon"><a class="exi" href="#expand"> </a></td>
2543 <a id="Roo-method-urlEncode" name=".urlEncode"></a>
2544 <div class="fixedFont">
2545 <span class="attributes">Roo.</span><b class="itemname">urlEncode</b>
2547 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
2553 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2562 <div class="short">Takes an object and converts it to an encoded URL.</div>
2568 Takes an object and converts it to an encoded URL. e.g. Roo.urlEncode({foo: 1, bar: 2}); would return "foo=1&bar=2". Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value.
2575 <dl class="detailList">
2576 <dt class="heading">Parameters:</dt>
2579 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>o</b>
2590 <dl class="detailList">
2591 <dt class="heading">Returns:</dt>
2593 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
2607 <td class="msource">
2618 <!-- ============================== events summary / details ======================== -->
2621 <a id="Roo-events"></a>
2627 <table cellspacing="0" class="member-table">
2628 <caption class="Empty">Events - Has None</caption>
2639 <!-- ============================== footer ================================= -->
2640 <div class="fineprint" style="clear:both">
2642 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Jul 26 2010 19:28:49 GMT+0800 (HKT)
2644 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>