docs/source/Container.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"><div id="cls-Ext.Container"></div>/**
  10  * @class Ext.Container
  11  * @extends Ext.BoxComponent
  12  * <p>Base class for any {@link Ext.BoxComponent} that may contain other Components. Containers handle the
  13  * basic behavior of containing items, namely adding, inserting and removing items.</p>
  14  *
  15  * <p>The most commonly used Container classes are {@link Ext.Panel}, {@link Ext.Window} and {@link Ext.TabPanel}.
  16  * If you do not need the capabilities offered by the aforementioned classes you can create a lightweight
  17  * Container to be encapsulated by an HTML element to your specifications by using the
  18  * <code><b>{@link Ext.Component#autoEl autoEl}</b></code> config option. This is a useful technique when creating
  19  * embedded {@link Ext.layout.ColumnLayout column} layouts inside {@link Ext.form.FormPanel FormPanels}
  20  * for example.</p>
  21  *
  22  * <p>The code below illustrates both how to explicitly create a Container, and how to implicitly
  23  * create one using the <b><code>'container'</code></b> xtype:<pre><code>
  24 // explicitly create a Container
  25 var embeddedColumns = new Ext.Container({
  26     autoEl: 'div',  // This is the default
  27     layout: 'column',
  28     defaults: {
  29         // implicitly create Container by specifying xtype
  30         xtype: 'container',
  31         autoEl: 'div', // This is the default.
  32         layout: 'form',
  33         columnWidth: 0.5,
  34         style: {
  35             padding: '10px'
  36         }
  37     },
  38 //  The two items below will be Ext.Containers, each encapsulated by a &lt;DIV> element.
  39     items: [{
  40         items: {
  41             xtype: 'datefield',
  42             name: 'startDate',
  43             fieldLabel: 'Start date'
  44         }
  45     }, {
  46         items: {
  47             xtype: 'datefield',
  48             name: 'endDate',
  49             fieldLabel: 'End date'
  50         }
  51     }]
  52 });</code></pre></p>
  53  *
  54  * <p><u><b>Layout</b></u></p>
  55  * <p>Container classes delegate the rendering of child Components to a layout
  56  * manager class which must be configured into the Container using the
  57  * <code><b>{@link #layout}</b></code> configuration property.</p>
  58  * <p>When either specifying child <code>{@link #items}</code> of a Container,
  59  * or dynamically {@link #add adding} Components to a Container, remember to
  60  * consider how you wish the Container to arrange those child elements, and
  61  * whether those child elements need to be sized using one of Ext's built-in
  62  * <b><code>{@link #layout}</code></b> schemes. By default, Containers use the
  63  * {@link Ext.layout.ContainerLayout ContainerLayout} scheme which only
  64  * renders child components, appending them one after the other inside the
  65  * Container, and <b>does not apply any sizing</b> at all.</p>
  66  * <p>A common mistake is when a developer neglects to specify a
  67  * <b><code>{@link #layout}</code></b> (e.g. widgets like GridPanels or
  68  * TreePanels are added to Containers for which no <code><b>{@link #layout}</b></code>
  69  * has been specified). If a Container is left to use the default
  70  * {@link Ext.layout.ContainerLayout ContainerLayout} scheme, none of its
  71  * child components will be resized, or changed in any way when the Container
  72  * is resized.</p>
  73  * <p>Certain layout managers allow dynamic addition of child components.
  74  * Those that do include {@link Ext.layout.CardLayout},
  75  * {@link Ext.layout.AnchorLayout}, {@link Ext.layout.FormLayout}, and
  76  * {@link Ext.layout.TableLayout}. For example:<pre><code>
  77 //  Create the GridPanel.
  78 var myNewGrid = new Ext.grid.GridPanel({
  79     store: myStore,
  80     columns: myColumnModel,
  81     title: 'Results', // the title becomes the title of the tab
  82 });
  83
  84 myTabPanel.add(myNewGrid); // {@link Ext.TabPanel} implicitly uses {@link Ext.layout.CardLayout CardLayout}
  85 myTabPanel.{@link Ext.TabPanel#setActiveTab setActiveTab}(myNewGrid);
  86  * </code></pre></p>
  87  * <p>The example above adds a newly created GridPanel to a TabPanel. Note that
  88  * a TabPanel uses {@link Ext.layout.CardLayout} as its layout manager which
  89  * means all its child items are sized to {@link Ext.layout.FitLayout fit}
  90  * exactly into its client area.
  91  * <p><b><u>Overnesting is a common problem</u></b>.
  92  * An example of overnesting occurs when a GridPanel is added to a TabPanel
  93  * by wrapping the GridPanel <i>inside</i> a wrapping Panel (that has no
  94  * <code><b>{@link #layout}</b></code> specified) and then add that wrapping Panel
  95  * to the TabPanel. The point to realize is that a GridPanel <b>is</b> a
  96  * Component which can be added directly to a Container. If the wrapping Panel
  97  * has no <code><b>{@link #layout}</b></code> configuration, then the overnested
  98  * GridPanel will not be sized as expected.<p>
  99  *
 100  * <p><u><b>Adding via remote configuration</b></u></p>
 101  *
 102  * <p>A server side script can be used to add Components which are generated dynamically on the server.
 103  * An example of adding a GridPanel to a TabPanel where the GridPanel is generated by the server
 104  * based on certain parameters:
 105  * </p><pre><code>
 106 // execute an Ajax request to invoke server side script:
 107 Ext.Ajax.request({
 108     url: 'gen-invoice-grid.php',
 109     // send additional parameters to instruct server script
 110     params: {
 111         startDate: Ext.getCmp('start-date').getValue(),
 112         endDate: Ext.getCmp('end-date').getValue()
 113     },
 114     // process the response object to add it to the TabPanel:
 115     success: function(xhr) {
 116         var newComponent = eval(xhr.responseText); // see discussion below
 117         myTabPanel.add(newComponent); // add the component to the TabPanel
 118         myTabPanel.setActiveTab(newComponent);
 119     },
 120     failure: function() {
 121         Ext.Msg.alert("Grid create failed", "Server communication failure");
 122     }
 123 });
 124 </code></pre>
 125  * <p>The server script needs to return an executable Javascript statement which, when processed
 126  * using <code>eval()</code>, will return either a config object with an {@link Ext.Component#xtype xtype},
 127  * or an instantiated Component. The server might return this for example:</p><pre><code>
 128 (function() {
 129     function formatDate(value){
 130         return value ? value.dateFormat('M d, Y') : '';
 131     };
 132
 133     var store = new Ext.data.Store({
 134         url: 'get-invoice-data.php',
 135         baseParams: {
 136             startDate: '01/01/2008',
 137             endDate: '01/31/2008'
 138         },
 139         reader: new Ext.data.JsonReader({
 140             record: 'transaction',
 141             idProperty: 'id',
 142             totalRecords: 'total'
 143         }, [
 144            'customer',
 145            'invNo',
 146            {name: 'date', type: 'date', dateFormat: 'm/d/Y'},
 147            {name: 'value', type: 'float'}
 148         ])
 149     });
 150
 151     var grid = new Ext.grid.GridPanel({
 152         title: 'Invoice Report',
 153         bbar: new Ext.PagingToolbar(store),
 154         store: store,
 155         columns: [
 156             {header: "Customer", width: 250, dataIndex: 'customer', sortable: true},
 157             {header: "Invoice Number", width: 120, dataIndex: 'invNo', sortable: true},
 158             {header: "Invoice Date", width: 100, dataIndex: 'date', renderer: formatDate, sortable: true},
 159             {header: "Value", width: 120, dataIndex: 'value', renderer: 'usMoney', sortable: true}
 160         ],
 161     });
 162     store.load();
 163     return grid;  // return instantiated component
 164 })();
 165 </code></pre>
 166  * <p>When the above code fragment is passed through the <code>eval</code> function in the success handler
 167  * of the Ajax request, the code is executed by the Javascript processor, and the anonymous function
 168  * runs, and returns the instantiated grid component.</p>
 169  * <p>Note: since the code above is <i>generated</i> by a server script, the <code>baseParams</code> for
 170  * the Store, the metadata to allow generation of the Record layout, and the ColumnModel
 171  * can all be generated into the code since these are all known on the server.</p>
 172  *
 173  * @xtype container
 174  */
 175 Ext.Container = Ext.extend(Ext.BoxComponent, {
 176     <div id="cfg-Ext.Container-monitorResize"></div>/**
 177      * @cfg {Boolean} monitorResize
 178      * True to automatically monitor window resize events to handle anything that is sensitive to the current size
 179      * of the viewport.  This value is typically managed by the chosen <code>{@link #layout}</code> and should not need
 180      * to be set manually.
 181      */
 182     <div id="cfg-Ext.Container-layout"></div>/**
 183      * @cfg {String/Object} layout
 184      * <p><b>*Important</b>: In order for child items to be correctly sized and
 185      * positioned, typically a layout manager <b>must</b> be specified through
 186      * the <code>layout</code> configuration option.</p>
 187      * <br><p>The sizing and positioning of child {@link items} is the responsibility of
 188      * the Container's layout manager which creates and manages the type of layout
 189      * you have in mind.  For example:</p><pre><code>
 190 new Ext.Window({
 191     width:300, height: 300,
 192     layout: 'fit', // explicitly set layout manager: override the default (layout:'auto')
 193     items: [{
 194         title: 'Panel inside a Window'
 195     }]
 196 }).show();
 197      * </code></pre>
 198      * <p>If the {@link #layout} configuration is not explicitly specified for
 199      * a general purpose container (e.g. Container or Panel) the
 200      * {@link Ext.layout.ContainerLayout default layout manager} will be used
 201      * which does nothing but render child components sequentially into the
 202      * Container (no sizing or positioning will be performed in this situation).
 203      * Some container classes implicitly specify a default layout
 204      * (e.g. FormPanel specifies <code>layout:'form'</code>). Other specific
 205      * purpose classes internally specify/manage their internal layout (e.g.
 206      * GridPanel, TabPanel, TreePanel, Toolbar, Menu, etc.).</p>
 207      * <br><p><b><code>layout</code></b> may be specified as either as an Object or
 208      * as a String:</p><div><ul class="mdetail-params">
 209      *
 210      * <li><u>Specify as an Object</u></li>
 211      * <div><ul class="mdetail-params">
 212      * <li>Example usage:</li>
 213 <pre><code>
 214 layout: {
 215     type: 'vbox',
 216     padding: '5',
 217     align: 'left'
 218 }
 219 </code></pre>
 220      *
 221      * <li><code><b>type</b></code></li>
 222      * <br/><p>The layout type to be used for this container.  If not specified,
 223      * a default {@link Ext.layout.ContainerLayout} will be created and used.</p>
 224      * <br/><p>Valid layout <code>type</code> values are:</p>
 225      * <div class="sub-desc"><ul class="mdetail-params">
 226      * <li><code><b>{@link Ext.layout.AbsoluteLayout absolute}</b></code></li>
 227      * <li><code><b>{@link Ext.layout.AccordionLayout accordion}</b></code></li>
 228      * <li><code><b>{@link Ext.layout.AnchorLayout anchor}</b></code></li>
 229      * <li><code><b>{@link Ext.layout.ContainerLayout auto}</b></code> &nbsp;&nbsp;&nbsp; <b>Default</b></li>
 230      * <li><code><b>{@link Ext.layout.BorderLayout border}</b></code></li>
 231      * <li><code><b>{@link Ext.layout.CardLayout card}</b></code></li>
 232      * <li><code><b>{@link Ext.layout.ColumnLayout column}</b></code></li>
 233      * <li><code><b>{@link Ext.layout.FitLayout fit}</b></code></li>
 234      * <li><code><b>{@link Ext.layout.FormLayout form}</b></code></li>
 235      * <li><code><b>{@link Ext.layout.HBoxLayout hbox}</b></code></li>
 236      * <li><code><b>{@link Ext.layout.MenuLayout menu}</b></code></li>
 237      * <li><code><b>{@link Ext.layout.TableLayout table}</b></code></li>
 238      * <li><code><b>{@link Ext.layout.ToolbarLayout toolbar}</b></code></li>
 239      * <li><code><b>{@link Ext.layout.VBoxLayout vbox}</b></code></li>
 240      * </ul></div>
 241      *
 242      * <li>Layout specific configuration properties</li>
 243      * <br/><p>Additional layout specific configuration properties may also be
 244      * specified. For complete details regarding the valid config options for
 245      * each layout type, see the layout class corresponding to the <code>type</code>
 246      * specified.</p>
 247      *
 248      * </ul></div>
 249      *
 250      * <li><u>Specify as a String</u></li>
 251      * <div><ul class="mdetail-params">
 252      * <li>Example usage:</li>
 253 <pre><code>
 254 layout: 'vbox',
 255 layoutConfig: {
 256     padding: '5',
 257     align: 'left'
 258 }
 259 </code></pre>
 260      * <li><code><b>layout</b></code></li>
 261      * <br/><p>The layout <code>type</code> to be used for this container (see list
 262      * of valid layout type values above).</p><br/>
 263      * <li><code><b>{@link #layoutConfig}</b></code></li>
 264      * <br/><p>Additional layout specific configuration properties. For complete
 265      * details regarding the valid config options for each layout type, see the
 266      * layout class corresponding to the <code>layout</code> specified.</p>
 267      * </ul></div></ul></div>
 268      */
 269     <div id="cfg-Ext.Container-layoutConfig"></div>/**
 270      * @cfg {Object} layoutConfig
 271      * This is a config object containing properties specific to the chosen
 272      * <b><code>{@link #layout}</code></b> if <b><code>{@link #layout}</code></b>
 273      * has been specified as a <i>string</i>.</p>
 274      */
 275     <div id="cfg-Ext.Container-bufferResize"></div>/**
 276      * @cfg {Boolean/Number} bufferResize
 277      * When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
 278      * the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
 279      * with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to <code>50</code>.
 280      */
 281     // Deprecated - will be removed in 3.2.x
 282     bufferResize: 50,
 283
 284     <div id="cfg-Ext.Container-activeItem"></div>/**
 285      * @cfg {String/Number} activeItem
 286      * A string component id or the numeric index of the component that should be initially activated within the
 287      * container's layout on render.  For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first
 288      * item in the container's collection).  activeItem only applies to layout styles that can display
 289      * items one at a time (like {@link Ext.layout.AccordionLayout}, {@link Ext.layout.CardLayout} and
 290      * {@link Ext.layout.FitLayout}).  Related to {@link Ext.layout.ContainerLayout#activeItem}.
 291      */
 292     <div id="cfg-Ext.Container-items"></div>/**
 293      * @cfg {Object/Array} items
 294      * <pre><b>** IMPORTANT</b>: be sure to <b>{@link #layout specify a <code>layout</code>} if needed ! **</b></pre>
 295      * <p>A single item, or an array of child Components to be added to this container,
 296      * for example:</p>
 297      * <pre><code>
 298 // specifying a single item
 299 items: {...},
 300 layout: 'fit',    // specify a layout!
 301
 302 // specifying multiple items
 303 items: [{...}, {...}],
 304 layout: 'anchor', // specify a layout!
 305      * </code></pre>
 306      * <p>Each item may be:</p>
 307      * <div><ul class="mdetail-params">
 308      * <li>any type of object based on {@link Ext.Component}</li>
 309      * <li>a fully instanciated object or</li>
 310      * <li>an object literal that:</li>
 311      * <div><ul class="mdetail-params">
 312      * <li>has a specified <code>{@link Ext.Component#xtype xtype}</code></li>
 313      * <li>the {@link Ext.Component#xtype} specified is associated with the Component
 314      * desired and should be chosen from one of the available xtypes as listed
 315      * in {@link Ext.Component}.</li>
 316      * <li>If an <code>{@link Ext.Component#xtype xtype}</code> is not explicitly
 317      * specified, the {@link #defaultType} for that Container is used.</li>
 318      * <li>will be "lazily instanciated", avoiding the overhead of constructing a fully
 319      * instanciated Component object</li>
 320      * </ul></div></ul></div>
 321      * <p><b>Notes</b>:</p>
 322      * <div><ul class="mdetail-params">
 323      * <li>Ext uses lazy rendering. Child Components will only be rendered
 324      * should it become necessary. Items are automatically laid out when they are first
 325      * shown (no sizing is done while hidden), or in response to a {@link #doLayout} call.</li>
 326      * <li>Do not specify <code>{@link Ext.Panel#contentEl contentEl}</code>/
 327      * <code>{@link Ext.Panel#html html}</code> with <code>items</code>.</li>
 328      * </ul></div>
 329      */
 330     <div id="cfg-Ext.Container-defaults"></div>/**
 331      * @cfg {Object|Function} defaults
 332      * <p>This option is a means of applying default settings to all added items whether added through the {@link #items}
 333      * config or via the {@link #add} or {@link #insert} methods.</p>
 334      * <p>If an added item is a config object, and <b>not</b> an instantiated Component, then the default properties are
 335      * unconditionally applied. If the added item <b>is</b> an instantiated Component, then the default properties are
 336      * applied conditionally so as not to override existing properties in the item.</p>
 337      * <p>If the defaults option is specified as a function, then the function will be called using this Container as the
 338      * scope (<code>this</code> reference) and passing the added item as the first parameter. Any resulting object
 339      * from that call is then applied to the item as default properties.</p>
 340      * <p>For example, to automatically apply padding to the body of each of a set of
 341      * contained {@link Ext.Panel} items, you could pass: <code>defaults: {bodyStyle:'padding:15px'}</code>.</p>
 342      * <p>Usage:</p><pre><code>
 343 defaults: {               // defaults are applied to items, not the container
 344     autoScroll:true
 345 },
 346 items: [
 347     {
 348         xtype: 'panel',   // defaults <b>do not</b> have precedence over
 349         id: 'panel1',     // options in config objects, so the defaults
 350         autoScroll: false // will not be applied here, panel1 will be autoScroll:false
 351     },
 352     new Ext.Panel({       // defaults <b>do</b> have precedence over options
 353         id: 'panel2',     // options in components, so the defaults
 354         autoScroll: false // will be applied here, panel2 will be autoScroll:true.
 355     })
 356 ]
 357      * </code></pre>
 358      */
 359
 360
 361     <div id="cfg-Ext.Container-autoDestroy"></div>/** @cfg {Boolean} autoDestroy
 362      * If true the container will automatically destroy any contained component that is removed from it, else
 363      * destruction must be handled manually (defaults to true).
 364      */
 365     autoDestroy : true,
 366
 367     <div id="cfg-Ext.Container-forceLayout"></div>/** @cfg {Boolean} forceLayout
 368      * If true the container will force a layout initially even if hidden or collapsed. This option
 369      * is useful for forcing forms to render in collapsed or hidden containers. (defaults to false).
 370      */
 371     forceLayout: false,
 372
 373     <div id="cfg-Ext.Container-hideBorders"></div>/** @cfg {Boolean} hideBorders
 374      * True to hide the borders of each contained component, false to defer to the component's existing
 375      * border settings (defaults to false).
 376      */
 377     <div id="cfg-Ext.Container-defaultType"></div>/** @cfg {String} defaultType
 378      * <p>The default {@link Ext.Component xtype} of child Components to create in this Container when
 379      * a child item is specified as a raw configuration object, rather than as an instantiated Component.</p>
 380      * <p>Defaults to <code>'panel'</code>, except {@link Ext.menu.Menu} which defaults to <code>'menuitem'</code>,
 381      * and {@link Ext.Toolbar} and {@link Ext.ButtonGroup} which default to <code>'button'</code>.</p>
 382      */
 383     defaultType : 'panel',
 384
 385     <div id="cfg-Ext.Container-resizeEvent"></div>/** @cfg {String} resizeEvent
 386      * The event to listen to for resizing in layouts. Defaults to <code>'resize'</code>.
 387      */
 388     resizeEvent: 'resize',
 389
 390     <div id="cfg-Ext.Container-bubbleEvents"></div>/**
 391      * @cfg {Array} bubbleEvents
 392      * <p>An array of events that, when fired, should be bubbled to any parent container.
 393      * See {@link Ext.util.Observable#enableBubble}.
 394      * Defaults to <code>['add', 'remove']</code>.
 395      */
 396     bubbleEvents: ['add', 'remove'],
 397
 398     // private
 399     initComponent : function(){
 400         Ext.Container.superclass.initComponent.call(this);
 401
 402         this.addEvents(
 403             <div id="event-Ext.Container-afterlayout"></div>/**
 404              * @event afterlayout
 405              * Fires when the components in this container are arranged by the associated layout manager.
 406              * @param {Ext.Container} this
 407              * @param {ContainerLayout} layout The ContainerLayout implementation for this container
 408              */
 409             'afterlayout',
 410             <div id="event-Ext.Container-beforeadd"></div>/**
 411              * @event beforeadd
 412              * Fires before any {@link Ext.Component} is added or inserted into the container.
 413              * A handler can return false to cancel the add.
 414              * @param {Ext.Container} this
 415              * @param {Ext.Component} component The component being added
 416              * @param {Number} index The index at which the component will be added to the container's items collection
 417              */
 418             'beforeadd',
 419             <div id="event-Ext.Container-beforeremove"></div>/**
 420              * @event beforeremove
 421              * Fires before any {@link Ext.Component} is removed from the container.  A handler can return
 422              * false to cancel the remove.
 423              * @param {Ext.Container} this
 424              * @param {Ext.Component} component The component being removed
 425              */
 426             'beforeremove',
 427             <div id="event-Ext.Container-add"></div>/**
 428              * @event add
 429              * @bubbles
 430              * Fires after any {@link Ext.Component} is added or inserted into the container.
 431              * @param {Ext.Container} this
 432              * @param {Ext.Component} component The component that was added
 433              * @param {Number} index The index at which the component was added to the container's items collection
 434              */
 435             'add',
 436             <div id="event-Ext.Container-remove"></div>/**
 437              * @event remove
 438              * @bubbles
 439              * Fires after any {@link Ext.Component} is removed from the container.
 440              * @param {Ext.Container} this
 441              * @param {Ext.Component} component The component that was removed
 442              */
 443             'remove'
 444         );
 445
 446         this.enableBubble(this.bubbleEvents);
 447
 448         <div id="prop-Ext.Container-items"></div>/**
 449          * The collection of components in this container as a {@link Ext.util.MixedCollection}
 450          * @type MixedCollection
 451          * @property items
 452          */
 453         var items = this.items;
 454         if(items){
 455             delete this.items;
 456             this.add(items);
 457         }
 458     },
 459
 460     // private
 461     initItems : function(){
 462         if(!this.items){
 463             this.items = new Ext.util.MixedCollection(false, this.getComponentId);
 464             this.getLayout(); // initialize the layout
 465         }
 466     },
 467
 468     // private
 469     setLayout : function(layout){
 470         if(this.layout && this.layout != layout){
 471             this.layout.setContainer(null);
 472         }
 473         this.initItems();
 474         this.layout = layout;
 475         layout.setContainer(this);
 476     },
 477
 478     afterRender: function(){
 479         // Render this Container, this should be done before setLayout is called which
 480         // will hook onResize
 481         Ext.Container.superclass.afterRender.call(this);
 482         if(!this.layout){
 483             this.layout = 'auto';
 484         }
 485         if(Ext.isObject(this.layout) && !this.layout.layout){
 486             this.layoutConfig = this.layout;
 487             this.layout = this.layoutConfig.type;
 488         }
 489         if(Ext.isString(this.layout)){
 490             this.layout = new Ext.Container.LAYOUTS[this.layout.toLowerCase()](this.layoutConfig);
 491         }
 492         this.setLayout(this.layout);
 493
 494         // If a CardLayout, the active item set
 495         if(this.activeItem !== undefined){
 496             var item = this.activeItem;
 497             delete this.activeItem;
 498             this.layout.setActiveItem(item);
 499         }
 500
 501         // If we have no ownerCt, render and size all children
 502         if(!this.ownerCt){
 503             this.doLayout(false, true);
 504         }
 505
 506         // This is a manually configured flag set by users in conjunction with renderTo.
 507         // Not to be confused with the flag by the same name used in Layouts.
 508         if(this.monitorResize === true){
 509             Ext.EventManager.onWindowResize(this.doLayout, this, [false]);
 510         }
 511     },
 512
 513     <div id="method-Ext.Container-getLayoutTarget"></div>/**
 514      * <p>Returns the Element to be used to contain the child Components of this Container.</p>
 515      * <p>An implementation is provided which returns the Container's {@link #getEl Element}, but
 516      * if there is a more complex structure to a Container, this may be overridden to return
 517      * the element into which the {@link #layout layout} renders child Components.</p>
 518      * @return {Ext.Element} The Element to render child Components into.
 519      */
 520     getLayoutTarget : function(){
 521         return this.el;
 522     },
 523
 524     // private - used as the key lookup function for the items collection
 525     getComponentId : function(comp){
 526         return comp.getItemId();
 527     },
 528
 529     <div id="method-Ext.Container-add"></div>/**
 530      * <p>Adds {@link Ext.Component Component}(s) to this Container.</p>
 531      * <br><p><b>Description</b></u> :
 532      * <div><ul class="mdetail-params">
 533      * <li>Fires the {@link #beforeadd} event before adding</li>
 534      * <li>The Container's {@link #defaults default config values} will be applied
 535      * accordingly (see <code>{@link #defaults}</code> for details).</li>
 536      * <li>Fires the {@link #add} event after the component has been added.</li>
 537      * </ul></div>
 538      * <br><p><b>Notes</b></u> :
 539      * <div><ul class="mdetail-params">
 540      * <li>If the Container is <i>already rendered</i> when <code>add</code>
 541      * is called, you may need to call {@link #doLayout} to refresh the view which causes
 542      * any unrendered child Components to be rendered. This is required so that you can
 543      * <code>add</code> multiple child components if needed while only refreshing the layout
 544      * once. For example:<pre><code>
 545 var tb = new {@link Ext.Toolbar}();
 546 tb.render(document.body);  // toolbar is rendered
 547 tb.add({text:'Button 1'}); // add multiple items ({@link #defaultType} for {@link Ext.Toolbar Toolbar} is 'button')
 548 tb.add({text:'Button 2'});
 549 tb.{@link #doLayout}();             // refresh the layout
 550      * </code></pre></li>
 551      * <li><i>Warning:</i> Containers directly managed by the BorderLayout layout manager
 552      * may not be removed or added.  See the Notes for {@link Ext.layout.BorderLayout BorderLayout}
 553      * for more details.</li>
 554      * </ul></div>
 555      * @param {Object/Array} component
 556      * <p>Either a single component or an Array of components to add.  See
 557      * <code>{@link #items}</code> for additional information.</p>
 558      * @param {Object} (Optional) component_2
 559      * @param {Object} (Optional) component_n
 560      * @return {Ext.Component} component The Component (or config object) that was added.
 561      */
 562     add : function(comp){
 563         this.initItems();
 564         var args = arguments.length > 1;
 565         if(args || Ext.isArray(comp)){
 566             var result = [];
 567             Ext.each(args ? arguments : comp, function(c){
 568                 result.push(this.add(c));
 569             }, this);
 570             return result;
 571         }
 572         var c = this.lookupComponent(this.applyDefaults(comp));
 573         var index = this.items.length;
 574         if(this.fireEvent('beforeadd', this, c, index) !== false && this.onBeforeAdd(c) !== false){
 575             this.items.add(c);
 576             // *onAdded
 577             c.onAdded(this, index);
 578             this.onAdd(c);
 579             this.fireEvent('add', this, c, index);
 580         }
 581         return c;
 582     },
 583
 584     onAdd : function(c){
 585         // Empty template method
 586     },
 587
 588     // private
 589     onAdded : function(container, pos) {
 590         //overridden here so we can cascade down, not worth creating a template method.
 591         this.ownerCt = container;
 592         this.initRef();
 593         //initialize references for child items
 594         this.cascade(function(c){
 595             c.initRef();
 596         });
 597         this.fireEvent('added', this, container, pos);
 598     },
 599
 600     <div id="method-Ext.Container-insert"></div>/**
 601      * Inserts a Component into this Container at a specified index. Fires the
 602      * {@link #beforeadd} event before inserting, then fires the {@link #add} event after the
 603      * Component has been inserted.
 604      * @param {Number} index The index at which the Component will be inserted
 605      * into the Container's items collection
 606      * @param {Ext.Component} component The child Component to insert.<br><br>
 607      * Ext uses lazy rendering, and will only render the inserted Component should
 608      * it become necessary.<br><br>
 609      * A Component config object may be passed in order to avoid the overhead of
 610      * constructing a real Component object if lazy rendering might mean that the
 611      * inserted Component will not be rendered immediately. To take advantage of
 612      * this 'lazy instantiation', set the {@link Ext.Component#xtype} config
 613      * property to the registered type of the Component wanted.<br><br>
 614      * For a list of all available xtypes, see {@link Ext.Component}.
 615      * @return {Ext.Component} component The Component (or config object) that was
 616      * inserted with the Container's default config values applied.
 617      */
 618     insert : function(index, comp){
 619         this.initItems();
 620         var a = arguments, len = a.length;
 621         if(len > 2){
 622             var result = [];
 623             for(var i = len-1; i >= 1; --i) {
 624                 result.push(this.insert(index, a[i]));
 625             }
 626             return result;
 627         }
 628         var c = this.lookupComponent(this.applyDefaults(comp));
 629         index = Math.min(index, this.items.length);
 630         if(this.fireEvent('beforeadd', this, c, index) !== false && this.onBeforeAdd(c) !== false){
 631             if(c.ownerCt == this){
 632                 this.items.remove(c);
 633             }
 634             this.items.insert(index, c);
 635             c.onAdded(this, index);
 636             this.onAdd(c);
 637             this.fireEvent('add', this, c, index);
 638         }
 639         return c;
 640     },
 641
 642     // private
 643     applyDefaults : function(c){
 644         var d = this.defaults;
 645         if(d){
 646             if(Ext.isFunction(d)){
 647                 d = d.call(this, c);
 648             }
 649             if(Ext.isString(c)){
 650                 c = Ext.ComponentMgr.get(c);
 651                 Ext.apply(c, d);
 652             }else if(!c.events){
 653                 Ext.applyIf(c, d);
 654             }else{
 655                 Ext.apply(c, d);
 656             }
 657         }
 658         return c;
 659     },
 660
 661     // private
 662     onBeforeAdd : function(item){
 663         if(item.ownerCt){
 664             item.ownerCt.remove(item, false);
 665         }
 666         if(this.hideBorders === true){
 667             item.border = (item.border === true);
 668         }
 669     },
 670
 671     <div id="method-Ext.Container-remove"></div>/**
 672      * Removes a component from this container.  Fires the {@link #beforeremove} event before removing, then fires
 673      * the {@link #remove} event after the component has been removed.
 674      * @param {Component/String} component The component reference or id to remove.
 675      * @param {Boolean} autoDestroy (optional) True to automatically invoke the removed Component's {@link Ext.Component#destroy} function.
 676      * Defaults to the value of this Container's {@link #autoDestroy} config.
 677      * @return {Ext.Component} component The Component that was removed.
 678      */
 679     remove : function(comp, autoDestroy){
 680         this.initItems();
 681         var c = this.getComponent(comp);
 682         if(c && this.fireEvent('beforeremove', this, c) !== false){
 683             this.doRemove(c, autoDestroy);
 684             this.fireEvent('remove', this, c);
 685         }
 686         return c;
 687     },
 688
 689     onRemove: function(c){
 690         // Empty template method
 691     },
 692
 693     // private
 694     doRemove: function(c, autoDestroy){
 695         var l = this.layout,
 696             hasLayout = l && this.rendered;
 697
 698         if(hasLayout){
 699             l.onRemove(c);
 700         }
 701         this.items.remove(c);
 702         c.onRemoved();
 703         this.onRemove(c);
 704         if(autoDestroy === true || (autoDestroy !== false && this.autoDestroy)){
 705             c.destroy();
 706         }
 707         if(hasLayout){
 708             l.afterRemove(c);
 709         }
 710     },
 711
 712     <div id="method-Ext.Container-removeAll"></div>/**
 713      * Removes all components from this container.
 714      * @param {Boolean} autoDestroy (optional) True to automatically invoke the removed Component's {@link Ext.Component#destroy} function.
 715      * Defaults to the value of this Container's {@link #autoDestroy} config.
 716      * @return {Array} Array of the destroyed components
 717      */
 718     removeAll: function(autoDestroy){
 719         this.initItems();
 720         var item, rem = [], items = [];
 721         this.items.each(function(i){
 722             rem.push(i);
 723         });
 724         for (var i = 0, len = rem.length; i < len; ++i){
 725             item = rem[i];
 726             this.remove(item, autoDestroy);
 727             if(item.ownerCt !== this){
 728                 items.push(item);
 729             }
 730         }
 731         return items;
 732     },
 733
 734     <div id="method-Ext.Container-getComponent"></div>/**
 735      * Examines this container's <code>{@link #items}</code> <b>property</b>
 736      * and gets a direct child component of this container.
 737      * @param {String/Number} comp This parameter may be any of the following:
 738      * <div><ul class="mdetail-params">
 739      * <li>a <b><code>String</code></b> : representing the <code>{@link Ext.Component#itemId itemId}</code>
 740      * or <code>{@link Ext.Component#id id}</code> of the child component </li>
 741      * <li>a <b><code>Number</code></b> : representing the position of the child component
 742      * within the <code>{@link #items}</code> <b>property</b></li>
 743      * </ul></div>
 744      * <p>For additional information see {@link Ext.util.MixedCollection#get}.
 745      * @return Ext.Component The component (if found).
 746      */
 747     getComponent : function(comp){
 748         if(Ext.isObject(comp)){
 749             comp = comp.getItemId();
 750         }
 751         return this.items.get(comp);
 752     },
 753
 754     // private
 755     lookupComponent : function(comp){
 756         if(Ext.isString(comp)){
 757             return Ext.ComponentMgr.get(comp);
 758         }else if(!comp.events){
 759             return this.createComponent(comp);
 760         }
 761         return comp;
 762     },
 763
 764     // private
 765     createComponent : function(config, defaultType){
 766         // add in ownerCt at creation time but then immediately
 767         // remove so that onBeforeAdd can handle it
 768         var c = config.render ? config : Ext.create(Ext.apply({
 769             ownerCt: this
 770         }, config), defaultType || this.defaultType);
 771         delete c.ownerCt;
 772         return c;
 773     },
 774
 775     <div id="prop-Ext.Container-private"></div>/**
 776     * We can only lay out if there is a view area in which to layout.
 777     * display:none on the layout target, *or any of its parent elements* will mean it has no view area.
 778     */
 779
 780     // private
 781     canLayout : function() {
 782         var el = this.getVisibilityEl();
 783         return el && el.dom && !el.isStyle("display", "none");
 784     },
 785
 786     <div id="method-Ext.Container-doLayout"></div>/**
 787      * Force this container's layout to be recalculated. A call to this function is required after adding a new component
 788      * to an already rendered container, or possibly after changing sizing/position properties of child components.
 789      * @param {Boolean} shallow (optional) True to only calc the layout of this component, and let child components auto
 790      * calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer)
 791      * @param {Boolean} force (optional) True to force a layout to occur, even if the item is hidden.
 792      * @return {Ext.Container} this
 793      */
 794
 795     doLayout : function(shallow, force){
 796         var rendered = this.rendered,
 797             forceLayout = force || this.forceLayout;
 798
 799         if(this.collapsed || !this.canLayout()){
 800             this.deferLayout = this.deferLayout || !shallow;
 801             if(!forceLayout){
 802                 return;
 803             }
 804             shallow = shallow && !this.deferLayout;
 805         } else {
 806             delete this.deferLayout;
 807         }
 808         if(rendered && this.layout){
 809             this.layout.layout();
 810         }
 811         if(shallow !== true && this.items){
 812             var cs = this.items.items;
 813             for(var i = 0, len = cs.length; i < len; i++){
 814                 var c = cs[i];
 815                 if(c.doLayout){
 816                     c.doLayout(false, forceLayout);
 817                 }
 818             }
 819         }
 820         if(rendered){
 821             this.onLayout(shallow, forceLayout);
 822         }
 823         // Initial layout completed
 824         this.hasLayout = true;
 825         delete this.forceLayout;
 826     },
 827
 828     onLayout : Ext.emptyFn,
 829
 830     // private
 831     shouldBufferLayout: function(){
 832         /*
 833          * Returns true if the container should buffer a layout.
 834          * This is true only if the container has previously been laid out
 835          * and has a parent container that is pending a layout.
 836          */
 837         var hl = this.hasLayout;
 838         if(this.ownerCt){
 839             // Only ever buffer if we've laid out the first time and we have one pending.
 840             return hl ? !this.hasLayoutPending() : false;
 841         }
 842         // Never buffer initial layout
 843         return hl;
 844     },
 845
 846     // private
 847     hasLayoutPending: function(){
 848         // Traverse hierarchy to see if any parent container has a pending layout.
 849         var pending = false;
 850         this.ownerCt.bubble(function(c){
 851             if(c.layoutPending){
 852                 pending = true;
 853                 return false;
 854             }
 855         });
 856         return pending;
 857     },
 858
 859     onShow : function(){
 860         // removes css classes that were added to hide
 861         Ext.Container.superclass.onShow.call(this);
 862         // If we were sized during the time we were hidden, layout.
 863         if(Ext.isDefined(this.deferLayout)){
 864             delete this.deferLayout;
 865             this.doLayout(true);
 866         }
 867     },
 868
 869     <div id="method-Ext.Container-getLayout"></div>/**
 870      * Returns the layout currently in use by the container.  If the container does not currently have a layout
 871      * set, a default {@link Ext.layout.ContainerLayout} will be created and set as the container's layout.
 872      * @return {ContainerLayout} layout The container's layout
 873      */
 874     getLayout : function(){
 875         if(!this.layout){
 876             var layout = new Ext.layout.ContainerLayout(this.layoutConfig);
 877             this.setLayout(layout);
 878         }
 879         return this.layout;
 880     },
 881
 882     // private
 883     beforeDestroy : function(){
 884         var c;
 885         if(this.items){
 886             while(c = this.items.first()){
 887                 this.doRemove(c, true);
 888             }
 889         }
 890         if(this.monitorResize){
 891             Ext.EventManager.removeResizeListener(this.doLayout, this);
 892         }
 893         Ext.destroy(this.layout);
 894         Ext.Container.superclass.beforeDestroy.call(this);
 895     },
 896
 897     <div id="method-Ext.Container-bubble"></div>/**
 898      * Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
 899      * function call will be the scope provided or the current component. The arguments to the function
 900      * will be the args provided or the current component. If the function returns false at any point,
 901      * the bubble is stopped.
 902      * @param {Function} fn The function to call
 903      * @param {Object} scope (optional) The scope of the function (defaults to current node)
 904      * @param {Array} args (optional) The args to call the function with (default to passing the current component)
 905      * @return {Ext.Container} this
 906      */
 907     bubble : function(fn, scope, args){
 908         var p = this;
 909         while(p){
 910             if(fn.apply(scope || p, args || [p]) === false){
 911                 break;
 912             }
 913             p = p.ownerCt;
 914         }
 915         return this;
 916     },
 917
 918     <div id="method-Ext.Container-cascade"></div>/**
 919      * Cascades down the component/container heirarchy from this component (called first), calling the specified function with
 920      * each component. The scope (<i>this</i>) of
 921      * function call will be the scope provided or the current component. The arguments to the function
 922      * will be the args provided or the current component. If the function returns false at any point,
 923      * the cascade is stopped on that branch.
 924      * @param {Function} fn The function to call
 925      * @param {Object} scope (optional) The scope of the function (defaults to current component)
 926      * @param {Array} args (optional) The args to call the function with (defaults to passing the current component)
 927      * @return {Ext.Container} this
 928      */
 929     cascade : function(fn, scope, args){
 930         if(fn.apply(scope || this, args || [this]) !== false){
 931             if(this.items){
 932                 var cs = this.items.items;
 933                 for(var i = 0, len = cs.length; i < len; i++){
 934                     if(cs[i].cascade){
 935                         cs[i].cascade(fn, scope, args);
 936                     }else{
 937                         fn.apply(scope || cs[i], args || [cs[i]]);
 938                     }
 939                 }
 940             }
 941         }
 942         return this;
 943     },
 944
 945     <div id="method-Ext.Container-findById"></div>/**
 946      * Find a component under this container at any level by id
 947      * @param {String} id
 948      * @return Ext.Component
 949      */
 950     findById : function(id){
 951         var m, ct = this;
 952         this.cascade(function(c){
 953             if(ct != c && c.id === id){
 954                 m = c;
 955                 return false;
 956             }
 957         });
 958         return m || null;
 959     },
 960
 961     <div id="method-Ext.Container-findByType"></div>/**
 962      * Find a component under this container at any level by xtype or class
 963      * @param {String/Class} xtype The xtype string for a component, or the class of the component directly
 964      * @param {Boolean} shallow (optional) False to check whether this Component is descended from the xtype (this is
 965      * the default), or true to check whether this Component is directly of the specified xtype.
 966      * @return {Array} Array of Ext.Components
 967      */
 968     findByType : function(xtype, shallow){
 969         return this.findBy(function(c){
 970             return c.isXType(xtype, shallow);
 971         });
 972     },
 973
 974     <div id="method-Ext.Container-find"></div>/**
 975      * Find a component under this container at any level by property
 976      * @param {String} prop
 977      * @param {String} value
 978      * @return {Array} Array of Ext.Components
 979      */
 980     find : function(prop, value){
 981         return this.findBy(function(c){
 982             return c[prop] === value;
 983         });
 984     },
 985
 986     <div id="method-Ext.Container-findBy"></div>/**
 987      * Find a component under this container at any level by a custom function. If the passed function returns
 988      * true, the component will be included in the results. The passed function is called with the arguments (component, this container).
 989      * @param {Function} fn The function to call
 990      * @param {Object} scope (optional)
 991      * @return {Array} Array of Ext.Components
 992      */
 993     findBy : function(fn, scope){
 994         var m = [], ct = this;
 995         this.cascade(function(c){
 996             if(ct != c && fn.call(scope || c, c, ct) === true){
 997                 m.push(c);
 998             }
 999         });
1000         return m;
1001     },
1002
1003     <div id="method-Ext.Container-get"></div>/**
1004      * Get a component contained by this container (alias for items.get(key))
1005      * @param {String/Number} key The index or id of the component
1006      * @return {Ext.Component} Ext.Component
1007      */
1008     get : function(key){
1009         return this.items.get(key);
1010     }
1011 });
1012
1013 Ext.Container.LAYOUTS = {};
1014 Ext.reg('container', Ext.Container);
1015 </pre>    \r
1016 </body>\r
1017 </html>