1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="bookmark" href="../docs/?class=Ext"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
7 | </div> |
---|
8 | <h1>Class Ext</h1> |
---|
9 | <table cellspacing="0"> |
---|
10 | <tr><td class="label">Package:</td><td class="hd-info">Global</td></tr> |
---|
11 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Ext.js" target="_blank">Ext.js</a></td></tr> |
---|
12 | <tr><td class="label">Class:</td><td class="hd-info">Ext</td></tr> |
---|
13 | <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr> |
---|
14 | </table> |
---|
15 | <div class="description"> |
---|
16 | Ext core utilities and functions.<br><br><i>This class is a singleton and cannot be created directly.</i> </div> |
---|
17 | |
---|
18 | <div class="hr"></div> |
---|
19 | <a id="Ext-props"></a> |
---|
20 | <h2>Public Properties</h2> |
---|
21 | <table cellspacing="0" class="member-table"> |
---|
22 | <tr> |
---|
23 | <th class="sig-header" colspan="2">Property</th> |
---|
24 | <th class="msource-header">Defined By</th> |
---|
25 | </tr> |
---|
26 | <tr class="property-row expandable"> |
---|
27 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
28 | <td class="sig"> |
---|
29 | <a id="Ext-BLANK_IMAGE_URL"></a> |
---|
30 | <b>BLANK_IMAGE_URL</b> : String <div class="mdesc"> |
---|
31 | <div class="short">URL to a 1x1 transparent gif image used by Ext to create inline icons with CSS background images. (Defaults to |
---|
32 | "http:...</div> |
---|
33 | <div class="long"> |
---|
34 | URL to a 1x1 transparent gif image used by Ext to create inline icons with CSS background images. (Defaults to |
---|
35 | "http://extjs.com/s.gif" and you should change this to a URL on your server). </div> |
---|
36 | </div> |
---|
37 | </td> |
---|
38 | <td class="msource">Ext</td> |
---|
39 | </tr> |
---|
40 | <tr class="property-row alt expandable"> |
---|
41 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
42 | <td class="sig"> |
---|
43 | <a id="Ext-SSL_SECURE_URL"></a> |
---|
44 | <b>SSL_SECURE_URL</b> : String <div class="mdesc"> |
---|
45 | <div class="short">URL to a blank file used by Ext when in secure mode for iframe src and onReady src to prevent |
---|
46 | the IE insecure content...</div> |
---|
47 | <div class="long"> |
---|
48 | URL to a blank file used by Ext when in secure mode for iframe src and onReady src to prevent |
---|
49 | the IE insecure content warning (defaults to javascript:false). </div> |
---|
50 | </div> |
---|
51 | </td> |
---|
52 | <td class="msource">Ext</td> |
---|
53 | </tr> |
---|
54 | <tr class="property-row"> |
---|
55 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
56 | <td class="sig"> |
---|
57 | <a id="Ext-emptyFn"></a> |
---|
58 | <b>emptyFn</b> : Function <div class="mdesc"> |
---|
59 | A reusable empty function </div> |
---|
60 | </td> |
---|
61 | <td class="msource">Ext</td> |
---|
62 | </tr> |
---|
63 | <tr class="property-row alt"> |
---|
64 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
65 | <td class="sig"> |
---|
66 | <a id="Ext-enableGarbageCollector"></a> |
---|
67 | <b>enableGarbageCollector</b> : Boolean <div class="mdesc"> |
---|
68 | True to automatically uncache orphaned Ext.Elements periodically (defaults to true) </div> |
---|
69 | </td> |
---|
70 | <td class="msource">Ext</td> |
---|
71 | </tr> |
---|
72 | <tr class="property-row expandable"> |
---|
73 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
74 | <td class="sig"> |
---|
75 | <a id="Ext-enableListenerCollection"></a> |
---|
76 | <b>enableListenerCollection</b> : Boolean <div class="mdesc"> |
---|
77 | <div class="short">True to automatically purge event listeners after uncaching an element (defaults to false). |
---|
78 | Note: this only happens i...</div> |
---|
79 | <div class="long"> |
---|
80 | True to automatically purge event listeners after uncaching an element (defaults to false). |
---|
81 | Note: this only happens if enableGarbageCollector is true. </div> |
---|
82 | </div> |
---|
83 | </td> |
---|
84 | <td class="msource">Ext</td> |
---|
85 | </tr> |
---|
86 | <tr class="property-row alt"> |
---|
87 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
88 | <td class="sig"> |
---|
89 | <a id="Ext-isAir"></a> |
---|
90 | <b>isAir</b> : Boolean <div class="mdesc"> |
---|
91 | True if the detected platform is Adobe Air. </div> |
---|
92 | </td> |
---|
93 | <td class="msource">Ext</td> |
---|
94 | </tr> |
---|
95 | <tr class="property-row"> |
---|
96 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
97 | <td class="sig"> |
---|
98 | <a id="Ext-isBorderBox"></a> |
---|
99 | <b>isBorderBox</b> : Boolean <div class="mdesc"> |
---|
100 | True if the detected browser is Internet Explorer running in non-strict mode. </div> |
---|
101 | </td> |
---|
102 | <td class="msource">Ext</td> |
---|
103 | </tr> |
---|
104 | <tr class="property-row alt"> |
---|
105 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
106 | <td class="sig"> |
---|
107 | <a id="Ext-isChrome"></a> |
---|
108 | <b>isChrome</b> : Boolean <div class="mdesc"> |
---|
109 | True if the detected browser is Chrome. </div> |
---|
110 | </td> |
---|
111 | <td class="msource">Ext</td> |
---|
112 | </tr> |
---|
113 | <tr class="property-row"> |
---|
114 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
115 | <td class="sig"> |
---|
116 | <a id="Ext-isGecko"></a> |
---|
117 | <b>isGecko</b> : Boolean <div class="mdesc"> |
---|
118 | True if the detected browser uses the Gecko layout engine (e.g. Mozilla, Firefox). </div> |
---|
119 | </td> |
---|
120 | <td class="msource">Ext</td> |
---|
121 | </tr> |
---|
122 | <tr class="property-row alt"> |
---|
123 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
124 | <td class="sig"> |
---|
125 | <a id="Ext-isGecko2"></a> |
---|
126 | <b>isGecko2</b> : Boolean <div class="mdesc"> |
---|
127 | True if the detected browser uses a pre-Gecko 1.9 layout engine (e.g. Firefox 2.x). </div> |
---|
128 | </td> |
---|
129 | <td class="msource">Ext</td> |
---|
130 | </tr> |
---|
131 | <tr class="property-row"> |
---|
132 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
133 | <td class="sig"> |
---|
134 | <a id="Ext-isGecko3"></a> |
---|
135 | <b>isGecko3</b> : Boolean <div class="mdesc"> |
---|
136 | True if the detected browser uses a Gecko 1.9+ layout engine (e.g. Firefox 3.x). </div> |
---|
137 | </td> |
---|
138 | <td class="msource">Ext</td> |
---|
139 | </tr> |
---|
140 | <tr class="property-row alt"> |
---|
141 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
142 | <td class="sig"> |
---|
143 | <a id="Ext-isIE"></a> |
---|
144 | <b>isIE</b> : Boolean <div class="mdesc"> |
---|
145 | True if the detected browser is Internet Explorer. </div> |
---|
146 | </td> |
---|
147 | <td class="msource">Ext</td> |
---|
148 | </tr> |
---|
149 | <tr class="property-row"> |
---|
150 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
151 | <td class="sig"> |
---|
152 | <a id="Ext-isIE6"></a> |
---|
153 | <b>isIE6</b> : Boolean <div class="mdesc"> |
---|
154 | True if the detected browser is Internet Explorer 6.x. </div> |
---|
155 | </td> |
---|
156 | <td class="msource">Ext</td> |
---|
157 | </tr> |
---|
158 | <tr class="property-row alt"> |
---|
159 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
160 | <td class="sig"> |
---|
161 | <a id="Ext-isIE7"></a> |
---|
162 | <b>isIE7</b> : Boolean <div class="mdesc"> |
---|
163 | True if the detected browser is Internet Explorer 7.x. </div> |
---|
164 | </td> |
---|
165 | <td class="msource">Ext</td> |
---|
166 | </tr> |
---|
167 | <tr class="property-row"> |
---|
168 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
169 | <td class="sig"> |
---|
170 | <a id="Ext-isIE8"></a> |
---|
171 | <b>isIE8</b> : Boolean <div class="mdesc"> |
---|
172 | True if the detected browser is Internet Explorer 8.x. </div> |
---|
173 | </td> |
---|
174 | <td class="msource">Ext</td> |
---|
175 | </tr> |
---|
176 | <tr class="property-row alt"> |
---|
177 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
178 | <td class="sig"> |
---|
179 | <a id="Ext-isLinux"></a> |
---|
180 | <b>isLinux</b> : Boolean <div class="mdesc"> |
---|
181 | True if the detected platform is Linux. </div> |
---|
182 | </td> |
---|
183 | <td class="msource">Ext</td> |
---|
184 | </tr> |
---|
185 | <tr class="property-row"> |
---|
186 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
187 | <td class="sig"> |
---|
188 | <a id="Ext-isMac"></a> |
---|
189 | <b>isMac</b> : Boolean <div class="mdesc"> |
---|
190 | True if the detected platform is Mac OS. </div> |
---|
191 | </td> |
---|
192 | <td class="msource">Ext</td> |
---|
193 | </tr> |
---|
194 | <tr class="property-row alt"> |
---|
195 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
196 | <td class="sig"> |
---|
197 | <a id="Ext-isOpera"></a> |
---|
198 | <b>isOpera</b> : Boolean <div class="mdesc"> |
---|
199 | True if the detected browser is Opera. </div> |
---|
200 | </td> |
---|
201 | <td class="msource">Ext</td> |
---|
202 | </tr> |
---|
203 | <tr class="property-row"> |
---|
204 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
205 | <td class="sig"> |
---|
206 | <a id="Ext-isReady"></a> |
---|
207 | <b>isReady</b> : Boolean <div class="mdesc"> |
---|
208 | True when the document is fully initialized and ready for action </div> |
---|
209 | </td> |
---|
210 | <td class="msource">Ext</td> |
---|
211 | </tr> |
---|
212 | <tr class="property-row alt"> |
---|
213 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
214 | <td class="sig"> |
---|
215 | <a id="Ext-isSafari"></a> |
---|
216 | <b>isSafari</b> : Boolean <div class="mdesc"> |
---|
217 | True if the detected browser is Safari. </div> |
---|
218 | </td> |
---|
219 | <td class="msource">Ext</td> |
---|
220 | </tr> |
---|
221 | <tr class="property-row"> |
---|
222 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
223 | <td class="sig"> |
---|
224 | <a id="Ext-isSafari2"></a> |
---|
225 | <b>isSafari2</b> : Boolean <div class="mdesc"> |
---|
226 | True if the detected browser is Safari 2.x. </div> |
---|
227 | </td> |
---|
228 | <td class="msource">Ext</td> |
---|
229 | </tr> |
---|
230 | <tr class="property-row alt"> |
---|
231 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
232 | <td class="sig"> |
---|
233 | <a id="Ext-isSafari3"></a> |
---|
234 | <b>isSafari3</b> : Boolean <div class="mdesc"> |
---|
235 | True if the detected browser is Safari 3.x. </div> |
---|
236 | </td> |
---|
237 | <td class="msource">Ext</td> |
---|
238 | </tr> |
---|
239 | <tr class="property-row"> |
---|
240 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
241 | <td class="sig"> |
---|
242 | <a id="Ext-isSecure"></a> |
---|
243 | <b>isSecure</b> : Boolean <div class="mdesc"> |
---|
244 | True if the page is running over SSL </div> |
---|
245 | </td> |
---|
246 | <td class="msource">Ext</td> |
---|
247 | </tr> |
---|
248 | <tr class="property-row alt"> |
---|
249 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
250 | <td class="sig"> |
---|
251 | <a id="Ext-isStrict"></a> |
---|
252 | <b>isStrict</b> : Boolean <div class="mdesc"> |
---|
253 | True if the browser is in strict (standards-compliant) mode, as opposed to quirks mode </div> |
---|
254 | </td> |
---|
255 | <td class="msource">Ext</td> |
---|
256 | </tr> |
---|
257 | <tr class="property-row"> |
---|
258 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
259 | <td class="sig"> |
---|
260 | <a id="Ext-isWindows"></a> |
---|
261 | <b>isWindows</b> : Boolean <div class="mdesc"> |
---|
262 | True if the detected platform is Windows. </div> |
---|
263 | </td> |
---|
264 | <td class="msource">Ext</td> |
---|
265 | </tr> |
---|
266 | <tr class="property-row alt expandable"> |
---|
267 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
268 | <td class="sig"> |
---|
269 | <a id="Ext-useShims"></a> |
---|
270 | <b>useShims</b> : Boolean <div class="mdesc"> |
---|
271 | <div class="short">By default, Ext intelligently decides whether floating elements should be shimmed. If you are using flash, |
---|
272 | you may wa...</div> |
---|
273 | <div class="long"> |
---|
274 | By default, Ext intelligently decides whether floating elements should be shimmed. If you are using flash, |
---|
275 | you may want to set this to true. </div> |
---|
276 | </div> |
---|
277 | </td> |
---|
278 | <td class="msource">Ext</td> |
---|
279 | </tr> |
---|
280 | </table> |
---|
281 | <a id="Ext-methods"></a> |
---|
282 | <h2>Public Methods</h2> |
---|
283 | <table cellspacing="0" class="member-table"> |
---|
284 | <tr> |
---|
285 | <th class="sig-header" colspan="2">Method</th> |
---|
286 | <th class="msource-header">Defined By</th> |
---|
287 | </tr> |
---|
288 | <tr class="method-row expandable"> |
---|
289 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
290 | <td class="sig"> |
---|
291 | <a id="Ext-addBehaviors"></a> |
---|
292 | <b>addBehaviors</b>( <code>Object obj</code> ) : void <div class="mdesc"> |
---|
293 | <div class="short">Applies event listeners to elements by selectors when the document is ready. |
---|
294 | The event name is specified with an @ su...</div> |
---|
295 | <div class="long"> |
---|
296 | Applies event listeners to elements by selectors when the document is ready. |
---|
297 | The event name is specified with an @ suffix. |
---|
298 | <pre><code>Ext.addBehaviors({ |
---|
299 | <i>// add a listener <b>for</b> click on all anchors <b>in</b> element <b>with</b> id foo</i> |
---|
300 | <em>'#foo a@click'</em> : <b>function</b>(e, t){ |
---|
301 | <i>// <b>do</b> something</i> |
---|
302 | }, |
---|
303 | |
---|
304 | <i>// add the same listener to multiple selectors (separated by comma BEFORE the @)</i> |
---|
305 | <em>'#foo a, #bar span.some-class@mouseover'</em> : <b>function</b>(){ |
---|
306 | <i>// <b>do</b> something</i> |
---|
307 | } |
---|
308 | });</code></pre> <div class="mdetail-params"> |
---|
309 | <strong>Parameters:</strong> |
---|
310 | <ul><li><code>obj</code> : Object<div class="sub-desc">The list of behaviors to apply</div></li> </ul> |
---|
311 | <strong>Returns:</strong> |
---|
312 | <ul> |
---|
313 | <li><code>void</code></li> |
---|
314 | </ul> |
---|
315 | </div> |
---|
316 | </div> |
---|
317 | </div> |
---|
318 | </td> |
---|
319 | <td class="msource">Ext</td> |
---|
320 | </tr> |
---|
321 | <tr class="method-row alt expandable"> |
---|
322 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
323 | <td class="sig"> |
---|
324 | <a id="Ext-apply"></a> |
---|
325 | <b>apply</b>( <code>Object obj</code>, <code>Object config</code>, <code>Object defaults</code> ) : Object <div class="mdesc"> |
---|
326 | <div class="short"> |
---|
327 | Copies all the properties of config to obj.</div> |
---|
328 | <div class="long"> |
---|
329 | |
---|
330 | Copies all the properties of config to obj. <div class="mdetail-params"> |
---|
331 | <strong>Parameters:</strong> |
---|
332 | <ul><li><code>obj</code> : Object<div class="sub-desc">The receiver of the properties</div></li><li><code>config</code> : Object<div class="sub-desc">The source of the properties</div></li><li><code>defaults</code> : Object<div class="sub-desc">A different object that will also be applied for default values</div></li> </ul> |
---|
333 | <strong>Returns:</strong> |
---|
334 | <ul> |
---|
335 | <li><code>Object</code><div class="sub-desc">returns obj</div></li> |
---|
336 | </ul> |
---|
337 | </div> |
---|
338 | </div> |
---|
339 | </div> |
---|
340 | </td> |
---|
341 | <td class="msource">Ext</td> |
---|
342 | </tr> |
---|
343 | <tr class="method-row expandable"> |
---|
344 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
345 | <td class="sig"> |
---|
346 | <a id="Ext-applyIf"></a> |
---|
347 | <b>applyIf</b>( <code>Object obj</code>, <code>Object config</code> ) : Object <div class="mdesc"> |
---|
348 | <div class="short">Copies all the properties of config to obj if they don't already exist.</div> |
---|
349 | <div class="long"> |
---|
350 | Copies all the properties of config to obj if they don't already exist. <div class="mdetail-params"> |
---|
351 | <strong>Parameters:</strong> |
---|
352 | <ul><li><code>obj</code> : Object<div class="sub-desc">The receiver of the properties</div></li><li><code>config</code> : Object<div class="sub-desc">The source of the properties</div></li> </ul> |
---|
353 | <strong>Returns:</strong> |
---|
354 | <ul> |
---|
355 | <li><code>Object</code><div class="sub-desc">returns obj</div></li> |
---|
356 | </ul> |
---|
357 | </div> |
---|
358 | </div> |
---|
359 | </div> |
---|
360 | </td> |
---|
361 | <td class="msource">Ext</td> |
---|
362 | </tr> |
---|
363 | <tr class="method-row alt expandable"> |
---|
364 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
365 | <td class="sig"> |
---|
366 | <a id="Ext-decode"></a> |
---|
367 | <b>decode</b>( <code>String json</code> ) : Object <div class="mdesc"> |
---|
368 | <div class="short">Shorthand for <a ext:cls="Ext.util.JSON" ext:member="decode" href="output/Ext.util.JSON.html#decode">Ext.util.JSON.decode</a></div> |
---|
369 | <div class="long"> |
---|
370 | Shorthand for <a ext:cls="Ext.util.JSON" ext:member="decode" href="output/Ext.util.JSON.html#decode">Ext.util.JSON.decode</a> <div class="mdetail-params"> |
---|
371 | <strong>Parameters:</strong> |
---|
372 | <ul><li><code>json</code> : String<div class="sub-desc">The JSON string</div></li> </ul> |
---|
373 | <strong>Returns:</strong> |
---|
374 | <ul> |
---|
375 | <li><code>Object</code><div class="sub-desc">The resulting object</div></li> |
---|
376 | </ul> |
---|
377 | </div> |
---|
378 | </div> |
---|
379 | </div> |
---|
380 | </td> |
---|
381 | <td class="msource">Ext</td> |
---|
382 | </tr> |
---|
383 | <tr class="method-row expandable"> |
---|
384 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
385 | <td class="sig"> |
---|
386 | <a id="Ext-destroy"></a> |
---|
387 | <b>destroy</b>( <code>Mixed arg1</code>, <span class="optional" title="Optional">[<code>Mixed arg2</code>]</span>, <span class="optional" title="Optional">[<code>Mixed etc...</code>]</span> ) : void <div class="mdesc"> |
---|
388 | <div class="short">Attempts to destroy any objects passed to it by removing all event listeners, removing them from the |
---|
389 | DOM (if applicab...</div> |
---|
390 | <div class="long"> |
---|
391 | Attempts to destroy any objects passed to it by removing all event listeners, removing them from the |
---|
392 | DOM (if applicable) and calling their destroy functions (if available). This method is primarily |
---|
393 | intended for arguments of type <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> and <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a>, but any subclass of |
---|
394 | <a ext:cls="Ext.util.Observable" href="output/Ext.util.Observable.html">Ext.util.Observable</a> can be passed in. Any number of elements and/or components can be |
---|
395 | passed into this function in a single call as separate arguments. <div class="mdetail-params"> |
---|
396 | <strong>Parameters:</strong> |
---|
397 | <ul><li><code>arg1</code> : Mixed<div class="sub-desc">An <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> or <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> to destroy</div></li><li><code>arg2</code> : Mixed<div class="sub-desc">(optional)</div></li><li><code>etc...</code> : Mixed<div class="sub-desc">(optional)</div></li> </ul> |
---|
398 | <strong>Returns:</strong> |
---|
399 | <ul> |
---|
400 | <li><code>void</code></li> |
---|
401 | </ul> |
---|
402 | </div> |
---|
403 | </div> |
---|
404 | </div> |
---|
405 | </td> |
---|
406 | <td class="msource">Ext</td> |
---|
407 | </tr> |
---|
408 | <tr class="method-row alt expandable"> |
---|
409 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
410 | <td class="sig"> |
---|
411 | <a id="Ext-each"></a> |
---|
412 | <b>each</b>( <code>Array/NodeList/Mixed array</code>, <code>Function fn</code>, <code>Object scope</code> ) : void <div class="mdesc"> |
---|
413 | <div class="short">Iterates an array calling the passed function with each item, stopping if your function returns false. If the |
---|
414 | passed ...</div> |
---|
415 | <div class="long"> |
---|
416 | Iterates an array calling the passed function with each item, stopping if your function returns false. If the |
---|
417 | passed array is not really an array, your function is called once with it. |
---|
418 | The supplied function is called with (Object item, Number index, Array allItems). <div class="mdetail-params"> |
---|
419 | <strong>Parameters:</strong> |
---|
420 | <ul><li><code>array</code> : Array/NodeList/Mixed<div class="sub-desc"></div></li><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc"></div></li> </ul> |
---|
421 | <strong>Returns:</strong> |
---|
422 | <ul> |
---|
423 | <li><code>void</code></li> |
---|
424 | </ul> |
---|
425 | </div> |
---|
426 | </div> |
---|
427 | </div> |
---|
428 | </td> |
---|
429 | <td class="msource">Ext</td> |
---|
430 | </tr> |
---|
431 | <tr class="method-row expandable"> |
---|
432 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
433 | <td class="sig"> |
---|
434 | <a id="Ext-encode"></a> |
---|
435 | <b>encode</b>( <code>Mixed o</code> ) : String <div class="mdesc"> |
---|
436 | <div class="short">Shorthand for <a ext:cls="Ext.util.JSON" ext:member="encode" href="output/Ext.util.JSON.html#encode">Ext.util.JSON.encode</a></div> |
---|
437 | <div class="long"> |
---|
438 | Shorthand for <a ext:cls="Ext.util.JSON" ext:member="encode" href="output/Ext.util.JSON.html#encode">Ext.util.JSON.encode</a> <div class="mdetail-params"> |
---|
439 | <strong>Parameters:</strong> |
---|
440 | <ul><li><code>o</code> : Mixed<div class="sub-desc">The variable to encode</div></li> </ul> |
---|
441 | <strong>Returns:</strong> |
---|
442 | <ul> |
---|
443 | <li><code>String</code><div class="sub-desc">The JSON string</div></li> |
---|
444 | </ul> |
---|
445 | </div> |
---|
446 | </div> |
---|
447 | </div> |
---|
448 | </td> |
---|
449 | <td class="msource">Ext</td> |
---|
450 | </tr> |
---|
451 | <tr class="method-row alt expandable"> |
---|
452 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
453 | <td class="sig"> |
---|
454 | <a id="Ext-escapeRe"></a> |
---|
455 | <b>escapeRe</b>( <code>String str</code> ) : String <div class="mdesc"> |
---|
456 | <div class="short">Escapes the passed string for use in a regular expression</div> |
---|
457 | <div class="long"> |
---|
458 | Escapes the passed string for use in a regular expression <div class="mdetail-params"> |
---|
459 | <strong>Parameters:</strong> |
---|
460 | <ul><li><code>str</code> : String<div class="sub-desc"></div></li> </ul> |
---|
461 | <strong>Returns:</strong> |
---|
462 | <ul> |
---|
463 | <li><code>String</code></li> |
---|
464 | </ul> |
---|
465 | </div> |
---|
466 | </div> |
---|
467 | </div> |
---|
468 | </td> |
---|
469 | <td class="msource">Ext</td> |
---|
470 | </tr> |
---|
471 | <tr class="method-row expandable"> |
---|
472 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
473 | <td class="sig"> |
---|
474 | <a id="Ext-extend"></a> |
---|
475 | <b>extend</b>( <code>Function subclass</code>, <code>Function superclass</code>, <span class="optional" title="Optional">[<code>Object overrides</code>]</span> ) : Function <div class="mdesc"> |
---|
476 | <div class="short">Extends one class with another class and optionally overrides members with the passed literal. This class |
---|
477 | also adds t...</div> |
---|
478 | <div class="long"> |
---|
479 | Extends one class with another class and optionally overrides members with the passed literal. This class |
---|
480 | also adds the function "override()" to the class that can be used to override |
---|
481 | members on an instance. |
---|
482 | <p> |
---|
483 | This function also supports a 2-argument call in which the subclass's constructor is |
---|
484 | not passed as an argument. In this form, the parameters are as follows:</p><p> |
---|
485 | <div class="mdetail-params"><ul> |
---|
486 | <li><code>superclass</code> |
---|
487 | <div class="sub-desc">The class being extended</div></li> |
---|
488 | <li><code>overrides</code> |
---|
489 | <div class="sub-desc">A literal with members which are copied into the subclass's |
---|
490 | prototype, and are therefore shared among all instances of the new class.<p> |
---|
491 | This may contain a special member named <tt><b>constructor</b></tt>. This is used |
---|
492 | to define the constructor of the new class, and is returned. If this property is |
---|
493 | <i>not</i> specified, a constructor is generated and returned which just calls the |
---|
494 | superclass's constructor passing on its parameters.</p></div></li> |
---|
495 | </ul></div></p><p> |
---|
496 | For example, to create a subclass of the Ext GridPanel: |
---|
497 | <pre><code>MyGridPanel = Ext.extend(Ext.grid.GridPanel, { |
---|
498 | constructor: <b>function</b>(config) { |
---|
499 | <i>// Your preprocessing here</i> |
---|
500 | MyGridPanel.superclass.constructor.apply(<b>this</b>, arguments); |
---|
501 | <i>// Your postprocessing here</i> |
---|
502 | }, |
---|
503 | |
---|
504 | yourMethod: <b>function</b>() { |
---|
505 | <i>// etc.</i> |
---|
506 | } |
---|
507 | });</code></pre> |
---|
508 | </p> <div class="mdetail-params"> |
---|
509 | <strong>Parameters:</strong> |
---|
510 | <ul><li><code>subclass</code> : Function<div class="sub-desc">The class inheriting the functionality</div></li><li><code>superclass</code> : Function<div class="sub-desc">The class being extended</div></li><li><code>overrides</code> : Object<div class="sub-desc">(optional) A literal with members which are copied into the subclass's |
---|
511 | prototype, and are therefore shared between all instances of the new class.</div></li> </ul> |
---|
512 | <strong>Returns:</strong> |
---|
513 | <ul> |
---|
514 | <li><code>Function</code><div class="sub-desc">The subclass constructor.</div></li> |
---|
515 | </ul> |
---|
516 | </div> |
---|
517 | </div> |
---|
518 | </div> |
---|
519 | </td> |
---|
520 | <td class="msource">Ext</td> |
---|
521 | </tr> |
---|
522 | <tr class="method-row alt expandable"> |
---|
523 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
524 | <td class="sig"> |
---|
525 | <a id="Ext-fly"></a> |
---|
526 | <b>fly</b>( <code>String/HTMLElement el</code>, <span class="optional" title="Optional">[<code>String named</code>]</span> ) : Element <div class="mdesc"> |
---|
527 | <div class="short"><static> Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a...</div> |
---|
528 | <div class="long"> |
---|
529 | <static> Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - |
---|
530 | the dom node can be overwritten by other code. |
---|
531 | Shorthand of <a ext:cls="Ext.Element" ext:member="fly" href="output/Ext.Element.html#fly">Ext.Element.fly</a> <div class="mdetail-params"> |
---|
532 | <strong>Parameters:</strong> |
---|
533 | <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The dom node or id</div></li><li><code>named</code> : String<div class="sub-desc">(optional) Allows for creation of named reusable flyweights to |
---|
534 | prevent conflicts (e.g. internally Ext uses "_internal")</div></li> </ul> |
---|
535 | <strong>Returns:</strong> |
---|
536 | <ul> |
---|
537 | <li><code>Element</code><div class="sub-desc">The shared Element object</div></li> |
---|
538 | </ul> |
---|
539 | </div> |
---|
540 | </div> |
---|
541 | </div> |
---|
542 | </td> |
---|
543 | <td class="msource">Ext</td> |
---|
544 | </tr> |
---|
545 | <tr class="method-row expandable"> |
---|
546 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
547 | <td class="sig"> |
---|
548 | <a id="Ext-get"></a> |
---|
549 | <b>get</b>( <code>Mixed el</code> ) : Element <div class="mdesc"> |
---|
550 | <div class="short">Static method to retrieve Element objects. Uses simple caching to consistently return the same object. |
---|
551 | Automatically ...</div> |
---|
552 | <div class="long"> |
---|
553 | Static method to retrieve Element objects. Uses simple caching to consistently return the same object. |
---|
554 | Automatically fixes if an object was recreated with the same id via AJAX or DOM. |
---|
555 | Shorthand of <a ext:cls="Ext.Element" ext:member="get" href="output/Ext.Element.html#get">Ext.Element.get</a> <div class="mdetail-params"> |
---|
556 | <strong>Parameters:</strong> |
---|
557 | <ul><li><code>el</code> : Mixed<div class="sub-desc">The id of the node, a DOM Node or an existing Element.</div></li> </ul> |
---|
558 | <strong>Returns:</strong> |
---|
559 | <ul> |
---|
560 | <li><code>Element</code><div class="sub-desc">The Element object</div></li> |
---|
561 | </ul> |
---|
562 | </div> |
---|
563 | </div> |
---|
564 | </div> |
---|
565 | </td> |
---|
566 | <td class="msource">Ext</td> |
---|
567 | </tr> |
---|
568 | <tr class="method-row alt expandable"> |
---|
569 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
570 | <td class="sig"> |
---|
571 | <a id="Ext-getBody"></a> |
---|
572 | <b>getBody</b>() : Ext.Element <div class="mdesc"> |
---|
573 | <div class="short">Returns the current document body as an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.</div> |
---|
574 | <div class="long"> |
---|
575 | Returns the current document body as an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>. <div class="mdetail-params"> |
---|
576 | <strong>Parameters:</strong> |
---|
577 | <ul><li>None.</li> </ul> |
---|
578 | <strong>Returns:</strong> |
---|
579 | <ul> |
---|
580 | <li><code>Ext.Element</code><div class="sub-desc">The document body</div></li> |
---|
581 | </ul> |
---|
582 | </div> |
---|
583 | </div> |
---|
584 | </div> |
---|
585 | </td> |
---|
586 | <td class="msource">Ext</td> |
---|
587 | </tr> |
---|
588 | <tr class="method-row expandable"> |
---|
589 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
590 | <td class="sig"> |
---|
591 | <a id="Ext-getCmp"></a> |
---|
592 | <b>getCmp</b>( <code>String id</code> ) : Ext.Component <div class="mdesc"> |
---|
593 | <div class="short">Shorthand for <a ext:cls="Ext.ComponentMgr" ext:member="get" href="output/Ext.ComponentMgr.html#get">Ext.ComponentMgr.get</a></div> |
---|
594 | <div class="long"> |
---|
595 | Shorthand for <a ext:cls="Ext.ComponentMgr" ext:member="get" href="output/Ext.ComponentMgr.html#get">Ext.ComponentMgr.get</a> <div class="mdetail-params"> |
---|
596 | <strong>Parameters:</strong> |
---|
597 | <ul><li><code>id</code> : String<div class="sub-desc"></div></li> </ul> |
---|
598 | <strong>Returns:</strong> |
---|
599 | <ul> |
---|
600 | <li><code>Ext.Component</code></li> |
---|
601 | </ul> |
---|
602 | </div> |
---|
603 | </div> |
---|
604 | </div> |
---|
605 | </td> |
---|
606 | <td class="msource">Ext</td> |
---|
607 | </tr> |
---|
608 | <tr class="method-row alt expandable"> |
---|
609 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
610 | <td class="sig"> |
---|
611 | <a id="Ext-getDoc"></a> |
---|
612 | <b>getDoc</b>() : Ext.Element <div class="mdesc"> |
---|
613 | <div class="short">Returns the current HTML document object as an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.</div> |
---|
614 | <div class="long"> |
---|
615 | Returns the current HTML document object as an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>. <div class="mdetail-params"> |
---|
616 | <strong>Parameters:</strong> |
---|
617 | <ul><li>None.</li> </ul> |
---|
618 | <strong>Returns:</strong> |
---|
619 | <ul> |
---|
620 | <li><code>Ext.Element</code><div class="sub-desc">The document</div></li> |
---|
621 | </ul> |
---|
622 | </div> |
---|
623 | </div> |
---|
624 | </div> |
---|
625 | </td> |
---|
626 | <td class="msource">Ext</td> |
---|
627 | </tr> |
---|
628 | <tr class="method-row expandable"> |
---|
629 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
630 | <td class="sig"> |
---|
631 | <a id="Ext-getDom"></a> |
---|
632 | <b>getDom</b>( <code>Mixed el</code> ) : HTMLElement <div class="mdesc"> |
---|
633 | <div class="short">Return the dom node for the passed string (id), dom node, or Ext.Element</div> |
---|
634 | <div class="long"> |
---|
635 | Return the dom node for the passed string (id), dom node, or Ext.Element <div class="mdetail-params"> |
---|
636 | <strong>Parameters:</strong> |
---|
637 | <ul><li><code>el</code> : Mixed<div class="sub-desc"></div></li> </ul> |
---|
638 | <strong>Returns:</strong> |
---|
639 | <ul> |
---|
640 | <li><code>HTMLElement</code></li> |
---|
641 | </ul> |
---|
642 | </div> |
---|
643 | </div> |
---|
644 | </div> |
---|
645 | </td> |
---|
646 | <td class="msource">Ext</td> |
---|
647 | </tr> |
---|
648 | <tr class="method-row alt expandable"> |
---|
649 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
650 | <td class="sig"> |
---|
651 | <a id="Ext-id"></a> |
---|
652 | <b>id</b>( <span class="optional" title="Optional">[<code>Mixed el</code>]</span>, <span class="optional" title="Optional">[<code>String prefix</code>]</span> ) : String <div class="mdesc"> |
---|
653 | <div class="short">Generates unique ids. If the element already has an id, it is unchanged</div> |
---|
654 | <div class="long"> |
---|
655 | Generates unique ids. If the element already has an id, it is unchanged <div class="mdetail-params"> |
---|
656 | <strong>Parameters:</strong> |
---|
657 | <ul><li><code>el</code> : Mixed<div class="sub-desc">(optional) The element to generate an id for</div></li><li><code>prefix</code> : String<div class="sub-desc">(optional) Id prefix (defaults "ext-gen")</div></li> </ul> |
---|
658 | <strong>Returns:</strong> |
---|
659 | <ul> |
---|
660 | <li><code>String</code><div class="sub-desc">The generated Id.</div></li> |
---|
661 | </ul> |
---|
662 | </div> |
---|
663 | </div> |
---|
664 | </div> |
---|
665 | </td> |
---|
666 | <td class="msource">Ext</td> |
---|
667 | </tr> |
---|
668 | <tr class="method-row expandable"> |
---|
669 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
670 | <td class="sig"> |
---|
671 | <a id="Ext-isArray"></a> |
---|
672 | <b>isArray</b>( <code>Object The</code> ) : Boolean <div class="mdesc"> |
---|
673 | <div class="short">Returns true if the passed object is a JavaScript array, otherwise false.</div> |
---|
674 | <div class="long"> |
---|
675 | Returns true if the passed object is a JavaScript array, otherwise false. <div class="mdetail-params"> |
---|
676 | <strong>Parameters:</strong> |
---|
677 | <ul><li><code>The</code> : Object<div class="sub-desc">object to test</div></li> </ul> |
---|
678 | <strong>Returns:</strong> |
---|
679 | <ul> |
---|
680 | <li><code>Boolean</code></li> |
---|
681 | </ul> |
---|
682 | </div> |
---|
683 | </div> |
---|
684 | </div> |
---|
685 | </td> |
---|
686 | <td class="msource">Ext</td> |
---|
687 | </tr> |
---|
688 | <tr class="method-row alt expandable"> |
---|
689 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
690 | <td class="sig"> |
---|
691 | <a id="Ext-isDate"></a> |
---|
692 | <b>isDate</b>( <code>Object The</code> ) : Boolean <div class="mdesc"> |
---|
693 | <div class="short">Returns true if the passed object is a JavaScript date object, otherwise false.</div> |
---|
694 | <div class="long"> |
---|
695 | Returns true if the passed object is a JavaScript date object, otherwise false. <div class="mdetail-params"> |
---|
696 | <strong>Parameters:</strong> |
---|
697 | <ul><li><code>The</code> : Object<div class="sub-desc">object to test</div></li> </ul> |
---|
698 | <strong>Returns:</strong> |
---|
699 | <ul> |
---|
700 | <li><code>Boolean</code></li> |
---|
701 | </ul> |
---|
702 | </div> |
---|
703 | </div> |
---|
704 | </div> |
---|
705 | </td> |
---|
706 | <td class="msource">Ext</td> |
---|
707 | </tr> |
---|
708 | <tr class="method-row expandable"> |
---|
709 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
710 | <td class="sig"> |
---|
711 | <a id="Ext-isEmpty"></a> |
---|
712 | <b>isEmpty</b>( <code>Mixed value</code>, <span class="optional" title="Optional">[<code>Boolean allowBlank</code>]</span> ) : Boolean <div class="mdesc"> |
---|
713 | <div class="short">Returns true if the passed value is null, undefined or an empty string.</div> |
---|
714 | <div class="long"> |
---|
715 | Returns true if the passed value is null, undefined or an empty string. <div class="mdetail-params"> |
---|
716 | <strong>Parameters:</strong> |
---|
717 | <ul><li><code>value</code> : Mixed<div class="sub-desc">The value to test</div></li><li><code>allowBlank</code> : Boolean<div class="sub-desc">(optional) true to allow empty strings (defaults to false)</div></li> </ul> |
---|
718 | <strong>Returns:</strong> |
---|
719 | <ul> |
---|
720 | <li><code>Boolean</code></li> |
---|
721 | </ul> |
---|
722 | </div> |
---|
723 | </div> |
---|
724 | </div> |
---|
725 | </td> |
---|
726 | <td class="msource">Ext</td> |
---|
727 | </tr> |
---|
728 | <tr class="method-row alt expandable"> |
---|
729 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
730 | <td class="sig"> |
---|
731 | <a id="Ext-namespace"></a> |
---|
732 | <b>namespace</b>( <code>String namespace1</code>, <code>String namespace2</code>, <code>String etc</code> ) : void <div class="mdesc"> |
---|
733 | <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global. Usage: |
---|
734 | Ext.namespace('C...</div> |
---|
735 | <div class="long"> |
---|
736 | Creates namespaces to be used for scoping variables and classes so that they are not global. Usage: |
---|
737 | <pre><code>Ext.namespace(<em>'Company'</em>, <em>'Company.data'</em>); |
---|
738 | Company.Widget = <b>function</b>() { ... } |
---|
739 | Company.data.CustomStore = <b>function</b>(config) { ... }</code></pre> <div class="mdetail-params"> |
---|
740 | <strong>Parameters:</strong> |
---|
741 | <ul><li><code>namespace1</code> : String<div class="sub-desc"></div></li><li><code>namespace2</code> : String<div class="sub-desc"></div></li><li><code>etc</code> : String<div class="sub-desc"></div></li> </ul> |
---|
742 | <strong>Returns:</strong> |
---|
743 | <ul> |
---|
744 | <li><code>void</code></li> |
---|
745 | </ul> |
---|
746 | </div> |
---|
747 | </div> |
---|
748 | </div> |
---|
749 | </td> |
---|
750 | <td class="msource">Ext</td> |
---|
751 | </tr> |
---|
752 | <tr class="method-row expandable"> |
---|
753 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
754 | <td class="sig"> |
---|
755 | <a id="Ext-num"></a> |
---|
756 | <b>num</b>( <code>Mixed value</code>, <code>Number defaultValue</code> ) : Number <div class="mdesc"> |
---|
757 | <div class="short">Utility method for validating that a value is numeric, returning the specified default value if it is not.</div> |
---|
758 | <div class="long"> |
---|
759 | Utility method for validating that a value is numeric, returning the specified default value if it is not. <div class="mdetail-params"> |
---|
760 | <strong>Parameters:</strong> |
---|
761 | <ul><li><code>value</code> : Mixed<div class="sub-desc">Should be a number, but any type will be handled appropriately</div></li><li><code>defaultValue</code> : Number<div class="sub-desc">The value to return if the original value is non-numeric</div></li> </ul> |
---|
762 | <strong>Returns:</strong> |
---|
763 | <ul> |
---|
764 | <li><code>Number</code><div class="sub-desc">Value, if numeric, else defaultValue</div></li> |
---|
765 | </ul> |
---|
766 | </div> |
---|
767 | </div> |
---|
768 | </div> |
---|
769 | </td> |
---|
770 | <td class="msource">Ext</td> |
---|
771 | </tr> |
---|
772 | <tr class="method-row alt expandable"> |
---|
773 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
774 | <td class="sig"> |
---|
775 | <a id="Ext-onReady"></a> |
---|
776 | <b>onReady</b>( <code>Function fn</code>, <code>Object scope</code>, <span class="optional" title="Optional">[<code>boolean options</code>]</span> ) : void <div class="mdesc"> |
---|
777 | <div class="short">Fires when the document is ready (before onload and before images are loaded). Shorthand of Ext.EventManager.onDocum...</div> |
---|
778 | <div class="long"> |
---|
779 | Fires when the document is ready (before onload and before images are loaded). Shorthand of <a ext:cls="Ext.EventManager" ext:member="onDocumentReady" href="output/Ext.EventManager.html#onDocumentReady">Ext.EventManager.onDocumentReady</a>. <div class="mdetail-params"> |
---|
780 | <strong>Parameters:</strong> |
---|
781 | <ul><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">An object that becomes the scope of the handler</div></li><li><code>options</code> : boolean<div class="sub-desc">(optional) An object containing standard <a ext:cls="Ext" ext:member="addListener" href="output/Ext.html#addListener">addListener</a> options</div></li> </ul> |
---|
782 | <strong>Returns:</strong> |
---|
783 | <ul> |
---|
784 | <li><code>void</code></li> |
---|
785 | </ul> |
---|
786 | </div> |
---|
787 | </div> |
---|
788 | </div> |
---|
789 | </td> |
---|
790 | <td class="msource">Ext</td> |
---|
791 | </tr> |
---|
792 | <tr class="method-row expandable"> |
---|
793 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
794 | <td class="sig"> |
---|
795 | <a id="Ext-override"></a> |
---|
796 | <b>override</b>( <code>Object origclass</code>, <code>Object overrides</code> ) : void <div class="mdesc"> |
---|
797 | <div class="short">Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name. |
---|
798 | ...</div> |
---|
799 | <div class="long"> |
---|
800 | Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name. |
---|
801 | Usage:<pre><code>Ext.override(MyClass, { |
---|
802 | newMethod1: <b>function</b>(){ |
---|
803 | <i>// etc.</i> |
---|
804 | }, |
---|
805 | newMethod2: <b>function</b>(foo){ |
---|
806 | <i>// etc.</i> |
---|
807 | } |
---|
808 | });</code></pre> <div class="mdetail-params"> |
---|
809 | <strong>Parameters:</strong> |
---|
810 | <ul><li><code>origclass</code> : Object<div class="sub-desc">The class to override</div></li><li><code>overrides</code> : Object<div class="sub-desc">The list of functions to add to origClass. This should be specified as an object literal |
---|
811 | containing one or more methods.</div></li> </ul> |
---|
812 | <strong>Returns:</strong> |
---|
813 | <ul> |
---|
814 | <li><code>void</code></li> |
---|
815 | </ul> |
---|
816 | </div> |
---|
817 | </div> |
---|
818 | </div> |
---|
819 | </td> |
---|
820 | <td class="msource">Ext</td> |
---|
821 | </tr> |
---|
822 | <tr class="method-row alt expandable"> |
---|
823 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
824 | <td class="sig"> |
---|
825 | <a id="Ext-query"></a> |
---|
826 | <b>query</b>( <code>String path</code>, <span class="optional" title="Optional">[<code>Node root</code>]</span> ) : Array <div class="mdesc"> |
---|
827 | <div class="short">Selects an array of DOM nodes by CSS/XPath selector. Shorthand of <a ext:cls="Ext.DomQuery" ext:member="select" href="output/Ext.DomQuery.html#select">Ext.DomQuery.select</a></div> |
---|
828 | <div class="long"> |
---|
829 | Selects an array of DOM nodes by CSS/XPath selector. Shorthand of <a ext:cls="Ext.DomQuery" ext:member="select" href="output/Ext.DomQuery.html#select">Ext.DomQuery.select</a> <div class="mdetail-params"> |
---|
830 | <strong>Parameters:</strong> |
---|
831 | <ul><li><code>path</code> : String<div class="sub-desc">The selector/xpath query</div></li><li><code>root</code> : Node<div class="sub-desc">(optional) The start of the query (defaults to document).</div></li> </ul> |
---|
832 | <strong>Returns:</strong> |
---|
833 | <ul> |
---|
834 | <li><code>Array</code></li> |
---|
835 | </ul> |
---|
836 | </div> |
---|
837 | </div> |
---|
838 | </div> |
---|
839 | </td> |
---|
840 | <td class="msource">Ext</td> |
---|
841 | </tr> |
---|
842 | <tr class="method-row expandable"> |
---|
843 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
844 | <td class="sig"> |
---|
845 | <a id="Ext-reg"></a> |
---|
846 | <b>reg</b>( <code>String xtype</code>, <code>Constructor cls</code> ) : void <div class="mdesc"> |
---|
847 | <div class="short">Shorthand for <a ext:cls="Ext.ComponentMgr" ext:member="registerType" href="output/Ext.ComponentMgr.html#registerType">Ext.ComponentMgr.registerType</a></div> |
---|
848 | <div class="long"> |
---|
849 | Shorthand for <a ext:cls="Ext.ComponentMgr" ext:member="registerType" href="output/Ext.ComponentMgr.html#registerType">Ext.ComponentMgr.registerType</a> <div class="mdetail-params"> |
---|
850 | <strong>Parameters:</strong> |
---|
851 | <ul><li><code>xtype</code> : String<div class="sub-desc">The mnemonic string by which the Component class |
---|
852 | may be looked up.</div></li><li><code>cls</code> : Constructor<div class="sub-desc">The new Component class.</div></li> </ul> |
---|
853 | <strong>Returns:</strong> |
---|
854 | <ul> |
---|
855 | <li><code>void</code></li> |
---|
856 | </ul> |
---|
857 | </div> |
---|
858 | </div> |
---|
859 | </div> |
---|
860 | </td> |
---|
861 | <td class="msource">Ext</td> |
---|
862 | </tr> |
---|
863 | <tr class="method-row alt expandable"> |
---|
864 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
865 | <td class="sig"> |
---|
866 | <a id="Ext-removeNode"></a> |
---|
867 | <b>removeNode</b>( <code>HTMLElement node</code> ) : void <div class="mdesc"> |
---|
868 | <div class="short">Removes a DOM node from the document. The body node will be ignored if passed in.</div> |
---|
869 | <div class="long"> |
---|
870 | Removes a DOM node from the document. The body node will be ignored if passed in. <div class="mdetail-params"> |
---|
871 | <strong>Parameters:</strong> |
---|
872 | <ul><li><code>node</code> : HTMLElement<div class="sub-desc">The node to remove</div></li> </ul> |
---|
873 | <strong>Returns:</strong> |
---|
874 | <ul> |
---|
875 | <li><code>void</code></li> |
---|
876 | </ul> |
---|
877 | </div> |
---|
878 | </div> |
---|
879 | </div> |
---|
880 | </td> |
---|
881 | <td class="msource">Ext</td> |
---|
882 | </tr> |
---|
883 | <tr class="method-row expandable"> |
---|
884 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
885 | <td class="sig"> |
---|
886 | <a id="Ext-select"></a> |
---|
887 | <b>select</b>( <code>String/Array selector</code>, <span class="optional" title="Optional">[<code>Boolean unique</code>]</span>, <span class="optional" title="Optional">[<code>HTMLElement/String root</code>]</span> ) : CompositeElementLite/CompositeElement <div class="mdesc"> |
---|
888 | <div class="short">Selects elements based on the passed CSS selector to enable working on them as 1.</div> |
---|
889 | <div class="long"> |
---|
890 | Selects elements based on the passed CSS selector to enable working on them as 1. <div class="mdetail-params"> |
---|
891 | <strong>Parameters:</strong> |
---|
892 | <ul><li><code>selector</code> : String/Array<div class="sub-desc">The CSS selector or an array of elements</div></li><li><code>unique</code> : Boolean<div class="sub-desc">(optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object)</div></li><li><code>root</code> : HTMLElement/String<div class="sub-desc">(optional) The root element of the query or id of the root</div></li> </ul> |
---|
893 | <strong>Returns:</strong> |
---|
894 | <ul> |
---|
895 | <li><code>CompositeElementLite/CompositeElement</code></li> |
---|
896 | </ul> |
---|
897 | </div> |
---|
898 | </div> |
---|
899 | </div> |
---|
900 | </td> |
---|
901 | <td class="msource">Ext</td> |
---|
902 | </tr> |
---|
903 | <tr class="method-row alt expandable"> |
---|
904 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
905 | <td class="sig"> |
---|
906 | <a id="Ext-type"></a> |
---|
907 | <b>type</b>( <code>Mixed object</code> ) : String <div class="mdesc"> |
---|
908 | <div class="short">Returns the type of object that is passed in. If the object passed in is null or undefined it |
---|
909 | return false otherwise ...</div> |
---|
910 | <div class="long"> |
---|
911 | Returns the type of object that is passed in. If the object passed in is null or undefined it |
---|
912 | return false otherwise it returns one of the following values:<ul> |
---|
913 | <li><b>string</b>: If the object passed is a string</li> |
---|
914 | <li><b>number</b>: If the object passed is a number</li> |
---|
915 | <li><b>boolean</b>: If the object passed is a boolean value</li> |
---|
916 | <li><b>date</b>: If the object passed is a Date object</li> |
---|
917 | <li><b>function</b>: If the object passed is a function reference</li> |
---|
918 | <li><b>object</b>: If the object passed is an object</li> |
---|
919 | <li><b>array</b>: If the object passed is an array</li> |
---|
920 | <li><b>regexp</b>: If the object passed is a regular expression</li> |
---|
921 | <li><b>element</b>: If the object passed is a DOM Element</li> |
---|
922 | <li><b>nodelist</b>: If the object passed is a DOM NodeList</li> |
---|
923 | <li><b>textnode</b>: If the object passed is a DOM text node and contains something other than whitespace</li> |
---|
924 | <li><b>whitespace</b>: If the object passed is a DOM text node and contains only whitespace</li> <div class="mdetail-params"> |
---|
925 | <strong>Parameters:</strong> |
---|
926 | <ul><li><code>object</code> : Mixed<div class="sub-desc"></div></li> </ul> |
---|
927 | <strong>Returns:</strong> |
---|
928 | <ul> |
---|
929 | <li><code>String</code></li> |
---|
930 | </ul> |
---|
931 | </div> |
---|
932 | </div> |
---|
933 | </div> |
---|
934 | </td> |
---|
935 | <td class="msource">Ext</td> |
---|
936 | </tr> |
---|
937 | <tr class="method-row expandable"> |
---|
938 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
939 | <td class="sig"> |
---|
940 | <a id="Ext-urlDecode"></a> |
---|
941 | <b>urlDecode</b>( <code>String string</code>, <span class="optional" title="Optional">[<code>Boolean overwrite</code>]</span> ) : Object <div class="mdesc"> |
---|
942 | <div class="short">Takes an encoded URL and and converts it to an object. e.g. Ext.urlDecode("foo=1&bar=2"); would return {foo: "1", bar...</div> |
---|
943 | <div class="long"> |
---|
944 | Takes an encoded URL and and converts it to an object. e.g. Ext.urlDecode("foo=1&bar=2"); would return {foo: "1", bar: "2"} |
---|
945 | or Ext.urlDecode("foo=1&bar=2&bar=3&bar=4", false); would return {foo: "1", bar: ["2", "3", "4"]}. <div class="mdetail-params"> |
---|
946 | <strong>Parameters:</strong> |
---|
947 | <ul><li><code>string</code> : String<div class="sub-desc"></div></li><li><code>overwrite</code> : Boolean<div class="sub-desc">(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).</div></li> </ul> |
---|
948 | <strong>Returns:</strong> |
---|
949 | <ul> |
---|
950 | <li><code>Object</code><div class="sub-desc">A literal with members</div></li> |
---|
951 | </ul> |
---|
952 | </div> |
---|
953 | </div> |
---|
954 | </div> |
---|
955 | </td> |
---|
956 | <td class="msource">Ext</td> |
---|
957 | </tr> |
---|
958 | <tr class="method-row alt expandable"> |
---|
959 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
960 | <td class="sig"> |
---|
961 | <a id="Ext-urlEncode"></a> |
---|
962 | <b>urlEncode</b>( <code>Object o</code> ) : String <div class="mdesc"> |
---|
963 | <div class="short">Takes an object and converts it to an encoded URL. e.g. Ext.urlEncode({foo: 1, bar: 2}); would return "foo=1&bar=2". ...</div> |
---|
964 | <div class="long"> |
---|
965 | 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. <div class="mdetail-params"> |
---|
966 | <strong>Parameters:</strong> |
---|
967 | <ul><li><code>o</code> : Object<div class="sub-desc"></div></li> </ul> |
---|
968 | <strong>Returns:</strong> |
---|
969 | <ul> |
---|
970 | <li><code>String</code></li> |
---|
971 | </ul> |
---|
972 | </div> |
---|
973 | </div> |
---|
974 | </div> |
---|
975 | </td> |
---|
976 | <td class="msource">Ext</td> |
---|
977 | </tr> |
---|
978 | <tr class="method-row expandable"> |
---|
979 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
980 | <td class="sig"> |
---|
981 | <a id="Ext-value"></a> |
---|
982 | <b>value</b>( <code>Mixed value</code>, <code>Mixed defaultValue</code>, <span class="optional" title="Optional">[<code>Boolean allowBlank</code>]</span> ) : Mixed <div class="mdesc"> |
---|
983 | <div class="short">Utility method for validating that a value is non-empty (i.e. i) not null, ii) not undefined, and iii) not an empty s...</div> |
---|
984 | <div class="long"> |
---|
985 | Utility method for validating that a value is non-empty (i.e. i) not null, ii) not undefined, and iii) not an empty string), |
---|
986 | returning the specified default value if it is. <div class="mdetail-params"> |
---|
987 | <strong>Parameters:</strong> |
---|
988 | <ul><li><code>value</code> : Mixed<div class="sub-desc">The value to test</div></li><li><code>defaultValue</code> : Mixed<div class="sub-desc">The value to return if the original value is empty</div></li><li><code>allowBlank</code> : Boolean<div class="sub-desc">(optional) true to allow empty strings (defaults to false)</div></li> </ul> |
---|
989 | <strong>Returns:</strong> |
---|
990 | <ul> |
---|
991 | <li><code>Mixed</code><div class="sub-desc">value, if non-empty, else defaultValue</div></li> |
---|
992 | </ul> |
---|
993 | </div> |
---|
994 | </div> |
---|
995 | </div> |
---|
996 | </td> |
---|
997 | <td class="msource">Ext</td> |
---|
998 | </tr> |
---|
999 | </table> |
---|
1000 | <a id="Ext-events"></a> |
---|
1001 | <h2>Public Events</h2> |
---|
1002 | <div class="no-members">This class has no public events.</div> |
---|
1003 | </div> |
---|