Upgrade to ExtJS 3.1.0 - Released 12/16/2009

[extjs.git] / docs / source / Element.position-more.html
diff --git a/docs/source/Element.position-more.html b/docs/source/Element.position-more.html

index c8e4462..ef90dac 100644 (file)
--- a/docs/source/Element.position-more.html
+++ b/docs/source/Element.position-more.html
@@ -1,17 +1,12 @@
-<html>
-<head>
-  <title>The source code</title>
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
-</head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-/**\r
+<html>\r
+<head>\r
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \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">/**\r
   * @class Ext.Element\r
   */\r
  Ext.Element.addMethods({\r
   * @class Ext.Element\r
   */\r
  Ext.Element.addMethods({\r
@@ -33,13 +28,24 @@ Ext.Element.addMethods({
          me.setBounds(box.x, box.y, w, h, me.animTest.call(me, arguments, animate, 2));\r
          return me;\r
      },\r
          me.setBounds(box.x, box.y, w, h, me.animTest.call(me, arguments, animate, 2));\r
          return me;\r
      },\r
-    \r
+\r
      <div id="method-Ext.Element-getBox"></div>/**\r
      <div id="method-Ext.Element-getBox"></div>/**\r
-     * Return a box {x, y, width, height} that can be used to set another elements\r
-     * size/location to match this element.\r
+     * Return an object defining the area of this Element which can be passed to {@link #setBox} to\r
+     * set another Element's size/location to match this element.\r
       * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned.\r
       * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y.\r
       * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned.\r
       * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y.\r
-     * @return {Object} box An object in the format {x, y, width, height}\r
+     * @return {Object} box An object in the format<pre><code>\r
+{\r
+    x: &lt;Element's X position>,\r
+    y: &lt;Element's Y position>,\r
+    width: &lt;Element's width>,\r
+    height: &lt;Element's height>,\r
+    bottom: &lt;Element's lower bound>,\r
+    right: &lt;Element's rightmost bound>\r
+}\r
+</code></pre>\r
+     * The returned object may also be addressed as an Array where index 0 contains the X position\r
+     * and index 1 contains the Y position. So the result may also be used for {@link #setXY}\r
       */\r
         getBox : function(contentBox, local) {      \r
             var me = this,\r
       */\r
         getBox : function(contentBox, local) {      \r
             var me = this,\r
@@ -169,6 +175,6 @@ Ext.Element.addMethods({
      setRegion : function(region, animate) {\r
          return this.setBounds(region.left, region.top, region.right-region.left, region.bottom-region.top, this.animTest.call(this, arguments, animate, 1));\r
      }\r
      setRegion : function(region, animate) {\r
          return this.setBounds(region.left, region.top, region.right-region.left, region.bottom-region.top, this.animTest.call(this, arguments, animate, 1));\r
      }\r
-});</pre>
-</body>
+});</pre>    \r
+</body>\r
  </html>
 \ No newline at end of file
  </html>
 \ No newline at end of file