Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / Ext.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js">
10 // for old browsers
11 window.undefined = window.undefined;
12
13 <div id="cls-Ext"></div>/**
14  * @class Ext
15  * Ext core utilities and functions.
16  * @singleton
17  */
18
19 Ext = {
20     <div id="prop-Ext-version"></div>/**
21      * The version of the framework
22      * @type String
23      */
24     version : '3.1.0'
25 };
26
27 <div id="method-Ext-apply"></div>/**
28  * Copies all the properties of config to obj.
29  * @param {Object} obj The receiver of the properties
30  * @param {Object} config The source of the properties
31  * @param {Object} defaults A different object that will also be applied for default values
32  * @return {Object} returns obj
33  * @member Ext apply
34  */
35 Ext.apply = function(o, c, defaults){
36     // no "this" reference for friendly out of scope calls
37     if(defaults){
38         Ext.apply(o, defaults);
39     }
40     if(o && c && typeof c == 'object'){
41         for(var p in c){
42             o[p] = c[p];
43         }
44     }
45     return o;
46 };
47
48 (function(){
49     var idSeed = 0,
50         toString = Object.prototype.toString,
51         ua = navigator.userAgent.toLowerCase(),
52         check = function(r){
53             return r.test(ua);
54         },
55         DOC = document,
56         isStrict = DOC.compatMode == "CSS1Compat",
57         isOpera = check(/opera/),
58         isChrome = check(/chrome/),
59         isWebKit = check(/webkit/),
60         isSafari = !isChrome && check(/safari/),
61         isSafari2 = isSafari && check(/applewebkit\/4/), // unique to Safari 2
62         isSafari3 = isSafari && check(/version\/3/),
63         isSafari4 = isSafari && check(/version\/4/),
64         isIE = !isOpera && check(/msie/),
65         isIE7 = isIE && check(/msie 7/),
66         isIE8 = isIE && check(/msie 8/),
67         isIE6 = isIE && !isIE7 && !isIE8,
68         isGecko = !isWebKit && check(/gecko/),
69         isGecko2 = isGecko && check(/rv:1\.8/),
70         isGecko3 = isGecko && check(/rv:1\.9/),
71         isBorderBox = isIE && !isStrict,
72         isWindows = check(/windows|win32/),
73         isMac = check(/macintosh|mac os x/),
74         isAir = check(/adobeair/),
75         isLinux = check(/linux/),
76         isSecure = /^https/i.test(window.location.protocol);
77
78     // remove css image flicker
79     if(isIE6){
80         try{
81             DOC.execCommand("BackgroundImageCache", false, true);
82         }catch(e){}
83     }
84
85     Ext.apply(Ext, {
86         <div id="prop-Ext-SSL_SECURE_URL"></div>/**
87          * URL to a blank file used by Ext when in secure mode for iframe src and onReady src to prevent
88          * the IE insecure content warning (<tt>'about:blank'</tt>, except for IE in secure mode, which is <tt>'javascript:""'</tt>).
89          * @type String
90          */
91         SSL_SECURE_URL : isSecure && isIE ? 'javascript:""' : 'about:blank',
92         <div id="prop-Ext-isStrict"></div>/**
93          * True if the browser is in strict (standards-compliant) mode, as opposed to quirks mode
94          * @type Boolean
95          */
96         isStrict : isStrict,
97         <div id="prop-Ext-isSecure"></div>/**
98          * True if the page is running over SSL
99          * @type Boolean
100          */
101         isSecure : isSecure,
102         <div id="prop-Ext-isReady"></div>/**
103          * True when the document is fully initialized and ready for action
104          * @type Boolean
105          */
106         isReady : false,
107
108         <div id="prop-Ext-enableFx"></div>/**
109          * True if the {@link Ext.Fx} Class is available
110          * @type Boolean
111          * @property enableFx
112          */
113
114         <div id="prop-Ext-enableGarbageCollector"></div>/**
115          * True to automatically uncache orphaned Ext.Elements periodically (defaults to true)
116          * @type Boolean
117          */
118         enableGarbageCollector : true,
119
120         <div id="prop-Ext-enableListenerCollection"></div>/**
121          * True to automatically purge event listeners during garbageCollection (defaults to false).
122          * @type Boolean
123          */
124         enableListenerCollection : false,
125
126         <div id="prop-Ext-enableNestedListenerRemoval"></div>/**
127          * EXPERIMENTAL - True to cascade listener removal to child elements when an element is removed.
128          * Currently not optimized for performance.
129          * @type Boolean
130          */
131         enableNestedListenerRemoval : false,
132
133         <div id="prop-Ext-USE_NATIVE_JSON"></div>/**
134          * Indicates whether to use native browser parsing for JSON methods.
135          * This option is ignored if the browser does not support native JSON methods.
136          * <b>Note: Native JSON methods will not work with objects that have functions.
137          * Also, property names must be quoted, otherwise the data will not parse.</b> (Defaults to false)
138          * @type Boolean
139          */
140         USE_NATIVE_JSON : false,
141
142         <div id="method-Ext-applyIf"></div>/**
143          * Copies all the properties of config to obj if they don't already exist.
144          * @param {Object} obj The receiver of the properties
145          * @param {Object} config The source of the properties
146          * @return {Object} returns obj
147          */
148         applyIf : function(o, c){
149             if(o){
150                 for(var p in c){
151                     if(!Ext.isDefined(o[p])){
152                         o[p] = c[p];
153                     }
154                 }
155             }
156             return o;
157         },
158
159         <div id="method-Ext-id"></div>/**
160          * Generates unique ids. If the element already has an id, it is unchanged
161          * @param {Mixed} el (optional) The element to generate an id for
162          * @param {String} prefix (optional) Id prefix (defaults "ext-gen")
163          * @return {String} The generated Id.
164          */
165         id : function(el, prefix){
166             return (el = Ext.getDom(el) || {}).id = el.id || (prefix || "ext-gen") + (++idSeed);
167         },
168
169         <div id="method-Ext-extend"></div>/**
170          * <p>Extends one class to create a subclass and optionally overrides members with the passed literal. This method
171          * also adds the function "override()" to the subclass that can be used to override members of the class.</p>
172          * For example, to create a subclass of Ext GridPanel:
173          * <pre><code>
174 MyGridPanel = Ext.extend(Ext.grid.GridPanel, {
175     constructor: function(config) {
176
177 //      Create configuration for this Grid.
178         var store = new Ext.data.Store({...});
179         var colModel = new Ext.grid.ColumnModel({...});
180
181 //      Create a new config object containing our computed properties
182 //      *plus* whatever was in the config parameter.
183         config = Ext.apply({
184             store: store,
185             colModel: colModel
186         }, config);
187
188         MyGridPanel.superclass.constructor.call(this, config);
189
190 //      Your postprocessing here
191     },
192
193     yourMethod: function() {
194         // etc.
195     }
196 });
197 </code></pre>
198          *
199          * <p>This function also supports a 3-argument call in which the subclass's constructor is
200          * passed as an argument. In this form, the parameters are as follows:</p>
201          * <div class="mdetail-params"><ul>
202          * <li><code>subclass</code> : Function <div class="sub-desc">The subclass constructor.</div></li>
203          * <li><code>superclass</code> : Function <div class="sub-desc">The constructor of class being extended</div></li>
204          * <li><code>overrides</code> : Object <div class="sub-desc">A literal with members which are copied into the subclass's
205          * prototype, and are therefore shared among all instances of the new class.</div></li>
206          * </ul></div>
207          *
208          * @param {Function} superclass The constructor of class being extended.
209          * @param {Object} overrides <p>A literal with members which are copied into the subclass's
210          * prototype, and are therefore shared between all instances of the new class.</p>
211          * <p>This may contain a special member named <tt><b>constructor</b></tt>. This is used
212          * to define the constructor of the new class, and is returned. If this property is
213          * <i>not</i> specified, a constructor is generated and returned which just calls the
214          * superclass's constructor passing on its parameters.</p>
215          * <p><b>It is essential that you call the superclass constructor in any provided constructor. See example code.</b></p>
216          * @return {Function} The subclass constructor from the <code>overrides</code> parameter, or a generated one if not provided.
217          */
218         extend : function(){
219             // inline overrides
220             var io = function(o){
221                 for(var m in o){
222                     this[m] = o[m];
223                 }
224             };
225             var oc = Object.prototype.constructor;
226
227             return function(sb, sp, overrides){
228                 if(Ext.isObject(sp)){
229                     overrides = sp;
230                     sp = sb;
231                     sb = overrides.constructor != oc ? overrides.constructor : function(){sp.apply(this, arguments);};
232                 }
233                 var F = function(){},
234                     sbp,
235                     spp = sp.prototype;
236
237                 F.prototype = spp;
238                 sbp = sb.prototype = new F();
239                 sbp.constructor=sb;
240                 sb.superclass=spp;
241                 if(spp.constructor == oc){
242                     spp.constructor=sp;
243                 }
244                 sb.override = function(o){
245                     Ext.override(sb, o);
246                 };
247                 sbp.superclass = sbp.supr = (function(){
248                     return spp;
249                 });
250                 sbp.override = io;
251                 Ext.override(sb, overrides);
252                 sb.extend = function(o){return Ext.extend(sb, o);};
253                 return sb;
254             };
255         }(),
256
257         <div id="method-Ext-override"></div>/**
258          * Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.
259          * Usage:<pre><code>
260 Ext.override(MyClass, {
261     newMethod1: function(){
262         // etc.
263     },
264     newMethod2: function(foo){
265         // etc.
266     }
267 });
268 </code></pre>
269          * @param {Object} origclass The class to override
270          * @param {Object} overrides The list of functions to add to origClass.  This should be specified as an object literal
271          * containing one or more methods.
272          * @method override
273          */
274         override : function(origclass, overrides){
275             if(overrides){
276                 var p = origclass.prototype;
277                 Ext.apply(p, overrides);
278                 if(Ext.isIE && overrides.hasOwnProperty('toString')){
279                     p.toString = overrides.toString;
280                 }
281             }
282         },
283
284         <div id="method-Ext-namespace"></div>/**
285          * Creates namespaces to be used for scoping variables and classes so that they are not global.
286          * Specifying the last node of a namespace implicitly creates all other nodes. Usage:
287          * <pre><code>
288 Ext.namespace('Company', 'Company.data');
289 Ext.namespace('Company.data'); // equivalent and preferable to above syntax
290 Company.Widget = function() { ... }
291 Company.data.CustomStore = function(config) { ... }
292 </code></pre>
293          * @param {String} namespace1
294          * @param {String} namespace2
295          * @param {String} etc
296          * @return {Object} The namespace object. (If multiple arguments are passed, this will be the last namespace created)
297          * @method namespace
298          */
299         namespace : function(){
300             var o, d;
301             Ext.each(arguments, function(v) {
302                 d = v.split(".");
303                 o = window[d[0]] = window[d[0]] || {};
304                 Ext.each(d.slice(1), function(v2){
305                     o = o[v2] = o[v2] || {};
306                 });
307             });
308             return o;
309         },
310
311         <div id="method-Ext-urlEncode"></div>/**
312          * Takes an object and converts it to an encoded URL. e.g. Ext.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.
313          * @param {Object} o
314          * @param {String} pre (optional) A prefix to add to the url encoded string
315          * @return {String}
316          */
317         urlEncode : function(o, pre){
318             var empty,
319                 buf = [],
320                 e = encodeURIComponent;
321
322             Ext.iterate(o, function(key, item){
323                 empty = Ext.isEmpty(item);
324                 Ext.each(empty ? key : item, function(val){
325                     buf.push('&', e(key), '=', (!Ext.isEmpty(val) && (val != key || !empty)) ? (Ext.isDate(val) ? Ext.encode(val).replace(/"/g, '') : e(val)) : '');
326                 });
327             });
328             if(!pre){
329                 buf.shift();
330                 pre = '';
331             }
332             return pre + buf.join('');
333         },
334
335         <div id="method-Ext-urlDecode"></div>/**
336          * Takes an encoded URL and and converts it to an object. Example: <pre><code>
337 Ext.urlDecode("foo=1&bar=2"); // returns {foo: "1", bar: "2"}
338 Ext.urlDecode("foo=1&bar=2&bar=3&bar=4", false); // returns {foo: "1", bar: ["2", "3", "4"]}
339 </code></pre>
340          * @param {String} string
341          * @param {Boolean} overwrite (optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).
342          * @return {Object} A literal with members
343          */
344         urlDecode : function(string, overwrite){
345             if(Ext.isEmpty(string)){
346                 return {};
347             }
348             var obj = {},
349                 pairs = string.split('&'),
350                 d = decodeURIComponent,
351                 name,
352                 value;
353             Ext.each(pairs, function(pair) {
354                 pair = pair.split('=');
355                 name = d(pair[0]);
356                 value = d(pair[1]);
357                 obj[name] = overwrite || !obj[name] ? value :
358                             [].concat(obj[name]).concat(value);
359             });
360             return obj;
361         },
362
363         <div id="method-Ext-urlAppend"></div>/**
364          * Appends content to the query string of a URL, handling logic for whether to place
365          * a question mark or ampersand.
366          * @param {String} url The URL to append to.
367          * @param {String} s The content to append to the URL.
368          * @return (String) The resulting URL
369          */
370         urlAppend : function(url, s){
371             if(!Ext.isEmpty(s)){
372                 return url + (url.indexOf('?') === -1 ? '?' : '&') + s;
373             }
374             return url;
375         },
376
377         <div id="method-Ext-toArray"></div>/**
378          * Converts any iterable (numeric indices and a length property) into a true array
379          * Don't use this on strings. IE doesn't support "abc"[0] which this implementation depends on.
380          * For strings, use this instead: "abc".match(/./g) => [a,b,c];
381          * @param {Iterable} the iterable object to be turned into a true Array.
382          * @return (Array) array
383          */
384          toArray : function(){
385              return isIE ?
386                  function(a, i, j, res){
387                      res = [];
388                      for(var x = 0, len = a.length; x < len; x++) {
389                          res.push(a[x]);
390                      }
391                      return res.slice(i || 0, j || res.length);
392                  } :
393                  function(a, i, j){
394                      return Array.prototype.slice.call(a, i || 0, j || a.length);
395                  }
396          }(),
397
398         isIterable : function(v){
399             //check for array or arguments
400             if(Ext.isArray(v) || v.callee){
401                 return true;
402             }
403             //check for node list type
404             if(/NodeList|HTMLCollection/.test(toString.call(v))){
405                 return true;
406             }
407             //NodeList has an item and length property
408             //IXMLDOMNodeList has nextNode method, needs to be checked first.
409             return ((v.nextNode || v.item) && Ext.isNumber(v.length));
410         },
411
412         <div id="method-Ext-each"></div>/**
413          * Iterates an array calling the supplied function.
414          * @param {Array/NodeList/Mixed} array The array to be iterated. If this
415          * argument is not really an array, the supplied function is called once.
416          * @param {Function} fn The function to be called with each item. If the
417          * supplied function returns false, iteration stops and this method returns
418          * the current <code>index</code>. This function is called with
419          * the following arguments:
420          * <div class="mdetail-params"><ul>
421          * <li><code>item</code> : <i>Mixed</i>
422          * <div class="sub-desc">The item at the current <code>index</code>
423          * in the passed <code>array</code></div></li>
424          * <li><code>index</code> : <i>Number</i>
425          * <div class="sub-desc">The current index within the array</div></li>
426          * <li><code>allItems</code> : <i>Array</i>
427          * <div class="sub-desc">The <code>array</code> passed as the first
428          * argument to <code>Ext.each</code>.</div></li>
429          * </ul></div>
430          * @param {Object} scope The scope (<code>this</code> reference) in which the specified function is executed.
431          * Defaults to the <code>item</code> at the current <code>index</code>
432          * within the passed <code>array</code>.
433          * @return See description for the fn parameter.
434          */
435         each : function(array, fn, scope){
436             if(Ext.isEmpty(array, true)){
437                 return;
438             }
439             if(!Ext.isIterable(array) || Ext.isPrimitive(array)){
440                 array = [array];
441             }
442             for(var i = 0, len = array.length; i < len; i++){
443                 if(fn.call(scope || array[i], array[i], i, array) === false){
444                     return i;
445                 };
446             }
447         },
448
449         <div id="method-Ext-iterate"></div>/**
450          * Iterates either the elements in an array, or each of the properties in an object.
451          * <b>Note</b>: If you are only iterating arrays, it is better to call {@link #each}.
452          * @param {Object/Array} object The object or array to be iterated
453          * @param {Function} fn The function to be called for each iteration.
454          * The iteration will stop if the supplied function returns false, or
455          * all array elements / object properties have been covered. The signature
456          * varies depending on the type of object being interated:
457          * <div class="mdetail-params"><ul>
458          * <li>Arrays : <tt>(Object item, Number index, Array allItems)</tt>
459          * <div class="sub-desc">
460          * When iterating an array, the supplied function is called with each item.</div></li>
461          * <li>Objects : <tt>(String key, Object value, Object)</tt>
462          * <div class="sub-desc">
463          * When iterating an object, the supplied function is called with each key-value pair in
464          * the object, and the iterated object</div></li>
465          * </ul></div>
466          * @param {Object} scope The scope (<code>this</code> reference) in which the specified function is executed. Defaults to
467          * the <code>object</code> being iterated.
468          */
469         iterate : function(obj, fn, scope){
470             if(Ext.isEmpty(obj)){
471                 return;
472             }
473             if(Ext.isIterable(obj)){
474                 Ext.each(obj, fn, scope);
475                 return;
476             }else if(Ext.isObject(obj)){
477                 for(var prop in obj){
478                     if(obj.hasOwnProperty(prop)){
479                         if(fn.call(scope || obj, prop, obj[prop], obj) === false){
480                             return;
481                         };
482                     }
483                 }
484             }
485         },
486
487         <div id="method-Ext-getDom"></div>/**
488          * Return the dom node for the passed String (id), dom node, or Ext.Element.
489          * Here are some examples:
490          * <pre><code>
491 // gets dom node based on id
492 var elDom = Ext.getDom('elId');
493 // gets dom node based on the dom node
494 var elDom1 = Ext.getDom(elDom);
495
496 // If we don&#39;t know if we are working with an
497 // Ext.Element or a dom node use Ext.getDom
498 function(el){
499     var dom = Ext.getDom(el);
500     // do something with the dom node
501 }
502          * </code></pre>
503          * <b>Note</b>: the dom node to be found actually needs to exist (be rendered, etc)
504          * when this method is called to be successful.
505          * @param {Mixed} el
506          * @return HTMLElement
507          */
508         getDom : function(el){
509             if(!el || !DOC){
510                 return null;
511             }
512             return el.dom ? el.dom : (Ext.isString(el) ? DOC.getElementById(el) : el);
513         },
514
515         <div id="method-Ext-getBody"></div>/**
516          * Returns the current document body as an {@link Ext.Element}.
517          * @return Ext.Element The document body
518          */
519         getBody : function(){
520             return Ext.get(DOC.body || DOC.documentElement);
521         },
522
523         <div id="prop-Ext-"></div>/**
524          * Removes a DOM node from the document.
525          */
526         <div id="method-Ext-removeNode"></div>/**
527          * <p>Removes this element from the document, removes all DOM event listeners, and deletes the cache reference.
528          * All DOM event listeners are removed from this element. If {@link Ext#enableNestedListenerRemoval} is
529          * <code>true</code>, then DOM event listeners are also removed from all child nodes. The body node
530          * will be ignored if passed in.</p>
531          * @param {HTMLElement} node The node to remove
532          */
533         removeNode : isIE && !isIE8 ? function(){
534             var d;
535             return function(n){
536                 if(n && n.tagName != 'BODY'){
537                     (Ext.enableNestedListenerRemoval) ? Ext.EventManager.purgeElement(n, true) : Ext.EventManager.removeAll(n);
538                     d = d || DOC.createElement('div');
539                     d.appendChild(n);
540                     d.innerHTML = '';
541                     delete Ext.elCache[n.id];
542                 }
543             }
544         }() : function(n){
545             if(n && n.parentNode && n.tagName != 'BODY'){
546                 (Ext.enableNestedListenerRemoval) ? Ext.EventManager.purgeElement(n, true) : Ext.EventManager.removeAll(n);
547                 n.parentNode.removeChild(n);
548                 delete Ext.elCache[n.id];
549             }
550         },
551
552         <div id="method-Ext-isEmpty"></div>/**
553          * <p>Returns true if the passed value is empty.</p>
554          * <p>The value is deemed to be empty if it is<div class="mdetail-params"><ul>
555          * <li>null</li>
556          * <li>undefined</li>
557          * <li>an empty array</li>
558          * <li>a zero length string (Unless the <tt>allowBlank</tt> parameter is <tt>true</tt>)</li>
559          * </ul></div>
560          * @param {Mixed} value The value to test
561          * @param {Boolean} allowBlank (optional) true to allow empty strings (defaults to false)
562          * @return {Boolean}
563          */
564         isEmpty : function(v, allowBlank){
565             return v === null || v === undefined || ((Ext.isArray(v) && !v.length)) || (!allowBlank ? v === '' : false);
566         },
567
568         <div id="method-Ext-isArray"></div>/**
569          * Returns true if the passed value is a JavaScript array, otherwise false.
570          * @param {Mixed} value The value to test
571          * @return {Boolean}
572          */
573         isArray : function(v){
574             return toString.apply(v) === '[object Array]';
575         },
576
577         <div id="method-Ext-isDate"></div>/**
578          * Returns true if the passed object is a JavaScript date object, otherwise false.
579          * @param {Object} object The object to test
580          * @return {Boolean}
581          */
582         isDate : function(v){
583             return toString.apply(v) === '[object Date]';
584         },
585
586         <div id="method-Ext-isObject"></div>/**
587          * Returns true if the passed value is a JavaScript Object, otherwise false.
588          * @param {Mixed} value The value to test
589          * @return {Boolean}
590          */
591         isObject : function(v){
592             return !!v && Object.prototype.toString.call(v) === '[object Object]';
593         },
594
595         <div id="method-Ext-isPrimitive"></div>/**
596          * Returns true if the passed value is a JavaScript 'primitive', a string, number or boolean.
597          * @param {Mixed} value The value to test
598          * @return {Boolean}
599          */
600         isPrimitive : function(v){
601             return Ext.isString(v) || Ext.isNumber(v) || Ext.isBoolean(v);
602         },
603
604         <div id="method-Ext-isFunction"></div>/**
605          * Returns true if the passed value is a JavaScript Function, otherwise false.
606          * @param {Mixed} value The value to test
607          * @return {Boolean}
608          */
609         isFunction : function(v){
610             return toString.apply(v) === '[object Function]';
611         },
612
613         <div id="method-Ext-isNumber"></div>/**
614          * Returns true if the passed value is a number. Returns false for non-finite numbers.
615          * @param {Mixed} value The value to test
616          * @return {Boolean}
617          */
618         isNumber : function(v){
619             return typeof v === 'number' && isFinite(v);
620         },
621
622         <div id="method-Ext-isString"></div>/**
623          * Returns true if the passed value is a string.
624          * @param {Mixed} value The value to test
625          * @return {Boolean}
626          */
627         isString : function(v){
628             return typeof v === 'string';
629         },
630
631         <div id="method-Ext-isBoolean"></div>/**
632          * Returns true if the passed value is a boolean.
633          * @param {Mixed} value The value to test
634          * @return {Boolean}
635          */
636         isBoolean : function(v){
637             return typeof v === 'boolean';
638         },
639
640         <div id="method-Ext-isElement"></div>/**
641          * Returns true if the passed value is an HTMLElement
642          * @param {Mixed} value The value to test
643          * @return {Boolean}
644          */
645         isElement : function(v) {
646             return !!v && v.tagName;
647         },
648
649         <div id="method-Ext-isDefined"></div>/**
650          * Returns true if the passed value is not undefined.
651          * @param {Mixed} value The value to test
652          * @return {Boolean}
653          */
654         isDefined : function(v){
655             return typeof v !== 'undefined';
656         },
657
658         <div id="prop-Ext-isOpera"></div>/**
659          * True if the detected browser is Opera.
660          * @type Boolean
661          */
662         isOpera : isOpera,
663         <div id="prop-Ext-isWebKit"></div>/**
664          * True if the detected browser uses WebKit.
665          * @type Boolean
666          */
667         isWebKit : isWebKit,
668         <div id="prop-Ext-isChrome"></div>/**
669          * True if the detected browser is Chrome.
670          * @type Boolean
671          */
672         isChrome : isChrome,
673         <div id="prop-Ext-isSafari"></div>/**
674          * True if the detected browser is Safari.
675          * @type Boolean
676          */
677         isSafari : isSafari,
678         <div id="prop-Ext-isSafari3"></div>/**
679          * True if the detected browser is Safari 3.x.
680          * @type Boolean
681          */
682         isSafari3 : isSafari3,
683         <div id="prop-Ext-isSafari4"></div>/**
684          * True if the detected browser is Safari 4.x.
685          * @type Boolean
686          */
687         isSafari4 : isSafari4,
688         <div id="prop-Ext-isSafari2"></div>/**
689          * True if the detected browser is Safari 2.x.
690          * @type Boolean
691          */
692         isSafari2 : isSafari2,
693         <div id="prop-Ext-isIE"></div>/**
694          * True if the detected browser is Internet Explorer.
695          * @type Boolean
696          */
697         isIE : isIE,
698         <div id="prop-Ext-isIE6"></div>/**
699          * True if the detected browser is Internet Explorer 6.x.
700          * @type Boolean
701          */
702         isIE6 : isIE6,
703         <div id="prop-Ext-isIE7"></div>/**
704          * True if the detected browser is Internet Explorer 7.x.
705          * @type Boolean
706          */
707         isIE7 : isIE7,
708         <div id="prop-Ext-isIE8"></div>/**
709          * True if the detected browser is Internet Explorer 8.x.
710          * @type Boolean
711          */
712         isIE8 : isIE8,
713         <div id="prop-Ext-isGecko"></div>/**
714          * True if the detected browser uses the Gecko layout engine (e.g. Mozilla, Firefox).
715          * @type Boolean
716          */
717         isGecko : isGecko,
718         <div id="prop-Ext-isGecko2"></div>/**
719          * True if the detected browser uses a pre-Gecko 1.9 layout engine (e.g. Firefox 2.x).
720          * @type Boolean
721          */
722         isGecko2 : isGecko2,
723         <div id="prop-Ext-isGecko3"></div>/**
724          * True if the detected browser uses a Gecko 1.9+ layout engine (e.g. Firefox 3.x).
725          * @type Boolean
726          */
727         isGecko3 : isGecko3,
728         <div id="prop-Ext-isBorderBox"></div>/**
729          * True if the detected browser is Internet Explorer running in non-strict mode.
730          * @type Boolean
731          */
732         isBorderBox : isBorderBox,
733         <div id="prop-Ext-isLinux"></div>/**
734          * True if the detected platform is Linux.
735          * @type Boolean
736          */
737         isLinux : isLinux,
738         <div id="prop-Ext-isWindows"></div>/**
739          * True if the detected platform is Windows.
740          * @type Boolean
741          */
742         isWindows : isWindows,
743         <div id="prop-Ext-isMac"></div>/**
744          * True if the detected platform is Mac OS.
745          * @type Boolean
746          */
747         isMac : isMac,
748         <div id="prop-Ext-isAir"></div>/**
749          * True if the detected platform is Adobe Air.
750          * @type Boolean
751          */
752         isAir : isAir
753     });
754
755     <div id="method-Ext-ns"></div>/**
756      * Creates namespaces to be used for scoping variables and classes so that they are not global.
757      * Specifying the last node of a namespace implicitly creates all other nodes. Usage:
758      * <pre><code>
759 Ext.namespace('Company', 'Company.data');
760 Ext.namespace('Company.data'); // equivalent and preferable to above syntax
761 Company.Widget = function() { ... }
762 Company.data.CustomStore = function(config) { ... }
763 </code></pre>
764      * @param {String} namespace1
765      * @param {String} namespace2
766      * @param {String} etc
767      * @return {Object} The namespace object. (If multiple arguments are passed, this will be the last namespace created)
768      * @method ns
769      */
770     Ext.ns = Ext.namespace;
771 })();
772
773 Ext.ns("Ext.util", "Ext.lib", "Ext.data");
774
775 Ext.elCache = {};
776
777 <div id="cls-Function"></div>/**
778  * @class Function
779  * These functions are available on every Function object (any JavaScript function).
780  */
781 Ext.apply(Function.prototype, {
782      <div id="method-Function-createInterceptor"></div>/**
783      * Creates an interceptor function. The passed function is called before the original one. If it returns false,
784      * the original one is not called. The resulting function returns the results of the original function.
785      * The passed function is called with the parameters of the original function. Example usage:
786      * <pre><code>
787 var sayHi = function(name){
788     alert('Hi, ' + name);
789 }
790
791 sayHi('Fred'); // alerts "Hi, Fred"
792
793 // create a new function that validates input without
794 // directly modifying the original function:
795 var sayHiToFriend = sayHi.createInterceptor(function(name){
796     return name == 'Brian';
797 });
798
799 sayHiToFriend('Fred');  // no alert
800 sayHiToFriend('Brian'); // alerts "Hi, Brian"
801 </code></pre>
802      * @param {Function} fcn The function to call before the original
803      * @param {Object} scope (optional) The scope (<code><b>this</b></code> reference) in which the passed function is executed.
804      * <b>If omitted, defaults to the scope in which the original function is called or the browser window.</b>
805      * @return {Function} The new function
806      */
807     createInterceptor : function(fcn, scope){
808         var method = this;
809         return !Ext.isFunction(fcn) ?
810                 this :
811                 function() {
812                     var me = this,
813                         args = arguments;
814                     fcn.target = me;
815                     fcn.method = method;
816                     return (fcn.apply(scope || me || window, args) !== false) ?
817                             method.apply(me || window, args) :
818                             null;
819                 };
820     },
821
822      <div id="method-Function-createCallback"></div>/**
823      * Creates a callback that passes arguments[0], arguments[1], arguments[2], ...
824      * Call directly on any function. Example: <code>myFunction.createCallback(arg1, arg2)</code>
825      * Will create a function that is bound to those 2 args. <b>If a specific scope is required in the
826      * callback, use {@link #createDelegate} instead.</b> The function returned by createCallback always
827      * executes in the window scope.
828      * <p>This method is required when you want to pass arguments to a callback function.  If no arguments
829      * are needed, you can simply pass a reference to the function as a callback (e.g., callback: myFn).
830      * However, if you tried to pass a function with arguments (e.g., callback: myFn(arg1, arg2)) the function
831      * would simply execute immediately when the code is parsed. Example usage:
832      * <pre><code>
833 var sayHi = function(name){
834     alert('Hi, ' + name);
835 }
836
837 // clicking the button alerts "Hi, Fred"
838 new Ext.Button({
839     text: 'Say Hi',
840     renderTo: Ext.getBody(),
841     handler: sayHi.createCallback('Fred')
842 });
843 </code></pre>
844      * @return {Function} The new function
845     */
846     createCallback : function(/*args...*/){
847         // make args available, in function below
848         var args = arguments,
849             method = this;
850         return function() {
851             return method.apply(window, args);
852         };
853     },
854
855     <div id="method-Function-createDelegate"></div>/**
856      * Creates a delegate (callback) that sets the scope to obj.
857      * Call directly on any function. Example: <code>this.myFunction.createDelegate(this, [arg1, arg2])</code>
858      * Will create a function that is automatically scoped to obj so that the <tt>this</tt> variable inside the
859      * callback points to obj. Example usage:
860      * <pre><code>
861 var sayHi = function(name){
862     // Note this use of "this.text" here.  This function expects to
863     // execute within a scope that contains a text property.  In this
864     // example, the "this" variable is pointing to the btn object that
865     // was passed in createDelegate below.
866     alert('Hi, ' + name + '. You clicked the "' + this.text + '" button.');
867 }
868
869 var btn = new Ext.Button({
870     text: 'Say Hi',
871     renderTo: Ext.getBody()
872 });
873
874 // This callback will execute in the scope of the
875 // button instance. Clicking the button alerts
876 // "Hi, Fred. You clicked the "Say Hi" button."
877 btn.on('click', sayHi.createDelegate(btn, ['Fred']));
878 </code></pre>
879      * @param {Object} scope (optional) The scope (<code><b>this</b></code> reference) in which the function is executed.
880      * <b>If omitted, defaults to the browser window.</b>
881      * @param {Array} args (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)
882      * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding,
883      * if a number the args are inserted at the specified position
884      * @return {Function} The new function
885      */
886     createDelegate : function(obj, args, appendArgs){
887         var method = this;
888         return function() {
889             var callArgs = args || arguments;
890             if (appendArgs === true){
891                 callArgs = Array.prototype.slice.call(arguments, 0);
892                 callArgs = callArgs.concat(args);
893             }else if (Ext.isNumber(appendArgs)){
894                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
895                 var applyArgs = [appendArgs, 0].concat(args); // create method call params
896                 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
897             }
898             return method.apply(obj || window, callArgs);
899         };
900     },
901
902     <div id="method-Function-defer"></div>/**
903      * Calls this function after the number of millseconds specified, optionally in a specific scope. Example usage:
904      * <pre><code>
905 var sayHi = function(name){
906     alert('Hi, ' + name);
907 }
908
909 // executes immediately:
910 sayHi('Fred');
911
912 // executes after 2 seconds:
913 sayHi.defer(2000, this, ['Fred']);
914
915 // this syntax is sometimes useful for deferring
916 // execution of an anonymous function:
917 (function(){
918     alert('Anonymous');
919 }).defer(100);
920 </code></pre>
921      * @param {Number} millis The number of milliseconds for the setTimeout call (if less than or equal to 0 the function is executed immediately)
922      * @param {Object} scope (optional) The scope (<code><b>this</b></code> reference) in which the function is executed.
923      * <b>If omitted, defaults to the browser window.</b>
924      * @param {Array} args (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)
925      * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding,
926      * if a number the args are inserted at the specified position
927      * @return {Number} The timeout id that can be used with clearTimeout
928      */
929     defer : function(millis, obj, args, appendArgs){
930         var fn = this.createDelegate(obj, args, appendArgs);
931         if(millis > 0){
932             return setTimeout(fn, millis);
933         }
934         fn();
935         return 0;
936     }
937 });
938
939 <div id="cls-String"></div>/**
940  * @class String
941  * These functions are available on every String object.
942  */
943 Ext.applyIf(String, {
944     <div id="method-String-format"></div>/**
945      * Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens.  Each
946      * token must be unique, and must increment in the format {0}, {1}, etc.  Example usage:
947      * <pre><code>
948 var cls = 'my-class', text = 'Some text';
949 var s = String.format('&lt;div class="{0}">{1}&lt;/div>', cls, text);
950 // s now contains the string: '&lt;div class="my-class">Some text&lt;/div>'
951      * </code></pre>
952      * @param {String} string The tokenized string to be formatted
953      * @param {String} value1 The value to replace token {0}
954      * @param {String} value2 Etc...
955      * @return {String} The formatted string
956      * @static
957      */
958     format : function(format){
959         var args = Ext.toArray(arguments, 1);
960         return format.replace(/\{(\d+)\}/g, function(m, i){
961             return args[i];
962         });
963     }
964 });
965
966 <div id="cls-Array"></div>/**
967  * @class Array
968  */
969 Ext.applyIf(Array.prototype, {
970     <div id="method-Array-indexOf"></div>/**
971      * Checks whether or not the specified object exists in the array.
972      * @param {Object} o The object to check for
973      * @param {Number} from (Optional) The index at which to begin the search
974      * @return {Number} The index of o in the array (or -1 if it is not found)
975      */
976     indexOf : function(o, from){
977         var len = this.length;
978         from = from || 0;
979         from += (from < 0) ? len : 0;
980         for (; from < len; ++from){
981             if(this[from] === o){
982                 return from;
983             }
984         }
985         return -1;
986     },
987
988     <div id="method-Array-remove"></div>/**
989      * Removes the specified object from the array.  If the object is not found nothing happens.
990      * @param {Object} o The object to remove
991      * @return {Array} this array
992      */
993     remove : function(o){
994         var index = this.indexOf(o);
995         if(index != -1){
996             this.splice(index, 1);
997         }
998         return this;
999     }
1000 });
1001 </pre>    \r
1002 </body>\r
1003 </html>