Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / output / Ext.layout.AbsoluteLayout.html
index 79e9133..e0bc050 100644 (file)
@@ -1,62 +1,92 @@
-        <div class="body-wrap">
-        <div class="top-tools">
-            <a class="inner-link" href="#Ext.layout.AbsoluteLayout-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
-            <a class="inner-link" href="#Ext.layout.AbsoluteLayout-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
-            <a class="inner-link" href="#Ext.layout.AbsoluteLayout-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
-                            <a class="inner-link" href="#Ext.layout.AbsoluteLayout-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
-                        <a class="bookmark" href="../docs/?class=Ext.layout.AbsoluteLayout"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
-        </div>
-                <div class="inheritance res-block">
-<pre class="res-block-inner"><a ext:cls="Ext.layout.ContainerLayout" ext:member="" href="output/Ext.layout.ContainerLayout.html">ContainerLayout</a>
-  <img src="resources/elbow-end.gif"/><a ext:cls="Ext.layout.AnchorLayout" ext:member="" href="output/Ext.layout.AnchorLayout.html">AnchorLayout</a>
-    <img src="resources/elbow-end.gif"/>AbsoluteLayout</pre></div>
-                <h1>Class Ext.layout.AbsoluteLayout</h1>
-        <table cellspacing="0">
-            <tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr>
-            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/AbsoluteLayout.js" target="_blank">AbsoluteLayout.js</a></td></tr>
-            <tr><td class="label">Class:</td><td class="hd-info">AbsoluteLayout</td></tr>
-                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.layout.AnchorLayout" ext:member="" href="output/Ext.layout.AnchorLayout.html">AnchorLayout</a></td></tr>
-                    </table>
-        <div class="description">
-            *
-<p>Inherits the anchoring of <a ext:cls="Ext.layout.AnchorLayout" href="output/Ext.layout.AnchorLayout.html">Ext.layout.AnchorLayout</a> and adds the ability for x/y positioning using the
-standard x and y component config options.</p>        </div>
-        
-        <div class="hr"></div>
-                <a id="Ext.layout.AbsoluteLayout-configs"></a>
-        <h2>Config Options</h2>
-        <table cellspacing="0" class="member-table">
-            <tr>
-                <th class="sig-header" colspan="2">Config Options</th>
-                <th class="msource-header">Defined By</th>
-            </tr>
-                <tr class="config-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.layout.AbsoluteLayout-extraCls"></a>\r
-            <b>extraCls</b> : String            <div class="mdesc">\r
-                        <div class="short">An optional extra CSS class that will be added to the container (defaults to 'x-abs-layout-item'). This can be useful...</div>\r
-            <div class="long">\r
-                An optional extra CSS class that will be added to the container (defaults to 'x-abs-layout-item'). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.            </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">AbsoluteLayout</td>\r
-    </tr>\r
-        <tr class="config-row inherited alt">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.layout.AbsoluteLayout-renderHidden"></a>\r
-            <b>renderHidden</b> : Boolean            <div class="mdesc">\r
-                            True to hide each contained item on render (defaults to false).                        </div>\r
-        </td>\r
-        <td class="msource"><a ext:cls="Ext.layout.ContainerLayout" ext:member="#renderHidden" href="output/Ext.layout.ContainerLayout.html#renderHidden">ContainerLayout</a></td>\r
-    </tr>\r
-            </table>
-                <a id="Ext.layout.AbsoluteLayout-props"></a>
-        <h2>Public Properties</h2>
-        <div class="no-members">This class has no public properties.</div>        <a id="Ext.layout.AbsoluteLayout-methods"></a>
-        <h2>Public Methods</h2>
-        <div class="no-members">This class has no public methods.</div>        <a id="Ext.layout.AbsoluteLayout-events"></a>
-        <h2>Public Events</h2>
-        <div class="no-members">This class has no public events.</div>
-        </div>
\ No newline at end of file
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.layout.AbsoluteLayout-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.layout.AbsoluteLayout-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.layout.AbsoluteLayout-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.layout.AbsoluteLayout-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.layout.AbsoluteLayout"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.layout.ContainerLayout.html" ext:member="" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.layout.AnchorLayout.html" ext:member="" ext:cls="Ext.layout.AnchorLayout">AnchorLayout</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">AbsoluteLayout</pre></div><h1>Class <a href="source/AbsoluteLayout.html#cls-Ext.layout.AbsoluteLayout">Ext.layout.AbsoluteLayout</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">AbsoluteLayout.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/AbsoluteLayout.html#cls-Ext.layout.AbsoluteLayout">AbsoluteLayout</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout" ext:member="">AnchorLayout</a></td></tr></table><div class="description"><p>This is a layout that inherits the anchoring of <b><a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">Ext.layout.AnchorLayout</a></b> and adds the\r
+ability for x/y positioning using the standard x and y component config options.</p>\r
+<p>This class is intended to be extended or created via the <tt><b><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></b></tt>\r
+configuration property.  See <tt><b><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">Ext.Container.layout</a></b></tt> for additional details.</p>\r
+<p>Example usage:</p>\r
+<pre><code><b>var</b> form = <b>new</b> Ext.form.FormPanel({\r
+    title: <em>'Absolute Layout'</em>,\r
+    layout:<em>'absolute'</em>,\r
+    layoutConfig: {\r
+        <i>// layout-specific configs go here\r</i>
+        extraCls: <em>'x-abs-layout-item'</em>,\r
+    },\r
+    baseCls: <em>'x-plain'</em>,\r
+    url:<em>'save-form.php'</em>,\r
+    defaultType: <em>'textfield'</em>,\r
+    items: [{\r
+        x: 0,\r
+        y: 5,\r
+        xtype:<em>'<b>label</b>'</em>,\r
+        text: <em>'Send To:'</em>\r
+    },{\r
+        x: 60,\r
+        y: 0,\r
+        name: <em>'to'</em>,\r
+        anchor:<em>'100%'</em>  <i>// anchor width by percentage\r</i>
+    },{\r
+        x: 0,\r
+        y: 35,\r
+        xtype:<em>'<b>label</b>'</em>,\r
+        text: <em>'Subject:'</em>\r
+    },{\r
+        x: 60,\r
+        y: 30,\r
+        name: <em>'subject'</em>,\r
+        anchor: <em>'100%'</em>  <i>// anchor width by percentage\r</i>
+    },{\r
+        x:0,\r
+        y: 60,\r
+        xtype: <em>'textarea'</em>,\r
+        name: <em>'msg'</em>,\r
+        anchor: <em>'100% 100%'</em>  <i>// anchor width and height\r</i>
+    }]\r
+});</code></pre></div><div class="hr"></div><a id="Ext.layout.AbsoluteLayout-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.AnchorLayout-anchor"></a><b><a href="source/AnchorLayout.html#cfg-Ext.layout.AnchorLayout-anchor">anchor</a></b> : String<div class="mdesc"><div class="short">This configuation option is to be applied to child items of a container managed by&#13;
+this layout (ie. configured with ...</div><div class="long"><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
+<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
+<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><i>// two values specified\r</i>
+anchor: <em>'100% 50%'</em> <i>// render item complete width of the container and\r</i>
+                   <i>// 1/2 height of the container\r</i>
+<i>// one value specified\r</i>
+anchor: <em>'100%'</em>     <i>// the width value; the height will <b>default</b> to auto</i></code></pre></div></li>\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><i>// two values specified\r</i>
+anchor: <em>'-50 -100'</em> <i>// render item the complete width of the container\r</i>
+                   <i>// minus 50 pixels and\r</i>
+                   <i>// the complete height minus 100 pixels.\r</i>
+<i>// one value specified\r</i>
+anchor: <em>'-50'</em>      <i>// anchor value is assumed to be the right offset value\r</i>
+                   <i>// bottom offset will <b>default</b> to 0</i></code></pre></div></li>\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
+<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>anchor: <em>'-50 75%'</em></code></pre></div></li>\r
+</ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.AnchorLayout.html#anchor" ext:member="#anchor" ext:cls="Ext.layout.AnchorLayout">AnchorLayout</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.ContainerLayout-extraCls"></a><b><a href="source/ContainerLayout.html#cfg-Ext.layout.ContainerLayout-extraCls">extraCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to the container. This can be useful for adding
+customized styles to t...</div><div class="long"><p>An optional extra CSS class that will be added to the container. This can be useful for adding
+customized styles to the container or any of its children using standard CSS rules. See
+<a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a>.<a href="output/Ext.Component.html#Ext.Component-ctCls" ext:member="ctCls" ext:cls="Ext.Component">ctCls</a> also.</p>
+<p><b>Note</b>: <tt>extraCls</tt> defaults to <tt>''</tt> except for the following classes
+which assign a value by default:
+<div class="mdetail-params"><ul>
+<li><a href="output/Ext.layout.AbsoluteLayout.html" ext:cls="Ext.layout.AbsoluteLayout">Absolute Layout</a> : <tt>'x-abs-layout-item'</tt></li>
+<li><a href="output/Ext.layout.Box.html" ext:cls="Ext.layout.Box">Box Layout</a> : <tt>'x-box-item'</tt></li>
+<li><a href="output/Ext.layout.ColumnLayout.html" ext:cls="Ext.layout.ColumnLayout">Column Layout</a> : <tt>'x-column'</tt></li>
+</ul></div>
+To configure the above Classes with an extra CSS class append to the default.  For example,
+for ColumnLayout:<pre><code>extraCls: <em>'x-column custom-class'</em></code></pre>
+</p></div></div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#extraCls" ext:member="#extraCls" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.ContainerLayout-renderHidden"></a><b><a href="source/ContainerLayout.html#cfg-Ext.layout.ContainerLayout-renderHidden">renderHidden</a></b> : Boolean<div class="mdesc">True to hide each contained item on render (defaults to false).</div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#renderHidden" ext:member="#renderHidden" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr></tbody></table><a id="Ext.layout.AbsoluteLayout-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.ContainerLayout-fieldTpl"></a><b><a href="source/ContainerLayout.html#prop-Ext.layout.ContainerLayout-fieldTpl">fieldTpl</a></b> : Ext.Template<div class="mdesc"><div class="short">The Ext.Template used by Field rendering layout classes (such as
+Ext.layout.FormLayout) to create the DOM structure o...</div><div class="long">The <a href="output/Template.html" ext:cls="Template">Ext.Template</a> used by Field rendering layout classes (such as
+<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>) to create the DOM structure of a fully wrapped,
+labeled and styled form Field. A default Template is supplied, but this may be
+overriden to create custom field structures. The template processes values returned from
+<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-getTemplateArgs" ext:member="getTemplateArgs" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout.getTemplateArgs</a>.</div></div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#fieldTpl" ext:member="#fieldTpl" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr></tbody></table><a id="Ext.layout.AbsoluteLayout-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.layout.AbsoluteLayout-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file