]> source.dussan.org Git - jquery.git/commitdiff
Touched up the docs and formatting.
authorJohn Resig <jeresig@gmail.com>
Fri, 8 Sep 2006 10:44:32 +0000 (10:44 +0000)
committerJohn Resig <jeresig@gmail.com>
Fri, 8 Sep 2006 10:44:32 +0000 (10:44 +0000)
src/dimensions/dimensions.js

index cc248202e666f9d4aa364df29ecce9be325caad4..a821696ee9e2020ffba7fccded8d9c885d70508d 100644 (file)
 /**\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 viewports (window's) height\r
+ * If used on window, returns the viewport's (window) height\r
  *\r
  * @example $("#testdiv").height()\r
- * @result [ 200px ]\r
+ * @result "200px"
+ *
+ * @example $(document).height();
+ * @result 800
+ *
+ * @example $(window).height();
+ * @result 400\r
  * \r
  * @name height\r
- * @type jQuery\r
+ * @type Object\r
  * @cat Dimensions\r
  */\r
 $.fn.height = function() {\r
-\r
-       if(this.get(0) == window) {\r
-               if (self.innerHeight) return self.innerHeight;  \r
-               else if (document.documentElement && document.documentElement.clientHeight) return document.documentElement.clientHeight;\r
-               else if (document.body) return document.body.clientHeight;\r
-       }\r
+       if ( this.get(0) == window )
+               return self.innerHeight ||
+                       jQuery.boxModel && document.documentElement.clientHeight ||\r
+                       document.body.clientHeight;\r
        \r
-       if(this.get(0) == document) {\r
-\r
-               var test1 = document.body.scrollHeight;\r
-               var test2 = document.body.offsetHeight;\r
-               if (test1 > test2) return document.body.scrollHeight;\r
-               else return document.body.offsetHeight;         \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 viewports (window's) width\r
+ * If used on window, returns the viewport's (window) width\r
  *\r
  * @example $("#testdiv").width()\r
- * @result [ 200px ]\r
+ * @result "200px"
+ *
+ * @example $(document).width();
+ * @result 800
+ *
+ * @example $(window).width();
+ * @result 400\r
  * \r
  * @name width\r
- * @type jQuery\r
+ * @type Object\r
  * @cat Dimensions\r
  */\r
 $.fn.width = function() {\r
-\r
-       if(this.get(0) == window) {\r
-               if (self.innerWidth) return self.innerWidth;    \r
-               else if (document.documentElement && document.documentElement.clientWidth) return document.documentElement.clientWidth;\r
-               else if (document.body) return document.body.clientWidth;\r
-       }\r
+       if ( this.get(0) == window )
+               return self.innerWidth ||
+                       jQuery.boxModel && document.documentElement.clientWidth ||\r
+                       document.body.clientWidth;\r
        \r
-       if(this.get(0) == document) {\r
-\r
-               var test1 = document.body.scrollWidth;\r
-               var test2 = document.body.offsetWidth;\r
-               if (test1 > test2) return document.body.scrollWidth;\r
-               else return document.body.offsetWidth;          \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 viewports (window's) height\r
+ * If used on window, returns the viewport's (window) height\r
  *\r
  * @example $("#testdiv").innerHeight()\r
- * @result [ 800px ]\r
+ * @result 800\r
  * \r
  * @name innerHeight\r
- * @type jQuery\r
+ * @type Number\r
  * @cat Dimensions\r
  */\r
 $.fn.innerHeight = function() {\r
-       if(this.get(0) == window || this.get(0) == document) return this.height();\r
-       return this.get(0).offsetHeight - (parseInt(this.css("borderTop")) + parseInt(this.css("borderBottom")));\r
-}\r
+       return this.get(0) == window || this.get(0) == document ?
+               this.height() :
+               this.get(0).offsetHeight - parseInt(this.css("borderTop")) - parseInt(this.css("borderBottom"));\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 viewports (window's) width\r
+ * If used on window, returns the viewport's (window) width\r
  *\r
  * @example $("#testdiv").innerWidth()\r
- * @result [ 1000px ]\r
+ * @result 1000\r
  * \r
  * @name innerWidth\r
- * @type jQuery\r
+ * @type Number\r
  * @cat Dimensions\r
  */\r
 $.fn.innerWidth = function() {\r
-       if(this.get(0) == window || this.get(0) == document) return this.width();\r
-       return this.get(0).offsetWidth - (parseInt(this.css("borderLeft")) + parseInt(this.css("borderRight")));\r
-}\r
+       return this.get(0) == window || this.get(0) == document ?
+               this.width() :
+               this.get(0).offsetWidth - parseInt(this.css("borderLeft")) - parseInt(this.css("borderRight"));\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 [ 1000px ]\r
+ * @result 1000\r
  * \r
  * @name outerHeight\r
- * @type jQuery\r
+ * @type Number\r
  * @cat Dimensions\r
  */\r
 $.fn.outerHeight = function() {\r
-       if(this.get(0) == window || this.get(0) == document) return 0;\r
-       return this.get(0).offsetHeight;        \r
-}\r
+       return this.get(0) == window || this.get(0) == document ?
+               this.height() :
+               this.get(0).offsetHeight;       \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 [ 1000px ]\r
+ * @result 1000\r
  * \r
  * @name outerWidth\r
- * @type jQuery\r
+ * @type Number\r
  * @cat Dimensions\r
  */\r
 $.fn.outerWidth = function() {\r
-       if(this.get(0) == window || this.get(0) == document) return 0;\r
-       return this.get(0).offsetWidth; \r
-}\r
+       return this.get(0) == window || this.get(0) == document ?
+               this.width() :
+               this.get(0).offsetWidth;        \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 [ 100px ]\r
+ * @result 100\r
  * \r
  * @name scrollLeft\r
- * @type jQuery\r
+ * @type Number\r
  * @cat Dimensions\r
  */\r
 $.fn.scrollLeft = function() {\r
-       if(this.get(0) == window || this.get(0) == document) {\r
-       if (self.pageXOffset) return self.pageXOffset;\r
-       else if (document.documentElement && document.documentElement.scrollLeft) return document.documentElement.scrollLeft;\r
-       else if (document.body) return document.body.scrollLeft;\r
-       }\r
+       if ( this.get(0) == window || this.get(0) == document )
+               return self.pageXOffset ||
+                       jQuery.boxModel && document.documentElement.scrollLeft ||
+                       document.body.scrollLeft;
+       \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 [ 100px ]\r
+ * @result 100\r
  * \r
  * @name scrollTop\r
- * @type jQuery\r
+ * @type Number\r
  * @cat Dimensions\r
  */\r
 $.fn.scrollTop = function() {\r
-       if(this.get(0) == window || this.get(0) == document) {\r
-       if (self.pageYOffset) return self.pageYOffset;\r
-       else if (document.documentElement && document.documentElement.scrollTop) return document.documentElement.scrollTop;\r
-       else if (document.body) return document.body.scrollTop;\r
-       }       \r
+       if ( this.get(0) == window || this.get(0) == document )
+               return self.pageYOffset ||
+                       jQuery.boxModel && document.documentElement.scrollTop ||
+                       document.body.scrollTop;
+\r
        return this.get(0).scrollTop;\r
-}
\ No newline at end of file
+};
\ No newline at end of file