Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / AnchorLayout.html
diff --git a/docs/source/AnchorLayout.html b/docs/source/AnchorLayout.html
new file mode 100644 (file)
index 0000000..b63abfd
--- /dev/null
@@ -0,0 +1,203 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.layout.AnchorLayout"></div>/**\r
+ * @class Ext.layout.AnchorLayout\r
+ * @extends Ext.layout.ContainerLayout\r
+ * <p>This is a layout that enables anchoring of contained elements relative to the container's dimensions.\r
+ * If the container is resized, all anchored items are automatically rerendered according to their\r
+ * <b><tt>{@link #anchor}</tt></b> rules.</p>\r
+ * <p>This class is intended to be extended or created via the layout:'anchor' {@link Ext.Container#layout}\r
+ * config, and should generally not need to be created directly via the new keyword.</p>\r
+ * <p>AnchorLayout does not have any direct config options (other than inherited ones). By default,\r
+ * AnchorLayout will calculate anchor measurements based on the size of the container itself. However, the\r
+ * container using the AnchorLayout can supply an anchoring-specific config property of <b>anchorSize</b>.\r
+ * If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating\r
+ * anchor measurements based on it instead, allowing the container to be sized independently of the anchoring\r
+ * logic if necessary.  For example:</p>\r
+ * <pre><code>\r
+var viewport = new Ext.Viewport({\r
+    layout:'anchor',\r
+    anchorSize: {width:800, height:600},\r
+    items:[{\r
+        title:'Item 1',\r
+        html:'Content 1',\r
+        width:800,\r
+        anchor:'right 20%'\r
+    },{\r
+        title:'Item 2',\r
+        html:'Content 2',\r
+        width:300,\r
+        anchor:'50% 30%'\r
+    },{\r
+        title:'Item 3',\r
+        html:'Content 3',\r
+        width:600,\r
+        anchor:'-100 50%'\r
+    }]\r
+});\r
+ * </code></pre>\r
+ */\r
+Ext.layout.AnchorLayout = Ext.extend(Ext.layout.ContainerLayout, {\r
+    <div id="cfg-Ext.layout.AnchorLayout-anchor"></div>/**\r
+     * @cfg {String} anchor\r
+     * <p>This configuation option is to be applied to <b>child <tt>items</tt></b> of a container managed by\r
+     * this layout (ie. configured with <tt>layout:'anchor'</tt>).</p><br/>\r
+     * \r
+     * <p>This value is what tells the layout how an item should be anchored to the container. <tt>items</tt>\r
+     * added to an AnchorLayout accept an anchoring-specific config property of <b>anchor</b> which is a string\r
+     * containing two values: the horizontal anchor value and the vertical anchor value (for example, '100% 50%').\r
+     * The following types of anchor values are supported:<div class="mdetail-params"><ul>\r
+     * \r
+     * <li><b>Percentage</b> : Any value between 1 and 100, expressed as a percentage.<div class="sub-desc">\r
+     * The first anchor is the percentage width that the item should take up within the container, and the\r
+     * second is the percentage height.  For example:<pre><code>\r
+// two values specified\r
+anchor: '100% 50%' // render item complete width of the container and\r
+                   // 1/2 height of the container\r
+// one value specified\r
+anchor: '100%'     // the width value; the height will default to auto\r
+     * </code></pre></div></li>\r
+     * \r
+     * <li><b>Offsets</b> : Any positive or negative integer value.<div class="sub-desc">\r
+     * This is a raw adjustment where the first anchor is the offset from the right edge of the container,\r
+     * and the second is the offset from the bottom edge. For example:<pre><code>\r
+// two values specified\r
+anchor: '-50 -100' // render item the complete width of the container\r
+                   // minus 50 pixels and\r
+                   // the complete height minus 100 pixels.\r
+// one value specified\r
+anchor: '-50'      // anchor value is assumed to be the right offset value\r
+                   // bottom offset will default to 0\r
+     * </code></pre></div></li>\r
+     * \r
+     * <li><b>Sides</b> : Valid values are <tt>'right'</tt> (or <tt>'r'</tt>) and <tt>'bottom'</tt>\r
+     * (or <tt>'b'</tt>).<div class="sub-desc">\r
+     * Either the container must have a fixed size or an anchorSize config value defined at render time in\r
+     * order for these to have any effect.</div></li>\r
+     *\r
+     * <li><b>Mixed</b> : <div class="sub-desc">\r
+     * Anchor values can also be mixed as needed.  For example, to render the width offset from the container\r
+     * right edge by 50 pixels and 75% of the container's height use:\r
+     * <pre><code>\r
+anchor: '-50 75%' \r
+     * </code></pre></div></li>\r
+     * \r
+     * \r
+     * </ul></div>\r
+     */\r
+    \r
+    // private\r
+    monitorResize:true,\r
+\r
+    // private\r
+    getAnchorViewSize : function(ct, target){\r
+        return target.dom == document.body ?\r
+                   target.getViewSize() : target.getStyleSize();\r
+    },\r
+\r
+    // private\r
+    onLayout : function(ct, target){\r
+        Ext.layout.AnchorLayout.superclass.onLayout.call(this, ct, target);\r
+\r
+        var size = this.getAnchorViewSize(ct, target);\r
+\r
+        var w = size.width, h = size.height;\r
+\r
+        if(w < 20 && h < 20){\r
+            return;\r
+        }\r
+\r
+        // find the container anchoring size\r
+        var aw, ah;\r
+        if(ct.anchorSize){\r
+            if(typeof ct.anchorSize == 'number'){\r
+                aw = ct.anchorSize;\r
+            }else{\r
+                aw = ct.anchorSize.width;\r
+                ah = ct.anchorSize.height;\r
+            }\r
+        }else{\r
+            aw = ct.initialConfig.width;\r
+            ah = ct.initialConfig.height;\r
+        }\r
+\r
+        var cs = ct.items.items, len = cs.length, i, c, a, cw, ch;\r
+        for(i = 0; i < len; i++){\r
+            c = cs[i];\r
+            if(c.anchor){\r
+                a = c.anchorSpec;\r
+                if(!a){ // cache all anchor values\r
+                    var vs = c.anchor.split(' ');\r
+                    c.anchorSpec = a = {\r
+                        right: this.parseAnchor(vs[0], c.initialConfig.width, aw),\r
+                        bottom: this.parseAnchor(vs[1], c.initialConfig.height, ah)\r
+                    };\r
+                }\r
+                cw = a.right ? this.adjustWidthAnchor(a.right(w), c) : undefined;\r
+                ch = a.bottom ? this.adjustHeightAnchor(a.bottom(h), c) : undefined;\r
+\r
+                if(cw || ch){\r
+                    c.setSize(cw || undefined, ch || undefined);\r
+                }\r
+            }\r
+        }\r
+    },\r
+\r
+    // private\r
+    parseAnchor : function(a, start, cstart){\r
+        if(a && a != 'none'){\r
+            var last;\r
+            if(/^(r|right|b|bottom)$/i.test(a)){   // standard anchor\r
+                var diff = cstart - start;\r
+                return function(v){\r
+                    if(v !== last){\r
+                        last = v;\r
+                        return v - diff;\r
+                    }\r
+                }\r
+            }else if(a.indexOf('%') != -1){\r
+                var ratio = parseFloat(a.replace('%', ''))*.01;   // percentage\r
+                return function(v){\r
+                    if(v !== last){\r
+                        last = v;\r
+                        return Math.floor(v*ratio);\r
+                    }\r
+                }\r
+            }else{\r
+                a = parseInt(a, 10);\r
+                if(!isNaN(a)){                            // simple offset adjustment\r
+                    return function(v){\r
+                        if(v !== last){\r
+                            last = v;\r
+                            return v + a;\r
+                        }\r
+                    }\r
+                }\r
+            }\r
+        }\r
+        return false;\r
+    },\r
+\r
+    // private\r
+    adjustWidthAnchor : function(value, comp){\r
+        return value;\r
+    },\r
+\r
+    // private\r
+    adjustHeightAnchor : function(value, comp){\r
+        return value;\r
+    }\r
+    \r
+    <div id="prop-Ext.layout.AnchorLayout-activeItem"></div>/**\r
+     * @property activeItem\r
+     * @hide\r
+     */\r
+});\r
+Ext.Container.LAYOUTS['anchor'] = Ext.layout.AnchorLayout;</pre>    \r
+</body>\r
+</html>
\ No newline at end of file