Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / Element.position.html
index 8495b08..8e4a9d5 100644 (file)
@@ -1,305 +1 @@
-<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
-(function(){\r
-var D = Ext.lib.Dom,\r
-        LEFT = "left",\r
-        RIGHT = "right",\r
-        TOP = "top",\r
-        BOTTOM = "bottom",\r
-        POSITION = "position",\r
-        STATIC = "static",\r
-        RELATIVE = "relative",\r
-        AUTO = "auto",\r
-        ZINDEX = "z-index";\r
-\r
-Ext.Element.addMethods({\r
-       <div id="method-Ext.Element-getX"></div>/**\r
-      * Gets the current X position of the element based on page coordinates.  Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-      * @return {Number} The X position of the element\r
-      */\r
-    getX : function(){\r
-        return D.getX(this.dom);\r
-    },\r
-\r
-    <div id="method-Ext.Element-getY"></div>/**\r
-      * Gets the current Y position of the element based on page coordinates.  Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-      * @return {Number} The Y position of the element\r
-      */\r
-    getY : function(){\r
-        return D.getY(this.dom);\r
-    },\r
-\r
-    <div id="method-Ext.Element-getXY"></div>/**\r
-      * Gets the current position of the element based on page coordinates.  Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-      * @return {Array} The XY position of the element\r
-      */\r
-    getXY : function(){\r
-        return D.getXY(this.dom);\r
-    },\r
-\r
-    <div id="method-Ext.Element-getOffsetsTo"></div>/**\r
-      * Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have display:none to have page coordinates.\r
-      * @param {Mixed} element The element to get the offsets from.\r
-      * @return {Array} The XY page offsets (e.g. [100, -200])\r
-      */\r
-    getOffsetsTo : function(el){\r
-        var o = this.getXY(),\r
-               e = Ext.fly(el, '_internal').getXY();\r
-        return [o[0]-e[0],o[1]-e[1]];\r
-    },\r
-\r
-    <div id="method-Ext.Element-setX"></div>/**\r
-     * Sets the X position of the element based on page coordinates.  Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-     * @param {Number} The X position of the element\r
-     * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object\r
-     * @return {Ext.Element} this\r
-     */\r
-    setX : function(x, animate){           \r
-           return this.setXY([x, this.getY()], this.animTest(arguments, animate, 1));\r
-    },\r
-\r
-    <div id="method-Ext.Element-setY"></div>/**\r
-     * Sets the Y position of the element based on page coordinates.  Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-     * @param {Number} The Y position of the element\r
-     * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object\r
-     * @return {Ext.Element} this\r
-     */\r
-    setY : function(y, animate){           \r
-           return this.setXY([this.getX(), y], this.animTest(arguments, animate, 1));\r
-    },\r
-\r
-    <div id="method-Ext.Element-setLeft"></div>/**\r
-     * Sets the element's left position directly using CSS style (instead of {@link #setX}).\r
-     * @param {String} left The left CSS property value\r
-     * @return {Ext.Element} this\r
-     */\r
-    setLeft : function(left){\r
-        this.setStyle(LEFT, this.addUnits(left));\r
-        return this;\r
-    },\r
-\r
-    <div id="method-Ext.Element-setTop"></div>/**\r
-     * Sets the element's top position directly using CSS style (instead of {@link #setY}).\r
-     * @param {String} top The top CSS property value\r
-     * @return {Ext.Element} this\r
-     */\r
-    setTop : function(top){\r
-        this.setStyle(TOP, this.addUnits(top));\r
-        return this;\r
-    },\r
-\r
-    <div id="method-Ext.Element-setRight"></div>/**\r
-     * Sets the element's CSS right style.\r
-     * @param {String} right The right CSS property value\r
-     * @return {Ext.Element} this\r
-     */\r
-    setRight : function(right){\r
-        this.setStyle(RIGHT, this.addUnits(right));\r
-        return this;\r
-    },\r
-\r
-    <div id="method-Ext.Element-setBottom"></div>/**\r
-     * Sets the element's CSS bottom style.\r
-     * @param {String} bottom The bottom CSS property value\r
-     * @return {Ext.Element} this\r
-     */\r
-    setBottom : function(bottom){\r
-        this.setStyle(BOTTOM, this.addUnits(bottom));\r
-        return this;\r
-    },\r
-\r
-    <div id="method-Ext.Element-setXY"></div>/**\r
-     * Sets the position of the element in page coordinates, regardless of how the element is positioned.\r
-     * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-     * @param {Array} pos Contains X & Y [x, y] values for new position (coordinates are page-based)\r
-     * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object\r
-     * @return {Ext.Element} this\r
-     */\r
-    setXY : function(pos, animate){\r
-           var me = this;\r
-        if(!animate || !me.anim){\r
-            D.setXY(me.dom, pos);\r
-        }else{\r
-            me.anim({points: {to: pos}}, me.preanim(arguments, 1), 'motion');\r
-        }\r
-        return me;\r
-    },\r
-\r
-    <div id="method-Ext.Element-setLocation"></div>/**\r
-     * Sets the position of the element in page coordinates, regardless of how the element is positioned.\r
-     * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-     * @param {Number} x X value for new position (coordinates are page-based)\r
-     * @param {Number} y Y value for new position (coordinates are page-based)\r
-     * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object\r
-     * @return {Ext.Element} this\r
-     */\r
-    setLocation : function(x, y, animate){\r
-        return this.setXY([x, y], this.animTest(arguments, animate, 2));\r
-    },\r
-\r
-    <div id="method-Ext.Element-moveTo"></div>/**\r
-     * Sets the position of the element in page coordinates, regardless of how the element is positioned.\r
-     * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).\r
-     * @param {Number} x X value for new position (coordinates are page-based)\r
-     * @param {Number} y Y value for new position (coordinates are page-based)\r
-     * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object\r
-     * @return {Ext.Element} this\r
-     */\r
-    moveTo : function(x, y, animate){\r
-        return this.setXY([x, y], this.animTest(arguments, animate, 2));        \r
-    },    \r
-    \r
-    <div id="method-Ext.Element-getLeft"></div>/**\r
-     * Gets the left X coordinate\r
-     * @param {Boolean} local True to get the local css position instead of page coordinate\r
-     * @return {Number}\r
-     */\r
-    getLeft : function(local){\r
-           return !local ? this.getX() : parseInt(this.getStyle(LEFT), 10) || 0;\r
-    },\r
-\r
-    <div id="method-Ext.Element-getRight"></div>/**\r
-     * Gets the right X coordinate of the element (element X position + element width)\r
-     * @param {Boolean} local True to get the local css position instead of page coordinate\r
-     * @return {Number}\r
-     */\r
-    getRight : function(local){\r
-           var me = this;\r
-           return !local ? me.getX() + me.getWidth() : (me.getLeft(true) + me.getWidth()) || 0;\r
-    },\r
-\r
-    <div id="method-Ext.Element-getTop"></div>/**\r
-     * Gets the top Y coordinate\r
-     * @param {Boolean} local True to get the local css position instead of page coordinate\r
-     * @return {Number}\r
-     */\r
-    getTop : function(local) {\r
-           return !local ? this.getY() : parseInt(this.getStyle(TOP), 10) || 0;\r
-    },\r
-\r
-    <div id="method-Ext.Element-getBottom"></div>/**\r
-     * Gets the bottom Y coordinate of the element (element Y position + element height)\r
-     * @param {Boolean} local True to get the local css position instead of page coordinate\r
-     * @return {Number}\r
-     */\r
-    getBottom : function(local){\r
-           var me = this;\r
-           return !local ? me.getY() + me.getHeight() : (me.getTop(true) + me.getHeight()) || 0;\r
-    },\r
-\r
-    <div id="method-Ext.Element-position"></div>/**\r
-    * Initializes positioning on this element. If a desired position is not passed, it will make the\r
-    * the element positioned relative IF it is not already positioned.\r
-    * @param {String} pos (optional) Positioning to use "relative", "absolute" or "fixed"\r
-    * @param {Number} zIndex (optional) The zIndex to apply\r
-    * @param {Number} x (optional) Set the page X position\r
-    * @param {Number} y (optional) Set the page Y position\r
-    */\r
-    position : function(pos, zIndex, x, y){\r
-           var me = this;\r
-           \r
-        if(!pos && me.isStyle(POSITION, STATIC)){           \r
-            me.setStyle(POSITION, RELATIVE);           \r
-        } else if(pos) {\r
-            me.setStyle(POSITION, pos);\r
-        }\r
-        if(zIndex){\r
-            me.setStyle(ZINDEX, zIndex);\r
-        }\r
-        if(x || y) me.setXY([x || false, y || false]);\r
-    },\r
-\r
-    <div id="method-Ext.Element-clearPositioning"></div>/**\r
-    * Clear positioning back to the default when the document was loaded\r
-    * @param {String} value (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.\r
-    * @return {Ext.Element} this\r
-     */\r
-    clearPositioning : function(value){\r
-        value = value || '';\r
-        this.setStyle({\r
-            left : value,\r
-            right : value,\r
-            top : value,\r
-            bottom : value,\r
-            "z-index" : "",\r
-            position : STATIC\r
-        });\r
-        return this;\r
-    },\r
-\r
-    <div id="method-Ext.Element-getPositioning"></div>/**\r
-    * Gets an object with all CSS positioning properties. Useful along with setPostioning to get\r
-    * snapshot before performing an update and then restoring the element.\r
-    * @return {Object}\r
-    */\r
-    getPositioning : function(){\r
-        var l = this.getStyle(LEFT);\r
-        var t = this.getStyle(TOP);\r
-        return {\r
-            "position" : this.getStyle(POSITION),\r
-            "left" : l,\r
-            "right" : l ? "" : this.getStyle(RIGHT),\r
-            "top" : t,\r
-            "bottom" : t ? "" : this.getStyle(BOTTOM),\r
-            "z-index" : this.getStyle(ZINDEX)\r
-        };\r
-    },\r
-    \r
-    <div id="method-Ext.Element-setPositioning"></div>/**\r
-    * Set positioning with an object returned by getPositioning().\r
-    * @param {Object} posCfg\r
-    * @return {Ext.Element} this\r
-     */\r
-    setPositioning : function(pc){\r
-           var me = this,\r
-               style = me.dom.style;\r
-               \r
-        me.setStyle(pc);\r
-        \r
-        if(pc.right == AUTO){\r
-            style.right = "";\r
-        }\r
-        if(pc.bottom == AUTO){\r
-            style.bottom = "";\r
-        }\r
-        \r
-        return me;\r
-    },    \r
-       \r
-    <div id="method-Ext.Element-translatePoints"></div>/**\r
-     * Translates the passed page coordinates into left/top css values for this element\r
-     * @param {Number/Array} x The page x or an array containing [x, y]\r
-     * @param {Number} y (optional) The page y, required if x is not an array\r
-     * @return {Object} An object with left and top properties. e.g. {left: (value), top: (value)}\r
-     */\r
-    translatePoints : function(x, y){               \r
-           y = isNaN(x[1]) ? y : x[1];\r
-        x = isNaN(x[0]) ? x : x[0];\r
-        var me = this,\r
-               relative = me.isStyle(POSITION, RELATIVE),\r
-               o = me.getXY(),\r
-               l = parseInt(me.getStyle(LEFT), 10),\r
-               t = parseInt(me.getStyle(TOP), 10);\r
-        \r
-        l = !isNaN(l) ? l : (relative ? 0 : me.dom.offsetLeft);\r
-        t = !isNaN(t) ? t : (relative ? 0 : me.dom.offsetTop);        \r
-\r
-        return {left: (x - o[0] + l), top: (y - o[1] + t)}; \r
-    },\r
-    \r
-    animTest : function(args, animate, i) {\r
-        return !!animate && this.preanim ? this.preanim(args, i) : false;\r
-    }\r
-});\r
-})();</pre>    \r
-</body>\r
-</html>
\ No newline at end of file
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre></pre></pre></body></html>
\ No newline at end of file