Container.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:37k
源码类别:

中间件编程

开发平台:

JavaScript

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