examples/ux/RowLayout.js

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