Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Single.html
index 5c332d4..761b4da 100644 (file)
@@ -1,51 +1,63 @@
-<!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-slider.Single'>/**
-</span> * @class Ext.slider.Single
- * @extends Ext.slider.Multi
- * Slider which supports vertical or horizontal orientation, keyboard adjustments,
- * configurable snapping, axis clicking and animation. Can be added as an item to
- * any container. 
- * {@img Ext.slider.Single/Ext.slider.Single.png Ext.slider.Single component}
- * Example usage:
-&lt;pre&gt;&lt;code&gt;
-    Ext.create('Ext.slider.Single', {
-        width: 200,
-        value: 50,
-        increment: 10,
-        minValue: 0,
-        maxValue: 100,
-        renderTo: Ext.getBody()
-    });
-&lt;/code&gt;&lt;/pre&gt;
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/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-slider-Single'>/**
+</span> * Slider which supports vertical or horizontal orientation, keyboard adjustments, configurable snapping, axis clicking
+ * and animation. Can be added as an item to any container.
+ *
+ *     @example
+ *     Ext.create('Ext.slider.Single', {
+ *         width: 200,
+ *         value: 50,
+ *         increment: 10,
+ *         minValue: 0,
+ *         maxValue: 100,
+ *         renderTo: Ext.getBody()
+ *     });
+ *
  * The class Ext.slider.Single is aliased to Ext.Slider for backwards compatibility.
- * @xtype slider
  */
 Ext.define('Ext.slider.Single', {
     extend: 'Ext.slider.Multi',
     alias: ['widget.slider', 'widget.sliderfield'],
     alternateClassName: ['Ext.Slider', 'Ext.form.SliderField', 'Ext.slider.SingleSlider', 'Ext.slider.Slider'],
 
-<span id='Ext-slider.Single-method-getValue'>    /**
+<span id='Ext-slider-Single-method-getValue'>    /**
 </span>     * Returns the current value of the slider
      * @return {Number} The current value of the slider
      */
     getValue: function() {
-        //just returns the value of the first thumb, which should be the only one in a single slider
+        // just returns the value of the first thumb, which should be the only one in a single slider
         return this.callParent([0]);
     },
 
-<span id='Ext-slider.Single-method-setValue'>    /**
-</span>     * Programmatically sets the value of the Slider. Ensures that the value is constrained within
-     * the minValue and maxValue.
+<span id='Ext-slider-Single-method-setValue'>    /**
+</span>     * Programmatically sets the value of the Slider. Ensures that the value is constrained within the minValue and
+     * maxValue.
      * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
-     * @param {Boolean} animate Turn on or off animation, defaults to true
+     * @param {Boolean} [animate] Turn on or off animation
      */
     setValue: function(value, animate) {
         var args = Ext.toArray(arguments),
             len  = args.length;
 
-        //this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb
-        //index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider
-        //signature without the required index. The index will always be 0 for a single slider
+        // this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb
+        // index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider
+        // signature without the required index. The index will always be 0 for a single slider
         if (len == 1 || (len &lt;= 3 &amp;&amp; typeof arguments[1] != 'number')) {
             args.unshift(0);
         }
@@ -59,4 +71,6 @@ Ext.define('Ext.slider.Single', {
         return this.thumbs[0];
     }
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>