X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..refs/heads/master:/docs/source/Point.html diff --git a/docs/source/Point.html b/docs/source/Point.html index 00f85e76..e13a3e42 100644 --- a/docs/source/Point.html +++ b/docs/source/Point.html @@ -1,14 +1,27 @@ -Sencha Documentation Project
/**
- * @class Ext.util.Point
- * @extends Ext.util.Region
- *
- * Represents a 2D point with x and y properties, useful for comparison and instantiation
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
+ * Represents a 2D point with x and y properties, useful for comparison and instantiation
  * from an event:
- * <pre><code>
- * var point = Ext.util.Point.fromEvent(e);
- * </code></pre>
+ *
+ *     var point = Ext.util.Point.fromEvent(e);
+ *
  */
-
 Ext.define('Ext.util.Point', {
 
     /* Begin Definitions */
@@ -16,11 +29,11 @@ Ext.define('Ext.util.Point', {
 
     statics: {
 
-        /**
+        /**
          * Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event
          * @static
          * @param {Event} e The event
-         * @returns Ext.util.Point
+         * @return {Ext.util.Point}
          */
         fromEvent: function(e) {
             e = (e.changedTouches && e.changedTouches.length > 0) ? e.changedTouches[0] : e;
@@ -30,11 +43,16 @@ Ext.define('Ext.util.Point', {
 
     /* End Definitions */
 
+    /**
+     * Creates a point from two coordinates.
+     * @param {Number} x X coordinate.
+     * @param {Number} y Y coordinate.
+     */
     constructor: function(x, y) {
         this.callParent([y, x, y, x]);
     },
 
-    /**
+    /**
      * Returns a human-eye-friendly string that represents this point,
      * useful for debugging
      * @return {String}
@@ -43,7 +61,7 @@ Ext.define('Ext.util.Point', {
         return "Point[" + this.x + "," + this.y + "]";
     },
 
-    /**
+    /**
      * Compare this point and another point
      * @param {Ext.util.Point/Object} The point to compare with, either an instance
      * of Ext.util.Point or an object with left and top properties
@@ -53,10 +71,9 @@ Ext.define('Ext.util.Point', {
         return (this.x == p.x && this.y == p.y);
     },
 
-    /**
+    /**
      * Whether the given point is not away from this point within the given threshold amount.
-     * TODO: Rename this isNear.
-     * @param {Ext.util.Point/Object} The point to check with, either an instance
+     * @param {Ext.util.Point/Object} p The point to check with, either an instance
      * of Ext.util.Point or an object with left and top properties
      * @param {Object/Number} threshold Can be either an object with x and y properties or a number
      * @return {Boolean}
@@ -73,10 +90,10 @@ Ext.define('Ext.util.Point', {
                 this.y <= p.y + threshold.y && this.y >= p.y - threshold.y);
     },
 
-    /**
+    /**
      * Compare this point with another point when the x and y values of both points are rounded. E.g:
      * [100.3,199.8] will equals to [100, 200]
-     * @param {Ext.util.Point/Object} The point to compare with, either an instance
+     * @param {Ext.util.Point/Object} p The point to compare with, either an instance
      * of Ext.util.Point or an object with x and y properties
      * @return {Boolean}
      */
@@ -84,13 +101,13 @@ Ext.define('Ext.util.Point', {
         return (Math.round(this.x) == Math.round(p.x) && Math.round(this.y) == Math.round(p.y));
     }
 }, function() {
-    /**
-     * Translate this region by the given offset amount. TODO: Either use translate or translateBy!
-     * @param {Ext.util.Offset/Object} offset Object containing the <code>x</code> and <code>y</code> properties.
-     * Or the x value is using the two argument form.
-     * @param {Number} The y value unless using an Offset object.
-     * @return {Ext.util.Region} this This Region
+    /**
+     * @method
+     * Alias for {@link #translateBy}
+     * @alias Ext.util.Region#translateBy
      */
     this.prototype.translate = Ext.util.Region.prototype.translateBy;
 });
-
\ No newline at end of file +
+ +