docs/source/ColumnLayout.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4   <title>The source code</title>
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   7 </head>
   8 <body  onload="prettyPrint();">
   9     <pre class="prettyprint lang-js">/*!
  10  * Ext JS Library 3.3.1
  11  * Copyright(c) 2006-2010 Sencha Inc.
  12  * licensing@sencha.com
  13  * http://www.sencha.com/license
  14  */
  15 <div id="cls-Ext.layout.ColumnLayout"></div>/**
  16  * @class Ext.layout.ColumnLayout
  17  * @extends Ext.layout.ContainerLayout
  18  * <p>This is the layout style of choice for creating structural layouts in a multi-column format where the width of
  19  * each column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.
  20  * This class is intended to be extended or created via the layout:'column' {@link Ext.Container#layout} config,
  21  * and should generally not need to be created directly via the new keyword.</p>
  22  * <p>ColumnLayout does not have any direct config options (other than inherited ones), but it does support a
  23  * specific config property of <b><tt>columnWidth</tt></b> that can be included in the config of any panel added to it.  The
  24  * layout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel.
  25  * If width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto).</p>
  26  * <p>The width property is always evaluated as pixels, and must be a number greater than or equal to 1.
  27  * The columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and
  28  * less than 1 (e.g., .25).</p>
  29  * <p>The basic rules for specifying column widths are pretty simple.  The logic makes two passes through the
  30  * set of contained panels.  During the first layout pass, all panels that either have a fixed width or none
  31  * specified (auto) are skipped, but their widths are subtracted from the overall container width.  During the second
  32  * pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on
  33  * the total <b>remaining</b> container width.  In other words, percentage width panels are designed to fill the space
  34  * left over by all the fixed-width and/or auto-width panels.  Because of this, while you can specify any number of columns
  35  * with different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your
  36  * layout may not render as expected.  Example usage:</p>
  37  * <pre><code>
  38 // All columns are percentages -- they must add up to 1
  39 var p = new Ext.Panel({
  40     title: 'Column Layout - Percentage Only',
  41     layout:'column',
  42     items: [{
  43         title: 'Column 1',
  44         columnWidth: .25
  45     },{
  46         title: 'Column 2',
  47         columnWidth: .6
  48     },{
  49         title: 'Column 3',
  50         columnWidth: .15
  51     }]
  52 });
  53
  54 // Mix of width and columnWidth -- all columnWidth values must add up
  55 // to 1. The first column will take up exactly 120px, and the last two
  56 // columns will fill the remaining container width.
  57 var p = new Ext.Panel({
  58     title: 'Column Layout - Mixed',
  59     layout:'column',
  60     items: [{
  61         title: 'Column 1',
  62         width: 120
  63     },{
  64         title: 'Column 2',
  65         columnWidth: .8
  66     },{
  67         title: 'Column 3',
  68         columnWidth: .2
  69     }]
  70 });
  71 </code></pre>
  72  */
  73 Ext.layout.ColumnLayout = Ext.extend(Ext.layout.ContainerLayout, {
  74     // private
  75     monitorResize:true,
  76
  77     type: 'column',
  78
  79     extraCls: 'x-column',
  80
  81     scrollOffset : 0,
  82
  83     // private
  84
  85     targetCls: 'x-column-layout-ct',
  86
  87     isValidParent : function(c, target){
  88         return this.innerCt && c.getPositionEl().dom.parentNode == this.innerCt.dom;
  89     },
  90
  91     getLayoutTargetSize : function() {
  92         var target = this.container.getLayoutTarget(), ret;
  93         if (target) {
  94             ret = target.getViewSize();
  95
  96             // IE in strict mode will return a width of 0 on the 1st pass of getViewSize.
  97             // Use getStyleSize to verify the 0 width, the adjustment pass will then work properly
  98             // with getViewSize
  99             if (Ext.isIE && Ext.isStrict && ret.width == 0){
 100                 ret =  target.getStyleSize();
 101             }
 102
 103             ret.width -= target.getPadding('lr');
 104             ret.height -= target.getPadding('tb');
 105         }
 106         return ret;
 107     },
 108
 109     renderAll : function(ct, target) {
 110         if(!this.innerCt){
 111             // the innerCt prevents wrapping and shuffling while
 112             // the container is resizing
 113             this.innerCt = target.createChild({cls:'x-column-inner'});
 114             this.innerCt.createChild({cls:'x-clear'});
 115         }
 116         Ext.layout.ColumnLayout.superclass.renderAll.call(this, ct, this.innerCt);
 117     },
 118
 119     // private
 120     onLayout : function(ct, target){
 121         var cs = ct.items.items,
 122             len = cs.length,
 123             c,
 124             i,
 125             m,
 126             margins = [];
 127
 128         this.renderAll(ct, target);
 129
 130         var size = this.getLayoutTargetSize();
 131
 132         if(size.width < 1 && size.height < 1){ // display none?
 133             return;
 134         }
 135
 136         var w = size.width - this.scrollOffset,
 137             h = size.height,
 138             pw = w;
 139
 140         this.innerCt.setWidth(w);
 141
 142         // some columns can be percentages while others are fixed
 143         // so we need to make 2 passes
 144
 145         for(i = 0; i < len; i++){
 146             c = cs[i];
 147             m = c.getPositionEl().getMargins('lr');
 148             margins[i] = m;
 149             if(!c.columnWidth){
 150                 pw -= (c.getWidth() + m);
 151             }
 152         }
 153
 154         pw = pw < 0 ? 0 : pw;
 155
 156         for(i = 0; i < len; i++){
 157             c = cs[i];
 158             m = margins[i];
 159             if(c.columnWidth){
 160                 c.setSize(Math.floor(c.columnWidth * pw) - m);
 161             }
 162         }
 163
 164         // Browsers differ as to when they account for scrollbars.  We need to re-measure to see if the scrollbar
 165         // spaces were accounted for properly.  If not, re-layout.
 166         if (Ext.isIE) {
 167             if (i = target.getStyle('overflow') && i != 'hidden' && !this.adjustmentPass) {
 168                 var ts = this.getLayoutTargetSize();
 169                 if (ts.width != size.width){
 170                     this.adjustmentPass = true;
 171                     this.onLayout(ct, target);
 172                 }
 173             }
 174         }
 175         delete this.adjustmentPass;
 176     }
 177
 178     <div id="prop-Ext.layout.ColumnLayout-activeItem"></div>/**
 179      * @property activeItem
 180      * @hide
 181      */
 182 });
 183
 184 Ext.Container.LAYOUTS['column'] = Ext.layout.ColumnLayout;
 185 </pre>
 186 </body>
 187 </html>