Fixed a bunch of endline issues.
[jquery.git] / src / dimensions / dimensions.js
index 6a7d20a..cf6f508 100644 (file)
-/** \r
- * This plugin overrides jQuery's height() and width() functions and\r
- * adds more handy stuff for cross-browser compatibility.\r
- */\r
-\r
-/**\r
- * Returns the css height value for the first matched element.\r
- * If used on document, returns the document's height (innerHeight)\r
- * If used on window, returns the viewport's (window) height\r
- *\r
- * @example $("#testdiv").height()\r
- * @result "200px"\r
- *\r
- * @example $(document).height();\r
- * @result 800\r
- *\r
- * @example $(window).height();\r
- * @result 400\r
- * \r
- * @name height\r
- * @type Object\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.height = function() {\r
-       if ( this.get(0) == window )\r
-               return self.innerHeight ||\r
-                       jQuery.boxModel && document.documentElement.clientHeight ||\r
-                       document.body.clientHeight;\r
-       \r
-       if ( this.get(0) == document )\r
-               return Math.max( document.body.scrollHeight, document.body.offsetHeight );\r
-       \r
-       return this.css("height");\r
-};\r
-\r
-/**\r
- * Returns the css width value for the first matched element.\r
- * If used on document, returns the document's width (innerWidth)\r
- * If used on window, returns the viewport's (window) width\r
- *\r
- * @example $("#testdiv").width()\r
- * @result "200px"\r
- *\r
- * @example $(document).width();\r
- * @result 800\r
- *\r
- * @example $(window).width();\r
- * @result 400\r
- * \r
- * @name width\r
- * @type Object\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.width = function() {\r
-       if ( this.get(0) == window )\r
-               return self.innerWidth ||\r
-                       jQuery.boxModel && document.documentElement.clientWidth ||\r
-                       document.body.clientWidth;\r
-       \r
-       if ( this.get(0) == document )\r
-               return Math.max( document.body.scrollWidth, document.body.offsetWidth );\r
-       \r
-       return this.css("width");\r
-};\r
-\r
-/**\r
- * Returns the inner height value (without border) for the first matched element.\r
- * If used on document, returns the document's height (innerHeight)\r
- * If used on window, returns the viewport's (window) height\r
- *\r
- * @example $("#testdiv").innerHeight()\r
- * @result 800\r
- * \r
- * @name innerHeight\r
- * @type Number\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.innerHeight = function() {\r
-       return this.get(0) == window || this.get(0) == document ?\r
-               this.height() :\r
-               this.get(0).offsetHeight - parseInt(this.css("borderTop") || 0) - parseInt(this.css("borderBottom") || 0);\r
-};\r
-\r
-/**\r
- * Returns the inner width value (without border) for the first matched element.\r
- * If used on document, returns the document's Width (innerWidth)\r
- * If used on window, returns the viewport's (window) width\r
- *\r
- * @example $("#testdiv").innerWidth()\r
- * @result 1000\r
- * \r
- * @name innerWidth\r
- * @type Number\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.innerWidth = function() {\r
-       return this.get(0) == window || this.get(0) == document ?\r
-               this.width() :\r
-               this.get(0).offsetWidth - parseInt(this.css("borderLeft") || 0) - parseInt(this.css("borderRight") || 0);\r
-};\r
-\r
-/**\r
- * Returns the outer height value (including border) for the first matched element.\r
- * Cannot be used on document or window.\r
- *\r
- * @example $("#testdiv").outerHeight()\r
- * @result 1000\r
- * \r
- * @name outerHeight\r
- * @type Number\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.outerHeight = function() {\r
-       return this.get(0) == window || this.get(0) == document ?\r
-               this.height() :\r
-               this.get(0).offsetHeight;       \r
-};\r
-\r
-/**\r
- * Returns the outer width value (including border) for the first matched element.\r
- * Cannot be used on document or window.\r
- *\r
- * @example $("#testdiv").outerWidth()\r
- * @result 1000\r
- * \r
- * @name outerWidth\r
- * @type Number\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.outerWidth = function() {\r
-       return this.get(0) == window || this.get(0) == document ?\r
-               this.width() :\r
-               this.get(0).offsetWidth;        \r
-};\r
-\r
-/**\r
- * Returns how many pixels the user has scrolled to the right (scrollLeft).\r
- * Works on containers with overflow: auto and window/document.\r
- *\r
- * @example $("#testdiv").scrollLeft()\r
- * @result 100\r
- * \r
- * @name scrollLeft\r
- * @type Number\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.scrollLeft = function() {\r
-       if ( this.get(0) == window || this.get(0) == document )\r
-               return self.pageXOffset ||\r
-                       jQuery.boxModel && document.documentElement.scrollLeft ||\r
-                       document.body.scrollLeft;\r
-       \r
-       return this.get(0).scrollLeft;\r
-};\r
-\r
-/**\r
- * Returns how many pixels the user has scrolled to the bottom (scrollTop).\r
- * Works on containers with overflow: auto and window/document.\r
- *\r
- * @example $("#testdiv").scrollTop()\r
- * @result 100\r
- * \r
- * @name scrollTop\r
- * @type Number\r
- * @cat Dimensions\r
- */\r
-jQuery.fn.scrollTop = function() {\r
-       if ( this.get(0) == window || this.get(0) == document )\r
-               return self.pageYOffset ||\r
-                       jQuery.boxModel && document.documentElement.scrollTop ||\r
-                       document.body.scrollTop;\r
-\r
-       return this.get(0).scrollTop;\r
-};\r
-\r
-/**\r
- * This returns an object with top, left, width, height, borderLeft,\r
- * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, \r
- * pageXOffset, pageYOffset.\r
- *\r
- * The top and left values include the scroll offsets but the\r
- * scrollLeft and scrollTop properties of the returned object\r
- * are the combined scroll offets of the parent elements \r
- * (not including the window scroll offsets). This is not the\r
- * same as the element's scrollTop and scrollLeft.\r
- * \r
- * For accurate readings make sure to use pixel values.\r
- *\r
- * @name offset        \r
- * @type Object\r
- * @cat Dimensions\r
- * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)\r
- */\r
-/**\r
- * This returns an object with top, left, width, height, borderLeft,\r
- * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, \r
- * pageXOffset, pageYOffset.\r
- *\r
- * The top and left values include the scroll offsets but the\r
- * scrollLeft and scrollTop properties of the returned object\r
- * are the combined scroll offets of the parent elements \r
- * (not including the window scroll offsets). This is not the\r
- * same as the element's scrollTop and scrollLeft.\r
- * \r
- * For accurate readings make sure to use pixel values.\r
- *\r
- * @name offset        \r
- * @type Object\r
- * @param String refElement This is an expression. The offset returned will be relative to the first matched element.\r
- * @cat Dimensions\r
- * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)\r
- */\r
-/**\r
- * This returns an object with top, left, width, height, borderLeft,\r
- * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, \r
- * pageXOffset, pageYOffset.\r
- *\r
- * The top and left values include the scroll offsets but the\r
- * scrollLeft and scrollTop properties of the returned object\r
- * are the combined scroll offets of the parent elements \r
- * (not including the window scroll offsets). This is not the\r
- * same as the element's scrollTop and scrollLeft.\r
- * \r
- * For accurate readings make sure to use pixel values.\r
- *\r
- * @name offset        \r
- * @type Object\r
- * @param jQuery refElement The offset returned will be relative to the first matched element.\r
- * @cat Dimensions\r
- * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)\r
- */\r
-/**\r
- * This returns an object with top, left, width, height, borderLeft,\r
- * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, \r
- * pageXOffset, pageYOffset.\r
- *\r
- * The top and left values include the scroll offsets but the\r
- * scrollLeft and scrollTop properties of the returned object\r
- * are the combined scroll offets of the parent elements \r
- * (not including the window scroll offsets). This is not the\r
- * same as the element's scrollTop and scrollLeft.\r
- * \r
- * For accurate readings make sure to use pixel values.\r
- *\r
- * @name offset        \r
- * @type Object\r
- * @param HTMLElement refElement The offset returned will be relative to this element.\r
- * @cat Dimensions\r
- * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)\r
- */\r
-jQuery.fn.offset = function(refElem) {\r
-       if (!this[0]) throw 'jQuery.fn.offset requires an element.';\r
-       \r
-       refElem = (refElem) ? jQuery(refElem)[0] : null;\r
-       var x = 0, y = 0, elm = this[0], parent = this[0], pos = null, borders = [0,0], isElm = true, sl = 0, st = 0;\r
-       do {\r
-               if (parent.tagName == 'BODY' || parent.tagName == 'HTML') {\r
-                       // Safari and IE don't add margin for static and relative\r
-                       if ((jQuery.browser.safari || jQuery.browser.msie) && pos != 'absolute') {\r
-                               x += parseInt(jQuery.css(parent, 'marginLeft')) || 0;\r
-                               y += parseInt(jQuery.css(parent, 'marginTop'))  || 0;\r
-                       }\r
-                       break;\r
-               }\r
-               \r
-               pos    = jQuery.css(parent, 'position');\r
-               border = [parseInt(jQuery.css(parent, 'borderLeftWidth')) || 0,\r
-                                                       parseInt(jQuery.css(parent, 'borderTopWidth'))  || 0];\r
-               sl = parent.scrollLeft;\r
-               st = parent.scrollTop;\r
-               \r
-               x += (parent.offsetLeft || 0) + border[0] - sl;\r
-               y += (parent.offsetTop  || 0) + border[1] - st;\r
-               \r
-               // Safari and Opera include the border already for parents with position = absolute|relative\r
-               if ((jQuery.browser.safari || jQuery.browser.opera) && !isElm && (pos == 'absolute' || pos == 'relative')) {\r
-                       x -= border[0];\r
-                       y -= border[1];\r
-               }\r
-               \r
-               parent = parent.offsetParent;\r
-               isElm  = false;\r
-       } while(parent);\r
-       \r
-       if (refElem) {\r
-               var offset = jQuery(refElem).offset();\r
-               x  = x  - offset.left;\r
-               y  = y  - offset.top;\r
-               sl = sl - offset.scrollLeft;\r
-               st = st - offset.scrollTop;\r
-       }\r
-       \r
-       return {\r
-               top:  y,\r
-               left: x,\r
-               width:  elm.offsetWidth,\r
-               height: elm.offsetHeight,\r
-               borderTop:  parseInt(jQuery.css(elm, 'borderTopWidth'))  || 0,\r
-               borderLeft: parseInt(jQuery.css(elm, 'borderLeftWidth')) || 0,\r
-               marginTop:  parseInt(jQuery.css(elm, 'marginTopWidth'))  || 0,\r
-               marginLeft: parseInt(jQuery.css(elm, 'marginLeftWidth')) || 0,\r
-               scrollTop:  st,\r
-               scrollLeft: sl,\r
-               pageYOffset: window.pageYOffset || document.documentElement.scrollTop  || document.body.scrollTop  || 0,\r
-               pageXOffset: window.pageXOffset || document.documentElement.scrollLeft || document.body.scrollLeft || 0\r
-       };\r
+/** 
+ * This plugin overrides jQuery's height() and width() functions and
+ * adds more handy stuff for cross-browser compatibility.
+ */
+
+/**
+ * Returns the css height value for the first matched element.
+ * If used on document, returns the document's height (innerHeight)
+ * If used on window, returns the viewport's (window) height
+ *
+ * @example $("#testdiv").height()
+ * @result "200px"
+ *
+ * @example $(document).height();
+ * @result 800
+ *
+ * @example $(window).height();
+ * @result 400
+ * 
+ * @name height
+ * @type Object
+ * @cat Dimensions
+ */
+jQuery.fn.height = function() {
+       if ( this.get(0) == window )
+               return self.innerHeight ||
+                       jQuery.boxModel && document.documentElement.clientHeight ||
+                       document.body.clientHeight;
+       
+       if ( this.get(0) == document )
+               return Math.max( document.body.scrollHeight, document.body.offsetHeight );
+       
+       return this.css("height");
+};
+
+/**
+ * Returns the css width value for the first matched element.
+ * If used on document, returns the document's width (innerWidth)
+ * If used on window, returns the viewport's (window) width
+ *
+ * @example $("#testdiv").width()
+ * @result "200px"
+ *
+ * @example $(document).width();
+ * @result 800
+ *
+ * @example $(window).width();
+ * @result 400
+ * 
+ * @name width
+ * @type Object
+ * @cat Dimensions
+ */
+jQuery.fn.width = function() {
+       if ( this.get(0) == window )
+               return self.innerWidth ||
+                       jQuery.boxModel && document.documentElement.clientWidth ||
+                       document.body.clientWidth;
+       
+       if ( this.get(0) == document )
+               return Math.max( document.body.scrollWidth, document.body.offsetWidth );
+       
+       return this.css("width");
+};
+
+/**
+ * Returns the inner height value (without border) for the first matched element.
+ * If used on document, returns the document's height (innerHeight)
+ * If used on window, returns the viewport's (window) height
+ *
+ * @example $("#testdiv").innerHeight()
+ * @result 800
+ * 
+ * @name innerHeight
+ * @type Number
+ * @cat Dimensions
+ */
+jQuery.fn.innerHeight = function() {
+       return this.get(0) == window || this.get(0) == document ?
+               this.height() :
+               this.get(0).offsetHeight - parseInt(this.css("borderTop") || 0) - parseInt(this.css("borderBottom") || 0);
+};
+
+/**
+ * Returns the inner width value (without border) for the first matched element.
+ * If used on document, returns the document's Width (innerWidth)
+ * If used on window, returns the viewport's (window) width
+ *
+ * @example $("#testdiv").innerWidth()
+ * @result 1000
+ * 
+ * @name innerWidth
+ * @type Number
+ * @cat Dimensions
+ */
+jQuery.fn.innerWidth = function() {
+       return this.get(0) == window || this.get(0) == document ?
+               this.width() :
+               this.get(0).offsetWidth - parseInt(this.css("borderLeft") || 0) - parseInt(this.css("borderRight") || 0);
+};
+
+/**
+ * Returns the outer height value (including border) for the first matched element.
+ * Cannot be used on document or window.
+ *
+ * @example $("#testdiv").outerHeight()
+ * @result 1000
+ * 
+ * @name outerHeight
+ * @type Number
+ * @cat Dimensions
+ */
+jQuery.fn.outerHeight = function() {
+       return this.get(0) == window || this.get(0) == document ?
+               this.height() :
+               this.get(0).offsetHeight;       
+};
+
+/**
+ * Returns the outer width value (including border) for the first matched element.
+ * Cannot be used on document or window.
+ *
+ * @example $("#testdiv").outerWidth()
+ * @result 1000
+ * 
+ * @name outerWidth
+ * @type Number
+ * @cat Dimensions
+ */
+jQuery.fn.outerWidth = function() {
+       return this.get(0) == window || this.get(0) == document ?
+               this.width() :
+               this.get(0).offsetWidth;        
+};
+
+/**
+ * Returns how many pixels the user has scrolled to the right (scrollLeft).
+ * Works on containers with overflow: auto and window/document.
+ *
+ * @example $("#testdiv").scrollLeft()
+ * @result 100
+ * 
+ * @name scrollLeft
+ * @type Number
+ * @cat Dimensions
+ */
+jQuery.fn.scrollLeft = function() {
+       if ( this.get(0) == window || this.get(0) == document )
+               return self.pageXOffset ||
+                       jQuery.boxModel && document.documentElement.scrollLeft ||
+                       document.body.scrollLeft;
+       
+       return this.get(0).scrollLeft;
+};
+
+/**
+ * Returns how many pixels the user has scrolled to the bottom (scrollTop).
+ * Works on containers with overflow: auto and window/document.
+ *
+ * @example $("#testdiv").scrollTop()
+ * @result 100
+ * 
+ * @name scrollTop
+ * @type Number
+ * @cat Dimensions
+ */
+jQuery.fn.scrollTop = function() {
+       if ( this.get(0) == window || this.get(0) == document )
+               return self.pageYOffset ||
+                       jQuery.boxModel && document.documentElement.scrollTop ||
+                       document.body.scrollTop;
+
+       return this.get(0).scrollTop;
+};
+
+/**
+ * This returns an object with top, left, width, height, borderLeft,
+ * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, 
+ * pageXOffset, pageYOffset.
+ *
+ * The top and left values include the scroll offsets but the
+ * scrollLeft and scrollTop properties of the returned object
+ * are the combined scroll offets of the parent elements 
+ * (not including the window scroll offsets). This is not the
+ * same as the element's scrollTop and scrollLeft.
+ * 
+ * For accurate readings make sure to use pixel values.
+ *
+ * @name offset        
+ * @type Object
+ * @cat Dimensions
+ * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)
+ */
+/**
+ * This returns an object with top, left, width, height, borderLeft,
+ * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, 
+ * pageXOffset, pageYOffset.
+ *
+ * The top and left values include the scroll offsets but the
+ * scrollLeft and scrollTop properties of the returned object
+ * are the combined scroll offets of the parent elements 
+ * (not including the window scroll offsets). This is not the
+ * same as the element's scrollTop and scrollLeft.
+ * 
+ * For accurate readings make sure to use pixel values.
+ *
+ * @name offset        
+ * @type Object
+ * @param String refElement This is an expression. The offset returned will be relative to the first matched element.
+ * @cat Dimensions
+ * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)
+ */
+/**
+ * This returns an object with top, left, width, height, borderLeft,
+ * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, 
+ * pageXOffset, pageYOffset.
+ *
+ * The top and left values include the scroll offsets but the
+ * scrollLeft and scrollTop properties of the returned object
+ * are the combined scroll offets of the parent elements 
+ * (not including the window scroll offsets). This is not the
+ * same as the element's scrollTop and scrollLeft.
+ * 
+ * For accurate readings make sure to use pixel values.
+ *
+ * @name offset        
+ * @type Object
+ * @param jQuery refElement The offset returned will be relative to the first matched element.
+ * @cat Dimensions
+ * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)
+ */
+/**
+ * This returns an object with top, left, width, height, borderLeft,
+ * borderTop, marginLeft, marginTop, scrollLeft, scrollTop, 
+ * pageXOffset, pageYOffset.
+ *
+ * The top and left values include the scroll offsets but the
+ * scrollLeft and scrollTop properties of the returned object
+ * are the combined scroll offets of the parent elements 
+ * (not including the window scroll offsets). This is not the
+ * same as the element's scrollTop and scrollLeft.
+ * 
+ * For accurate readings make sure to use pixel values.
+ *
+ * @name offset        
+ * @type Object
+ * @param HTMLElement refElement The offset returned will be relative to this element.
+ * @cat Dimensions
+ * @author Brandon Aaron (brandon.aaron@gmail.com || http://brandonaaron.net)
+ */
+jQuery.fn.offset = function(refElem) {
+       if (!this[0]) throw 'jQuery.fn.offset requires an element.';
+       
+       refElem = (refElem) ? jQuery(refElem)[0] : null;
+       var x = 0, y = 0, elm = this[0], parent = this[0], pos = null, borders = [0,0], isElm = true, sl = 0, st = 0;
+       do {
+               if (parent.tagName == 'BODY' || parent.tagName == 'HTML') {
+                       // Safari and IE don't add margin for static and relative
+                       if ((jQuery.browser.safari || jQuery.browser.msie) && pos != 'absolute') {
+                               x += parseInt(jQuery.css(parent, 'marginLeft')) || 0;
+                               y += parseInt(jQuery.css(parent, 'marginTop'))  || 0;
+                       }
+                       break;
+               }
+               
+               pos    = jQuery.css(parent, 'position');
+               border = [parseInt(jQuery.css(parent, 'borderLeftWidth')) || 0,
+                                                       parseInt(jQuery.css(parent, 'borderTopWidth'))  || 0];
+               sl = parent.scrollLeft;
+               st = parent.scrollTop;
+               
+               x += (parent.offsetLeft || 0) + border[0] - sl;
+               y += (parent.offsetTop  || 0) + border[1] - st;
+               
+               // Safari and Opera include the border already for parents with position = absolute|relative
+               if ((jQuery.browser.safari || jQuery.browser.opera) && !isElm && (pos == 'absolute' || pos == 'relative')) {
+                       x -= border[0];
+                       y -= border[1];
+               }
+               
+               parent = parent.offsetParent;
+               isElm  = false;
+       } while(parent);
+       
+       if (refElem) {
+               var offset = jQuery(refElem).offset();
+               x  = x  - offset.left;
+               y  = y  - offset.top;
+               sl = sl - offset.scrollLeft;
+               st = st - offset.scrollTop;
+       }
+       
+       return {
+               top:  y,
+               left: x,
+               width:  elm.offsetWidth,
+               height: elm.offsetHeight,
+               borderTop:  parseInt(jQuery.css(elm, 'borderTopWidth'))  || 0,
+               borderLeft: parseInt(jQuery.css(elm, 'borderLeftWidth')) || 0,
+               marginTop:  parseInt(jQuery.css(elm, 'marginTopWidth'))  || 0,
+               marginLeft: parseInt(jQuery.css(elm, 'marginLeftWidth')) || 0,
+               scrollTop:  st,
+               scrollLeft: sl,
+               pageYOffset: window.pageYOffset || document.documentElement.scrollTop  || document.body.scrollTop  || 0,
+               pageXOffset: window.pageXOffset || document.documentElement.scrollLeft || document.body.scrollLeft || 0
+       };
 };
\ No newline at end of file