Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.layout.container.Anchor.html
diff --git a/docs/api/Ext.layout.container.Anchor.html b/docs/api/Ext.layout.container.Anchor.html
new file mode 100644 (file)
index 0000000..62cd5bc
--- /dev/null
@@ -0,0 +1,159 @@
+<!DOCTYPE html><html><head><title>Ext.layout.container.Anchor | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
+<style type="text/css">.head-band { display: none; }
+.header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
+.doc-tab .members .member a.more { background-color: #efefef; }
+</style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
+</head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
+<a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
+
+    req = {
+        liveURL: '.',
+        standAloneMode: true,
+        origDocClass: 'Ext.layout.container.Anchor',
+        docClass: 'Ext.layout.container.Anchor',
+        docReq: 'Ext.layout.container.Anchor',
+        version: '4.0',
+        baseURL: '.',
+        baseDocURL: '.',
+        baseProdURL: '.'
+    };
+
+    clsInfo = {};
+
+
+
+</script>
+
+<script type="text/javascript" src="../search.js"></script>
+<!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
+<script type="text/javascript" src="../class_tree.js"></script>
+<script type="text/javascript" src="../class_doc.js"></script>
+<script type="text/javascript">
+    req.source = 'Anchor.html#Ext-layout.container.Anchor';
+    clsInfo = {"methods":["getLayoutItems","getRenderTarget","getTarget"],"cfgs":["anchor","bindToOwnerCtComponent","bindToOwnerCtContainer","defaultAnchor","itemCls"],"properties":[],"events":[],"subclasses":["Ext.layout.container.Absolute"]};
+    Ext.onReady(function() {
+        Ext.create('Docs.classPanel');
+    });
+</script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Anchor.html#Ext-layout.container.Anchor" target="_blank">Ext.layout.container.Anchor</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.layout.Layout.html" rel="Ext.layout.Layout" class="cls docClass">Ext.layout.Layout</a><div class="subclass"><a href="Ext.layout.container.AbstractContainer.html" rel="Ext.layout.container.AbstractContainer" class="cls docClass">Ext.layout.container.AbstractContainer</a><div class="subclass"><a href="Ext.layout.container.Container.html" rel="Ext.layout.container.Container" class="cls docClass">Ext.layout.container.Container</a><div class="subclass"><strong>Ext.layout.container.Anchor</strong></div></div></div></div></pre><p>This is a layout that enables anchoring of contained elements relative to the container's dimensions.
+If the container is resized, all anchored items are automatically rerendered according to their
+<b><tt><a href="Ext.layout.container.Anchor.html#anchor" rel="Ext.layout.container.Anchor#anchor" class="docClass">anchor</a></tt></b> rules.</p>
+
+<p>This class is intended to be extended or created via the layout: 'anchor' <a href="Ext.layout.container.AbstractContainer.html#layout" rel="Ext.layout.container.AbstractContainer#layout" class="docClass">Ext.layout.container.AbstractContainer.layout</a>
+config, and should generally not need to be created directly via the new keyword.</p></p>
+
+<p>AnchorLayout does not have any direct config options (other than inherited ones). By default,
+AnchorLayout will calculate anchor measurements based on the size of the container itself. However, the
+container using the AnchorLayout can supply an anchoring-specific config property of <b>anchorSize</b>.
+If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating
+anchor measurements based on it instead, allowing the container to be sized independently of the anchoring
+logic if necessary.</p>
+
+<p><img class="screenshot" src="../Ext.layout.container.Anchor.png" alt="Ext.layout.container.Anchor container layout" /></p>
+
+<p>For example:</p>
+
+<pre class="prettyprint"><code>Ext.create('Ext.Panel', {
+    width: 500,
+    height: 400,
+    title: "AnchorLayout Panel",
+    layout: 'anchor',
+    renderTo: Ext.getBody(),
+    items: [{
+        xtype: 'panel',
+        title: '75% Width and 20% Height',
+        anchor: '75% 20%'
+    },{
+        xtype: 'panel',
+        title: 'Offset -300 Width &amp; -200 Height',
+        anchor: '-300 -200'     
+    },{
+        xtype: 'panel',
+        title: 'Mixed Offset and Percent',
+        anchor: '-250 20%'
+    }]
+});
+</code></pre>
+<div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">CSS Class configs</h4><div id="config-itemCls" class="member f inherited"><a href="Ext.layout.container.Anchor.html#config-itemCls" rel="config-itemCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.AbstractContainer.html" class="definedIn docClass">Ext.layout.container.AbstractContainer</a><br/><a href="../source/AbstractContainer2.html#Ext-layout.container.AbstractContainer-cfg-itemCls" class="viewSource">view source</a></div><a name="itemCls"></a><a name="config-itemCls"></a><a href="Ext.layout.container.Anchor.html#" rel="config-itemCls" class="cls expand">itemCls</a><span> : String</span></div><div class="description"><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="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>.<a href="Ext.Component.html#ctCls" rel="Ext.Component#ctCls" class="docClass">ctCls</a> also.</p>
+
+
+<p></p></p>
+</div></div></div><h4 class="cfgGroup">Other Configs</h4><div id="config-anchor" class="member f ni"><a href="Ext.layout.container.Anchor.html#config-anchor" rel="config-anchor" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.Anchor.html" class="definedIn docClass">Ext.layout.container.Anchor</a><br/><a href="../source/Anchor.html#Ext-layout.container.Anchor-cfg-anchor" class="viewSource">view source</a></div><a name="anchor"></a><a name="config-anchor"></a><a href="Ext.layout.container.Anchor.html#" rel="config-anchor" class="cls expand">anchor</a><span> : String</span></div><div class="description"><div class="short">This configuation option is to be applied to child items of a container managed by
+this layout (ie. configured with l...</div><div class="long"><p>This configuation option is to be applied to <b>child <tt>items</tt></b> of a container managed by
+this layout (ie. configured with <tt>layout:'anchor'</tt>).</p>
+
+
+<br/>
+
+
+
+
+<p>This value is what tells the layout how an item should be anchored to the container. <tt>items</tt>
+added to an AnchorLayout accept an anchoring-specific config property of <b>anchor</b> which is a string
+containing two values: the horizontal anchor value and the vertical anchor value (for example, '100% 50%').
+The following types of anchor values are supported:<div class="mdetail-params"><ul>
+
+<li><b>Percentage</b> : Any value between 1 and 100, expressed as a percentage.<div class="sub-desc">
+The first anchor is the percentage width that the item should take up within the container, and the
+second is the percentage height.  For example:
+<pre><code>// two values specified
+anchor: '100% 50%' // render item complete width of the container and
+                   // 1/2 height of the container
+// one value specified
+anchor: '100%'     // the width value; the height will default to auto
+</code></pre></div></li>
+
+<li><b>Offsets</b> : Any positive or negative integer value.<div class="sub-desc">
+This is a raw adjustment where the first anchor is the offset from the right edge of the container,
+and the second is the offset from the bottom edge. For example:
+<pre><code>// two values specified
+anchor: '-50 -100' // render item the complete width of the container
+                   // minus 50 pixels and
+                   // the complete height minus 100 pixels.
+// one value specified
+anchor: '-50'      // anchor value is assumed to be the right offset value
+                   // bottom offset will default to 0
+</code></pre></div></li>
+
+<li><b>Sides</b> : Valid values are <tt>'right'</tt> (or <tt>'r'</tt>) and <tt>'bottom'</tt>
+(or <tt>'b'</tt>).<div class="sub-desc">
+Either the container must have a fixed size or an anchorSize config value defined at render time in
+order for these to have any effect.</div></li>
+
+<li><b>Mixed</b> : <div class="sub-desc">
+Anchor values can also be mixed as needed.  For example, to render the width offset from the container
+right edge by 50 pixels and 75% of the container's height use:
+<pre><code>anchor: '-50 75%'
+</code></pre></div></li>
+
+
+</ul></div>
+
+</div></div></div><div id="config-bindToOwnerCtComponent" class="member inherited"><a href="Ext.layout.container.Anchor.html#config-bindToOwnerCtComponent" rel="config-bindToOwnerCtComponent" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.AbstractContainer.html" class="definedIn docClass">Ext.layout.container.AbstractContainer</a><br/><a href="../source/AbstractContainer2.html#Ext-layout.container.AbstractContainer-cfg-bindToOwnerCtComponent" class="viewSource">view source</a></div><a name="bindToOwnerCtComponent"></a><a name="config-bindToOwnerCtComponent"></a><a href="Ext.layout.container.Anchor.html#" rel="config-bindToOwnerCtComponent" class="cls expand">bindToOwnerCtComponent</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag to notify the ownerCt Component on afterLayout of a change</p>
+</div><div class="long"><p>Flag to notify the ownerCt Component on afterLayout of a change</p>
+</div></div></div><div id="config-bindToOwnerCtContainer" class="member inherited"><a href="Ext.layout.container.Anchor.html#config-bindToOwnerCtContainer" rel="config-bindToOwnerCtContainer" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.AbstractContainer.html" class="definedIn docClass">Ext.layout.container.AbstractContainer</a><br/><a href="../source/AbstractContainer2.html#Ext-layout.container.AbstractContainer-cfg-bindToOwnerCtContainer" class="viewSource">view source</a></div><a name="bindToOwnerCtContainer"></a><a name="config-bindToOwnerCtContainer"></a><a href="Ext.layout.container.Anchor.html#" rel="config-bindToOwnerCtContainer" class="cls expand">bindToOwnerCtContainer</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag to notify the ownerCt Container on afterLayout of a change</p>
+</div><div class="long"><p>Flag to notify the ownerCt Container on afterLayout of a change</p>
+</div></div></div><div id="config-defaultAnchor" class="member ni"><a href="Ext.layout.container.Anchor.html#config-defaultAnchor" rel="config-defaultAnchor" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.Anchor.html" class="definedIn docClass">Ext.layout.container.Anchor</a><br/><a href="../source/Anchor.html#Ext-layout.container.Anchor-cfg-defaultAnchor" class="viewSource">view source</a></div><a name="defaultAnchor"></a><a name="config-defaultAnchor"></a><a href="Ext.layout.container.Anchor.html#" rel="config-defaultAnchor" class="cls expand">defaultAnchor</a><span> : String</span></div><div class="description"><div class="short">default anchor for all child container items applied if no anchor or specific width is set on the child item.  Defaul...</div><div class="long"><p>default anchor for all child container items applied if no anchor or specific width is set on the child item.  Defaults to '100%'.</p>
+</div></div></div><div id="config-itemCls" class="member inherited"><a href="Ext.layout.container.Anchor.html#config-itemCls" rel="config-itemCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.AbstractContainer.html" class="definedIn docClass">Ext.layout.container.AbstractContainer</a><br/><a href="../source/AbstractContainer2.html#Ext-layout.container.AbstractContainer-cfg-itemCls" class="viewSource">view source</a></div><a name="itemCls"></a><a name="config-itemCls"></a><a href="Ext.layout.container.Anchor.html#" rel="config-itemCls" class="cls expand">itemCls</a><span> : String</span></div><div class="description"><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="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>.<a href="Ext.Component.html#ctCls" rel="Ext.Component#ctCls" class="docClass">ctCls</a> also.</p>
+
+
+<p></p></p>
+</div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-getLayoutItems" class="member f inherited"><a href="Ext.layout.container.Anchor.html#method-getLayoutItems" rel="method-getLayoutItems" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.AbstractContainer.html" class="definedIn docClass">Ext.layout.container.AbstractContainer</a><br/><a href="../source/AbstractContainer2.html#Ext-layout.container.AbstractContainer-method-getLayoutItems" class="viewSource">view source</a></div><a name="getLayoutItems"></a><a name="method-getLayoutItems"></a><a href="Ext.layout.container.Anchor.html#" rel="method-getLayoutItems" class="cls expand">getLayoutItems</a> : Array</div><div class="description"><div class="short">Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's
+...</div><div class="long"><p>Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's
+base class), or the layout phase (onLayout).</p>
+
+<h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>of child components</p>
+</li></ul></div></div></div><div id="method-getRenderTarget" class="member inherited"><a href="Ext.layout.container.Anchor.html#method-getRenderTarget" rel="method-getRenderTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.AbstractContainer.html" class="definedIn docClass">Ext.layout.container.AbstractContainer</a><br/><a href="../source/AbstractContainer2.html#Ext-layout.container.AbstractContainer-method-getRenderTarget" class="viewSource">view source</a></div><a name="getRenderTarget"></a><a name="method-getRenderTarget"></a><a href="Ext.layout.container.Anchor.html#" rel="method-getRenderTarget" class="cls expand">getRenderTarget</a> : Ext.core.Element</div><div class="description"><div class="short">Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.tar...</div><div class="long"><p>Returns the element into which rendering must take place. Defaults to the owner Container's <a href="Ext.AbstractComponent.html#targetEl" rel="Ext.AbstractComponent#targetEl" class="docClass">Ext.AbstractComponent.targetEl</a>.</p>
+
+
+<p>May be overridden in layout managers which implement an inner element.</p>
+<h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;
+</li></ul></div></div></div><div id="method-getTarget" class="member inherited"><a href="Ext.layout.container.Anchor.html#method-getTarget" rel="method-getTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.layout.container.AbstractContainer.html" class="definedIn docClass">Ext.layout.container.AbstractContainer</a><br/><a href="../source/AbstractContainer2.html#Ext-layout.container.AbstractContainer-method-getTarget" class="viewSource">view source</a></div><a name="getTarget"></a><a name="method-getTarget"></a><a href="Ext.layout.container.Anchor.html#" rel="method-getTarget" class="cls expand">getTarget</a> : Ext.core.Element</div><div class="description"><div class="short"><p>Returns the owner component's resize element.</p>
+</div><div class="long"><p>Returns the owner component's resize element.</p>
+<h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;
+</li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>
\ No newline at end of file