Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / src / widgets / layout / ColumnLayout.js
diff --git a/src/widgets/layout/ColumnLayout.js b/src/widgets/layout/ColumnLayout.js
new file mode 100644 (file)
index 0000000..10051aa
--- /dev/null
@@ -0,0 +1,130 @@
+/*!
+ * Ext JS Library 3.0.0
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**\r
+ * @class Ext.layout.ColumnLayout\r
+ * @extends Ext.layout.ContainerLayout\r
+ * <p>This is the layout style of choice for creating structural layouts in a multi-column format where the width of\r
+ * each column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.\r
+ * This class is intended to be extended or created via the layout:'column' {@link Ext.Container#layout} config,\r
+ * and should generally not need to be created directly via the new keyword.</p>\r
+ * <p>ColumnLayout does not have any direct config options (other than inherited ones), but it does support a\r
+ * specific config property of <b><tt>columnWidth</tt></b> that can be included in the config of any panel added to it.  The\r
+ * layout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel.\r
+ * If width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto).</p>\r
+ * <p>The width property is always evaluated as pixels, and must be a number greater than or equal to 1.\r
+ * The columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and\r
+ * less than 1 (e.g., .25).</p>\r
+ * <p>The basic rules for specifying column widths are pretty simple.  The logic makes two passes through the\r
+ * set of contained panels.  During the first layout pass, all panels that either have a fixed width or none\r
+ * specified (auto) are skipped, but their widths are subtracted from the overall container width.  During the second\r
+ * pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on\r
+ * the total <b>remaining</b> container width.  In other words, percentage width panels are designed to fill the space\r
+ * left over by all the fixed-width and/or auto-width panels.  Because of this, while you can specify any number of columns\r
+ * with different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your\r
+ * layout may not render as expected.  Example usage:</p>\r
+ * <pre><code>\r
+// All columns are percentages -- they must add up to 1\r
+var p = new Ext.Panel({\r
+    title: 'Column Layout - Percentage Only',\r
+    layout:'column',\r
+    items: [{\r
+        title: 'Column 1',\r
+        columnWidth: .25 \r
+    },{\r
+        title: 'Column 2',\r
+        columnWidth: .6\r
+    },{\r
+        title: 'Column 3',\r
+        columnWidth: .15\r
+    }]\r
+});\r
+\r
+// Mix of width and columnWidth -- all columnWidth values must add up\r
+// to 1. The first column will take up exactly 120px, and the last two\r
+// columns will fill the remaining container width.\r
+var p = new Ext.Panel({\r
+    title: 'Column Layout - Mixed',\r
+    layout:'column',\r
+    items: [{\r
+        title: 'Column 1',\r
+        width: 120\r
+    },{\r
+        title: 'Column 2',\r
+        columnWidth: .8\r
+    },{\r
+        title: 'Column 3',\r
+        columnWidth: .2\r
+    }]\r
+});\r
+</code></pre>\r
+ */\r
+Ext.layout.ColumnLayout = Ext.extend(Ext.layout.ContainerLayout, {\r
+    // private\r
+    monitorResize:true,\r
+    \r
+    extraCls: 'x-column',\r
+\r
+    scrollOffset : 0,\r
+\r
+    // private\r
+    isValidParent : function(c, target){\r
+        return (c.getPositionEl ? c.getPositionEl() : c.getEl()).dom.parentNode == this.innerCt.dom;\r
+    },\r
+\r
+    // private\r
+    onLayout : function(ct, target){\r
+        var cs = ct.items.items, len = cs.length, c, i;\r
+\r
+        if(!this.innerCt){\r
+            target.addClass('x-column-layout-ct');\r
+\r
+            // the innerCt prevents wrapping and shuffling while\r
+            // the container is resizing\r
+            this.innerCt = target.createChild({cls:'x-column-inner'});\r
+            this.innerCt.createChild({cls:'x-clear'});\r
+        }\r
+        this.renderAll(ct, this.innerCt);\r
+\r
+        var size = Ext.isIE && target.dom != Ext.getBody().dom ? target.getStyleSize() : target.getViewSize();\r
+\r
+        if(size.width < 1 && size.height < 1){ // display none?\r
+            return;\r
+        }\r
+\r
+        var w = size.width - target.getPadding('lr') - this.scrollOffset,\r
+            h = size.height - target.getPadding('tb'),\r
+            pw = w;\r
+\r
+        this.innerCt.setWidth(w);\r
+        \r
+        // some columns can be percentages while others are fixed\r
+        // so we need to make 2 passes\r
+\r
+        for(i = 0; i < len; i++){\r
+            c = cs[i];\r
+            if(!c.columnWidth){\r
+                pw -= (c.getSize().width + c.getEl().getMargins('lr'));\r
+            }\r
+        }\r
+\r
+        pw = pw < 0 ? 0 : pw;\r
+\r
+        for(i = 0; i < len; i++){\r
+            c = cs[i];\r
+            if(c.columnWidth){\r
+                c.setSize(Math.floor(c.columnWidth*pw) - c.getEl().getMargins('lr'));\r
+            }\r
+        }\r
+    }\r
+    \r
+    /**\r
+     * @property activeItem\r
+     * @hide\r
+     */\r
+});\r
+\r
+Ext.Container.LAYOUTS['column'] = Ext.layout.ColumnLayout;
\ No newline at end of file