examples/ux/RowLayout.js

   1 /*!
   2  * Ext JS Library 3.0.3
   3  * Copyright(c) 2006-2009 Ext JS, LLC
   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     // private
  77     isValidParent : function(c, target){
  78         return c.getEl().dom.parentNode == this.innerCt.dom;
  79     },
  80
  81     // private
  82     onLayout : function(ct, target){
  83         var rs = ct.items.items, len = rs.length, r, i;
  84
  85         if(!this.innerCt){
  86             target.addClass('ux-row-layout-ct');
  87             this.innerCt = target.createChild({cls:'x-row-inner'});
  88         }
  89         this.renderAll(ct, this.innerCt);
  90
  91         var size = target.getViewSize();
  92
  93         if(size.width < 1 && size.height < 1){ // display none?
  94             return;
  95         }
  96
  97         var h = size.height - target.getPadding('tb'),
  98             ph = h;
  99
 100         this.innerCt.setSize({height:h});
 101
 102         // some rows can be percentages while others are fixed
 103         // so we need to make 2 passes
 104
 105         for(i = 0; i < len; i++){
 106             r = rs[i];
 107             if(!r.rowHeight){
 108                 ph -= (r.getSize().height + r.getEl().getMargins('tb'));
 109             }
 110         }
 111
 112         ph = ph < 0 ? 0 : ph;
 113
 114         for(i = 0; i < len; i++){
 115             r = rs[i];
 116             if(r.rowHeight){
 117                 r.setSize({height: Math.floor(r.rowHeight*ph) - r.getEl().getMargins('tb')});
 118             }
 119         }
 120     }
 121
 122     /**
 123      * @property activeItem
 124      * @hide
 125      */
 126 });
 127
 128 Ext.Container.LAYOUTS['ux.row'] = Ext.ux.layout.RowLayout;