Upgrade to ExtJS 3.3.1 - Released 11/30/2010
[extjs.git] / docs / source / BoxComponent.html
1 <html>
2 <head>
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
4   <title>The source code</title>
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
7 </head>
8 <body  onload="prettyPrint();">
9     <pre class="prettyprint lang-js">/*!
10  * Ext JS Library 3.3.1
11  * Copyright(c) 2006-2010 Sencha Inc.
12  * licensing@sencha.com
13  * http://www.sencha.com/license
14  */
15 <div id="cls-Ext.BoxComponent"></div>/**
16  * @class Ext.BoxComponent
17  * @extends Ext.Component
18  * <p>Base class for any {@link Ext.Component Component} that is to be sized as a box, using width and height.</p>
19  * <p>BoxComponent provides automatic box model adjustments for sizing and positioning and will work correctly
20  * within the Component rendering model.</p>
21  * <p>A BoxComponent may be created as a custom Component which encapsulates any HTML element, either a pre-existing
22  * element, or one that is created to your specifications at render time. Usually, to participate in layouts,
23  * a Component will need to be a <b>Box</b>Component in order to have its width and height managed.</p>
24  * <p>To use a pre-existing element as a BoxComponent, configure it so that you preset the <b>el</b> property to the
25  * element to reference:<pre><code>
26 var pageHeader = new Ext.BoxComponent({
27     el: 'my-header-div'
28 });</code></pre>
29  * This may then be {@link Ext.Container#add added} to a {@link Ext.Container Container} as a child item.</p>
30  * <p>To create a BoxComponent based around a HTML element to be created at render time, use the
31  * {@link Ext.Component#autoEl autoEl} config option which takes the form of a
32  * {@link Ext.DomHelper DomHelper} specification:<pre><code>
33 var myImage = new Ext.BoxComponent({
34     autoEl: {
35         tag: 'img',
36         src: '/images/my-image.jpg'
37     }
38 });</code></pre></p>
39  * @constructor
40  * @param {Ext.Element/String/Object} config The configuration options.
41  * @xtype box
42  */
43 Ext.BoxComponent = Ext.extend(Ext.Component, {
44
45     // Configs below are used for all Components when rendered by BoxLayout.
46     <div id="cfg-Ext.BoxComponent-flex"></div>/**
47      * @cfg {Number} flex
48      * <p><b>Note</b>: this config is only used when this Component is rendered
49      * by a Container which has been configured to use a <b>{@link Ext.layout.BoxLayout BoxLayout}.</b>
50      * Each child Component with a <code>flex</code> property will be flexed either vertically (by a VBoxLayout)
51      * or horizontally (by an HBoxLayout) according to the item's <b>relative</b> <code>flex</code> value
52      * compared to the sum of all Components with <code>flex</flex> value specified. Any child items that have
53      * either a <code>flex = 0</code> or <code>flex = undefined</code> will not be 'flexed' (the initial size will not be changed).
54      */
55     // Configs below are used for all Components when rendered by AnchorLayout.
56     <div id="cfg-Ext.BoxComponent-anchor"></div>/**
57      * @cfg {String} anchor <p><b>Note</b>: this config is only used when this Component is rendered
58      * by a Container which has been configured to use an <b>{@link Ext.layout.AnchorLayout AnchorLayout} (or subclass thereof).</b>
59      * based layout manager, for example:<div class="mdetail-params"><ul>
60      * <li>{@link Ext.form.FormPanel}</li>
61      * <li>specifying <code>layout: 'anchor' // or 'form', or 'absolute'</code></li>
62      * </ul></div></p>
63      * <p>See {@link Ext.layout.AnchorLayout}.{@link Ext.layout.AnchorLayout#anchor anchor} also.</p>
64      */
65     // tabTip config is used when a BoxComponent is a child of a TabPanel
66     <div id="cfg-Ext.BoxComponent-tabTip"></div>/**
67      * @cfg {String} tabTip
68      * <p><b>Note</b>: this config is only used when this BoxComponent is a child item of a TabPanel.</p>
69      * A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
70      * the associated tab selector element. {@link Ext.QuickTips}.init()
71      * must be called in order for the tips to render.
72      */
73     // Configs below are used for all Components when rendered by BorderLayout.
74     <div id="cfg-Ext.BoxComponent-region"></div>/**
75      * @cfg {String} region <p><b>Note</b>: this config is only used when this BoxComponent is rendered
76      * by a Container which has been configured to use the <b>{@link Ext.layout.BorderLayout BorderLayout}</b>
77      * layout manager (e.g. specifying <tt>layout:'border'</tt>).</p><br>
78      * <p>See {@link Ext.layout.BorderLayout} also.</p>
79      */
80     // margins config is used when a BoxComponent is rendered by BorderLayout or BoxLayout.
81     <div id="cfg-Ext.BoxComponent-margins"></div>/**
82      * @cfg {Object} margins <p><b>Note</b>: this config is only used when this BoxComponent is rendered
83      * by a Container which has been configured to use the <b>{@link Ext.layout.BorderLayout BorderLayout}</b>
84      * or one of the two <b>{@link Ext.layout.BoxLayout BoxLayout} subclasses.</b></p>
85      * <p>An object containing margins to apply to this BoxComponent in the
86      * format:</p><pre><code>
87 {
88     top: (top margin),
89     right: (right margin),
90     bottom: (bottom margin),
91     left: (left margin)
92 }</code></pre>
93      * <p>May also be a string containing space-separated, numeric margin values. The order of the
94      * sides associated with each value matches the way CSS processes margin values:</p>
95      * <p><div class="mdetail-params"><ul>
96      * <li>If there is only one value, it applies to all sides.</li>
97      * <li>If there are two values, the top and bottom borders are set to the first value and the
98      * right and left are set to the second.</li>
99      * <li>If there are three values, the top is set to the first value, the left and right are set
100      * to the second, and the bottom is set to the third.</li>
101      * <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
102      * </ul></div></p>
103      * <p>Defaults to:</p><pre><code>
104      * {top:0, right:0, bottom:0, left:0}
105      * </code></pre>
106      */
107     <div id="cfg-Ext.BoxComponent-x"></div>/**
108      * @cfg {Number} x
109      * The local x (left) coordinate for this component if contained within a positioning container.
110      */
111     <div id="cfg-Ext.BoxComponent-y"></div>/**
112      * @cfg {Number} y
113      * The local y (top) coordinate for this component if contained within a positioning container.
114      */
115     <div id="cfg-Ext.BoxComponent-pageX"></div>/**
116      * @cfg {Number} pageX
117      * The page level x coordinate for this component if contained within a positioning container.
118      */
119     <div id="cfg-Ext.BoxComponent-pageY"></div>/**
120      * @cfg {Number} pageY
121      * The page level y coordinate for this component if contained within a positioning container.
122      */
123     <div id="cfg-Ext.BoxComponent-height"></div>/**
124      * @cfg {Number} height
125      * The height of this component in pixels (defaults to auto).
126      * <b>Note</b> to express this dimension as a percentage or offset see {@link Ext.Component#anchor}.
127      */
128     <div id="cfg-Ext.BoxComponent-width"></div>/**
129      * @cfg {Number} width
130      * The width of this component in pixels (defaults to auto).
131      * <b>Note</b> to express this dimension as a percentage or offset see {@link Ext.Component#anchor}.
132      */
133     <div id="cfg-Ext.BoxComponent-boxMinHeight"></div>/**
134      * @cfg {Number} boxMinHeight
135      * <p>The minimum value in pixels which this BoxComponent will set its height to.</p>
136      * <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
137      */
138     <div id="cfg-Ext.BoxComponent-boxMinWidth"></div>/**
139      * @cfg {Number} boxMinWidth
140      * <p>The minimum value in pixels which this BoxComponent will set its width to.</p>
141      * <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
142      */
143     <div id="cfg-Ext.BoxComponent-boxMaxHeight"></div>/**
144      * @cfg {Number} boxMaxHeight
145      * <p>The maximum value in pixels which this BoxComponent will set its height to.</p>
146      * <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
147      */
148     <div id="cfg-Ext.BoxComponent-boxMaxWidth"></div>/**
149      * @cfg {Number} boxMaxWidth
150      * <p>The maximum value in pixels which this BoxComponent will set its width to.</p>
151      * <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
152      */
153     <div id="cfg-Ext.BoxComponent-autoHeight"></div>/**
154      * @cfg {Boolean} autoHeight
155      * <p>True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
156      * Container's {@link Ext.Container#layout layout manager}. Defaults to false.</p>
157      * <p><b>Note</b>: Although many components inherit this config option, not all will
158      * function as expected with a height of 'auto'. Setting autoHeight:true means that the
159      * browser will manage height based on the element's contents, and that Ext will not manage it at all.</p>
160      * <p>If the <i>browser</i> is managing the height, be aware that resizes performed by the browser in response
161      * to changes within the structure of the Component cannot be detected. Therefore changes to the height might
162      * result in elements needing to be synchronized with the new height. Example:</p><pre><code>
163 var w = new Ext.Window({
164     title: 'Window',
165     width: 600,
166     autoHeight: true,
167     items: {
168         title: 'Collapse Me',
169         height: 400,
170         collapsible: true,
171         border: false,
172         listeners: {
173             beforecollapse: function() {
174                 w.el.shadow.hide();
175             },
176             beforeexpand: function() {
177                 w.el.shadow.hide();
178             },
179             collapse: function() {
180                 w.syncShadow();
181             },
182             expand: function() {
183                 w.syncShadow();
184             }
185         }
186     }
187 }).show();
188 </code></pre>
189      */
190     <div id="cfg-Ext.BoxComponent-autoWidth"></div>/**
191      * @cfg {Boolean} autoWidth
192      * <p>True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
193      * Container's {@link Ext.Container#layout layout manager}. Defaults to false.</p>
194      * <p><b>Note</b>: Although many components  inherit this config option, not all will
195      * function as expected with a width of 'auto'. Setting autoWidth:true means that the
196      * browser will manage width based on the element's contents, and that Ext will not manage it at all.</p>
197      * <p>If the <i>browser</i> is managing the width, be aware that resizes performed by the browser in response
198      * to changes within the structure of the Component cannot be detected. Therefore changes to the width might
199      * result in elements needing to be synchronized with the new width. For example, where the target element is:</p><pre><code>
200 &lt;div id='grid-container' style='margin-left:25%;width:50%'>&lt;/div>
201 </code></pre>
202      * A Panel rendered into that target element must listen for browser window resize in order to relay its
203       * child items when the browser changes its width:<pre><code>
204 var myPanel = new Ext.Panel({
205     renderTo: 'grid-container',
206     monitorResize: true, // relay on browser resize
207     title: 'Panel',
208     height: 400,
209     autoWidth: true,
210     layout: 'hbox',
211     layoutConfig: {
212         align: 'stretch'
213     },
214     defaults: {
215         flex: 1
216     },
217     items: [{
218         title: 'Box 1',
219     }, {
220         title: 'Box 2'
221     }, {
222         title: 'Box 3'
223     }],
224 });
225 </code></pre>
226      */
227     <div id="cfg-Ext.BoxComponent-autoScroll"></div>/**
228      * @cfg {Boolean} autoScroll
229      * <code>true</code> to use overflow:'auto' on the components layout element and show scroll bars automatically when
230      * necessary, <code>false</code> to clip any overflowing content (defaults to <code>false</code>).
231      */
232
233     /* // private internal config
234      * {Boolean} deferHeight
235      * True to defer height calculations to an external component, false to allow this component to set its own
236      * height (defaults to false).
237      */
238
239     // private
240     initComponent : function(){
241         Ext.BoxComponent.superclass.initComponent.call(this);
242         this.addEvents(
243             <div id="event-Ext.BoxComponent-resize"></div>/**
244              * @event resize
245              * Fires after the component is resized.
246              * @param {Ext.Component} this
247              * @param {Number} adjWidth The box-adjusted width that was set
248              * @param {Number} adjHeight The box-adjusted height that was set
249              * @param {Number} rawWidth The width that was originally specified
250              * @param {Number} rawHeight The height that was originally specified
251              */
252             'resize',
253             <div id="event-Ext.BoxComponent-move"></div>/**
254              * @event move
255              * Fires after the component is moved.
256              * @param {Ext.Component} this
257              * @param {Number} x The new x position
258              * @param {Number} y The new y position
259              */
260             'move'
261         );
262     },
263
264     // private, set in afterRender to signify that the component has been rendered
265     boxReady : false,
266     // private, used to defer height settings to subclasses
267     deferHeight: false,
268
269     <div id="method-Ext.BoxComponent-setSize"></div>/**
270      * Sets the width and height of this BoxComponent. This method fires the {@link #resize} event. This method can accept
271      * either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.
272      * @param {Mixed} width The new width to set. This may be one of:<div class="mdetail-params"><ul>
273      * <li>A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).</li>
274      * <li>A String used to set the CSS width style.</li>
275      * <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
276      * <li><code>undefined</code> to leave the width unchanged.</li>
277      * </ul></div>
278      * @param {Mixed} height The new height to set (not required if a size object is passed as the first arg).
279      * This may be one of:<div class="mdetail-params"><ul>
280      * <li>A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).</li>
281      * <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
282      * <li><code>undefined</code> to leave the height unchanged.</li>
283      * </ul></div>
284      * @return {Ext.BoxComponent} this
285      */
286     setSize : function(w, h){
287
288         // support for standard size objects
289         if(typeof w == 'object'){
290             h = w.height;
291             w = w.width;
292         }
293         if (Ext.isDefined(w) && Ext.isDefined(this.boxMinWidth) && (w < this.boxMinWidth)) {
294             w = this.boxMinWidth;
295         }
296         if (Ext.isDefined(h) && Ext.isDefined(this.boxMinHeight) && (h < this.boxMinHeight)) {
297             h = this.boxMinHeight;
298         }
299         if (Ext.isDefined(w) && Ext.isDefined(this.boxMaxWidth) && (w > this.boxMaxWidth)) {
300             w = this.boxMaxWidth;
301         }
302         if (Ext.isDefined(h) && Ext.isDefined(this.boxMaxHeight) && (h > this.boxMaxHeight)) {
303             h = this.boxMaxHeight;
304         }
305         // not rendered
306         if(!this.boxReady){
307             this.width  = w;
308             this.height = h;
309             return this;
310         }
311
312         // prevent recalcs when not needed
313         if(this.cacheSizes !== false && this.lastSize && this.lastSize.width == w && this.lastSize.height == h){
314             return this;
315         }
316         this.lastSize = {width: w, height: h};
317         var adj = this.adjustSize(w, h),
318             aw = adj.width,
319             ah = adj.height,
320             rz;
321         if(aw !== undefined || ah !== undefined){ // this code is nasty but performs better with floaters
322             rz = this.getResizeEl();
323             if(!this.deferHeight && aw !== undefined && ah !== undefined){
324                 rz.setSize(aw, ah);
325             }else if(!this.deferHeight && ah !== undefined){
326                 rz.setHeight(ah);
327             }else if(aw !== undefined){
328                 rz.setWidth(aw);
329             }
330             this.onResize(aw, ah, w, h);
331             this.fireEvent('resize', this, aw, ah, w, h);
332         }
333         return this;
334     },
335
336     <div id="method-Ext.BoxComponent-setWidth"></div>/**
337      * Sets the width of the component.  This method fires the {@link #resize} event.
338      * @param {Mixed} width The new width to set. This may be one of:<div class="mdetail-params"><ul>
339      * <li>A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit defaultUnit}s (by default, pixels).</li>
340      * <li>A String used to set the CSS width style.</li>
341      * </ul></div>
342      * @return {Ext.BoxComponent} this
343      */
344     setWidth : function(width){
345         return this.setSize(width);
346     },
347
348     <div id="method-Ext.BoxComponent-setHeight"></div>/**
349      * Sets the height of the component.  This method fires the {@link #resize} event.
350      * @param {Mixed} height The new height to set. This may be one of:<div class="mdetail-params"><ul>
351      * <li>A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit defaultUnit}s (by default, pixels).</li>
352      * <li>A String used to set the CSS height style.</li>
353      * <li><i>undefined</i> to leave the height unchanged.</li>
354      * </ul></div>
355      * @return {Ext.BoxComponent} this
356      */
357     setHeight : function(height){
358         return this.setSize(undefined, height);
359     },
360
361     <div id="method-Ext.BoxComponent-getSize"></div>/**
362      * Gets the current size of the component's underlying element.
363      * @return {Object} An object containing the element's size {width: (element width), height: (element height)}
364      */
365     getSize : function(){
366         return this.getResizeEl().getSize();
367     },
368
369     <div id="method-Ext.BoxComponent-getWidth"></div>/**
370      * Gets the current width of the component's underlying element.
371      * @return {Number}
372      */
373     getWidth : function(){
374         return this.getResizeEl().getWidth();
375     },
376
377     <div id="method-Ext.BoxComponent-getHeight"></div>/**
378      * Gets the current height of the component's underlying element.
379      * @return {Number}
380      */
381     getHeight : function(){
382         return this.getResizeEl().getHeight();
383     },
384
385     <div id="method-Ext.BoxComponent-getOuterSize"></div>/**
386      * Gets the current size of the component's underlying element, including space taken by its margins.
387      * @return {Object} An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
388      */
389     getOuterSize : function(){
390         var el = this.getResizeEl();
391         return {width: el.getWidth() + el.getMargins('lr'),
392                 height: el.getHeight() + el.getMargins('tb')};
393     },
394
395     <div id="method-Ext.BoxComponent-getPosition"></div>/**
396      * Gets the current XY position of the component's underlying element.
397      * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false)
398      * @return {Array} The XY position of the element (e.g., [100, 200])
399      */
400     getPosition : function(local){
401         var el = this.getPositionEl();
402         if(local === true){
403             return [el.getLeft(true), el.getTop(true)];
404         }
405         return this.xy || el.getXY();
406     },
407
408     <div id="method-Ext.BoxComponent-getBox"></div>/**
409      * Gets the current box measurements of the component's underlying element.
410      * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false)
411      * @return {Object} box An object in the format {x, y, width, height}
412      */
413     getBox : function(local){
414         var pos = this.getPosition(local);
415         var s = this.getSize();
416         s.x = pos[0];
417         s.y = pos[1];
418         return s;
419     },
420
421     <div id="method-Ext.BoxComponent-updateBox"></div>/**
422      * Sets the current box measurements of the component's underlying element.
423      * @param {Object} box An object in the format {x, y, width, height}
424      * @return {Ext.BoxComponent} this
425      */
426     updateBox : function(box){
427         this.setSize(box.width, box.height);
428         this.setPagePosition(box.x, box.y);
429         return this;
430     },
431
432     <div id="method-Ext.BoxComponent-getResizeEl"></div>/**
433      * <p>Returns the outermost Element of this Component which defines the Components overall size.</p>
434      * <p><i>Usually</i> this will return the same Element as <code>{@link #getEl}</code>,
435      * but in some cases, a Component may have some more wrapping Elements around its main
436      * active Element.</p>
437      * <p>An example is a ComboBox. It is encased in a <i>wrapping</i> Element which
438      * contains both the <code>&lt;input></code> Element (which is what would be returned
439      * by its <code>{@link #getEl}</code> method, <i>and</i> the trigger button Element.
440      * This Element is returned as the <code>resizeEl</code>.
441      * @return {Ext.Element} The Element which is to be resized by size managing layouts.
442      */
443     getResizeEl : function(){
444         return this.resizeEl || this.el;
445     },
446
447     <div id="method-Ext.BoxComponent-setAutoScroll"></div>/**
448      * Sets the overflow on the content element of the component.
449      * @param {Boolean} scroll True to allow the Component to auto scroll.
450      * @return {Ext.BoxComponent} this
451      */
452     setAutoScroll : function(scroll){
453         if(this.rendered){
454             this.getContentTarget().setOverflow(scroll ? 'auto' : '');
455         }
456         this.autoScroll = scroll;
457         return this;
458     },
459
460     <div id="method-Ext.BoxComponent-setPosition"></div>/**
461      * Sets the left and top of the component.  To set the page XY position instead, use {@link #setPagePosition}.
462      * This method fires the {@link #move} event.
463      * @param {Number} left The new left
464      * @param {Number} top The new top
465      * @return {Ext.BoxComponent} this
466      */
467     setPosition : function(x, y){
468         if(x && typeof x[1] == 'number'){
469             y = x[1];
470             x = x[0];
471         }
472         this.x = x;
473         this.y = y;
474         if(!this.boxReady){
475             return this;
476         }
477         var adj = this.adjustPosition(x, y);
478         var ax = adj.x, ay = adj.y;
479
480         var el = this.getPositionEl();
481         if(ax !== undefined || ay !== undefined){
482             if(ax !== undefined && ay !== undefined){
483                 el.setLeftTop(ax, ay);
484             }else if(ax !== undefined){
485                 el.setLeft(ax);
486             }else if(ay !== undefined){
487                 el.setTop(ay);
488             }
489             this.onPosition(ax, ay);
490             this.fireEvent('move', this, ax, ay);
491         }
492         return this;
493     },
494
495     <div id="method-Ext.BoxComponent-setPagePosition"></div>/**
496      * Sets the page XY position of the component.  To set the left and top instead, use {@link #setPosition}.
497      * This method fires the {@link #move} event.
498      * @param {Number} x The new x position
499      * @param {Number} y The new y position
500      * @return {Ext.BoxComponent} this
501      */
502     setPagePosition : function(x, y){
503         if(x && typeof x[1] == 'number'){
504             y = x[1];
505             x = x[0];
506         }
507         this.pageX = x;
508         this.pageY = y;
509         if(!this.boxReady){
510             return;
511         }
512         if(x === undefined || y === undefined){ // cannot translate undefined points
513             return;
514         }
515         var p = this.getPositionEl().translatePoints(x, y);
516         this.setPosition(p.left, p.top);
517         return this;
518     },
519
520     // private
521     afterRender : function(){
522         Ext.BoxComponent.superclass.afterRender.call(this);
523         if(this.resizeEl){
524             this.resizeEl = Ext.get(this.resizeEl);
525         }
526         if(this.positionEl){
527             this.positionEl = Ext.get(this.positionEl);
528         }
529         this.boxReady = true;
530         Ext.isDefined(this.autoScroll) && this.setAutoScroll(this.autoScroll);
531         this.setSize(this.width, this.height);
532         if(this.x || this.y){
533             this.setPosition(this.x, this.y);
534         }else if(this.pageX || this.pageY){
535             this.setPagePosition(this.pageX, this.pageY);
536         }
537     },
538
539     <div id="method-Ext.BoxComponent-syncSize"></div>/**
540      * Force the component's size to recalculate based on the underlying element's current height and width.
541      * @return {Ext.BoxComponent} this
542      */
543     syncSize : function(){
544         delete this.lastSize;
545         this.setSize(this.autoWidth ? undefined : this.getResizeEl().getWidth(), this.autoHeight ? undefined : this.getResizeEl().getHeight());
546         return this;
547     },
548
549     /* // protected
550      * Called after the component is resized, this method is empty by default but can be implemented by any
551      * subclass that needs to perform custom logic after a resize occurs.
552      * @param {Number} adjWidth The box-adjusted width that was set
553      * @param {Number} adjHeight The box-adjusted height that was set
554      * @param {Number} rawWidth The width that was originally specified
555      * @param {Number} rawHeight The height that was originally specified
556      */
557     onResize : function(adjWidth, adjHeight, rawWidth, rawHeight){
558     },
559
560     /* // protected
561      * Called after the component is moved, this method is empty by default but can be implemented by any
562      * subclass that needs to perform custom logic after a move occurs.
563      * @param {Number} x The new x position
564      * @param {Number} y The new y position
565      */
566     onPosition : function(x, y){
567
568     },
569
570     // private
571     adjustSize : function(w, h){
572         if(this.autoWidth){
573             w = 'auto';
574         }
575         if(this.autoHeight){
576             h = 'auto';
577         }
578         return {width : w, height: h};
579     },
580
581     // private
582     adjustPosition : function(x, y){
583         return {x : x, y: y};
584     }
585 });
586 Ext.reg('box', Ext.BoxComponent);
587
588
589 <div id="cls-Ext.Spacer"></div>/**
590  * @class Ext.Spacer
591  * @extends Ext.BoxComponent
592  * <p>Used to provide a sizable space in a layout.</p>
593  * @constructor
594  * @param {Object} config
595  */
596 Ext.Spacer = Ext.extend(Ext.BoxComponent, {
597     autoEl:'div'
598 });
599 Ext.reg('spacer', Ext.Spacer);</pre>    
600 </body>
601 </html>