X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..6e39d509471fe9b4e2660e0d1631b350d0c66f40:/docs/source/Element.position-more.html diff --git a/docs/source/Element.position-more.html b/docs/source/Element.position-more.html index c8e44621..ef90dace 100644 --- a/docs/source/Element.position-more.html +++ b/docs/source/Element.position-more.html @@ -1,17 +1,12 @@ - - - The source code - - - - - 
/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-/**
+
+
+      
+  The source code
+    
+    
+
+
+    
/**
  * @class Ext.Element
  */
 Ext.Element.addMethods({
@@ -33,13 +28,24 @@ Ext.Element.addMethods({
         me.setBounds(box.x, box.y, w, h, me.animTest.call(me, arguments, animate, 2));
         return me;
     },
-    
+
     
/**
-     * Return a box {x, y, width, height} that can be used to set another elements
-     * size/location to match this element.
+     * Return an object defining the area of this Element which can be passed to {@link #setBox} to
+     * set another Element's size/location to match this element.
      * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned.
      * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y.
-     * @return {Object} box An object in the format {x, y, width, height}
+     * @return {Object} box An object in the format

+{
+    x: <Element's X position>,
+    y: <Element's Y position>,
+    width: <Element's width>,
+    height: <Element's height>,
+    bottom: <Element's lower bound>,
+    right: <Element's rightmost bound>
+}
+

+     * The returned object may also be addressed as an Array where index 0 contains the X position
+     * and index 1 contains the Y position. So the result may also be used for {@link #setXY}
      */
 	getBox : function(contentBox, local) {	    
 	    var me = this,
@@ -169,6 +175,6 @@ Ext.Element.addMethods({
     setRegion : function(region, animate) {
         return this.setBounds(region.left, region.top, region.right-region.left, region.bottom-region.top, this.animTest.call(this, arguments, animate, 1));
     }
-});

-
+});
+ \ No newline at end of file