source/widgets/layout/ColumnLayout.js

   1 /*\r
   2  * Ext JS Library 2.2.1\r
   3  * Copyright(c) 2006-2009, Ext JS, LLC.\r
   4  * licensing@extjs.com\r
   5  * \r
   6  * http://extjs.com/license\r
   7  */\r
   8 \r
   9 /**\r
  10  * @class Ext.layout.ColumnLayout\r
  11  * @extends Ext.layout.ContainerLayout\r
  12  * <p>This is the layout style of choice for creating structural layouts in a multi-column format where the width of\r
  13  * each column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.\r
  14  * This class is intended to be extended or created via the layout:'column' {@link Ext.Container#layout} config,\r
  15  * and should generally not need to be created directly via the new keyword.</p>\r
  16  * <p>ColumnLayout does not have any direct config options (other than inherited ones), but it does support a\r
  17  * specific config property of <b><tt>columnWidth</tt></b> that can be included in the config of any panel added to it.  The\r
  18  * layout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel.\r
  19  * If width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto).</p>\r
  20  * <p>The width property is always evaluated as pixels, and must be a number greater than or equal to 1.\r
  21  * The columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and\r
  22  * less than 1 (e.g., .25).</p>\r
  23  * <p>The basic rules for specifying column widths are pretty simple.  The logic makes two passes through the\r
  24  * set of contained panels.  During the first layout pass, all panels that either have a fixed width or none\r
  25  * specified (auto) are skipped, but their widths are subtracted from the overall container width.  During the second\r
  26  * pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on\r
  27  * the total <b>remaining</b> container width.  In other words, percentage width panels are designed to fill the space\r
  28  * left over by all the fixed-width and/or auto-width panels.  Because of this, while you can specify any number of columns\r
  29  * with different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your\r
  30  * layout may not render as expected.  Example usage:</p>\r
  31  * <pre><code>\r
  32 // All columns are percentages -- they must add up to 1\r
  33 var p = new Ext.Panel({\r
  34     title: 'Column Layout - Percentage Only',\r
  35     layout:'column',\r
  36     items: [{\r
  37         title: 'Column 1',\r
  38         columnWidth: .25 \r
  39     },{\r
  40         title: 'Column 2',\r
  41         columnWidth: .6\r
  42     },{\r
  43         title: 'Column 3',\r
  44         columnWidth: .15\r
  45     }]\r
  46 });\r
  47 \r
  48 // Mix of width and columnWidth -- all columnWidth values must add up\r
  49 // to 1. The first column will take up exactly 120px, and the last two\r
  50 // columns will fill the remaining container width.\r
  51 var p = new Ext.Panel({\r
  52     title: 'Column Layout - Mixed',\r
  53     layout:'column',\r
  54     items: [{\r
  55         title: 'Column 1',\r
  56         width: 120\r
  57     },{\r
  58         title: 'Column 2',\r
  59         columnWidth: .8\r
  60     },{\r
  61         title: 'Column 3',\r
  62         columnWidth: .2\r
  63     }]\r
  64 });\r
  65 </code></pre>\r
  66  */\r
  67 Ext.layout.ColumnLayout = Ext.extend(Ext.layout.ContainerLayout, {\r
  68     // private\r
  69     monitorResize:true,\r
  70     \r
  71     /**\r
  72      * @cfg {String} extraCls\r
  73      * An optional extra CSS class that will be added to the container (defaults to 'x-column').  This can be useful for\r
  74      * adding customized styles to the container or any of its children using standard CSS rules.\r
  75      */\r
  76     extraCls: 'x-column',\r
  77 \r
  78     scrollOffset : 0,\r
  79 \r
  80     // private\r
  81     isValidParent : function(c, target){\r
  82         return (c.getPositionEl ? c.getPositionEl() : c.getEl()).dom.parentNode == this.innerCt.dom;\r
  83     },\r
  84 \r
  85     // private\r
  86     onLayout : function(ct, target){\r
  87         var cs = ct.items.items, len = cs.length, c, i;\r
  88 \r
  89         if(!this.innerCt){\r
  90             target.addClass('x-column-layout-ct');\r
  91 \r
  92             // the innerCt prevents wrapping and shuffling while\r
  93             // the container is resizing\r
  94             this.innerCt = target.createChild({cls:'x-column-inner'});\r
  95             this.innerCt.createChild({cls:'x-clear'});\r
  96         }\r
  97         this.renderAll(ct, this.innerCt);\r
  98 \r
  99         var size = Ext.isIE && target.dom != Ext.getBody().dom ? target.getStyleSize() : target.getViewSize();\r
 100 \r
 101         if(size.width < 1 && size.height < 1){ // display none?\r
 102             return;\r
 103         }\r
 104 \r
 105         var w = size.width - target.getPadding('lr') - this.scrollOffset,\r
 106             h = size.height - target.getPadding('tb'),\r
 107             pw = w;\r
 108 \r
 109         this.innerCt.setWidth(w);\r
 110         \r
 111         // some columns can be percentages while others are fixed\r
 112         // so we need to make 2 passes\r
 113 \r
 114         for(i = 0; i < len; i++){\r
 115             c = cs[i];\r
 116             if(!c.columnWidth){\r
 117                 pw -= (c.getSize().width + c.getEl().getMargins('lr'));\r
 118             }\r
 119         }\r
 120 \r
 121         pw = pw < 0 ? 0 : pw;\r
 122 \r
 123         for(i = 0; i < len; i++){\r
 124             c = cs[i];\r
 125             if(c.columnWidth){\r
 126                 c.setSize(Math.floor(c.columnWidth*pw) - c.getEl().getMargins('lr'));\r
 127             }\r
 128         }\r
 129     }\r
 130     \r
 131     /**\r
 132      * @property activeItem\r
 133      * @hide\r
 134      */\r
 135 });\r
 136 \r
 137 Ext.Container.LAYOUTS['column'] = Ext.layout.ColumnLayout;