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-debug" name=".debug"></a>
261 <div class="fixedFont">
262 <span class="attributes">Roo.</span><b class="itemname">debug</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 Turn on debugging output (currently only the factory uses this)
279 Turn on debugging output (currently only the factory uses this)
294 <tr class="property-row config-row-alt0 notInherited">
296 <a class="exi" href="#expand"> </a>
299 <a id="Roo-prop-enableGarbageCollector" name=".enableGarbageCollector"></a>
300 <div class="fixedFont">
301 <span class="attributes">Roo.</span><b class="itemname">enableGarbageCollector</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 uncache orphaned Roo.Elements periodically (defaults to true)
318 True to automatically uncache orphaned Roo.Elements periodically (defaults to true)
333 <tr class="property-row config-row-alt1 notInherited">
335 <a class="exi" href="#expand"> </a>
338 <a id="Roo-prop-enableListenerCollection" name=".enableListenerCollection"></a>
339 <div class="fixedFont">
340 <span class="attributes">Roo.</span><b class="itemname">enableListenerCollection</b> :
341 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
349 True to automatically purge event listeners after uncaching an element (defaults to false).
357 True to automatically purge event listeners after uncaching an element (defaults to false).<br/>Note: this only happens if enableGarbageCollector is true.
372 <tr class="property-row config-row-alt0 notInherited">
374 <a class="exi" href="#expand"> </a>
377 <a id="Roo-prop-isBorderBox" name=".isBorderBox"></a>
378 <div class="fixedFont">
379 <span class="attributes">Roo.</span><b class="itemname">isBorderBox</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-isGecko" name=".isGecko"></a>
417 <div class="fixedFont">
418 <span class="attributes">Roo.</span><b class="itemname">isGecko</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-isIE" name=".isIE"></a>
456 <div class="fixedFont">
457 <span class="attributes">Roo.</span><b class="itemname">isIE</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-isIE7" name=".isIE7"></a>
495 <div class="fixedFont">
496 <span class="attributes">Roo.</span><b class="itemname">isIE7</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-isLinux" name=".isLinux"></a>
534 <div class="fixedFont">
535 <span class="attributes">Roo.</span><b class="itemname">isLinux</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-isMac" name=".isMac"></a>
573 <div class="fixedFont">
574 <span class="attributes">Roo.</span><b class="itemname">isMac</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-isOpera" name=".isOpera"></a>
612 <div class="fixedFont">
613 <span class="attributes">Roo.</span><b class="itemname">isOpera</b> :
614 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
645 <tr class="property-row config-row-alt1 notInherited">
647 <a class="exi" href="#expand"> </a>
650 <a id="Roo-prop-isReady" name=".isReady"></a>
651 <div class="fixedFont">
652 <span class="attributes">Roo.</span><b class="itemname">isReady</b> :
653 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
661 True when the document is fully initialized and ready for action
669 True when the document is fully initialized and ready for action
684 <tr class="property-row config-row-alt0 notInherited">
686 <a class="exi" href="#expand"> </a>
689 <a id="Roo-prop-isSafari" name=".isSafari"></a>
690 <div class="fixedFont">
691 <span class="attributes">Roo.</span><b class="itemname">isSafari</b> :
692 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
723 <tr class="property-row config-row-alt1 notInherited">
725 <a class="exi" href="#expand"> </a>
728 <a id="Roo-prop-isSecure" name=".isSecure"></a>
729 <div class="fixedFont">
730 <span class="attributes">Roo.</span><b class="itemname">isSecure</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 page is running over SSL
747 True if the page is running over SSL
762 <tr class="property-row config-row-alt0 notInherited">
764 <a class="exi" href="#expand"> </a>
767 <a id="Roo-prop-isStrict" name=".isStrict"></a>
768 <div class="fixedFont">
769 <span class="attributes">Roo.</span><b class="itemname">isStrict</b> :
770 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
778 True if the browser is in strict mode
786 True if the browser is in strict mode
801 <tr class="property-row config-row-alt1 notInherited">
803 <a class="exi" href="#expand"> </a>
806 <a id="Roo-prop-isWindows" name=".isWindows"></a>
807 <div class="fixedFont">
808 <span class="attributes">Roo.</span><b class="itemname">isWindows</b> :
809 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
840 <tr class="property-row config-row-alt0 notInherited">
842 <a class="exi" href="#expand"> </a>
845 <a id="Roo-prop-useShims" name=".useShims"></a>
846 <div class="fixedFont">
847 <span class="attributes">Roo.</span><b class="itemname">useShims</b> :
848 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
856 By default, Ext intelligently decides whether floating elements should be shimmed.
864 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.
880 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
881 <tr class="property-row alt">
888 <!-- ============================== methods summary / details ======================== -->
891 <a id="Roo-methods"></a>
892 <!-- constructor?? -->
899 <!-- then dynamics first -->
906 <table cellspacing="0" class="member-table">
907 <caption>Public Methods</caption>
909 <th class="sig-header" colspan="2">Method</th>
910 <th class="msource-header">Defined By</th>
920 <tr class="method-row config-row-alt0 expandable notInherited">
921 <td class="micon"><a class="exi" href="#expand"> </a></td>
925 <a id="Roo-method-addBehaviors" name=".addBehaviors"></a>
926 <div class="fixedFont">
927 <span class="attributes">Roo.</span><b class="itemname">addBehaviors</b>
929 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>)
936 <div class="short">Applies event listeners to elements by selectors when the document is ready.</div>
942 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>
949 <dl class="detailList">
950 <dt class="heading">Parameters:</dt>
953 <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>
956 <dd>The list of behaviors to apply</dd>
982 <tr class="method-row config-row-alt1 expandable notInherited">
983 <td class="micon"><a class="exi" href="#expand"> </a></td>
987 <a id="Roo-method-apply" name=".apply"></a>
988 <div class="fixedFont">
989 <span class="attributes">Roo.</span><b class="itemname">apply</b>
991 (<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>)
997 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1006 <div class="short">Copies all the properties of config to obj.</div>
1012 Copies all the properties of config to obj.
1019 <dl class="detailList">
1020 <dt class="heading">Parameters:</dt>
1023 <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>
1026 <dd>The receiver of the properties</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>config</b>
1032 <dd>The source of the properties</dd>
1035 <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>
1038 <dd>A different object that will also be applied for default values</dd>
1046 <dl class="detailList">
1047 <dt class="heading">Returns:</dt>
1049 <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>
1063 <td class="msource">
1071 <tr class="method-row config-row-alt0 expandable notInherited">
1072 <td class="micon"><a class="exi" href="#expand"> </a></td>
1076 <a id="Roo-method-applyIf" name=".applyIf"></a>
1077 <div class="fixedFont">
1078 <span class="attributes">Roo.</span><b class="itemname">applyIf</b>
1080 (<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>)
1086 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1095 <div class="short">Copies all the properties of config to obj if they don't already exist.</div>
1101 Copies all the properties of config to obj if they don't already exist.
1108 <dl class="detailList">
1109 <dt class="heading">Parameters:</dt>
1112 <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>
1115 <dd>The receiver of the properties</dd>
1118 <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>
1121 <dd>The source of the properties</dd>
1129 <dl class="detailList">
1130 <dt class="heading">Returns:</dt>
1132 <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>
1146 <td class="msource">
1154 <tr class="method-row config-row-alt1 expandable notInherited">
1155 <td class="micon"><a class="exi" href="#expand"> </a></td>
1159 <a id="Roo-method-decode" name=".decode"></a>
1160 <div class="fixedFont">
1161 <span class="attributes">Roo.</span><b class="itemname">decode</b>
1170 <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}</div>
1176 Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}
1197 <td class="msource">
1205 <tr class="method-row config-row-alt0 expandable notInherited">
1206 <td class="micon"><a class="exi" href="#expand"> </a></td>
1210 <a id="Roo-method-each" name=".each"></a>
1211 <div class="fixedFont">
1212 <span class="attributes">Roo.</span><b class="itemname">each</b>
1214 (<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>)
1221 <div class="short">Iterates an array calling the passed function with each item, stopping if your function returns false.</div>
1227 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).
1234 <dl class="detailList">
1235 <dt class="heading">Parameters:</dt>
1238 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/NodeList/Mixed</span> <b>array</b>
1244 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1250 <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>
1271 <td class="msource">
1279 <tr class="method-row config-row-alt1 expandable notInherited">
1280 <td class="micon"><a class="exi" href="#expand"> </a></td>
1284 <a id="Roo-method-encode" name=".encode"></a>
1285 <div class="fixedFont">
1286 <span class="attributes">Roo.</span><b class="itemname">encode</b>
1295 <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}</div>
1301 Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}
1322 <td class="msource">
1330 <tr class="method-row config-row-alt0 expandable notInherited">
1331 <td class="micon"><a class="exi" href="#expand"> </a></td>
1335 <a id="Roo-method-escapeRe" name=".escapeRe"></a>
1336 <div class="fixedFont">
1337 <span class="attributes">Roo.</span><b class="itemname">escapeRe</b>
1339 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>str</i></B>)
1345 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1354 <div class="short">Escapes the passed string for use in a regular expression</div>
1360 Escapes the passed string for use in a regular expression
1367 <dl class="detailList">
1368 <dt class="heading">Parameters:</dt>
1371 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>str</b>
1382 <dl class="detailList">
1383 <dt class="heading">Returns:</dt>
1385 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1399 <td class="msource">
1407 <tr class="method-row config-row-alt1 expandable notInherited">
1408 <td class="micon"><a class="exi" href="#expand"> </a></td>
1412 <a id="Roo-method-extend" name=".extend"></a>
1413 <div class="fixedFont">
1414 <span class="attributes">Roo.</span><b class="itemname">extend</b>
1416 (<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>)
1423 <div class="short">Extends one class with another class and optionally overrides members with the passed literal.</div>
1429 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.
1436 <dl class="detailList">
1437 <dt class="heading">Parameters:</dt>
1440 <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>
1443 <dd>The class inheriting the functionality</dd>
1446 <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>
1449 <dd>The class being extended</dd>
1452 <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>
1455 <dd>(optional) A literal with members</dd>
1473 <td class="msource">
1481 <tr class="method-row config-row-alt0 expandable notInherited">
1482 <td class="micon"><a class="exi" href="#expand"> </a></td>
1486 <a id="Roo-method-factory" name=".factory"></a>
1487 <div class="fixedFont">
1488 <span class="attributes">Roo.</span><b class="itemname">factory</b>
1490 (<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>)
1497 <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
1503 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>
1510 <dl class="detailList">
1511 <dt class="heading">Parameters:</dt>
1514 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>classname</b>
1520 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>namespace</b>
1541 <td class="msource">
1549 <tr class="method-row config-row-alt1 expandable notInherited">
1550 <td class="micon"><a class="exi" href="#expand"> </a></td>
1554 <a id="Roo-method-fly" name=".fly"></a>
1555 <div class="fixedFont">
1556 <span class="attributes">Roo.</span><b class="itemname">fly</b>
1558 (<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>)
1573 <div class="short">Gets the globally shared flyweight Element, with the passed node as the active element.</div>
1579 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>}
1586 <dl class="detailList">
1587 <dt class="heading">Parameters:</dt>
1590 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span> <b>el</b>
1593 <dd>The dom node or id</dd>
1596 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>named</b>
1599 <dd>(optional) Allows for creation of named reusable flyweights to<br/> prevent conflicts (e.g. internally Roo uses "_internal")</dd>
1607 <dl class="detailList">
1608 <dt class="heading">Returns:</dt>
1610 <dd><span class="fixedFont">Element</span> The shared Element object</dd>
1624 <td class="msource">
1632 <tr class="method-row config-row-alt0 expandable notInherited">
1633 <td class="micon"><a class="exi" href="#expand"> </a></td>
1637 <a id="Roo-method-get" name=".get"></a>
1638 <div class="fixedFont">
1639 <span class="attributes">Roo.</span><b class="itemname">get</b>
1641 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1656 <div class="short">Static method to retrieve Element objects.</div>
1662 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>}
1669 <dl class="detailList">
1670 <dt class="heading">Parameters:</dt>
1673 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1676 <dd>The id of the node, a DOM Node or an existing Element.</dd>
1684 <dl class="detailList">
1685 <dt class="heading">Returns:</dt>
1687 <dd><span class="fixedFont">Element</span> The Element object</dd>
1701 <td class="msource">
1709 <tr class="method-row config-row-alt1 expandable notInherited">
1710 <td class="micon"><a class="exi" href="#expand"> </a></td>
1714 <a id="Roo-method-getCmp" name=".getCmp"></a>
1715 <div class="fixedFont">
1716 <span class="attributes">Roo.</span><b class="itemname">getCmp</b>
1718 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1733 <div class="short">Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}</div>
1739 Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}
1746 <dl class="detailList">
1747 <dt class="heading">Parameters:</dt>
1750 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1761 <dl class="detailList">
1762 <dt class="heading">Returns:</dt>
1764 <dd> Roo.Component</dd>
1778 <td class="msource">
1786 <tr class="method-row config-row-alt0 expandable notInherited">
1787 <td class="micon"><a class="exi" href="#expand"> </a></td>
1791 <a id="Roo-method-getDom" name=".getDom"></a>
1792 <div class="fixedFont">
1793 <span class="attributes">Roo.</span><b class="itemname">getDom</b>
1795 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>)
1810 <div class="short">Return the dom node for the passed string (id), dom node, or Roo.Element</div>
1816 Return the dom node for the passed string (id), dom node, or Roo.Element
1823 <dl class="detailList">
1824 <dt class="heading">Parameters:</dt>
1827 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
1838 <dl class="detailList">
1839 <dt class="heading">Returns:</dt>
1841 <dd> HTMLElement</dd>
1855 <td class="msource">
1863 <tr class="method-row config-row-alt1 expandable notInherited">
1864 <td class="micon"><a class="exi" href="#expand"> </a></td>
1868 <a id="Roo-method-id" name=".id"></a>
1869 <div class="fixedFont">
1870 <span class="attributes">Roo.</span><b class="itemname">id</b>
1872 (<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>)
1878 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1887 <div class="short">Generates unique ids.</div>
1893 Generates unique ids. If the element already has an id, it is unchanged
1900 <dl class="detailList">
1901 <dt class="heading">Parameters:</dt>
1904 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1907 <dd>(optional) The element to generate an id for</dd>
1910 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>prefix</b>
1913 <dd>(optional) Id prefix (defaults "Roo-gen")</dd>
1921 <dl class="detailList">
1922 <dt class="heading">Returns:</dt>
1924 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The generated Id.</dd>
1938 <td class="msource">
1946 <tr class="method-row config-row-alt0 expandable notInherited">
1947 <td class="micon"><a class="exi" href="#expand"> </a></td>
1951 <a id="Roo-method-isEmpty" name=".isEmpty"></a>
1952 <div class="fixedFont">
1953 <span class="attributes">Roo.</span><b class="itemname">isEmpty</b>
1955 (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>)
1961 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1970 <div class="short">Returns true if the passed value is null, undefined or an empty string (optional).</div>
1976 Returns true if the passed value is null, undefined or an empty string (optional).
1983 <dl class="detailList">
1984 <dt class="heading">Parameters:</dt>
1987 <span class="fixedFont">Mixed</span> <b>value</b>
1990 <dd>The value to test</dd>
1993 <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>
1996 <dd>(optional) Pass true if an empty string is not considered empty</dd>
2004 <dl class="detailList">
2005 <dt class="heading">Returns:</dt>
2007 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2021 <td class="msource">
2029 <tr class="method-row config-row-alt1 expandable notInherited">
2030 <td class="micon"><a class="exi" href="#expand"> </a></td>
2034 <a id="Roo-method-log" name=".log"></a>
2035 <div class="fixedFont">
2036 <span class="attributes">Roo.</span><b class="itemname">log</b>
2038 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>string</i></B>)
2045 <div class="short">Logs to console if it can.</div>
2051 Logs to console if it can.
2058 <dl class="detailList">
2059 <dt class="heading">Parameters:</dt>
2062 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>string</b>
2083 <td class="msource">
2091 <tr class="method-row config-row-alt0 expandable notInherited">
2092 <td class="micon"><a class="exi" href="#expand"> </a></td>
2096 <a id="Roo-method-namespace" name=".namespace"></a>
2097 <div class="fixedFont">
2098 <span class="attributes">Roo.</span><b class="itemname">namespace</b>
2100 (<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>)
2107 <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
2113 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>
2120 <dl class="detailList">
2121 <dt class="heading">Parameters:</dt>
2124 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>namespace1</b>
2130 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>namespace2</b>
2136 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>etc</b>
2157 <td class="msource">
2165 <tr class="method-row config-row-alt1 expandable notInherited">
2166 <td class="micon"><a class="exi" href="#expand"> </a></td>
2170 <a id="Roo-method-onReady" name=".onReady"></a>
2171 <div class="fixedFont">
2172 <span class="attributes">Roo.</span><b class="itemname">onReady</b>
2174 (<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>)
2181 <div class="short">Fires when the document is ready (before onload and before images are loaded).</div>
2187 Fires when the document is ready (before onload and before images are loaded). Shorthand of {<b>link</b> Roo.EventManager<b>onDocumentReady</b>}.
2194 <dl class="detailList">
2195 <dt class="heading">Parameters:</dt>
2198 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
2201 <dd>The method the event invokes</dd>
2204 <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>
2207 <dd>An object that becomes the scope of the handler</dd>
2210 <span class="fixedFont">boolean</span> <b>override</b>
2213 <dd>If true, the obj passed in becomes<br/> the execution scope of the listener</dd>
2231 <td class="msource">
2239 <tr class="method-row config-row-alt0 expandable notInherited">
2240 <td class="micon"><a class="exi" href="#expand"> </a></td>
2244 <a id="Roo-method-override" name=".override"></a>
2245 <div class="fixedFont">
2246 <span class="attributes">Roo.</span><b class="itemname">override</b>
2248 (<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>)
2255 <div class="short">Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.</div>
2261 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>
2268 <dl class="detailList">
2269 <dt class="heading">Parameters:</dt>
2272 <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>
2275 <dd>The class to override</dd>
2278 <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>
2281 <dd>The list of functions to add to origClass. This should be specified as an object literal<br/>containing one or more methods.</dd>
2299 <td class="msource">
2307 <tr class="method-row config-row-alt1 expandable notInherited">
2308 <td class="micon"><a class="exi" href="#expand"> </a></td>
2312 <a id="Roo-method-query" name=".query"></a>
2313 <div class="fixedFont">
2314 <span class="attributes">Roo.</span><b class="itemname">query</b>
2316 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>path</i></B>, Node <B><i>root</i></B>)
2322 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
2331 <div class="short">Selects an array of DOM nodes by CSS/XPath selector.</div>
2337 Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {<b>link</b> Roo.DomQuery<b>select</b>}
2344 <dl class="detailList">
2345 <dt class="heading">Parameters:</dt>
2348 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>path</b>
2351 <dd>The selector/xpath query</dd>
2354 <span class="fixedFont">Node</span> <b>root</b>
2357 <dd>(optional) The start of the query (defaults to document).</dd>
2365 <dl class="detailList">
2366 <dt class="heading">Returns:</dt>
2368 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
2382 <td class="msource">
2390 <tr class="method-row config-row-alt0 expandable notInherited">
2391 <td class="micon"><a class="exi" href="#expand"> </a></td>
2395 <a id="Roo-method-select" name=".select"></a>
2396 <div class="fixedFont">
2397 <span class="attributes">Roo.</span><b class="itemname">select</b>
2399 (<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>)
2405 CompositeElementLite/CompositeElement
2414 <div class="short">Selects elements based on the passed CSS selector to enable working on them as 1.</div>
2420 Selects elements based on the passed CSS selector to enable working on them as 1.
2427 <dl class="detailList">
2428 <dt class="heading">Parameters:</dt>
2431 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span> <b>selector</b>
2434 <dd>The CSS selector or an array of elements</dd>
2437 <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>
2440 <dd>(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)</dd>
2443 <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>
2446 <dd>(optional) The root element of the query or id of the root</dd>
2454 <dl class="detailList">
2455 <dt class="heading">Returns:</dt>
2457 <dd><span class="fixedFont">CompositeElementLite/CompositeElement</span> </dd>
2471 <td class="msource">
2479 <tr class="method-row config-row-alt1 expandable notInherited">
2480 <td class="micon"><a class="exi" href="#expand"> </a></td>
2484 <a id="Roo-method-type" name=".type"></a>
2485 <div class="fixedFont">
2486 <span class="attributes">Roo.</span><b class="itemname">type</b>
2488 (Mixed <B><i>object</i></B>)
2494 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2503 <div class="short">Returns the type of object that is passed in.</div>
2509 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>
2516 <dl class="detailList">
2517 <dt class="heading">Parameters:</dt>
2520 <span class="fixedFont">Mixed</span> <b>object</b>
2531 <dl class="detailList">
2532 <dt class="heading">Returns:</dt>
2534 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
2548 <td class="msource">
2556 <tr class="method-row config-row-alt0 expandable notInherited">
2557 <td class="micon"><a class="exi" href="#expand"> </a></td>
2561 <a id="Roo-method-urlDecode" name=".urlDecode"></a>
2562 <div class="fixedFont">
2563 <span class="attributes">Roo.</span><b class="itemname">urlDecode</b>
2565 (<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>)
2571 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2580 <div class="short">Takes an encoded URL and and converts it to an object.</div>
2586 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]}.
2593 <dl class="detailList">
2594 <dt class="heading">Parameters:</dt>
2597 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>string</b>
2603 <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>
2606 <dd>(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).</dd>
2614 <dl class="detailList">
2615 <dt class="heading">Returns:</dt>
2617 <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>
2631 <td class="msource">
2639 <tr class="method-row config-row-alt1 expandable notInherited">
2640 <td class="micon"><a class="exi" href="#expand"> </a></td>
2644 <a id="Roo-method-urlEncode" name=".urlEncode"></a>
2645 <div class="fixedFont">
2646 <span class="attributes">Roo.</span><b class="itemname">urlEncode</b>
2648 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
2654 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2663 <div class="short">Takes an object and converts it to an encoded URL.</div>
2669 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.
2676 <dl class="detailList">
2677 <dt class="heading">Parameters:</dt>
2680 <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>
2691 <dl class="detailList">
2692 <dt class="heading">Returns:</dt>
2694 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
2708 <td class="msource">
2719 <!-- ============================== events summary / details ======================== -->
2722 <a id="Roo-events"></a>
2728 <table cellspacing="0" class="member-table">
2729 <caption class="Empty">Events - Has None</caption>
2740 <!-- ============================== footer ================================= -->
2741 <div class="fineprint" style="clear:both">
2743 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:05:06 GMT+0800 (HKT)
2745 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob