Upgrade to ExtJS 4.0.2 - Released 06/09/2011

[extjs.git] / docs / source / Number3.html
diff --git a/docs/source/Number3.html b/docs/source/Number3.html

index cd9a4fa..9076b4a 100644 (file)
--- a/docs/source/Number3.html
+++ b/docs/source/Number3.html
@@ -1,4 +1,21 @@
-<!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><span id='Ext-Number'>/**
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-Number'>/**
  </span> * @class Ext.Number
   *
   * A collection of useful static methods to deal with numbers
@@ -11,7 +28,7 @@ var isToFixedBroken = (0.9).toFixed() !== '1';
  
  Ext.Number = {
  <span id='Ext-Number-method-constrain'>    /**
-</span>     * Checks whether or not the current number is within a desired range.  If the number is already within the
+</span>     * Checks whether or not the passed number is within a desired range.  If the number is already within the
       * range it is returned, otherwise the min or max value is returned depending on which side of the range is
       * exceeded. Note that this method returns the constrained value but does not change the current number.
       * @param {Number} number The number to check
@@ -31,6 +48,33 @@ Ext.Number = {
          return number;
      },
  
+<span id='Ext-Number-method-snap'>    /**
+</span>     * Snaps the passed number between stopping points based upon a passed increment value.
+     * @param {Number} value The unsnapped value.
+     * @param {Number} increment The increment by which the value must move.
+     * @param {Number} minValue The minimum value to which the returned value must be constrained. Overrides the increment..
+     * @param {Number} maxValue The maximum value to which the returned value must be constrained. Overrides the increment..
+     * @return {Number} The value of the nearest snap target.
+     */
+    snap : function(value, increment, minValue, maxValue) {
+        var newValue = value,
+            m;
+
+        if (!(increment &amp;&amp; value)) {
+            return value;
+        }
+        m = value % increment;
+        if (m !== 0) {
+            newValue -= m;
+            if (m * 2 &gt;= increment) {
+                newValue += increment;
+            } else if (m * 2 &lt; -increment) {
+                newValue -= increment;
+            }
+        }
+        return Ext.Number.constrain(newValue, minValue,  maxValue);
+    },
+
  <span id='Ext-Number-method-toFixed'>    /**
  </span>     * Formats a number using fixed-point notation
       * @param {Number} value The number to format
@@ -77,4 +121,6 @@ Ext.Number.from('abc', 1); // returns 1
   */
  Ext.num = function() {
      return Ext.Number.from.apply(this, arguments);
-};</pre></pre></body></html>
-\ No newline at end of file
+};</pre>
+</body>
+</html>