Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / source / Slider.html
1 <html>
2 <head>
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
4   <title>The source code</title>
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
7 </head>
8 <body  onload="prettyPrint();">
9     <pre class="prettyprint lang-js">/*!
10  * Ext JS Library 3.2.0
11  * Copyright(c) 2006-2010 Ext JS, Inc.
12  * licensing@extjs.com
13  * http://www.extjs.com/license
14  */
15 Ext.ns('Ext.slider');
16
17 <div id="cls-Ext.slider.Thumb"></div>/**
18  * @class Ext.slider.Thumb
19  * @extends Object
20  * Represents a single thumb element on a Slider. This would not usually be created manually and would instead
21  * be created internally by an {@link Ext.slider.MultiSlider Ext.Slider}.
22  */
23 Ext.slider.Thumb = Ext.extend(Object, {
24
25     <div id="cfg-Ext.slider.Thumb-slider"></div>/**
26      * @constructor
27      * @cfg {Ext.slider.MultiSlider} slider The Slider to render to (required)
28      */
29     constructor: function(config) {
30         <div id="prop-Ext.slider.Thumb-slider"></div>/**
31          * @property slider
32          * @type Ext.slider.MultiSlider
33          * The slider this thumb is contained within
34          */
35         Ext.apply(this, config || {}, {
36             cls: 'x-slider-thumb',
37
38             <div id="cfg-Ext.slider.Thumb-constrain"></div>/**
39              * @cfg {Boolean} constrain True to constrain the thumb so that it cannot overlap its siblings
40              */
41             constrain: false
42         });
43
44         Ext.slider.Thumb.superclass.constructor.call(this, config);
45
46         if (this.slider.vertical) {
47             Ext.apply(this, Ext.slider.Thumb.Vertical);
48         }
49     },
50
51     <div id="method-Ext.slider.Thumb-render"></div>/**
52      * Renders the thumb into a slider
53      */
54     render: function() {
55         this.el = this.slider.innerEl.insertFirst({cls: this.cls});
56
57         this.initEvents();
58     },
59
60     <div id="method-Ext.slider.Thumb-enable"></div>/**
61      * Enables the thumb if it is currently disabled
62      */
63     enable: function() {
64         this.disabled = false;
65         this.el.removeClass(this.slider.disabledClass);
66     },
67
68     <div id="method-Ext.slider.Thumb-disable"></div>/**
69      * Disables the thumb if it is currently enabled
70      */
71     disable: function() {
72         this.disabled = true;
73         this.el.addClass(this.slider.disabledClass);
74     },
75
76     <div id="method-Ext.slider.Thumb-initEvents"></div>/**
77      * Sets up an Ext.dd.DragTracker for this thumb
78      */
79     initEvents: function() {
80         var el = this.el;
81
82         el.addClassOnOver('x-slider-thumb-over');
83
84         this.tracker = new Ext.dd.DragTracker({
85             onBeforeStart: this.onBeforeDragStart.createDelegate(this),
86             onStart      : this.onDragStart.createDelegate(this),
87             onDrag       : this.onDrag.createDelegate(this),
88             onEnd        : this.onDragEnd.createDelegate(this),
89             tolerance    : 3,
90             autoStart    : 300
91         });
92
93         this.tracker.initEl(el);
94     },
95
96     /**
97      * @private
98      * This is tied into the internal Ext.dd.DragTracker. If the slider is currently disabled,
99      * this returns false to disable the DragTracker too.
100      * @return {Boolean} False if the slider is currently disabled
101      */
102     onBeforeDragStart : function(e) {
103         if (this.disabled) {
104             return false;
105         } else {
106             this.slider.promoteThumb(this);
107             return true;
108         }
109     },
110
111     /**
112      * @private
113      * This is tied into the internal Ext.dd.DragTracker's onStart template method. Adds the drag CSS class
114      * to the thumb and fires the 'dragstart' event
115      */
116     onDragStart: function(e){
117         this.el.addClass('x-slider-thumb-drag');
118         this.dragging = true;
119         this.dragStartValue = this.value;
120
121         this.slider.fireEvent('dragstart', this.slider, e, this);
122     },
123
124     /**
125      * @private
126      * This is tied into the internal Ext.dd.DragTracker's onDrag template method. This is called every time
127      * the DragTracker detects a drag movement. It updates the Slider's value using the position of the drag
128      */
129     onDrag: function(e) {
130         var slider   = this.slider,
131             index    = this.index,
132             newValue = this.getNewValue();
133
134         if (this.constrain) {
135             var above = slider.thumbs[index + 1],
136                 below = slider.thumbs[index - 1];
137
138             if (below != undefined && newValue <= below.value) newValue = below.value;
139             if (above != undefined && newValue >= above.value) newValue = above.value;
140         }
141
142         slider.setValue(index, newValue, false);
143         slider.fireEvent('drag', slider, e, this);
144     },
145
146     getNewValue: function() {
147         var slider   = this.slider,
148             pos      = slider.innerEl.translatePoints(this.tracker.getXY());
149
150         return Ext.util.Format.round(slider.reverseValue(pos.left), slider.decimalPrecision);
151     },
152
153     /**
154      * @private
155      * This is tied to the internal Ext.dd.DragTracker's onEnd template method. Removes the drag CSS class and
156      * fires the 'changecomplete' event with the new value
157      */
158     onDragEnd: function(e) {
159         var slider = this.slider,
160             value  = this.value;
161
162         this.el.removeClass('x-slider-thumb-drag');
163
164         this.dragging = false;
165         slider.fireEvent('dragend', slider, e);
166
167         if (this.dragStartValue != value) {
168             slider.fireEvent('changecomplete', slider, value, this);
169         }
170     }
171 });
172
173 <div id="cls-Ext.slider.MultiSlider"></div>/**
174  * @class Ext.slider.MultiSlider
175  * @extends Ext.BoxComponent
176  * 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 usage:
177 <pre>
178 new Ext.Slider({
179     renderTo: Ext.getBody(),
180     width: 200,
181     value: 50,
182     increment: 10,
183     minValue: 0,
184     maxValue: 100
185 });
186 </pre>
187  * Sliders can be created with more than one thumb handle by passing an array of values instead of a single one:
188 <pre>
189 new Ext.Slider({
190     renderTo: Ext.getBody(),
191     width: 200,
192     values: [25, 50, 75],
193     minValue: 0,
194     maxValue: 100,
195
196     //this defaults to true, setting to false allows the thumbs to pass each other
197     {@link #constrainThumbs}: false
198 });
199 </pre>
200  */
201 Ext.slider.MultiSlider = Ext.extend(Ext.BoxComponent, {
202     <div id="cfg-Ext.slider.MultiSlider-value"></div>/**
203      * @cfg {Number} value The value to initialize the slider with. Defaults to minValue.
204      */
205     <div id="cfg-Ext.slider.MultiSlider-vertical"></div>/**
206      * @cfg {Boolean} vertical Orient the Slider vertically rather than horizontally, defaults to false.
207      */
208     vertical: false,
209     <div id="cfg-Ext.slider.MultiSlider-minValue"></div>/**
210      * @cfg {Number} minValue The minimum value for the Slider. Defaults to 0.
211      */
212     minValue: 0,
213     <div id="cfg-Ext.slider.MultiSlider-maxValue"></div>/**
214      * @cfg {Number} maxValue The maximum value for the Slider. Defaults to 100.
215      */
216     maxValue: 100,
217     <div id="cfg-Ext.slider.MultiSlider-decimalPrecision."></div>/**
218      * @cfg {Number/Boolean} decimalPrecision.
219      * <p>The number of decimal places to which to round the Slider's value. Defaults to 0.</p>
220      * <p>To disable rounding, configure as <tt><b>false</b></tt>.</p>
221      */
222     decimalPrecision: 0,
223     <div id="cfg-Ext.slider.MultiSlider-keyIncrement"></div>/**
224      * @cfg {Number} keyIncrement How many units to change the Slider when adjusting with keyboard navigation. Defaults to 1. If the increment config is larger, it will be used instead.
225      */
226     keyIncrement: 1,
227     <div id="cfg-Ext.slider.MultiSlider-increment"></div>/**
228      * @cfg {Number} increment How many units to change the slider when adjusting by drag and drop. Use this option to enable 'snapping'.
229      */
230     increment: 0,
231
232     /**
233      * @private
234      * @property clickRange
235      * @type Array
236      * Determines whether or not a click to the slider component is considered to be a user request to change the value. Specified as an array of [top, bottom],
237      * the click event's 'top' property is compared to these numbers and the click only considered a change request if it falls within them. e.g. if the 'top'
238      * value of the click event is 4 or 16, the click is not considered a change request as it falls outside of the [5, 15] range
239      */
240     clickRange: [5,15],
241
242     <div id="cfg-Ext.slider.MultiSlider-clickToChange"></div>/**
243      * @cfg {Boolean} clickToChange Determines whether or not clicking on the Slider axis will change the slider. Defaults to true
244      */
245     clickToChange : true,
246     <div id="cfg-Ext.slider.MultiSlider-animate"></div>/**
247      * @cfg {Boolean} animate Turn on or off animation. Defaults to true
248      */
249     animate: true,
250
251     <div id="prop-Ext.slider.MultiSlider-dragging"></div>/**
252      * True while the thumb is in a drag operation
253      * @type Boolean
254      */
255     dragging: false,
256
257     <div id="cfg-Ext.slider.MultiSlider-constrainThumbs"></div>/**
258      * @cfg {Boolean} constrainThumbs True to disallow thumbs from overlapping one another. Defaults to true
259      */
260     constrainThumbs: true,
261
262     /**
263      * @private
264      * @property topThumbZIndex
265      * @type Number
266      * The number used internally to set the z index of the top thumb (see promoteThumb for details)
267      */
268     topThumbZIndex: 10000,
269
270     // private override
271     initComponent : function(){
272         if(!Ext.isDefined(this.value)){
273             this.value = this.minValue;
274         }
275
276         <div id="prop-Ext.slider.MultiSlider-thumbs"></div>/**
277          * @property thumbs
278          * @type Array
279          * Array containing references to each thumb
280          */
281         this.thumbs = [];
282
283         Ext.slider.MultiSlider.superclass.initComponent.call(this);
284
285         this.keyIncrement = Math.max(this.increment, this.keyIncrement);
286         this.addEvents(
287             <div id="event-Ext.slider.MultiSlider-beforechange"></div>/**
288              * @event beforechange
289              * Fires before the slider value is changed. By returning false from an event handler,
290              * you can cancel the event and prevent the slider from changing.
291              * @param {Ext.Slider} slider The slider
292              * @param {Number} newValue The new value which the slider is being changed to.
293              * @param {Number} oldValue The old value which the slider was previously.
294              */
295             'beforechange',
296
297             <div id="event-Ext.slider.MultiSlider-change"></div>/**
298              * @event change
299              * Fires when the slider value is changed.
300              * @param {Ext.Slider} slider The slider
301              * @param {Number} newValue The new value which the slider has been changed to.
302              * @param {Ext.slider.Thumb} thumb The thumb that was changed
303              */
304             'change',
305
306             <div id="event-Ext.slider.MultiSlider-changecomplete"></div>/**
307              * @event changecomplete
308              * Fires when the slider value is changed by the user and any drag operations have completed.
309              * @param {Ext.Slider} slider The slider
310              * @param {Number} newValue The new value which the slider has been changed to.
311              * @param {Ext.slider.Thumb} thumb The thumb that was changed
312              */
313             'changecomplete',
314
315             <div id="event-Ext.slider.MultiSlider-dragstart"></div>/**
316              * @event dragstart
317              * Fires after a drag operation has started.
318              * @param {Ext.Slider} slider The slider
319              * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
320              */
321             'dragstart',
322
323             <div id="event-Ext.slider.MultiSlider-drag"></div>/**
324              * @event drag
325              * Fires continuously during the drag operation while the mouse is moving.
326              * @param {Ext.Slider} slider The slider
327              * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
328              */
329             'drag',
330
331             <div id="event-Ext.slider.MultiSlider-dragend"></div>/**
332              * @event dragend
333              * Fires after the drag operation has completed.
334              * @param {Ext.Slider} slider The slider
335              * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
336              */
337             'dragend'
338         );
339
340         <div id="prop-Ext.slider.MultiSlider-values"></div>/**
341          * @property values
342          * @type Array
343          * Array of values to initalize the thumbs with
344          */
345         if (this.values == undefined || Ext.isEmpty(this.values)) this.values = [0];
346
347         var values = this.values;
348
349         for (var i=0; i < values.length; i++) {
350             this.addThumb(values[i]);
351         }
352
353         if(this.vertical){
354             Ext.apply(this, Ext.slider.Vertical);
355         }
356     },
357
358     <div id="method-Ext.slider.MultiSlider-addThumb"></div>/**
359      * Creates a new thumb and adds it to the slider
360      * @param {Number} value The initial value to set on the thumb. Defaults to 0
361      */
362     addThumb: function(value) {
363         var thumb = new Ext.slider.Thumb({
364             value    : value,
365             slider   : this,
366             index    : this.thumbs.length,
367             constrain: this.constrainThumbs
368         });
369         this.thumbs.push(thumb);
370
371         //render the thumb now if needed
372         if (this.rendered) thumb.render();
373     },
374
375     /**
376      * @private
377      * Moves the given thumb above all other by increasing its z-index. This is called when as drag
378      * any thumb, so that the thumb that was just dragged is always at the highest z-index. This is
379      * required when the thumbs are stacked on top of each other at one of the ends of the slider's
380      * range, which can result in the user not being able to move any of them.
381      * @param {Ext.slider.Thumb} topThumb The thumb to move to the top
382      */
383     promoteThumb: function(topThumb) {
384         var thumbs = this.thumbs,
385             zIndex, thumb;
386
387         for (var i = 0, j = thumbs.length; i < j; i++) {
388             thumb = thumbs[i];
389
390             if (thumb == topThumb) {
391                 zIndex = this.topThumbZIndex;
392             } else {
393                 zIndex = '';
394             }
395
396             thumb.el.setStyle('zIndex', zIndex);
397         }
398     },
399
400     // private override
401     onRender : function() {
402         this.autoEl = {
403             cls: 'x-slider ' + (this.vertical ? 'x-slider-vert' : 'x-slider-horz'),
404             cn : {
405                 cls: 'x-slider-end',
406                 cn : {
407                     cls:'x-slider-inner',
408                     cn : [{tag:'a', cls:'x-slider-focus', href:"#", tabIndex: '-1', hidefocus:'on'}]
409                 }
410             }
411         };
412
413         Ext.slider.MultiSlider.superclass.onRender.apply(this, arguments);
414
415         this.endEl   = this.el.first();
416         this.innerEl = this.endEl.first();
417         this.focusEl = this.innerEl.child('.x-slider-focus');
418
419         //render each thumb
420         for (var i=0; i < this.thumbs.length; i++) {
421             this.thumbs[i].render();
422         }
423
424         //calculate the size of half a thumb
425         var thumb      = this.innerEl.child('.x-slider-thumb');
426         this.halfThumb = (this.vertical ? thumb.getHeight() : thumb.getWidth()) / 2;
427
428         this.initEvents();
429     },
430
431     /**
432      * @private
433      * Adds keyboard and mouse listeners on this.el. Ignores click events on the internal focus element.
434      * Creates a new DragTracker which is used to control what happens when the user drags the thumb around.
435      */
436     initEvents : function(){
437         this.mon(this.el, {
438             scope    : this,
439             mousedown: this.onMouseDown,
440             keydown  : this.onKeyDown
441         });
442
443         this.focusEl.swallowEvent("click", true);
444     },
445
446     /**
447      * @private
448      * Mousedown handler for the slider. If the clickToChange is enabled and the click was not on the draggable 'thumb',
449      * this calculates the new value of the slider and tells the implementation (Horizontal or Vertical) to move the thumb
450      * @param {Ext.EventObject} e The click event
451      */
452     onMouseDown : function(e){
453         if(this.disabled){
454             return;
455         }
456
457         //see if the click was on any of the thumbs
458         var thumbClicked = false;
459         for (var i=0; i < this.thumbs.length; i++) {
460             thumbClicked = thumbClicked || e.target == this.thumbs[i].el.dom;
461         }
462
463         if (this.clickToChange && !thumbClicked) {
464             var local = this.innerEl.translatePoints(e.getXY());
465             this.onClickChange(local);
466         }
467         this.focus();
468     },
469
470     /**
471      * @private
472      * Moves the thumb to the indicated position. Note that a Vertical implementation is provided in Ext.slider.Vertical.
473      * Only changes the value if the click was within this.clickRange.
474      * @param {Object} local Object containing top and left values for the click event.
475      */
476     onClickChange : function(local) {
477         if (local.top > this.clickRange[0] && local.top < this.clickRange[1]) {
478             //find the nearest thumb to the click event
479             var thumb = this.getNearest(local, 'left'),
480                 index = thumb.index;
481
482             this.setValue(index, Ext.util.Format.round(this.reverseValue(local.left), this.decimalPrecision), undefined, true);
483         }
484     },
485
486     /**
487      * @private
488      * Returns the nearest thumb to a click event, along with its distance
489      * @param {Object} local Object containing top and left values from a click event
490      * @param {String} prop The property of local to compare on. Use 'left' for horizontal sliders, 'top' for vertical ones
491      * @return {Object} The closest thumb object and its distance from the click event
492      */
493     getNearest: function(local, prop) {
494         var localValue = prop == 'top' ? this.innerEl.getHeight() - local[prop] : local[prop],
495             clickValue = this.reverseValue(localValue),
496             nearestDistance = (this.maxValue - this.minValue) + 5, //add a small fudge for the end of the slider 
497             index = 0,
498             nearest = null;
499
500         for (var i=0; i < this.thumbs.length; i++) {
501             var thumb = this.thumbs[i],
502                 value = thumb.value,
503                 dist  = Math.abs(value - clickValue);
504
505             if (Math.abs(dist <= nearestDistance)) {
506                 nearest = thumb;
507                 index = i;
508                 nearestDistance = dist;
509             }
510         }
511         return nearest;
512     },
513
514     /**
515      * @private
516      * Handler for any keypresses captured by the slider. If the key is UP or RIGHT, the thumb is moved along to the right
517      * by this.keyIncrement. If DOWN or LEFT it is moved left. Pressing CTRL moves the slider to the end in either direction
518      * @param {Ext.EventObject} e The Event object
519      */
520     onKeyDown : function(e){
521         if(this.disabled){e.preventDefault();return;}
522         var k = e.getKey();
523         switch(k){
524             case e.UP:
525             case e.RIGHT:
526                 e.stopEvent();
527                 if(e.ctrlKey){
528                     this.setValue(this.maxValue, undefined, true);
529                 }else{
530                     this.setValue(this.value+this.keyIncrement, undefined, true);
531                 }
532             break;
533             case e.DOWN:
534             case e.LEFT:
535                 e.stopEvent();
536                 if(e.ctrlKey){
537                     this.setValue(this.minValue, undefined, true);
538                 }else{
539                     this.setValue(this.value-this.keyIncrement, undefined, true);
540                 }
541             break;
542             default:
543                 e.preventDefault();
544         }
545     },
546
547     /**
548      * @private
549      * If using snapping, this takes a desired new value and returns the closest snapped
550      * value to it
551      * @param {Number} value The unsnapped value
552      * @return {Number} The value of the nearest snap target
553      */
554     doSnap : function(value){
555         if (!(this.increment && value)) {
556             return value;
557         }
558         var newValue = value,
559             inc = this.increment,
560             m = value % inc;
561         if (m != 0) {
562             newValue -= m;
563             if (m * 2 >= inc) {
564                 newValue += inc;
565             } else if (m * 2 < -inc) {
566                 newValue -= inc;
567             }
568         }
569         return newValue.constrain(this.minValue,  this.maxValue);
570     },
571
572     // private
573     afterRender : function(){
574         Ext.slider.MultiSlider.superclass.afterRender.apply(this, arguments);
575
576         for (var i=0; i < this.thumbs.length; i++) {
577             var thumb = this.thumbs[i];
578
579             if (thumb.value !== undefined) {
580                 var v = this.normalizeValue(thumb.value);
581
582                 if (v !== thumb.value) {
583                     // delete this.value;
584                     this.setValue(i, v, false);
585                 } else {
586                     this.moveThumb(i, this.translateValue(v), false);
587                 }
588             }
589         };
590     },
591
592     /**
593      * @private
594      * Returns the ratio of pixels to mapped values. e.g. if the slider is 200px wide and maxValue - minValue is 100,
595      * the ratio is 2
596      * @return {Number} The ratio of pixels to mapped values
597      */
598     getRatio : function(){
599         var w = this.innerEl.getWidth(),
600             v = this.maxValue - this.minValue;
601         return v == 0 ? w : (w/v);
602     },
603
604     /**
605      * @private
606      * Returns a snapped, constrained value when given a desired value
607      * @param {Number} value Raw number value
608      * @return {Number} The raw value rounded to the correct d.p. and constrained within the set max and min values
609      */
610     normalizeValue : function(v){
611         v = this.doSnap(v);
612         v = Ext.util.Format.round(v, this.decimalPrecision);
613         v = v.constrain(this.minValue, this.maxValue);
614         return v;
615     },
616
617     <div id="method-Ext.slider.MultiSlider-setMinValue"></div>/**
618      * Sets the minimum value for the slider instance. If the current value is less than the
619      * minimum value, the current value will be changed.
620      * @param {Number} val The new minimum value
621      */
622     setMinValue : function(val){
623         this.minValue = val;
624         this.syncThumb();
625
626         for (var i=0, j = this.thumbs.length; i < j; i++) {
627             if (this.thumbs[i].value < val) this.thumbs[i].value = val;
628         }
629     },
630
631     <div id="method-Ext.slider.MultiSlider-setMaxValue"></div>/**
632      * Sets the maximum value for the slider instance. If the current value is more than the
633      * maximum value, the current value will be changed.
634      * @param {Number} val The new maximum value
635      */
636     setMaxValue : function(val){
637         this.maxValue = val;
638         this.syncThumb();
639
640         for (var i=0; i < this.thumbs.length; i++) {
641             if (this.thumbs[i].value > val) this.thumbs[i].value = val;
642         }
643     },
644
645     <div id="method-Ext.slider.MultiSlider-setValue"></div>/**
646      * Programmatically sets the value of the Slider. Ensures that the value is constrained within
647      * the minValue and maxValue.
648      * @param {Number} index Index of the thumb to move
649      * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
650      * @param {Boolean} animate Turn on or off animation, defaults to true
651      */
652     setValue : function(index, v, animate, changeComplete) {
653         var thumb = this.thumbs[index],
654             el    = thumb.el;
655
656         v = this.normalizeValue(v);
657
658         if (v !== thumb.value && this.fireEvent('beforechange', this, v, thumb.value) !== false) {
659             thumb.value = v;
660             this.moveThumb(index, this.translateValue(v), animate !== false);
661             this.fireEvent('change', this, v, thumb);
662             if(changeComplete){
663                 this.fireEvent('changecomplete', this, v, thumb);
664             }
665         }
666     },
667
668     /**
669      * @private
670      */
671     translateValue : function(v) {
672         var ratio = this.getRatio();
673         return (v * ratio) - (this.minValue * ratio) - this.halfThumb;
674     },
675
676     /**
677      * @private
678      * Given a pixel location along the slider, returns the mapped slider value for that pixel.
679      * E.g. if we have a slider 200px wide with minValue = 100 and maxValue = 500, reverseValue(50)
680      * returns 200
681      * @param {Number} pos The position along the slider to return a mapped value for
682      * @return {Number} The mapped value for the given position
683      */
684     reverseValue : function(pos){
685         var ratio = this.getRatio();
686         return (pos + (this.minValue * ratio)) / ratio;
687     },
688
689     /**
690      * @private
691      * @param {Number} index Index of the thumb to move
692      */
693     moveThumb: function(index, v, animate){
694         var thumb = this.thumbs[index].el;
695
696         if(!animate || this.animate === false){
697             thumb.setLeft(v);
698         }else{
699             thumb.shift({left: v, stopFx: true, duration:.35});
700         }
701     },
702
703     // private
704     focus : function(){
705         this.focusEl.focus(10);
706     },
707
708     // private
709     onResize : function(w, h){
710         var thumbs = this.thumbs,
711             len = thumbs.length,
712             i = 0;
713             
714         /*
715          * If we happen to be animating during a resize, the position of the thumb will likely be off
716          * when the animation stops. As such, just stop any animations before syncing the thumbs.
717          */
718         for(; i < len; ++i){
719             thumbs[i].el.stopFx();    
720         }
721         this.innerEl.setWidth(w - (this.el.getPadding('l') + this.endEl.getPadding('r')));
722         this.syncThumb();
723         Ext.slider.MultiSlider.superclass.onResize.apply(this, arguments);
724     },
725
726     //private
727     onDisable: function(){
728         Ext.slider.MultiSlider.superclass.onDisable.call(this);
729
730         for (var i=0; i < this.thumbs.length; i++) {
731             var thumb = this.thumbs[i],
732                 el    = thumb.el;
733
734             thumb.disable();
735
736             if(Ext.isIE){
737                 //IE breaks when using overflow visible and opacity other than 1.
738                 //Create a place holder for the thumb and display it.
739                 var xy = el.getXY();
740                 el.hide();
741
742                 this.innerEl.addClass(this.disabledClass).dom.disabled = true;
743
744                 if (!this.thumbHolder) {
745                     this.thumbHolder = this.endEl.createChild({cls: 'x-slider-thumb ' + this.disabledClass});
746                 }
747
748                 this.thumbHolder.show().setXY(xy);
749             }
750         }
751     },
752
753     //private
754     onEnable: function(){
755         Ext.slider.MultiSlider.superclass.onEnable.call(this);
756
757         for (var i=0; i < this.thumbs.length; i++) {
758             var thumb = this.thumbs[i],
759                 el    = thumb.el;
760
761             thumb.enable();
762
763             if (Ext.isIE) {
764                 this.innerEl.removeClass(this.disabledClass).dom.disabled = false;
765
766                 if (this.thumbHolder) this.thumbHolder.hide();
767
768                 el.show();
769                 this.syncThumb();
770             }
771         }
772     },
773
774     <div id="method-Ext.slider.MultiSlider-syncThumb"></div>/**
775      * Synchronizes the thumb position to the proper proportion of the total component width based
776      * on the current slider {@link #value}.  This will be called automatically when the Slider
777      * is resized by a layout, but if it is rendered auto width, this method can be called from
778      * another resize handler to sync the Slider if necessary.
779      */
780     syncThumb : function() {
781         if (this.rendered) {
782             for (var i=0; i < this.thumbs.length; i++) {
783                 this.moveThumb(i, this.translateValue(this.thumbs[i].value));
784             }
785         }
786     },
787
788     <div id="method-Ext.slider.MultiSlider-getValue"></div>/**
789      * Returns the current value of the slider
790      * @param {Number} index The index of the thumb to return a value for
791      * @return {Number} The current value of the slider
792      */
793     getValue : function(index) {
794         return this.thumbs[index].value;
795     },
796
797     <div id="method-Ext.slider.MultiSlider-getValues"></div>/**
798      * Returns an array of values - one for the location of each thumb
799      * @return {Array} The set of thumb values
800      */
801     getValues: function() {
802         var values = [];
803
804         for (var i=0; i < this.thumbs.length; i++) {
805             values.push(this.thumbs[i].value);
806         }
807
808         return values;
809     },
810
811     // private
812     beforeDestroy : function(){
813         Ext.destroyMembers(this, 'endEl', 'innerEl', 'thumb', 'halfThumb', 'focusEl', 'tracker', 'thumbHolder');
814         Ext.slider.MultiSlider.superclass.beforeDestroy.call(this);
815     }
816 });
817
818 Ext.reg('multislider', Ext.slider.MultiSlider);
819
820 <div id="cls-Ext.slider.SingleSlider"></div>/**
821  * @class Ext.slider.SingleSlider
822  * @extends Ext.slider.MultiSlider
823  * Slider which supports vertical or horizontal orientation, keyboard adjustments,
824  * configurable snapping, axis clicking and animation. Can be added as an item to
825  * any container. Example usage:
826 <pre><code>
827 new Ext.slider.SingleSlider({
828     renderTo: Ext.getBody(),
829     width: 200,
830     value: 50,
831     increment: 10,
832     minValue: 0,
833     maxValue: 100
834 });
835 </code></pre>
836  * The class Ext.slider.SingleSlider is aliased to Ext.Slider for backwards compatibility.
837  */
838 Ext.slider.SingleSlider = Ext.extend(Ext.slider.MultiSlider, {
839     constructor: function(config) {
840       config = config || {};
841
842       Ext.applyIf(config, {
843           values: [config.value || 0]
844       });
845
846       Ext.slider.SingleSlider.superclass.constructor.call(this, config);
847     },
848
849     <div id="method-Ext.slider.SingleSlider-getValue"></div>/**
850      * Returns the current value of the slider
851      * @return {Number} The current value of the slider
852      */
853     getValue: function() {
854         //just returns the value of the first thumb, which should be the only one in a single slider
855         return Ext.slider.SingleSlider.superclass.getValue.call(this, 0);
856     },
857
858     <div id="method-Ext.slider.SingleSlider-setValue"></div>/**
859      * Programmatically sets the value of the Slider. Ensures that the value is constrained within
860      * the minValue and maxValue.
861      * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
862      * @param {Boolean} animate Turn on or off animation, defaults to true
863      */
864     setValue: function(value, animate) {
865         var args = Ext.toArray(arguments),
866             len  = args.length;
867
868         //this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb
869         //index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider
870         //signature without the required index. The index will always be 0 for a single slider
871         if (len == 1 || (len <= 3 && typeof arguments[1] != 'number')) {
872             args.unshift(0);
873         }
874
875         return Ext.slider.SingleSlider.superclass.setValue.apply(this, args);
876     },
877
878     <div id="method-Ext.slider.SingleSlider-syncThumb"></div>/**
879      * Synchronizes the thumb position to the proper proportion of the total component width based
880      * on the current slider {@link #value}.  This will be called automatically when the Slider
881      * is resized by a layout, but if it is rendered auto width, this method can be called from
882      * another resize handler to sync the Slider if necessary.
883      */
884     syncThumb : function() {
885         return Ext.slider.SingleSlider.superclass.syncThumb.apply(this, [0].concat(arguments));
886     },
887     
888     // private
889     getNearest : function(){
890         // Since there's only 1 thumb, it's always the nearest
891         return this.thumbs[0];    
892     }
893 });
894
895 //backwards compatibility
896 Ext.Slider = Ext.slider.SingleSlider;
897
898 Ext.reg('slider', Ext.slider.SingleSlider);
899
900 // private class to support vertical sliders
901 Ext.slider.Vertical = {
902     onResize : function(w, h){
903         this.innerEl.setHeight(h - (this.el.getPadding('t') + this.endEl.getPadding('b')));
904         this.syncThumb();
905     },
906
907     getRatio : function(){
908         var h = this.innerEl.getHeight(),
909             v = this.maxValue - this.minValue;
910         return h/v;
911     },
912
913     moveThumb: function(index, v, animate) {
914         var thumb = this.thumbs[index],
915             el    = thumb.el;
916
917         if (!animate || this.animate === false) {
918             el.setBottom(v);
919         } else {
920             el.shift({bottom: v, stopFx: true, duration:.35});
921         }
922     },
923
924     onClickChange : function(local) {
925         if (local.left > this.clickRange[0] && local.left < this.clickRange[1]) {
926             var thumb = this.getNearest(local, 'top'),
927                 index = thumb.index,
928                 value = this.minValue + this.reverseValue(this.innerEl.getHeight() - local.top);
929
930             this.setValue(index, Ext.util.Format.round(value, this.decimalPrecision), undefined, true);
931         }
932     }
933 };
934
935 //private class to support vertical dragging of thumbs within a slider
936 Ext.slider.Thumb.Vertical = {
937     getNewValue: function() {
938         var slider   = this.slider,
939             innerEl  = slider.innerEl,
940             pos      = innerEl.translatePoints(this.tracker.getXY()),
941             bottom   = innerEl.getHeight() - pos.top;
942
943         return slider.minValue + Ext.util.Format.round(bottom / slider.getRatio(), slider.decimalPrecision);
944     }
945 };
946 </pre>    
947 </body>
948 </html>